1 /******************************************************************************
3 * Module Name: prutils - Preprocessor utilities
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include "aslcompiler.h"
154 #define _COMPONENT ASL_PREPROCESSOR
155 ACPI_MODULE_NAME ("prutils")
158 /******************************************************************************
160 * FUNCTION: PrGetNextToken
162 * PARAMETERS: Buffer - Current line buffer
163 * MatchString - String with valid token delimiters
164 * Next - Set to next possible token in buffer
166 * RETURN: Next token (null-terminated). Modifies the input line.
167 * Remainder of line is stored in *Next.
169 * DESCRIPTION: Local implementation of strtok() with local storage for the
170 * next pointer. Not only thread-safe, but allows multiple
171 * parsing of substrings such as expressions.
173 *****************************************************************************/
186 /* Use Next if it is valid */
195 /* Skip any leading delimiters */
199 if (strchr (MatchString
, *Buffer
))
209 /* Anything left on the line? */
219 /* Find the end of this token */
223 if (strchr (MatchString
, *Buffer
))
243 /*******************************************************************************
247 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
248 * MessageId - Index into global message buffer
249 * Column - Column in current line
253 * DESCRIPTION: Preprocessor error reporting. Front end to AslCommonError2
255 ******************************************************************************/
264 AcpiOsPrintf ("%s (%u) : %s", Gbl_Files
[ASL_FILE_INPUT
].Filename
,
265 Gbl_CurrentLineNumber
, Gbl_CurrentLineBuffer
);
274 /* TBD: Need Logical line number? */
276 AslCommonError2 (Level
, MessageId
,
277 Gbl_CurrentLineNumber
, Column
,
278 Gbl_CurrentLineBuffer
,
279 Gbl_Files
[ASL_FILE_INPUT
].Filename
, "Preprocessor");
281 Gbl_PreprocessorError
= TRUE
;
285 /*******************************************************************************
287 * FUNCTION: PrReplaceData
289 * PARAMETERS: Buffer - Original(target) buffer pointer
290 * LengthToRemove - Length to be removed from target buffer
291 * BufferToAdd - Data to be inserted into target buffer
292 * LengthToAdd - Length of BufferToAdd
296 * DESCRIPTION: Generic buffer data replacement.
298 ******************************************************************************/
303 UINT32 LengthToRemove
,
310 /* Buffer is a string, so the length must include the terminating zero */
312 BufferLength
= strlen (Buffer
) + 1;
314 if (LengthToRemove
!= LengthToAdd
)
317 * Move some of the existing data
318 * 1) If adding more bytes than removing, make room for the new data
319 * 2) if removing more bytes than adding, delete the extra space
321 if (LengthToRemove
> 0)
323 memmove ((Buffer
+ LengthToAdd
), (Buffer
+ LengthToRemove
),
324 (BufferLength
- LengthToRemove
));
328 /* Now we can move in the new data */
332 memmove (Buffer
, BufferToAdd
, LengthToAdd
);
337 /*******************************************************************************
339 * FUNCTION: PrOpenIncludeFile
341 * PARAMETERS: Filename - Filename or pathname for include file
345 * DESCRIPTION: Open an include file and push it on the input file stack.
347 ******************************************************************************/
356 ASL_INCLUDE_DIR
*NextDir
;
359 /* Start the actual include file on the next line */
361 Gbl_CurrentLineOffset
++;
363 /* Attempt to open the include file */
364 /* If the file specifies an absolute path, just open it */
366 if ((Filename
[0] == '/') ||
367 (Filename
[0] == '\\') ||
368 (Filename
[1] == ':'))
370 IncludeFile
= PrOpenIncludeWithPrefix (
371 "", Filename
, OpenMode
, FullPathname
);
376 return (IncludeFile
);
380 * The include filename is not an absolute path.
382 * First, search for the file within the "local" directory -- meaning
383 * the same directory that contains the source file.
385 * Construct the file pathname from the global directory name.
387 IncludeFile
= PrOpenIncludeWithPrefix (
388 Gbl_DirectoryPath
, Filename
, OpenMode
, FullPathname
);
391 return (IncludeFile
);
395 * Second, search for the file within the (possibly multiple)
396 * directories specified by the -I option on the command line.
398 NextDir
= Gbl_IncludeDirList
;
401 IncludeFile
= PrOpenIncludeWithPrefix (
402 NextDir
->Dir
, Filename
, OpenMode
, FullPathname
);
405 return (IncludeFile
);
408 NextDir
= NextDir
->Next
;
411 /* We could not open the include file after trying very hard */
414 sprintf (Gbl_MainTokenBuffer
, "%s, %s", Filename
, strerror (errno
));
415 PrError (ASL_ERROR
, ASL_MSG_INCLUDE_FILE_OPEN
, 0);
420 /*******************************************************************************
422 * FUNCTION: FlOpenIncludeWithPrefix
424 * PARAMETERS: PrefixDir - Prefix directory pathname. Can be a zero
426 * Filename - The include filename from the source ASL.
428 * RETURN: Valid file descriptor if successful. Null otherwise.
430 * DESCRIPTION: Open an include file and push it on the input file stack.
432 ******************************************************************************/
435 PrOpenIncludeWithPrefix (
445 /* Build the full pathname to the file */
447 Pathname
= FlMergePathnames (PrefixDir
, Filename
);
449 DbgPrint (ASL_PARSE_OUTPUT
, PR_PREFIX_ID
450 "Include: Opening file - \"%s\"\n",
451 Gbl_CurrentLineNumber
, Pathname
);
453 /* Attempt to open the file, push if successful */
455 IncludeFile
= fopen (Pathname
, OpenMode
);
458 fprintf (stderr
, "Could not open include file %s\n", Pathname
);
462 /* Push the include file on the open input file stack */
464 PrPushInputFileStack (IncludeFile
, Pathname
);
465 *FullPathname
= Pathname
;
466 return (IncludeFile
);
470 /*******************************************************************************
472 * FUNCTION: AslPushInputFileStack
474 * PARAMETERS: InputFile - Open file pointer
475 * Filename - Name of the file
479 * DESCRIPTION: Push the InputFile onto the file stack, and point the parser
480 * to this file. Called when an include file is successfully
483 ******************************************************************************/
486 PrPushInputFileStack (
493 Gbl_HasIncludeFiles
= TRUE
;
495 /* Save the current state in an Fnode */
497 Fnode
= UtLocalCalloc (sizeof (PR_FILE_NODE
));
499 Fnode
->File
= Gbl_Files
[ASL_FILE_INPUT
].Handle
;
500 Fnode
->Next
= Gbl_InputFileList
;
501 Fnode
->Filename
= Gbl_Files
[ASL_FILE_INPUT
].Filename
;
502 Fnode
->CurrentLineNumber
= Gbl_CurrentLineNumber
;
504 /* Push it on the stack */
506 Gbl_InputFileList
= Fnode
;
508 DbgPrint (ASL_PARSE_OUTPUT
, PR_PREFIX_ID
509 "Push InputFile Stack: handle %p\n\n",
510 Gbl_CurrentLineNumber
, InputFile
);
512 /* Reset the global line count and filename */
514 Gbl_Files
[ASL_FILE_INPUT
].Filename
=
515 UtLocalCacheCalloc (strlen (Filename
) + 1);
516 strcpy (Gbl_Files
[ASL_FILE_INPUT
].Filename
, Filename
);
518 Gbl_Files
[ASL_FILE_INPUT
].Handle
= InputFile
;
519 Gbl_CurrentLineNumber
= 1;
521 /* Emit a new #line directive for the include file */
523 FlPrintFile (ASL_FILE_PREPROCESSOR
, "#line %u \"%s\"\n", 1, Filename
);
527 /*******************************************************************************
529 * FUNCTION: AslPopInputFileStack
533 * RETURN: 0 if a node was popped, -1 otherwise
535 * DESCRIPTION: Pop the top of the input file stack and point the parser to
536 * the saved parse buffer contained in the fnode. Also, set the
537 * global line counters to the saved values. This function is
538 * called when an include file reaches EOF.
540 ******************************************************************************/
543 PrPopInputFileStack (
549 Fnode
= Gbl_InputFileList
;
550 DbgPrint (ASL_PARSE_OUTPUT
, "\n" PR_PREFIX_ID
551 "Pop InputFile Stack, Fnode %p\n\n",
552 Gbl_CurrentLineNumber
, Fnode
);
559 /* Close the current include file */
561 fclose (Gbl_Files
[ASL_FILE_INPUT
].Handle
);
563 /* Update the top-of-stack */
565 Gbl_InputFileList
= Fnode
->Next
;
567 /* Reset global line counter and filename */
569 Gbl_Files
[ASL_FILE_INPUT
].Filename
= Fnode
->Filename
;
570 Gbl_Files
[ASL_FILE_INPUT
].Handle
= Fnode
->File
;
571 Gbl_CurrentLineNumber
= Fnode
->CurrentLineNumber
;
573 /* Emit a new #line directive after the include file */
575 FlPrintFile (ASL_FILE_PREPROCESSOR
, "#line %u \"%s\"\n",
576 Gbl_CurrentLineNumber
, Fnode
->Filename
);
578 /* All done with this node */