acpica/utilities/utnonansi.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: utnonansi - Non-ansi C library functions
0004  *
0005  ******************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154
0155
0156 #define _COMPONENT          ACPI_UTILITIES
0157         ACPI_MODULE_NAME    ("utnonansi")
0158
0159 /*
0160  * Non-ANSI C library functions - strlwr, strupr, stricmp, and "safe"
0161  * string functions.
0162  */
0163
0164 /*******************************************************************************
0165  *
0166  * FUNCTION:    AcpiUtStrlwr (strlwr)
0167  *
0168  * PARAMETERS:  SrcString       - The source string to convert
0169  *
0170  * RETURN:      None
0171  *
0172  * DESCRIPTION: Convert a string to lowercase
0173  *
0174  ******************************************************************************/
0175
0176 void
0177 AcpiUtStrlwr (
0178     char                    *SrcString)
0179 {
0180     char                    *String;
0181
0182
0183     ACPI_FUNCTION_ENTRY ();
0184
0185
0186     if (!SrcString)
0187     {
0188         return;
0189     }
0190
0191     /* Walk entire string, lowercasing the letters */
0192
0193     for (String = SrcString; *String; String++)
0194     {
0195         *String = (char) tolower ((int) *String);
0196     }
0197 }
0198
0199
0200 /*******************************************************************************
0201  *
0202  * FUNCTION:    AcpiUtStrupr (strupr)
0203  *
0204  * PARAMETERS:  SrcString       - The source string to convert
0205  *
0206  * RETURN:      None
0207  *
0208  * DESCRIPTION: Convert a string to uppercase
0209  *
0210  ******************************************************************************/
0211
0212 void
0213 AcpiUtStrupr (
0214     char                    *SrcString)
0215 {
0216     char                    *String;
0217
0218
0219     ACPI_FUNCTION_ENTRY ();
0220
0221
0222     if (!SrcString)
0223     {
0224         return;
0225     }
0226
0227     /* Walk entire string, uppercasing the letters */
0228
0229     for (String = SrcString; *String; String++)
0230     {
0231         *String = (char) toupper ((int) *String);
0232     }
0233 }
0234
0235
0236 /******************************************************************************
0237  *
0238  * FUNCTION:    AcpiUtStricmp (stricmp)
0239  *
0240  * PARAMETERS:  String1             - first string to compare
0241  *              String2             - second string to compare
0242  *
0243  * RETURN:      int that signifies string relationship. Zero means strings
0244  *              are equal.
0245  *
0246  * DESCRIPTION: Case-insensitive string compare. Implementation of the
0247  *              non-ANSI stricmp function.
0248  *
0249  ******************************************************************************/
0250
0251 int
0252 AcpiUtStricmp (
0253     char                    *String1,
0254     char                    *String2)
0255 {
0256     int                     c1;
0257     int                     c2;
0258
0259
0260     do
0261     {
0262         c1 = tolower ((int) *String1);
0263         c2 = tolower ((int) *String2);
0264
0265         String1++;
0266         String2++;
0267     }
0268     while ((c1 == c2) && (c1));
0269
0270     return (c1 - c2);
0271 }
0272
0273
0274 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
0275 /*******************************************************************************
0276  *
0277  * FUNCTION:    AcpiUtSafeStrcpy, AcpiUtSafeStrcat, AcpiUtSafeStrncat
0278  *
0279  * PARAMETERS:  Adds a "DestSize" parameter to each of the standard string
0280  *              functions. This is the size of the Destination buffer.
0281  *
0282  * RETURN:      TRUE if the operation would overflow the destination buffer.
0283  *
0284  * DESCRIPTION: Safe versions of standard Clib string functions. Ensure that
0285  *              the result of the operation will not overflow the output string
0286  *              buffer.
0287  *
0288  * NOTE:        These functions are typically only helpful for processing
0289  *              user input and command lines. For most ACPICA code, the
0290  *              required buffer length is precisely calculated before buffer
0291  *              allocation, so the use of these functions is unnecessary.
0292  *
0293  ******************************************************************************/
0294
0295 BOOLEAN
0296 AcpiUtSafeStrcpy (
0297     char                    *Dest,
0298     ACPI_SIZE               DestSize,
0299     char                    *Source)
0300 {
0301
0302     if (strlen (Source) >= DestSize)
0303     {
0304         return (TRUE);
0305     }
0306
0307     strcpy (Dest, Source);
0308     return (FALSE);
0309 }
0310
0311 BOOLEAN
0312 AcpiUtSafeStrcat (
0313     char                    *Dest,
0314     ACPI_SIZE               DestSize,
0315     char                    *Source)
0316 {
0317
0318     if ((strlen (Dest) + strlen (Source)) >= DestSize)
0319     {
0320         return (TRUE);
0321     }
0322
0323     strcat (Dest, Source);
0324     return (FALSE);
0325 }
0326
0327 BOOLEAN
0328 AcpiUtSafeStrncat (
0329     char                    *Dest,
0330     ACPI_SIZE               DestSize,
0331     char                    *Source,
0332     ACPI_SIZE               MaxTransferLength)
0333 {
0334     ACPI_SIZE               ActualTransferLength;
0335
0336
0337     ActualTransferLength = ACPI_MIN (MaxTransferLength, strlen (Source));
0338
0339     if ((strlen (Dest) + ActualTransferLength) >= DestSize)
0340     {
0341         return (TRUE);
0342     }
0343
0344     strncat (Dest, Source, MaxTransferLength);
0345     return (FALSE);
0346 }
0347
0348 void
0349 AcpiUtSafeStrncpy (
0350     char                    *Dest,
0351     char                    *Source,
0352     ACPI_SIZE               DestSize)
0353 {
0354     /* Always terminate destination string */
0355
0356     strncpy (Dest, Source, DestSize);
0357     Dest[DestSize - 1] = 0;
0358 }
0359
0360 #endif