l4/pkg/acpica/lib-acpi/src/acpica/compiler/prutils.c

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