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