1 /****************************************************************************** 2 * 3 * Module Name: prutils - Preprocessor utilities 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 <contrib/dev/acpica/compiler/aslcompiler.h> 153 #include <contrib/dev/acpica/compiler/dtcompiler.h> 154 155 156 #define _COMPONENT ASL_PREPROCESSOR 157 ACPI_MODULE_NAME ("prutils") 158 159 160 /****************************************************************************** 161 * 162 * FUNCTION: PrGetNextToken 163 * 164 * PARAMETERS: Buffer - Current line buffer 165 * MatchString - String with valid token delimiters 166 * Next - Set to next possible token in buffer 167 * 168 * RETURN: Next token (null-terminated). Modifies the input line. 169 * Remainder of line is stored in *Next. 170 * 171 * DESCRIPTION: Local implementation of strtok() with local storage for the 172 * next pointer. Not only thread-safe, but allows multiple 173 * parsing of substrings such as expressions. 174 * 175 *****************************************************************************/ 176 177 char * 178 PrGetNextToken ( 179 char *Buffer, 180 char *MatchString, 181 char **Next) 182 { 183 char *TokenStart; 184 185 186 if (!Buffer) 187 { 188 /* Use Next if it is valid */ 189 190 Buffer = *Next; 191 if (!(*Next)) 192 { 193 return (NULL); 194 } 195 } 196 197 /* Skip any leading delimiters */ 198 199 while (*Buffer) 200 { 201 if (strchr (MatchString, *Buffer)) 202 { 203 Buffer++; 204 } 205 else 206 { 207 break; 208 } 209 } 210 211 /* Anything left on the line? */ 212 213 if (!(*Buffer)) 214 { 215 *Next = NULL; 216 return (NULL); 217 } 218 219 TokenStart = Buffer; 220 221 /* Find the end of this token */ 222 223 while (*Buffer) 224 { 225 if (strchr (MatchString, *Buffer)) 226 { 227 *Buffer = 0; 228 *Next = Buffer+1; 229 if (!**Next) 230 { 231 *Next = NULL; 232 } 233 234 return (TokenStart); 235 } 236 237 Buffer++; 238 } 239 240 *Next = NULL; 241 return (TokenStart); 242 } 243 244 245 /******************************************************************************* 246 * 247 * FUNCTION: PrError 248 * 249 * PARAMETERS: Level - Seriousness (Warning/error, etc.) 250 * MessageId - Index into global message buffer 251 * Column - Column in current line 252 * 253 * RETURN: None 254 * 255 * DESCRIPTION: Preprocessor error reporting. Front end to AslCommonError2 256 * 257 ******************************************************************************/ 258 259 void 260 PrError ( 261 UINT8 Level, 262 UINT16 MessageId, 263 UINT32 Column) 264 { 265 #if 0 266 AcpiOsPrintf ("%s (%u) : %s", Gbl_Files[ASL_FILE_INPUT].Filename, 267 Gbl_CurrentLineNumber, Gbl_CurrentLineBuffer); 268 #endif 269 270 271 if (Column > 120) 272 { 273 Column = 0; 274 } 275 276 /* TBD: Need Logical line number? */ 277 278 AslCommonError2 (Level, MessageId, 279 Gbl_CurrentLineNumber, Column, 280 Gbl_CurrentLineBuffer, 281 Gbl_Files[ASL_FILE_INPUT].Filename, "Preprocessor"); 282 283 Gbl_PreprocessorError = TRUE; 284 } 285 286 287 /******************************************************************************* 288 * 289 * FUNCTION: PrReplaceData 290 * 291 * PARAMETERS: Buffer - Original(target) buffer pointer 292 * LengthToRemove - Length to be removed from target buffer 293 * BufferToAdd - Data to be inserted into target buffer 294 * LengthToAdd - Length of BufferToAdd 295 * 296 * RETURN: None 297 * 298 * DESCRIPTION: Generic buffer data replacement. 299 * 300 ******************************************************************************/ 301 302 void 303 PrReplaceData ( 304 char *Buffer, 305 UINT32 LengthToRemove, 306 char *BufferToAdd, 307 UINT32 LengthToAdd) 308 { 309 UINT32 BufferLength; 310 311 312 /* Buffer is a string, so the length must include the terminating zero */ 313 314 BufferLength = strlen (Buffer) + 1; 315 316 if (LengthToRemove != LengthToAdd) 317 { 318 /* 319 * Move some of the existing data 320 * 1) If adding more bytes than removing, make room for the new data 321 * 2) if removing more bytes than adding, delete the extra space 322 */ 323 if (LengthToRemove > 0) 324 { 325 memmove ((Buffer + LengthToAdd), (Buffer + LengthToRemove), 326 (BufferLength - LengthToRemove)); 327 } 328 } 329 330 /* Now we can move in the new data */ 331 332 if (LengthToAdd > 0) 333 { 334 memmove (Buffer, BufferToAdd, LengthToAdd); 335 } 336 } 337 338 339 /******************************************************************************* 340 * 341 * FUNCTION: PrOpenIncludeFile 342 * 343 * PARAMETERS: Filename - Filename or pathname for include file 344 * 345 * RETURN: None. 346 * 347 * DESCRIPTION: Open an include file and push it on the input file stack. 348 * 349 ******************************************************************************/ 350 351 FILE * 352 PrOpenIncludeFile ( 353 char *Filename, 354 char *OpenMode, 355 char **FullPathname) 356 { 357 FILE *IncludeFile; 358 ASL_INCLUDE_DIR *NextDir; 359 360 361 /* Start the actual include file on the next line */ 362 363 Gbl_CurrentLineOffset++; 364 365 /* Attempt to open the include file */ 366 /* If the file specifies an absolute path, just open it */ 367 368 if ((Filename[0] == '/') || 369 (Filename[0] == '\\') || 370 (Filename[1] == ':')) 371 { 372 IncludeFile = PrOpenIncludeWithPrefix ( 373 "", Filename, OpenMode, FullPathname); 374 if (!IncludeFile) 375 { 376 goto ErrorExit; 377 } 378 return (IncludeFile); 379 } 380 381 /* 382 * The include filename is not an absolute path. 383 * 384 * First, search for the file within the "local" directory -- meaning 385 * the same directory that contains the source file. 386 * 387 * Construct the file pathname from the global directory name. 388 */ 389 IncludeFile = PrOpenIncludeWithPrefix ( 390 Gbl_DirectoryPath, Filename, OpenMode, FullPathname); 391 if (IncludeFile) 392 { 393 return (IncludeFile); 394 } 395 396 /* 397 * Second, search for the file within the (possibly multiple) 398 * directories specified by the -I option on the command line. 399 */ 400 NextDir = Gbl_IncludeDirList; 401 while (NextDir) 402 { 403 IncludeFile = PrOpenIncludeWithPrefix ( 404 NextDir->Dir, Filename, OpenMode, FullPathname); 405 if (IncludeFile) 406 { 407 return (IncludeFile); 408 } 409 410 NextDir = NextDir->Next; 411 } 412 413 /* We could not open the include file after trying very hard */ 414 415 ErrorExit: 416 sprintf (Gbl_MainTokenBuffer, "%s, %s", Filename, strerror (errno)); 417 PrError (ASL_ERROR, ASL_MSG_INCLUDE_FILE_OPEN, 0); 418 return (NULL); 419 } 420 421 422 /******************************************************************************* 423 * 424 * FUNCTION: FlOpenIncludeWithPrefix 425 * 426 * PARAMETERS: PrefixDir - Prefix directory pathname. Can be a zero 427 * length string. 428 * Filename - The include filename from the source ASL. 429 * 430 * RETURN: Valid file descriptor if successful. Null otherwise. 431 * 432 * DESCRIPTION: Open an include file and push it on the input file stack. 433 * 434 ******************************************************************************/ 435 436 FILE * 437 PrOpenIncludeWithPrefix ( 438 char *PrefixDir, 439 char *Filename, 440 char *OpenMode, 441 char **FullPathname) 442 { 443 FILE *IncludeFile; 444 char *Pathname; 445 446 447 /* Build the full pathname to the file */ 448 449 Pathname = FlMergePathnames (PrefixDir, Filename); 450 451 DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID 452 "Include: Opening file - \"%s\"\n", 453 Gbl_CurrentLineNumber, Pathname); 454 455 /* Attempt to open the file, push if successful */ 456 457 IncludeFile = fopen (Pathname, OpenMode); 458 if (!IncludeFile) 459 { 460 fprintf (stderr, "Could not open include file %s\n", Pathname); 461 return (NULL); 462 } 463 464 /* Push the include file on the open input file stack */ 465 466 PrPushInputFileStack (IncludeFile, Pathname); 467 *FullPathname = Pathname; 468 return (IncludeFile); 469 } 470 471 472 /******************************************************************************* 473 * 474 * FUNCTION: AslPushInputFileStack 475 * 476 * PARAMETERS: InputFile - Open file pointer 477 * Filename - Name of the file 478 * 479 * RETURN: None 480 * 481 * DESCRIPTION: Push the InputFile onto the file stack, and point the parser 482 * to this file. Called when an include file is successfully 483 * opened. 484 * 485 ******************************************************************************/ 486 487 void 488 PrPushInputFileStack ( 489 FILE *InputFile, 490 char *Filename) 491 { 492 PR_FILE_NODE *Fnode; 493 494 495 Gbl_HasIncludeFiles = TRUE; 496 497 /* Save the current state in an Fnode */ 498 499 Fnode = UtLocalCalloc (sizeof (PR_FILE_NODE)); 500 501 Fnode->File = Gbl_Files[ASL_FILE_INPUT].Handle; 502 Fnode->Next = Gbl_InputFileList; 503 Fnode->Filename = Gbl_Files[ASL_FILE_INPUT].Filename; 504 Fnode->CurrentLineNumber = Gbl_CurrentLineNumber; 505 506 /* Push it on the stack */ 507 508 Gbl_InputFileList = Fnode; 509 510 DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID 511 "Push InputFile Stack: handle %p\n\n", 512 Gbl_CurrentLineNumber, InputFile); 513 514 /* Reset the global line count and filename */ 515 516 Gbl_Files[ASL_FILE_INPUT].Filename = 517 UtStringCacheCalloc (strlen (Filename) + 1); 518 strcpy (Gbl_Files[ASL_FILE_INPUT].Filename, Filename); 519 520 Gbl_Files[ASL_FILE_INPUT].Handle = InputFile; 521 Gbl_CurrentLineNumber = 1; 522 523 /* Emit a new #line directive for the include file */ 524 525 FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n", 1, Filename); 526 } 527 528 529 /******************************************************************************* 530 * 531 * FUNCTION: AslPopInputFileStack 532 * 533 * PARAMETERS: None 534 * 535 * RETURN: 0 if a node was popped, -1 otherwise 536 * 537 * DESCRIPTION: Pop the top of the input file stack and point the parser to 538 * the saved parse buffer contained in the fnode. Also, set the 539 * global line counters to the saved values. This function is 540 * called when an include file reaches EOF. 541 * 542 ******************************************************************************/ 543 544 BOOLEAN 545 PrPopInputFileStack ( 546 void) 547 { 548 PR_FILE_NODE *Fnode; 549 550 551 Fnode = Gbl_InputFileList; 552 DbgPrint (ASL_PARSE_OUTPUT, "\n" PR_PREFIX_ID 553 "Pop InputFile Stack, Fnode %p\n\n", 554 Gbl_CurrentLineNumber, Fnode); 555 556 if (!Fnode) 557 { 558 return (FALSE); 559 } 560 561 /* Close the current include file */ 562 563 fclose (Gbl_Files[ASL_FILE_INPUT].Handle); 564 565 /* Update the top-of-stack */ 566 567 Gbl_InputFileList = Fnode->Next; 568 569 /* Reset global line counter and filename */ 570 571 Gbl_Files[ASL_FILE_INPUT].Filename = Fnode->Filename; 572 Gbl_Files[ASL_FILE_INPUT].Handle = Fnode->File; 573 Gbl_CurrentLineNumber = Fnode->CurrentLineNumber; 574 575 /* Emit a new #line directive after the include file */ 576 577 FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n", 578 Gbl_CurrentLineNumber, Fnode->Filename); 579 580 /* All done with this node */ 581 582 ACPI_FREE (Fnode); 583 return (TRUE); 584 } 585