xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utnonansi.c (revision 56430ad8002b8fd1ac69b590e9cc130de6d9e852)
1 /*******************************************************************************
2  *
3  * Module Name: utnonansi - Non-ansi C library functions
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #include "acpi.h"
117 #include "accommon.h"
118 
119 
120 #define _COMPONENT          ACPI_UTILITIES
121         ACPI_MODULE_NAME    ("utnonansi")
122 
123 
124 /*
125  * Non-ANSI C library functions - strlwr, strupr, stricmp, and a 64-bit
126  * version of strtoul.
127  */
128 
129 /*******************************************************************************
130  *
131  * FUNCTION:    AcpiUtStrlwr (strlwr)
132  *
133  * PARAMETERS:  SrcString       - The source string to convert
134  *
135  * RETURN:      None
136  *
137  * DESCRIPTION: Convert a string to lowercase
138  *
139  ******************************************************************************/
140 
141 void
142 AcpiUtStrlwr (
143     char                    *SrcString)
144 {
145     char                    *String;
146 
147 
148     ACPI_FUNCTION_ENTRY ();
149 
150 
151     if (!SrcString)
152     {
153         return;
154     }
155 
156     /* Walk entire string, lowercasing the letters */
157 
158     for (String = SrcString; *String; String++)
159     {
160         *String = (char) tolower ((int) *String);
161     }
162 }
163 
164 
165 /*******************************************************************************
166  *
167  * FUNCTION:    AcpiUtStrupr (strupr)
168  *
169  * PARAMETERS:  SrcString       - The source string to convert
170  *
171  * RETURN:      None
172  *
173  * DESCRIPTION: Convert a string to uppercase
174  *
175  ******************************************************************************/
176 
177 void
178 AcpiUtStrupr (
179     char                    *SrcString)
180 {
181     char                    *String;
182 
183 
184     ACPI_FUNCTION_ENTRY ();
185 
186 
187     if (!SrcString)
188     {
189         return;
190     }
191 
192     /* Walk entire string, uppercasing the letters */
193 
194     for (String = SrcString; *String; String++)
195     {
196         *String = (char) toupper ((int) *String);
197     }
198 }
199 
200 
201 /******************************************************************************
202  *
203  * FUNCTION:    AcpiUtStricmp (stricmp)
204  *
205  * PARAMETERS:  String1             - first string to compare
206  *              String2             - second string to compare
207  *
208  * RETURN:      int that signifies string relationship. Zero means strings
209  *              are equal.
210  *
211  * DESCRIPTION: Case-insensitive string compare. Implementation of the
212  *              non-ANSI stricmp function.
213  *
214  ******************************************************************************/
215 
216 int
217 AcpiUtStricmp (
218     char                    *String1,
219     char                    *String2)
220 {
221     int                     c1;
222     int                     c2;
223 
224 
225     do
226     {
227         c1 = tolower ((int) *String1);
228         c2 = tolower ((int) *String2);
229 
230         String1++;
231         String2++;
232     }
233     while ((c1 == c2) && (c1));
234 
235     return (c1 - c2);
236 }
237 
238 
239 /*******************************************************************************
240  *
241  * FUNCTION:    AcpiUtStrtoul64
242  *
243  * PARAMETERS:  String          - Null terminated string
244  *              Base            - Radix of the string: 16 or ACPI_ANY_BASE;
245  *                                ACPI_ANY_BASE means 'in behalf of ToInteger'
246  *              RetInteger      - Where the converted integer is returned
247  *
248  * RETURN:      Status and Converted value
249  *
250  * DESCRIPTION: Convert a string into an unsigned value. Performs either a
251  *              32-bit or 64-bit conversion, depending on the current mode
252  *              of the interpreter.
253  *
254  * NOTE:        Does not support Octal strings, not needed.
255  *
256  ******************************************************************************/
257 
258 ACPI_STATUS
259 AcpiUtStrtoul64 (
260     char                    *String,
261     UINT32                  Base,
262     UINT64                  *RetInteger)
263 {
264     UINT32                  ThisDigit = 0;
265     UINT64                  ReturnValue = 0;
266     UINT64                  Quotient;
267     UINT64                  Dividend;
268     UINT32                  ToIntegerOp = (Base == ACPI_ANY_BASE);
269     UINT32                  Mode32 = (AcpiGbl_IntegerByteWidth == 4);
270     UINT8                   ValidDigits = 0;
271     UINT8                   SignOf0x = 0;
272     UINT8                   Term = 0;
273 
274 
275     ACPI_FUNCTION_TRACE_STR (UtStroul64, String);
276 
277 
278     switch (Base)
279     {
280     case ACPI_ANY_BASE:
281     case 16:
282 
283         break;
284 
285     default:
286 
287         /* Invalid Base */
288 
289         return_ACPI_STATUS (AE_BAD_PARAMETER);
290     }
291 
292     if (!String)
293     {
294         goto ErrorExit;
295     }
296 
297     /* Skip over any white space in the buffer */
298 
299     while ((*String) && (isspace ((int) *String) || *String == '\t'))
300     {
301         String++;
302     }
303 
304     if (ToIntegerOp)
305     {
306         /*
307          * Base equal to ACPI_ANY_BASE means 'ToInteger operation case'.
308          * We need to determine if it is decimal or hexadecimal.
309          */
310         if ((*String == '0') && (tolower ((int) *(String + 1)) == 'x'))
311         {
312             SignOf0x = 1;
313             Base = 16;
314 
315             /* Skip over the leading '0x' */
316             String += 2;
317         }
318         else
319         {
320             Base = 10;
321         }
322     }
323 
324     /* Any string left? Check that '0x' is not followed by white space. */
325 
326     if (!(*String) || isspace ((int) *String) || *String == '\t')
327     {
328         if (ToIntegerOp)
329         {
330             goto ErrorExit;
331         }
332         else
333         {
334             goto AllDone;
335         }
336     }
337 
338     /*
339      * Perform a 32-bit or 64-bit conversion, depending upon the current
340      * execution mode of the interpreter
341      */
342     Dividend = (Mode32) ? ACPI_UINT32_MAX : ACPI_UINT64_MAX;
343 
344     /* Main loop: convert the string to a 32- or 64-bit integer */
345 
346     while (*String)
347     {
348         if (isdigit ((int) *String))
349         {
350             /* Convert ASCII 0-9 to Decimal value */
351 
352             ThisDigit = ((UINT8) *String) - '0';
353         }
354         else if (Base == 10)
355         {
356             /* Digit is out of range; possible in ToInteger case only */
357 
358             Term = 1;
359         }
360         else
361         {
362             ThisDigit = (UINT8) toupper ((int) *String);
363             if (isxdigit ((int) ThisDigit))
364             {
365                 /* Convert ASCII Hex char to value */
366 
367                 ThisDigit = ThisDigit - 'A' + 10;
368             }
369             else
370             {
371                 Term = 1;
372             }
373         }
374 
375         if (Term)
376         {
377             if (ToIntegerOp)
378             {
379                 goto ErrorExit;
380             }
381             else
382             {
383                 break;
384             }
385         }
386         else if ((ValidDigits == 0) && (ThisDigit == 0) && !SignOf0x)
387         {
388             /* Skip zeros */
389             String++;
390             continue;
391         }
392 
393         ValidDigits++;
394 
395         if (SignOf0x && ((ValidDigits > 16) || ((ValidDigits > 8) && Mode32)))
396         {
397             /*
398              * This is ToInteger operation case.
399              * No any restrictions for string-to-integer conversion,
400              * see ACPI spec.
401              */
402             goto ErrorExit;
403         }
404 
405         /* Divide the digit into the correct position */
406 
407         (void) AcpiUtShortDivide (
408             (Dividend - (UINT64) ThisDigit), Base, &Quotient, NULL);
409 
410         if (ReturnValue > Quotient)
411         {
412             if (ToIntegerOp)
413             {
414                 goto ErrorExit;
415             }
416             else
417             {
418                 break;
419             }
420         }
421 
422         ReturnValue *= Base;
423         ReturnValue += ThisDigit;
424         String++;
425     }
426 
427     /* All done, normal exit */
428 
429 AllDone:
430 
431     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Converted value: %8.8X%8.8X\n",
432         ACPI_FORMAT_UINT64 (ReturnValue)));
433 
434     *RetInteger = ReturnValue;
435     return_ACPI_STATUS (AE_OK);
436 
437 
438 ErrorExit:
439     /* Base was set/validated above */
440 
441     if (Base == 10)
442     {
443         return_ACPI_STATUS (AE_BAD_DECIMAL_CONSTANT);
444     }
445     else
446     {
447         return_ACPI_STATUS (AE_BAD_HEX_CONSTANT);
448     }
449 }
450 
451 
452 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
453 /*******************************************************************************
454  *
455  * FUNCTION:    AcpiUtSafeStrcpy, AcpiUtSafeStrcat, AcpiUtSafeStrncat
456  *
457  * PARAMETERS:  Adds a "DestSize" parameter to each of the standard string
458  *              functions. This is the size of the Destination buffer.
459  *
460  * RETURN:      TRUE if the operation would overflow the destination buffer.
461  *
462  * DESCRIPTION: Safe versions of standard Clib string functions. Ensure that
463  *              the result of the operation will not overflow the output string
464  *              buffer.
465  *
466  * NOTE:        These functions are typically only helpful for processing
467  *              user input and command lines. For most ACPICA code, the
468  *              required buffer length is precisely calculated before buffer
469  *              allocation, so the use of these functions is unnecessary.
470  *
471  ******************************************************************************/
472 
473 BOOLEAN
474 AcpiUtSafeStrcpy (
475     char                    *Dest,
476     ACPI_SIZE               DestSize,
477     char                    *Source)
478 {
479 
480     if (strlen (Source) >= DestSize)
481     {
482         return (TRUE);
483     }
484 
485     strcpy (Dest, Source);
486     return (FALSE);
487 }
488 
489 BOOLEAN
490 AcpiUtSafeStrcat (
491     char                    *Dest,
492     ACPI_SIZE               DestSize,
493     char                    *Source)
494 {
495 
496     if ((strlen (Dest) + strlen (Source)) >= DestSize)
497     {
498         return (TRUE);
499     }
500 
501     strcat (Dest, Source);
502     return (FALSE);
503 }
504 
505 BOOLEAN
506 AcpiUtSafeStrncat (
507     char                    *Dest,
508     ACPI_SIZE               DestSize,
509     char                    *Source,
510     ACPI_SIZE               MaxTransferLength)
511 {
512     ACPI_SIZE               ActualTransferLength;
513 
514 
515     ActualTransferLength = ACPI_MIN (MaxTransferLength, strlen (Source));
516 
517     if ((strlen (Dest) + ActualTransferLength) >= DestSize)
518     {
519         return (TRUE);
520     }
521 
522     strncat (Dest, Source, MaxTransferLength);
523     return (FALSE);
524 }
525 #endif
526