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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
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.
133 *
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.
145 *
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.
149 *
150 *****************************************************************************/
151
152#include "acpi.h"
153#include "accommon.h"
154
155
156#define _COMPONENT          ACPI_UTILITIES
157        ACPI_MODULE_NAME    ("utnonansi")
158
159/*
160 * Non-ANSI C library functions - strlwr, strupr, stricmp, and "safe"
161 * string functions.
162 */
163
164/*******************************************************************************
165 *
166 * FUNCTION:    AcpiUtStrlwr (strlwr)
167 *
168 * PARAMETERS:  SrcString       - The source string to convert
169 *
170 * RETURN:      None
171 *
172 * DESCRIPTION: Convert a string to lowercase
173 *
174 ******************************************************************************/
175
176void
177AcpiUtStrlwr (
178    char                    *SrcString)
179{
180    char                    *String;
181
182
183    ACPI_FUNCTION_ENTRY ();
184
185
186    if (!SrcString)
187    {
188        return;
189    }
190
191    /* Walk entire string, lowercasing the letters */
192
193    for (String = SrcString; *String; String++)
194    {
195        *String = (char) tolower ((int) *String);
196    }
197}
198
199
200/*******************************************************************************
201 *
202 * FUNCTION:    AcpiUtStrupr (strupr)
203 *
204 * PARAMETERS:  SrcString       - The source string to convert
205 *
206 * RETURN:      None
207 *
208 * DESCRIPTION: Convert a string to uppercase
209 *
210 ******************************************************************************/
211
212void
213AcpiUtStrupr (
214    char                    *SrcString)
215{
216    char                    *String;
217
218
219    ACPI_FUNCTION_ENTRY ();
220
221
222    if (!SrcString)
223    {
224        return;
225    }
226
227    /* Walk entire string, uppercasing the letters */
228
229    for (String = SrcString; *String; String++)
230    {
231        *String = (char) toupper ((int) *String);
232    }
233}
234
235
236/******************************************************************************
237 *
238 * FUNCTION:    AcpiUtStricmp (stricmp)
239 *
240 * PARAMETERS:  String1             - first string to compare
241 *              String2             - second string to compare
242 *
243 * RETURN:      int that signifies string relationship. Zero means strings
244 *              are equal.
245 *
246 * DESCRIPTION: Case-insensitive string compare. Implementation of the
247 *              non-ANSI stricmp function.
248 *
249 ******************************************************************************/
250
251int
252AcpiUtStricmp (
253    char                    *String1,
254    char                    *String2)
255{
256    int                     c1;
257    int                     c2;
258
259
260    do
261    {
262        c1 = tolower ((int) *String1);
263        c2 = tolower ((int) *String2);
264
265        String1++;
266        String2++;
267    }
268    while ((c1 == c2) && (c1));
269
270    return (c1 - c2);
271}
272
273
274#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
275/*******************************************************************************
276 *
277 * FUNCTION:    AcpiUtSafeStrcpy, AcpiUtSafeStrcat, AcpiUtSafeStrncat
278 *
279 * PARAMETERS:  Adds a "DestSize" parameter to each of the standard string
280 *              functions. This is the size of the Destination buffer.
281 *
282 * RETURN:      TRUE if the operation would overflow the destination buffer.
283 *
284 * DESCRIPTION: Safe versions of standard Clib string functions. Ensure that
285 *              the result of the operation will not overflow the output string
286 *              buffer.
287 *
288 * NOTE:        These functions are typically only helpful for processing
289 *              user input and command lines. For most ACPICA code, the
290 *              required buffer length is precisely calculated before buffer
291 *              allocation, so the use of these functions is unnecessary.
292 *
293 ******************************************************************************/
294
295BOOLEAN
296AcpiUtSafeStrcpy (
297    char                    *Dest,
298    ACPI_SIZE               DestSize,
299    char                    *Source)
300{
301
302    if (strlen (Source) >= DestSize)
303    {
304        return (TRUE);
305    }
306
307    strcpy (Dest, Source);
308    return (FALSE);
309}
310
311BOOLEAN
312AcpiUtSafeStrcat (
313    char                    *Dest,
314    ACPI_SIZE               DestSize,
315    char                    *Source)
316{
317
318    if ((strlen (Dest) + strlen (Source)) >= DestSize)
319    {
320        return (TRUE);
321    }
322
323    strcat (Dest, Source);
324    return (FALSE);
325}
326
327BOOLEAN
328AcpiUtSafeStrncat (
329    char                    *Dest,
330    ACPI_SIZE               DestSize,
331    char                    *Source,
332    ACPI_SIZE               MaxTransferLength)
333{
334    ACPI_SIZE               ActualTransferLength;
335
336
337    ActualTransferLength = ACPI_MIN (MaxTransferLength, strlen (Source));
338
339    if ((strlen (Dest) + ActualTransferLength) >= DestSize)
340    {
341        return (TRUE);
342    }
343
344    strncat (Dest, Source, MaxTransferLength);
345    return (FALSE);
346}
347
348void
349AcpiUtSafeStrncpy (
350    char                    *Dest,
351    char                    *Source,
352    ACPI_SIZE               DestSize)
353{
354    /* Always terminate destination string */
355
356    strncpy (Dest, Source, DestSize);
357    Dest[DestSize - 1] = 0;
358}
359
360#endif
361