1 /******************************************************************************
3 * Module Name: prutils - Preprocessor utilities
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/compiler/aslcompiler.h>
45 #include <contrib/dev/acpica/compiler/dtcompiler.h>
48 #define _COMPONENT ASL_PREPROCESSOR
49 ACPI_MODULE_NAME ("prutils")
52 /******************************************************************************
54 * FUNCTION: PrGetNextToken
56 * PARAMETERS: Buffer - Current line buffer
57 * MatchString - String with valid token delimiters
58 * Next - Set to next possible token in buffer
60 * RETURN: Next token (null-terminated). Modifies the input line.
61 * Remainder of line is stored in *Next.
63 * DESCRIPTION: Local implementation of strtok() with local storage for the
64 * next pointer. Not only thread-safe, but allows multiple
65 * parsing of substrings such as expressions.
67 *****************************************************************************/
80 /* Use Next if it is valid */
89 /* Skip any leading delimiters */
93 if (strchr (MatchString, *Buffer))
103 /* Anything left on the line? */
113 /* Find the end of this token */
117 if (strchr (MatchString, *Buffer))
135 /*******************************************************************************
139 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
140 * MessageId - Index into global message buffer
141 * Column - Column in current line
145 * DESCRIPTION: Preprocessor error reporting. Front end to AslCommonError2
147 ******************************************************************************/
156 AcpiOsPrintf ("%s (%u) : %s", Gbl_Files[ASL_FILE_INPUT].Filename,
157 Gbl_CurrentLineNumber, Gbl_CurrentLineBuffer);
166 /* TBD: Need Logical line number? */
168 AslCommonError2 (Level, MessageId,
169 Gbl_CurrentLineNumber, Column,
170 Gbl_CurrentLineBuffer,
171 Gbl_Files[ASL_FILE_INPUT].Filename, "Preprocessor");
173 Gbl_PreprocessorError = TRUE;
177 /*******************************************************************************
179 * FUNCTION: PrReplaceData
181 * PARAMETERS: Buffer - Original(target) buffer pointer
182 * LengthToRemove - Length to be removed from target buffer
183 * BufferToAdd - Data to be inserted into target buffer
184 * LengthToAdd - Length of BufferToAdd
188 * DESCRIPTION: Generic buffer data replacement.
190 ******************************************************************************/
195 UINT32 LengthToRemove,
202 /* Buffer is a string, so the length must include the terminating zero */
204 BufferLength = strlen (Buffer) + 1;
206 if (LengthToRemove != LengthToAdd)
209 * Move some of the existing data
210 * 1) If adding more bytes than removing, make room for the new data
211 * 2) if removing more bytes than adding, delete the extra space
213 if (LengthToRemove > 0)
215 memmove ((Buffer + LengthToAdd), (Buffer + LengthToRemove),
216 (BufferLength - LengthToRemove));
220 /* Now we can move in the new data */
224 memmove (Buffer, BufferToAdd, LengthToAdd);
229 /*******************************************************************************
231 * FUNCTION: PrOpenIncludeFile
233 * PARAMETERS: Filename - Filename or pathname for include file
237 * DESCRIPTION: Open an include file and push it on the input file stack.
239 ******************************************************************************/
246 ASL_INCLUDE_DIR *NextDir;
250 * start the actual include file on the next line
252 Gbl_CurrentLineOffset++;
254 /* Attempt to open the include file */
256 /* If the file specifies an absolute path, just open it */
258 if ((Filename[0] == '/') ||
259 (Filename[0] == '\\') ||
260 (Filename[1] == ':'))
262 IncludeFile = PrOpenIncludeWithPrefix ("", Filename);
271 * The include filename is not an absolute path.
273 * First, search for the file within the "local" directory -- meaning
274 * the same directory that contains the source file.
276 * Construct the file pathname from the global directory name.
278 IncludeFile = PrOpenIncludeWithPrefix (Gbl_DirectoryPath, Filename);
285 * Second, search for the file within the (possibly multiple)
286 * directories specified by the -I option on the command line.
288 NextDir = Gbl_IncludeDirList;
291 IncludeFile = PrOpenIncludeWithPrefix (NextDir->Dir, Filename);
297 NextDir = NextDir->Next;
300 /* We could not open the include file after trying very hard */
303 sprintf (Gbl_MainTokenBuffer, "%s, %s", Filename, strerror (errno));
304 PrError (ASL_ERROR, ASL_MSG_INCLUDE_FILE_OPEN, 0);
308 /*******************************************************************************
310 * FUNCTION: FlOpenIncludeWithPrefix
312 * PARAMETERS: PrefixDir - Prefix directory pathname. Can be a zero
314 * Filename - The include filename from the source ASL.
316 * RETURN: Valid file descriptor if successful. Null otherwise.
318 * DESCRIPTION: Open an include file and push it on the input file stack.
320 ******************************************************************************/
323 PrOpenIncludeWithPrefix (
331 /* Build the full pathname to the file */
333 Pathname = ACPI_ALLOCATE (strlen (PrefixDir) + strlen (Filename) + 1);
335 strcpy (Pathname, PrefixDir);
336 strcat (Pathname, Filename);
338 DbgPrint (ASL_PARSE_OUTPUT, "\n" PR_PREFIX_ID
339 "Opening include file: path %s\n",
340 Gbl_CurrentLineNumber, Pathname);
342 /* Attempt to open the file, push if successful */
344 IncludeFile = fopen (Pathname, "r");
347 /* Push the include file on the open input file stack */
349 PrPushInputFileStack (IncludeFile, Pathname);
350 return (IncludeFile);
353 ACPI_FREE (Pathname);
358 /*******************************************************************************
360 * FUNCTION: AslPushInputFileStack
362 * PARAMETERS: InputFile - Open file pointer
363 * Filename - Name of the file
367 * DESCRIPTION: Push the InputFile onto the file stack, and point the parser
368 * to this file. Called when an include file is successfully
371 ******************************************************************************/
374 PrPushInputFileStack (
381 /* Save the current state in an Fnode */
383 Fnode = UtLocalCalloc (sizeof (PR_FILE_NODE));
385 Fnode->File = Gbl_Files[ASL_FILE_INPUT].Handle;
386 Fnode->Next = Gbl_InputFileList;
387 Fnode->Filename = Gbl_Files[ASL_FILE_INPUT].Filename;
388 Fnode->CurrentLineNumber = Gbl_CurrentLineNumber;
390 /* Push it on the stack */
392 Gbl_InputFileList = Fnode;
394 DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
395 "Push InputFile Stack: handle %p\n\n",
396 Gbl_CurrentLineNumber, InputFile);
398 /* Reset the global line count and filename */
400 Gbl_Files[ASL_FILE_INPUT].Filename = Filename;
401 Gbl_Files[ASL_FILE_INPUT].Handle = InputFile;
402 Gbl_PreviousLineNumber = 0;
403 Gbl_CurrentLineNumber = 0;
405 /* Emit a new #line directive for the include file */
407 FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n",
412 /*******************************************************************************
414 * FUNCTION: AslPopInputFileStack
418 * RETURN: 0 if a node was popped, -1 otherwise
420 * DESCRIPTION: Pop the top of the input file stack and point the parser to
421 * the saved parse buffer contained in the fnode. Also, set the
422 * global line counters to the saved values. This function is
423 * called when an include file reaches EOF.
425 ******************************************************************************/
428 PrPopInputFileStack (
434 Fnode = Gbl_InputFileList;
435 DbgPrint (ASL_PARSE_OUTPUT, "\n" PR_PREFIX_ID
436 "Pop InputFile Stack, Fnode %p\n\n",
437 Gbl_CurrentLineNumber, Fnode);
444 /* Close the current include file */
446 fclose (Gbl_Files[ASL_FILE_INPUT].Handle);
448 /* Update the top-of-stack */
450 Gbl_InputFileList = Fnode->Next;
452 /* Reset global line counter and filename */
454 Gbl_Files[ASL_FILE_INPUT].Filename = Fnode->Filename;
455 Gbl_Files[ASL_FILE_INPUT].Handle = Fnode->File;
456 Gbl_CurrentLineNumber = Fnode->CurrentLineNumber;
457 Gbl_PreviousLineNumber = 0;
459 /* Emit a new #line directive after the include file */
461 FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n",
462 Gbl_CurrentLineNumber + 1, Fnode->Filename);
464 /* All done with this node */