1 /*******************************************************************************
3 * Module Name: utstrsuppt - Support functions for string-to-integer conversion
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
155 #define _COMPONENT ACPI_UTILITIES
156 ACPI_MODULE_NAME ("utstrsuppt")
159 /* Local prototypes */
163 UINT64 *AccumulatedValue,
168 AcpiUtStrtoulMultiply64 (
180 /*******************************************************************************
182 * FUNCTION: AcpiUtConvertOctalString
184 * PARAMETERS: String - Null terminated input string
185 * ReturnValuePtr - Where the converted value is returned
187 * RETURN: Status and 64-bit converted integer
189 * DESCRIPTION: Performs a base 8 conversion of the input string to an
190 * integer value, either 32 or 64 bits.
192 * NOTE: Maximum 64-bit unsigned octal value is 01777777777777777777777
193 * Maximum 32-bit unsigned octal value is 037777777777
195 ******************************************************************************/
198 AcpiUtConvertOctalString (
200 UINT64 *ReturnValuePtr)
202 UINT64 AccumulatedValue = 0;
203 ACPI_STATUS Status = AE_OK;
206 /* Convert each ASCII byte in the input string */
210 /* Character must be ASCII 0-7, otherwise terminate with no error */
212 if (!(ACPI_IS_OCTAL_DIGIT (*String)))
217 /* Convert and insert this octal digit into the accumulator */
219 Status = AcpiUtInsertDigit (&AccumulatedValue, 8, *String);
220 if (ACPI_FAILURE (Status))
222 Status = AE_OCTAL_OVERFLOW;
229 /* Always return the value that has been accumulated */
231 *ReturnValuePtr = AccumulatedValue;
236 /*******************************************************************************
238 * FUNCTION: AcpiUtConvertDecimalString
240 * PARAMETERS: String - Null terminated input string
241 * ReturnValuePtr - Where the converted value is returned
243 * RETURN: Status and 64-bit converted integer
245 * DESCRIPTION: Performs a base 10 conversion of the input string to an
246 * integer value, either 32 or 64 bits.
248 * NOTE: Maximum 64-bit unsigned decimal value is 18446744073709551615
249 * Maximum 32-bit unsigned decimal value is 4294967295
251 ******************************************************************************/
254 AcpiUtConvertDecimalString (
256 UINT64 *ReturnValuePtr)
258 UINT64 AccumulatedValue = 0;
259 ACPI_STATUS Status = AE_OK;
262 /* Convert each ASCII byte in the input string */
266 /* Character must be ASCII 0-9, otherwise terminate with no error */
268 if (!isdigit (*String))
273 /* Convert and insert this decimal digit into the accumulator */
275 Status = AcpiUtInsertDigit (&AccumulatedValue, 10, *String);
276 if (ACPI_FAILURE (Status))
278 Status = AE_DECIMAL_OVERFLOW;
285 /* Always return the value that has been accumulated */
287 *ReturnValuePtr = AccumulatedValue;
292 /*******************************************************************************
294 * FUNCTION: AcpiUtConvertHexString
296 * PARAMETERS: String - Null terminated input string
297 * ReturnValuePtr - Where the converted value is returned
299 * RETURN: Status and 64-bit converted integer
301 * DESCRIPTION: Performs a base 16 conversion of the input string to an
302 * integer value, either 32 or 64 bits.
304 * NOTE: Maximum 64-bit unsigned hex value is 0xFFFFFFFFFFFFFFFF
305 * Maximum 32-bit unsigned hex value is 0xFFFFFFFF
307 ******************************************************************************/
310 AcpiUtConvertHexString (
312 UINT64 *ReturnValuePtr)
314 UINT64 AccumulatedValue = 0;
315 ACPI_STATUS Status = AE_OK;
318 /* Convert each ASCII byte in the input string */
322 /* Must be ASCII A-F, a-f, or 0-9, otherwise terminate with no error */
324 if (!isxdigit (*String))
329 /* Convert and insert this hex digit into the accumulator */
331 Status = AcpiUtInsertDigit (&AccumulatedValue, 16, *String);
332 if (ACPI_FAILURE (Status))
334 Status = AE_HEX_OVERFLOW;
341 /* Always return the value that has been accumulated */
343 *ReturnValuePtr = AccumulatedValue;
348 /*******************************************************************************
350 * FUNCTION: AcpiUtRemoveLeadingZeros
352 * PARAMETERS: String - Pointer to input ASCII string
354 * RETURN: Next character after any leading zeros. This character may be
355 * used by the caller to detect end-of-string.
357 * DESCRIPTION: Remove any leading zeros in the input string. Return the
358 * next character after the final ASCII zero to enable the caller
359 * to check for the end of the string (NULL terminator).
361 ******************************************************************************/
364 AcpiUtRemoveLeadingZeros (
368 while (**String == ACPI_ASCII_ZERO)
377 /*******************************************************************************
379 * FUNCTION: AcpiUtRemoveWhitespace
381 * PARAMETERS: String - Pointer to input ASCII string
383 * RETURN: Next character after any whitespace. This character may be
384 * used by the caller to detect end-of-string.
386 * DESCRIPTION: Remove any leading whitespace in the input string. Return the
387 * next character after the final ASCII zero to enable the caller
388 * to check for the end of the string (NULL terminator).
390 ******************************************************************************/
393 AcpiUtRemoveWhitespace (
397 while (isspace ((UINT8) **String))
406 /*******************************************************************************
408 * FUNCTION: AcpiUtDetectHexPrefix
410 * PARAMETERS: String - Pointer to input ASCII string
412 * RETURN: TRUE if a "0x" prefix was found at the start of the string
414 * DESCRIPTION: Detect and remove a hex "0x" prefix
416 ******************************************************************************/
419 AcpiUtDetectHexPrefix (
422 char *InitialPosition = *String;
424 AcpiUtRemoveHexPrefix (String);
425 if (*String != InitialPosition)
427 return (TRUE); /* String is past leading 0x */
430 return (FALSE); /* Not a hex string */
434 /*******************************************************************************
436 * FUNCTION: AcpiUtRemoveHexPrefix
438 * PARAMETERS: String - Pointer to input ASCII string
442 * DESCRIPTION: Remove a hex "0x" prefix
444 ******************************************************************************/
447 AcpiUtRemoveHexPrefix (
450 if ((**String == ACPI_ASCII_ZERO) &&
451 (tolower ((int) *(*String + 1)) == 'x'))
453 *String += 2; /* Go past the leading 0x */
458 /*******************************************************************************
460 * FUNCTION: AcpiUtDetectOctalPrefix
462 * PARAMETERS: String - Pointer to input ASCII string
464 * RETURN: True if an octal "0" prefix was found at the start of the
467 * DESCRIPTION: Detect and remove an octal prefix (zero)
469 ******************************************************************************/
472 AcpiUtDetectOctalPrefix (
476 if (**String == ACPI_ASCII_ZERO)
478 *String += 1; /* Go past the leading 0 */
482 return (FALSE); /* Not an octal string */
486 /*******************************************************************************
488 * FUNCTION: AcpiUtInsertDigit
490 * PARAMETERS: AccumulatedValue - Current value of the integer value
491 * accumulator. The new value is
493 * Base - Radix, either 8/10/16
494 * AsciiDigit - ASCII single digit to be inserted
496 * RETURN: Status and result of the convert/insert operation. The only
497 * possible returned exception code is numeric overflow of
498 * either the multiply or add conversion operations.
500 * DESCRIPTION: Generic conversion and insertion function for all bases:
502 * 1) Multiply the current accumulated/converted value by the
503 * base in order to make room for the new character.
505 * 2) Convert the new character to binary and add it to the
506 * current accumulated value.
508 * Note: The only possible exception indicates an integer
509 * overflow (AE_NUMERIC_OVERFLOW)
511 ******************************************************************************/
515 UINT64 *AccumulatedValue,
523 /* Make room in the accumulated value for the incoming digit */
525 Status = AcpiUtStrtoulMultiply64 (*AccumulatedValue, Base, &Product);
526 if (ACPI_FAILURE (Status))
531 /* Add in the new digit, and store the sum to the accumulated value */
533 Status = AcpiUtStrtoulAdd64 (Product, AcpiUtAsciiCharToHex (AsciiDigit),
540 /*******************************************************************************
542 * FUNCTION: AcpiUtStrtoulMultiply64
544 * PARAMETERS: Multiplicand - Current accumulated converted integer
546 * OutProduct - Where the product is returned
548 * RETURN: Status and 64-bit product
550 * DESCRIPTION: Multiply two 64-bit values, with checking for 64-bit overflow as
551 * well as 32-bit overflow if necessary (if the current global
552 * integer width is 32).
554 ******************************************************************************/
557 AcpiUtStrtoulMultiply64 (
566 /* Exit if either operand is zero */
569 if (!Multiplicand || !Base)
575 * Check for 64-bit overflow before the actual multiplication.
577 * Notes: 64-bit division is often not supported on 32-bit platforms
578 * (it requires a library function), Therefore ACPICA has a local
579 * 64-bit divide function. Also, Multiplier is currently only used
580 * as the radix (8/10/16), to the 64/32 divide will always work.
582 AcpiUtShortDivide (ACPI_UINT64_MAX, Base, &Quotient, NULL);
583 if (Multiplicand > Quotient)
585 return (AE_NUMERIC_OVERFLOW);
588 Product = Multiplicand * Base;
590 /* Check for 32-bit overflow if necessary */
592 if ((AcpiGbl_IntegerBitWidth == 32) && (Product > ACPI_UINT32_MAX))
594 return (AE_NUMERIC_OVERFLOW);
597 *OutProduct = Product;
602 /*******************************************************************************
604 * FUNCTION: AcpiUtStrtoulAdd64
606 * PARAMETERS: Addend1 - Current accumulated converted integer
607 * Digit - New hex value/char
608 * OutSum - Where sum is returned (Accumulator)
610 * RETURN: Status and 64-bit sum
612 * DESCRIPTION: Add two 64-bit values, with checking for 64-bit overflow as
613 * well as 32-bit overflow if necessary (if the current global
614 * integer width is 32).
616 ******************************************************************************/
627 /* Check for 64-bit overflow before the actual addition */
629 if ((Addend1 > 0) && (Digit > (ACPI_UINT64_MAX - Addend1)))
631 return (AE_NUMERIC_OVERFLOW);
634 Sum = Addend1 + Digit;
636 /* Check for 32-bit overflow if necessary */
638 if ((AcpiGbl_IntegerBitWidth == 32) && (Sum > ACPI_UINT32_MAX))
640 return (AE_NUMERIC_OVERFLOW);