1 /*******************************************************************************
3 * Module Name: utstrtoul64 - string to 64-bit integer support
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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>
156 /*******************************************************************************
158 * The functions in this module satisfy the need for 64-bit string-to-integer
159 * conversions on both 32-bit and 64-bit platforms.
161 ******************************************************************************/
163 #define _COMPONENT ACPI_UTILITIES
164 ACPI_MODULE_NAME ("utstrtoul64")
166 /* Local prototypes */
169 AcpiUtStrtoulBase10 (
174 AcpiUtStrtoulBase16 (
179 /*******************************************************************************
181 * String conversion rules as written in the ACPI specification. The error
182 * conditions and behavior are different depending on the type of conversion.
185 * Implicit data type conversion: string-to-integer
186 * --------------------------------------------------
188 * Base is always 16. This is the ACPI_STRTOUL_BASE16 case.
191 * Add ("BA98", Arg0, Local0)
193 * The integer is initialized to the value zero.
194 * The ASCII string is interpreted as a hexadecimal constant.
196 * 1) A "0x" prefix is not allowed. However, ACPICA allows this for
197 * compatibility with previous ACPICA. (NO ERROR)
199 * 2) Terminates when the size of an integer is reached (32 or 64 bits).
202 * 3) The first non-hex character terminates the conversion without error.
205 * 4) Conversion of a null (zero-length) string to an integer is not
206 * allowed. However, ACPICA allows this for compatibility with previous
207 * ACPICA. This conversion returns the value 0. (NO ERROR)
210 * Explicit data type conversion: ToInteger() with string operand
211 * ---------------------------------------------------------------
213 * Base is either 10 (default) or 16 (with 0x prefix)
217 * ToInteger ("0xABCD")
219 * 1) Can be (must be) either a decimal or hexadecimal numeric string.
220 * A hex value must be prefixed by "0x" or it is interpreted as a decimal.
222 * 2) The value must not exceed the maximum of an integer value. ACPI spec
223 * states the behavior is "unpredictable", so ACPICA matches the behavior
224 * of the implicit conversion case.(NO ERROR)
226 * 3) Behavior on the first non-hex character is not specified by the ACPI
227 * spec, so ACPICA matches the behavior of the implicit conversion case
228 * and terminates. (NO ERROR)
230 * 4) A null (zero-length) string is illegal.
231 * However, ACPICA allows this for compatibility with previous ACPICA.
232 * This conversion returns the value 0. (NO ERROR)
234 ******************************************************************************/
237 /*******************************************************************************
239 * FUNCTION: AcpiUtStrtoul64
241 * PARAMETERS: String - Null terminated input string
242 * Flags - Conversion info, see below
243 * ReturnValue - Where the converted integer is
246 * RETURN: Status and Converted value
248 * DESCRIPTION: Convert a string into an unsigned value. Performs either a
249 * 32-bit or 64-bit conversion, depending on the input integer
250 * size in Flags (often the current mode of the interpreter).
253 * ACPI_STRTOUL_32BIT - Max integer value is 32 bits
254 * ACPI_STRTOUL_64BIT - Max integer value is 64 bits
255 * ACPI_STRTOUL_BASE16 - Input string is hexadecimal. Default
256 * is 10/16 based on string prefix (0x).
259 * Negative numbers are not supported, as they are not supported by ACPI.
261 * Supports only base 16 or base 10 strings/values. Does not
262 * support Octal strings, as these are not supported by ACPI.
264 * Current users of this support:
266 * Interpreter - Implicit and explicit conversions, GPE method names
267 * Debugger - Command line input string conversion
268 * iASL - Main parser, conversion of constants to integers
269 * iASL - Data Table Compiler parser (constant math expressions)
270 * iASL - Preprocessor (constant math expressions)
271 * AcpiDump - Input table addresses
272 * AcpiExec - Testing of the AcpiUtStrtoul64 function
274 * Note concerning callers:
275 * AcpiGbl_IntegerByteWidth can be used to set the 32/64 limit. If used,
276 * this global should be set to the proper width. For the core ACPICA code,
277 * this width depends on the DSDT version. For iASL, the default byte
278 * width is always 8 for the parser, but error checking is performed later
279 * to flag cases where a 64-bit constant is defined in a 32-bit DSDT/SSDT.
281 ******************************************************************************/
289 ACPI_STATUS Status = AE_OK;
293 ACPI_FUNCTION_TRACE_STR (UtStrtoul64, String);
296 /* Parameter validation */
298 if (!String || !ReturnValue)
300 return_ACPI_STATUS (AE_BAD_PARAMETER);
305 /* Check for zero-length string, returns 0 */
309 return_ACPI_STATUS (AE_OK);
312 /* Skip over any white space at start of string */
314 while (isspace ((int) *String))
319 /* End of string? return 0 */
323 return_ACPI_STATUS (AE_OK);
327 * 1) The "0x" prefix indicates base 16. Per the ACPI specification,
328 * the "0x" prefix is only allowed for implicit (non-strict) conversions.
329 * However, we always allow it for compatibility with older ACPICA.
331 if ((*String == ACPI_ASCII_ZERO) &&
332 (tolower ((int) *(String + 1)) == 'x'))
334 String += 2; /* Go past the 0x */
337 return_ACPI_STATUS (AE_OK); /* Return value 0 */
343 /* 2) Force to base 16 (implicit conversion case) */
345 else if (Flags & ACPI_STRTOUL_BASE16)
350 /* 3) Default fallback is to Base 10 */
357 /* Skip all leading zeros */
359 while (*String == ACPI_ASCII_ZERO)
364 return_ACPI_STATUS (AE_OK); /* Return value 0 */
368 /* Perform the base 16 or 10 conversion */
372 *ReturnValue = AcpiUtStrtoulBase16 (String, Flags);
376 *ReturnValue = AcpiUtStrtoulBase10 (String, Flags);
379 return_ACPI_STATUS (Status);
383 /*******************************************************************************
385 * FUNCTION: AcpiUtStrtoulBase10
387 * PARAMETERS: String - Null terminated input string
388 * Flags - Conversion info
390 * RETURN: 64-bit converted integer
392 * DESCRIPTION: Performs a base 10 conversion of the input string to an
393 * integer value, either 32 or 64 bits.
394 * Note: String must be valid and non-null.
396 ******************************************************************************/
399 AcpiUtStrtoulBase10 (
405 UINT64 ReturnValue = 0;
408 /* Main loop: convert each ASCII byte in the input string */
412 AsciiDigit = *String;
413 if (!isdigit (AsciiDigit))
415 /* Not ASCII 0-9, terminate */
420 /* Convert and insert (add) the decimal digit */
423 (ReturnValue * 10) + (AsciiDigit - ACPI_ASCII_ZERO);
425 /* Check for overflow (32 or 64 bit) - return current converted value */
427 if (((Flags & ACPI_STRTOUL_32BIT) && (NextValue > ACPI_UINT32_MAX)) ||
428 (NextValue < ReturnValue)) /* 64-bit overflow case */
433 ReturnValue = NextValue;
438 return (ReturnValue);
442 /*******************************************************************************
444 * FUNCTION: AcpiUtStrtoulBase16
446 * PARAMETERS: String - Null terminated input string
447 * Flags - conversion info
449 * RETURN: 64-bit converted integer
451 * DESCRIPTION: Performs a base 16 conversion of the input string to an
452 * integer value, either 32 or 64 bits.
453 * Note: String must be valid and non-null.
455 ******************************************************************************/
458 AcpiUtStrtoulBase16 (
463 UINT32 ValidDigits = 1;
464 UINT64 ReturnValue = 0;
467 /* Main loop: convert each ASCII byte in the input string */
471 /* Check for overflow (32 or 64 bit) - return current converted value */
473 if ((ValidDigits > 16) ||
474 ((ValidDigits > 8) && (Flags & ACPI_STRTOUL_32BIT)))
479 AsciiDigit = *String;
480 if (!isxdigit (AsciiDigit))
482 /* Not Hex ASCII A-F, a-f, or 0-9, terminate */
487 /* Convert and insert the hex digit */
490 (ReturnValue << 4) | AcpiUtAsciiCharToHex (AsciiDigit);
497 return (ReturnValue);