1 /*******************************************************************************
2  *
3  * Module Name: utstring - Common functions for strings and characters
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2017, 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 #include "acnamesp.h"
155 
156 
157 #define _COMPONENT          ACPI_UTILITIES
158         ACPI_MODULE_NAME    ("utstring")
159 
160 
161 /*******************************************************************************
162  *
163  * FUNCTION:    AcpiUtPrintString
164  *
165  * PARAMETERS:  String          - Null terminated ASCII string
166  *              MaxLength       - Maximum output length. Used to constrain the
167  *                                length of strings during debug output only.
168  *
169  * RETURN:      None
170  *
171  * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
172  *              sequences.
173  *
174  ******************************************************************************/
175 
176 void
177 AcpiUtPrintString (
178     char                    *String,
179     UINT16                  MaxLength)
180 {
181     UINT32                  i;
182 
183 
184     if (!String)
185     {
186         AcpiOsPrintf ("<\"NULL STRING PTR\">");
187         return;
188     }
189 
190     AcpiOsPrintf ("\"");
191     for (i = 0; (i < MaxLength) && String[i]; i++)
192     {
193         /* Escape sequences */
194 
195         switch (String[i])
196         {
197         case 0x07:
198 
199             AcpiOsPrintf ("\\a");       /* BELL */
200             break;
201 
202         case 0x08:
203 
204             AcpiOsPrintf ("\\b");       /* BACKSPACE */
205             break;
206 
207         case 0x0C:
208 
209             AcpiOsPrintf ("\\f");       /* FORMFEED */
210             break;
211 
212         case 0x0A:
213 
214             AcpiOsPrintf ("\\n");       /* LINEFEED */
215             break;
216 
217         case 0x0D:
218 
219             AcpiOsPrintf ("\\r");       /* CARRIAGE RETURN*/
220             break;
221 
222         case 0x09:
223 
224             AcpiOsPrintf ("\\t");       /* HORIZONTAL TAB */
225             break;
226 
227         case 0x0B:
228 
229             AcpiOsPrintf ("\\v");       /* VERTICAL TAB */
230             break;
231 
232         case '\'':                      /* Single Quote */
233         case '\"':                      /* Double Quote */
234         case '\\':                      /* Backslash */
235 
236             AcpiOsPrintf ("\\%c", (int) String[i]);
237             break;
238 
239         default:
240 
241             /* Check for printable character or hex escape */
242 
243             if (isprint ((int) String[i]))
244             {
245                 /* This is a normal character */
246 
247                 AcpiOsPrintf ("%c", (int) String[i]);
248             }
249             else
250             {
251                 /* All others will be Hex escapes */
252 
253                 AcpiOsPrintf ("\\x%2.2X", (INT32) String[i]);
254             }
255             break;
256         }
257     }
258 
259     AcpiOsPrintf ("\"");
260 
261     if (i == MaxLength && String[i])
262     {
263         AcpiOsPrintf ("...");
264     }
265 }
266 
267 
268 /*******************************************************************************
269  *
270  * FUNCTION:    AcpiUtRepairName
271  *
272  * PARAMETERS:  Name            - The ACPI name to be repaired
273  *
274  * RETURN:      Repaired version of the name
275  *
276  * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and
277  *              return the new name. NOTE: the Name parameter must reside in
278  *              read/write memory, cannot be a const.
279  *
280  * An ACPI Name must consist of valid ACPI characters. We will repair the name
281  * if necessary because we don't want to abort because of this, but we want
282  * all namespace names to be printable. A warning message is appropriate.
283  *
284  * This issue came up because there are in fact machines that exhibit
285  * this problem, and we want to be able to enable ACPI support for them,
286  * even though there are a few bad names.
287  *
288  ******************************************************************************/
289 
290 void
291 AcpiUtRepairName (
292     char                    *Name)
293 {
294     UINT32                  i;
295     BOOLEAN                 FoundBadChar = FALSE;
296     UINT32                  OriginalName;
297 
298 
299     ACPI_FUNCTION_NAME (UtRepairName);
300 
301 
302     /*
303      * Special case for the root node. This can happen if we get an
304      * error during the execution of module-level code.
305      */
306     if (ACPI_COMPARE_NAME (Name, "\\___"))
307     {
308         return;
309     }
310 
311     ACPI_MOVE_NAME (&OriginalName, Name);
312 
313     /* Check each character in the name */
314 
315     for (i = 0; i < ACPI_NAME_SIZE; i++)
316     {
317         if (AcpiUtValidNameChar (Name[i], i))
318         {
319             continue;
320         }
321 
322         /*
323          * Replace a bad character with something printable, yet technically
324          * still invalid. This prevents any collisions with existing "good"
325          * names in the namespace.
326          */
327         Name[i] = '*';
328         FoundBadChar = TRUE;
329     }
330 
331     if (FoundBadChar)
332     {
333         /* Report warning only if in strict mode or debug mode */
334 
335         if (!AcpiGbl_EnableInterpreterSlack)
336         {
337             ACPI_WARNING ((AE_INFO,
338                 "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]",
339                 OriginalName, Name));
340         }
341         else
342         {
343             ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
344                 "Invalid character(s) in name (0x%.8X), repaired: [%4.4s]",
345                 OriginalName, Name));
346         }
347     }
348 }
349 
350 
351 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
352 /*******************************************************************************
353  *
354  * FUNCTION:    UtConvertBackslashes
355  *
356  * PARAMETERS:  Pathname        - File pathname string to be converted
357  *
358  * RETURN:      Modifies the input Pathname
359  *
360  * DESCRIPTION: Convert all backslashes (0x5C) to forward slashes (0x2F) within
361  *              the entire input file pathname string.
362  *
363  ******************************************************************************/
364 
365 void
366 UtConvertBackslashes (
367     char                    *Pathname)
368 {
369 
370     if (!Pathname)
371     {
372         return;
373     }
374 
375     while (*Pathname)
376     {
377         if (*Pathname == '\\')
378         {
379             *Pathname = '/';
380         }
381 
382         Pathname++;
383     }
384 }
385 #endif
386