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