1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
|
/******************************************************************************
*
* Module Name: prscan - Preprocessor start-up and file scan module
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* documentation and/or other materials provided with distribution. In
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* provision in the documentation and/or other materials provided with the
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* ensure that the distribution and export/re-export of the software is in
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* any of its subsidiaries will export/re-export any technical data, process,
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************
*
* Alternatively, you may choose to be licensed under the terms of the
* following license:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
* 3. Neither the names of the above-listed copyright holders nor the names
* of any contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Alternatively, you may choose to be licensed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*
*****************************************************************************/
#define _DECLARE_PR_GLOBALS
#include "aslcompiler.h"
/*
* TBDs:
*
* No nested macros, maybe never
* Implement ASL "Include" as well as "#include" here?
*/
#define _COMPONENT ASL_PREPROCESSOR
ACPI_MODULE_NAME ("prscan")
/* Local prototypes */
static void
PrPreprocessInputFile (
void);
static void
PrDoDirective (
char *DirectiveToken,
char **Next);
static void
PrGetNextLineInit (
void);
static UINT32
PrGetNextLine (
FILE *Handle);
static int
PrMatchDirective (
char *Directive);
static void
PrPushDirective (
int Directive,
char *Argument);
static ACPI_STATUS
PrPopDirective (
void);
static void
PrDbgPrint (
char *Action,
char *DirectiveName);
static void
PrDoIncludeBuffer (
char *Pathname,
char *BufferName);
static void
PrDoIncludeFile (
char *Pathname);
/*
* Supported preprocessor directives
* Each entry is of the form "Name, ArgumentCount"
*/
static const PR_DIRECTIVE_INFO AslGbl_DirectiveInfo[] =
{
{"define", 1},
{"elif", 0}, /* Converted to #else..#if internally */
{"else", 0},
{"endif", 0},
{"error", 1},
{"if", 1},
{"ifdef", 1},
{"ifndef", 1},
{"include", 0}, /* Argument is not standard format, so just use 0 here */
{"includebuffer", 0}, /* Argument is not standard format, so just use 0 here */
{"line", 1},
{"pragma", 1},
{"undef", 1},
{"warning", 1},
{NULL, 0}
};
/* This table must match ordering of above table exactly */
enum Gbl_DirectiveIndexes
{
PR_DIRECTIVE_DEFINE = 0,
PR_DIRECTIVE_ELIF,
PR_DIRECTIVE_ELSE,
PR_DIRECTIVE_ENDIF,
PR_DIRECTIVE_ERROR,
PR_DIRECTIVE_IF,
PR_DIRECTIVE_IFDEF,
PR_DIRECTIVE_IFNDEF,
PR_DIRECTIVE_INCLUDE,
PR_DIRECTIVE_INCLUDEBUFFER,
PR_DIRECTIVE_LINE,
PR_DIRECTIVE_PRAGMA,
PR_DIRECTIVE_UNDEF,
PR_DIRECTIVE_WARNING
};
#define ASL_DIRECTIVE_NOT_FOUND -1
/*******************************************************************************
*
* FUNCTION: PrInitializePreprocessor
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Startup initialization for the Preprocessor.
*
******************************************************************************/
void
PrInitializePreprocessor (
void)
{
/* Init globals and the list of #defines */
PrInitializeGlobals ();
AslGbl_DefineList = NULL;
}
/*******************************************************************************
*
* FUNCTION: PrInitializeGlobals
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Initialize globals for the Preprocessor. Used for startuup
* initialization and re-initialization between compiles during
* a multiple source file compile.
*
******************************************************************************/
void
PrInitializeGlobals (
void)
{
/* Init globals */
AslGbl_InputFileList = NULL;
AslGbl_CurrentLineNumber = 1;
AslGbl_PreprocessorLineNumber = 1;
AslGbl_PreprocessorError = FALSE;
/* These are used to track #if/#else blocks (possibly nested) */
AslGbl_IfDepth = 0;
AslGbl_IgnoringThisCodeBlock = FALSE;
AslGbl_DirectiveStack = NULL;
}
/*******************************************************************************
*
* FUNCTION: PrTerminatePreprocessor
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Termination of the preprocessor. Delete lists. Keep any
* defines that were specified on the command line, in order to
* support multiple compiles with a single compiler invocation.
*
******************************************************************************/
void
PrTerminatePreprocessor (
void)
{
PR_DEFINE_INFO *DefineInfo;
/*
* The persistent defines (created on the command line) are always at the
* end of the list. We save them.
*/
while ((AslGbl_DefineList) && (!AslGbl_DefineList->Persist))
{
DefineInfo = AslGbl_DefineList;
AslGbl_DefineList = DefineInfo->Next;
ACPI_FREE (DefineInfo->Replacement);
ACPI_FREE (DefineInfo->Identifier);
ACPI_FREE (DefineInfo);
}
}
/*******************************************************************************
*
* FUNCTION: PrDoPreprocess
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Main entry point for the iASL Preprocessor. Input file must
* be already open. Handles multiple input files via the
* #include directive.
*
******************************************************************************/
void
PrDoPreprocess (
void)
{
BOOLEAN MoreInputFiles;
DbgPrint (ASL_DEBUG_OUTPUT, "Starting preprocessing phase\n\n");
FlSeekFile (ASL_FILE_INPUT, 0);
PrDumpPredefinedNames ();
/* Main preprocessor loop, handles include files */
do
{
PrPreprocessInputFile ();
MoreInputFiles = PrPopInputFileStack ();
} while (MoreInputFiles);
/* Point compiler input to the new preprocessor output file (.pre) */
FlCloseFile (ASL_FILE_INPUT);
AslGbl_Files[ASL_FILE_INPUT].Handle = AslGbl_Files[ASL_FILE_PREPROCESSOR].Handle;
AslCompilerin = AslGbl_Files[ASL_FILE_INPUT].Handle;
/* Reset globals to allow compiler to run */
FlSeekFile (ASL_FILE_INPUT, 0);
if (!AslGbl_PreprocessOnly)
{
AslGbl_CurrentLineNumber = 0;
}
DbgPrint (ASL_DEBUG_OUTPUT, "Preprocessing phase complete \n\n");
}
/*******************************************************************************
*
* FUNCTION: PrPreprocessInputFile
*
* PARAMETERS: None
*
* RETURN: None
*
* DESCRIPTION: Preprocess one entire file, line-by-line.
*
* Input: Raw user ASL from ASL_FILE_INPUT
* Output: Preprocessed file written to ASL_FILE_PREPROCESSOR and
* (optionally) ASL_FILE_PREPROCESSOR_USER
*
******************************************************************************/
static void
PrPreprocessInputFile (
void)
{
UINT32 Status;
char *Token;
char *ReplaceString;
PR_DEFINE_INFO *DefineInfo;
ACPI_SIZE TokenOffset;
char *Next;
int OffsetAdjust;
PrGetNextLineInit ();
/* Scan source line-by-line and process directives. Then write the .i file */
while ((Status = PrGetNextLine (AslGbl_Files[ASL_FILE_INPUT].Handle)) != ASL_EOF)
{
AslGbl_CurrentLineNumber++;
AslGbl_LogicalLineNumber++;
if (Status == ASL_IGNORE_LINE)
{
goto WriteEntireLine;
}
/* Need a copy of the input line for strok() */
strcpy (AslGbl_MainTokenBuffer, AslGbl_CurrentLineBuffer);
Token = PrGetNextToken (AslGbl_MainTokenBuffer, PR_TOKEN_SEPARATORS, &Next);
OffsetAdjust = 0;
/* All preprocessor directives must begin with '#' */
if (Token && (*Token == '#'))
{
if (strlen (Token) == 1)
{
Token = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, &Next);
}
else
{
Token++; /* Skip leading # */
}
/* Execute the directive, do not write line to output file */
PrDoDirective (Token, &Next);
continue;
}
/*
* If we are currently within the part of an IF/ELSE block that is
* FALSE, ignore the line and do not write it to the output file.
* This continues until an #else or #endif is encountered.
*/
if (AslGbl_IgnoringThisCodeBlock)
{
continue;
}
/* Match and replace all #defined names within this source line */
while (Token)
{
DefineInfo = PrMatchDefine (Token);
if (DefineInfo)
{
if (DefineInfo->Body)
{
/* This is a macro */
DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
"Matched Macro: %s->%s\n",
AslGbl_CurrentLineNumber, DefineInfo->Identifier,
DefineInfo->Replacement);
PrDoMacroInvocation (AslGbl_MainTokenBuffer, Token,
DefineInfo, &Next);
}
else
{
ReplaceString = DefineInfo->Replacement;
/* Replace the name in the original line buffer */
TokenOffset = Token - AslGbl_MainTokenBuffer + OffsetAdjust;
PrReplaceData (
&AslGbl_CurrentLineBuffer[TokenOffset], strlen (Token),
ReplaceString, strlen (ReplaceString));
/* Adjust for length difference between old and new name length */
OffsetAdjust += strlen (ReplaceString) - strlen (Token);
DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
"Matched #define: %s->%s\n",
AslGbl_CurrentLineNumber, Token,
*ReplaceString ? ReplaceString : "(NULL STRING)");
}
}
Token = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, &Next);
}
AslGbl_PreprocessorLineNumber++;
WriteEntireLine:
/*
* Now we can write the possibly modified source line to the
* preprocessor file(s).
*/
FlWriteFile (ASL_FILE_PREPROCESSOR, AslGbl_CurrentLineBuffer,
strlen (AslGbl_CurrentLineBuffer));
}
}
/*******************************************************************************
*
* FUNCTION: PrDoDirective
*
* PARAMETERS: Directive - Pointer to directive name token
* Next - "Next" buffer from GetNextToken
*
* RETURN: None.
*
* DESCRIPTION: Main processing for all preprocessor directives
*
******************************************************************************/
static void
PrDoDirective (
char *DirectiveToken,
char **Next)
{
char *Token = AslGbl_MainTokenBuffer;
char *Token2 = NULL;
char *End;
UINT64 Value;
ACPI_SIZE TokenOffset;
int Directive;
ACPI_STATUS Status;
if (!DirectiveToken)
{
goto SyntaxError;
}
Directive = PrMatchDirective (DirectiveToken);
if (Directive == ASL_DIRECTIVE_NOT_FOUND)
{
PrError (ASL_ERROR, ASL_MSG_UNKNOWN_DIRECTIVE,
THIS_TOKEN_OFFSET (DirectiveToken));
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"#%s: Unknown directive\n",
AslGbl_CurrentLineNumber, DirectiveToken);
return;
}
/*
* Emit a line directive into the preprocessor file (.pre) after
* every matched directive. This is passed through to the compiler
* so that error/warning messages are kept in sync with the
* original source file.
*/
FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\" // #%s\n",
AslGbl_CurrentLineNumber, AslGbl_Files[ASL_FILE_INPUT].Filename,
AslGbl_DirectiveInfo[Directive].Name);
/*
* If we are currently ignoring this block and we encounter a #else or
* #elif, we must ignore their blocks also if the parent block is also
* being ignored.
*/
if (AslGbl_IgnoringThisCodeBlock)
{
switch (Directive)
{
case PR_DIRECTIVE_ELSE:
case PR_DIRECTIVE_ELIF:
if (AslGbl_DirectiveStack &&
AslGbl_DirectiveStack->IgnoringThisCodeBlock)
{
PrDbgPrint ("Ignoring", AslGbl_DirectiveInfo[Directive].Name);
return;
}
break;
default:
break;
}
}
/*
* Need to always check for #else, #elif, #endif regardless of
* whether we are ignoring the current code block, since these
* are conditional code block terminators.
*/
switch (Directive)
{
case PR_DIRECTIVE_ELSE:
AslGbl_IgnoringThisCodeBlock = !(AslGbl_IgnoringThisCodeBlock);
PrDbgPrint ("Executing", "else block");
return;
case PR_DIRECTIVE_ELIF:
AslGbl_IgnoringThisCodeBlock = !(AslGbl_IgnoringThisCodeBlock);
Directive = PR_DIRECTIVE_IF;
if (AslGbl_IgnoringThisCodeBlock == TRUE)
{
/* Not executing the ELSE part -- all done here */
PrDbgPrint ("Ignoring", "elif block");
return;
}
/*
* After this, we will execute the IF part further below.
* First, however, pop off the original #if directive.
*/
if (ACPI_FAILURE (PrPopDirective ()))
{
PrError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
THIS_TOKEN_OFFSET (DirectiveToken));
}
PrDbgPrint ("Executing", "elif block");
break;
case PR_DIRECTIVE_ENDIF:
PrDbgPrint ("Executing", "endif");
/* Pop the owning #if/#ifdef/#ifndef */
if (ACPI_FAILURE (PrPopDirective ()))
{
PrError (ASL_ERROR, ASL_MSG_ENDIF_MISMATCH,
THIS_TOKEN_OFFSET (DirectiveToken));
}
return;
default:
break;
}
/* Most directives have at least one argument */
if (AslGbl_DirectiveInfo[Directive].ArgCount >= 1)
{
Token = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, Next);
if (!Token)
{
goto SyntaxError;
}
}
if (AslGbl_DirectiveInfo[Directive].ArgCount >= 2)
{
Token2 = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, Next);
if (!Token2)
{
goto SyntaxError;
}
}
/*
* At this point, if we are ignoring the current code block,
* do not process any more directives (i.e., ignore them also.)
* For "if" style directives, open/push a new block anyway. We
* must do this to keep track of #endif directives
*/
if (AslGbl_IgnoringThisCodeBlock)
{
switch (Directive)
{
case PR_DIRECTIVE_IF:
case PR_DIRECTIVE_IFDEF:
case PR_DIRECTIVE_IFNDEF:
PrPushDirective (Directive, Token);
PrDbgPrint ("Ignoring", AslGbl_DirectiveInfo[Directive].Name);
break;
default:
break;
}
return;
}
/*
* Execute the directive
*/
PrDbgPrint ("Begin execution", AslGbl_DirectiveInfo[Directive].Name);
switch (Directive)
{
case PR_DIRECTIVE_IF:
TokenOffset = Token - AslGbl_MainTokenBuffer;
/* Need to expand #define macros in the expression string first */
Status = PrResolveIntegerExpression (
&AslGbl_CurrentLineBuffer[TokenOffset-1], &Value);
if (ACPI_FAILURE (Status))
{
return;
}
PrPushDirective (Directive, Token);
if (!Value)
{
AslGbl_IgnoringThisCodeBlock = TRUE;
}
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"Resolved #if: %8.8X%8.8X %s\n",
AslGbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Value),
AslGbl_IgnoringThisCodeBlock ? "<Skipping Block>" : "<Executing Block>");
break;
case PR_DIRECTIVE_IFDEF:
PrPushDirective (Directive, Token);
if (!PrMatchDefine (Token))
{
AslGbl_IgnoringThisCodeBlock = TRUE;
}
PrDbgPrint ("Evaluated", "ifdef");
break;
case PR_DIRECTIVE_IFNDEF:
PrPushDirective (Directive, Token);
if (PrMatchDefine (Token))
{
AslGbl_IgnoringThisCodeBlock = TRUE;
}
PrDbgPrint ("Evaluated", "ifndef");
break;
case PR_DIRECTIVE_DEFINE:
/*
* By definition, if first char after the name is a paren,
* this is a function macro.
*/
TokenOffset = Token - AslGbl_MainTokenBuffer + strlen (Token);
if (*(&AslGbl_CurrentLineBuffer[TokenOffset]) == '(')
{
#ifndef MACROS_SUPPORTED
AcpiOsPrintf (
"%s ERROR - line %u: #define macros are not supported yet\n",
AslGbl_CurrentLineBuffer, AslGbl_LogicalLineNumber);
exit(1);
#else
PrAddMacro (Token, Next);
#endif
}
else
{
/* Use the remainder of the line for the #define */
Token2 = *Next;
if (Token2)
{
while ((*Token2 == ' ') || (*Token2 == '\t'))
{
Token2++;
}
End = Token2;
while (*End != '\n')
{
End++;
}
*End = 0;
}
else
{
Token2 = "";
}
#if 0
Token2 = PrGetNextToken (NULL, "\n", /*PR_TOKEN_SEPARATORS,*/ Next);
if (!Token2)
{
Token2 = "";
}
#endif
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"New #define: %s->%s\n",
AslGbl_LogicalLineNumber, Token, Token2);
PrAddDefine (Token, Token2, FALSE);
}
break;
case PR_DIRECTIVE_ERROR:
/* Note: No macro expansion */
PrError (ASL_ERROR, ASL_MSG_ERROR_DIRECTIVE,
THIS_TOKEN_OFFSET (Token));
AslGbl_SourceLine = 0;
AslGbl_NextError = AslGbl_ErrorLog;
CmCleanupAndExit ();
exit(1);
case PR_DIRECTIVE_INCLUDE:
Token = PrGetNextToken (NULL, " \"<>", Next);
if (!Token)
{
goto SyntaxError;
}
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"Start #include file \"%s\"\n", AslGbl_CurrentLineNumber,
Token, AslGbl_CurrentLineNumber);
PrDoIncludeFile (Token);
break;
case PR_DIRECTIVE_INCLUDEBUFFER:
Token = PrGetNextToken (NULL, " \"<>", Next);
if (!Token)
{
goto SyntaxError;
}
Token2 = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, Next);
if (!Token2)
{
goto SyntaxError;
}
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"Start #includebuffer input from file \"%s\", buffer name %s\n",
AslGbl_CurrentLineNumber, Token, Token2);
PrDoIncludeBuffer (Token, Token2);
break;
case PR_DIRECTIVE_LINE:
TokenOffset = Token - AslGbl_MainTokenBuffer;
Status = PrResolveIntegerExpression (
&AslGbl_CurrentLineBuffer[TokenOffset-1], &Value);
if (ACPI_FAILURE (Status))
{
return;
}
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"User #line invocation %s\n", AslGbl_CurrentLineNumber,
Token);
AslGbl_CurrentLineNumber = (UINT32) Value;
/* Emit #line into the preprocessor file */
FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n",
AslGbl_CurrentLineNumber, AslGbl_Files[ASL_FILE_INPUT].Filename);
break;
case PR_DIRECTIVE_PRAGMA:
if (!strcmp (Token, "disable"))
{
Token = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, Next);
if (!Token)
{
goto SyntaxError;
}
TokenOffset = Token - AslGbl_MainTokenBuffer;
AslDisableException (&AslGbl_CurrentLineBuffer[TokenOffset]);
}
else if (!strcmp (Token, "message"))
{
Token = PrGetNextToken (NULL, PR_TOKEN_SEPARATORS, Next);
if (!Token)
{
goto SyntaxError;
}
TokenOffset = Token - AslGbl_MainTokenBuffer;
AcpiOsPrintf ("%s\n", &AslGbl_CurrentLineBuffer[TokenOffset]);
}
else
{
PrError (ASL_ERROR, ASL_MSG_UNKNOWN_PRAGMA,
THIS_TOKEN_OFFSET (Token));
return;
}
break;
case PR_DIRECTIVE_UNDEF:
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"#undef: %s\n", AslGbl_CurrentLineNumber, Token);
PrRemoveDefine (Token);
break;
case PR_DIRECTIVE_WARNING:
PrError (ASL_WARNING, ASL_MSG_WARNING_DIRECTIVE,
THIS_TOKEN_OFFSET (Token));
AslGbl_SourceLine = 0;
AslGbl_NextError = AslGbl_ErrorLog;
break;
default:
/* Should never get here */
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"Unrecognized directive: %u\n",
AslGbl_CurrentLineNumber, Directive);
break;
}
return;
SyntaxError:
PrError (ASL_ERROR, ASL_MSG_DIRECTIVE_SYNTAX,
THIS_TOKEN_OFFSET (DirectiveToken));
return;
}
/*******************************************************************************
*
* FUNCTION: PrGetNextLine, PrGetNextLineInit
*
* PARAMETERS: Handle - Open file handle for the source file
*
* RETURN: Status of the GetLine operation:
* AE_OK - Normal line, OK status
* ASL_IGNORE_LINE - Line is blank or part of a multi-line
* comment
* ASL_EOF - End-of-file reached
*
* DESCRIPTION: Get the next text line from the input file. Does not strip
* comments.
*
******************************************************************************/
#define PR_NORMAL_TEXT 0
#define PR_MULTI_LINE_COMMENT 1
#define PR_SINGLE_LINE_COMMENT 2
#define PR_QUOTED_STRING 3
static UINT8 AcpiGbl_LineScanState = PR_NORMAL_TEXT;
static void
PrGetNextLineInit (
void)
{
AcpiGbl_LineScanState = 0;
}
static UINT32
PrGetNextLine (
FILE *Handle)
{
UINT32 i;
int c = 0;
int PreviousChar;
/* Always clear the global line buffer */
memset (AslGbl_CurrentLineBuffer, 0, AslGbl_LineBufferSize);
for (i = 0; ;)
{
/*
* If line is too long, expand the line buffers. Also increases
* AslGbl_LineBufferSize.
*/
if (i >= AslGbl_LineBufferSize)
{
UtExpandLineBuffers ();
}
PreviousChar = c;
c = getc (Handle);
if (c == EOF)
{
/*
* On EOF: If there is anything in the line buffer, terminate
* it with a newline, and catch the EOF on the next call
* to this function.
*/
if (i > 0)
{
AslGbl_CurrentLineBuffer[i] = '\n';
return (AE_OK);
}
return (ASL_EOF);
}
/* Update state machine as necessary */
switch (AcpiGbl_LineScanState)
{
case PR_NORMAL_TEXT:
/* Check for multi-line comment start */
if ((PreviousChar == '/') && (c == '*'))
{
AcpiGbl_LineScanState = PR_MULTI_LINE_COMMENT;
}
/* Check for single-line comment start */
else if ((PreviousChar == '/') && (c == '/'))
{
AcpiGbl_LineScanState = PR_SINGLE_LINE_COMMENT;
}
/* Check for quoted string start */
else if (PreviousChar == '"')
{
AcpiGbl_LineScanState = PR_QUOTED_STRING;
}
break;
case PR_QUOTED_STRING:
if (PreviousChar == '"')
{
AcpiGbl_LineScanState = PR_NORMAL_TEXT;
}
break;
case PR_MULTI_LINE_COMMENT:
/* Check for multi-line comment end */
if ((PreviousChar == '*') && (c == '/'))
{
AcpiGbl_LineScanState = PR_NORMAL_TEXT;
}
break;
case PR_SINGLE_LINE_COMMENT: /* Just ignore text until EOL */
default:
break;
}
/* Always copy the character into line buffer */
AslGbl_CurrentLineBuffer[i] = (char) c;
i++;
/* Always exit on end-of-line */
if (c == '\n')
{
/* Handle multi-line comments */
if (AcpiGbl_LineScanState == PR_MULTI_LINE_COMMENT)
{
return (ASL_IGNORE_LINE);
}
/* End of single-line comment */
if (AcpiGbl_LineScanState == PR_SINGLE_LINE_COMMENT)
{
AcpiGbl_LineScanState = PR_NORMAL_TEXT;
return (AE_OK);
}
/* Blank line */
if (i == 1)
{
return (ASL_IGNORE_LINE);
}
return (AE_OK);
}
}
}
/*******************************************************************************
*
* FUNCTION: PrMatchDirective
*
* PARAMETERS: Directive - Pointer to directive name token
*
* RETURN: Index into command array, -1 if not found
*
* DESCRIPTION: Lookup the incoming directive in the known directives table.
*
******************************************************************************/
static int
PrMatchDirective (
char *Directive)
{
int i;
if (!Directive || Directive[0] == 0)
{
return (ASL_DIRECTIVE_NOT_FOUND);
}
for (i = 0; AslGbl_DirectiveInfo[i].Name; i++)
{
if (!strcmp (AslGbl_DirectiveInfo[i].Name, Directive))
{
return (i);
}
}
return (ASL_DIRECTIVE_NOT_FOUND); /* Command not recognized */
}
/*******************************************************************************
*
* FUNCTION: PrPushDirective
*
* PARAMETERS: Directive - Encoded directive ID
* Argument - String containing argument to the
* directive
*
* RETURN: None
*
* DESCRIPTION: Push an item onto the directive stack. Used for processing
* nested #if/#else type conditional compilation directives.
* Specifically: Used on detection of #if/#ifdef/#ifndef to open
* a block.
*
******************************************************************************/
static void
PrPushDirective (
int Directive,
char *Argument)
{
DIRECTIVE_INFO *Info;
/* Allocate and populate a stack info item */
Info = ACPI_CAST_PTR (DIRECTIVE_INFO,
UtLocalCacheCalloc (sizeof (DIRECTIVE_INFO)));
Info->Next = AslGbl_DirectiveStack;
Info->Directive = Directive;
Info->IgnoringThisCodeBlock = AslGbl_IgnoringThisCodeBlock;
AcpiUtSafeStrncpy (Info->Argument, Argument, MAX_ARGUMENT_LENGTH);
DbgPrint (ASL_DEBUG_OUTPUT,
"Pr(%.4u) - [%u %s] %*s Pushed [#%s %s]: IgnoreFlag = %s\n",
AslGbl_CurrentLineNumber, AslGbl_IfDepth,
AslGbl_IgnoringThisCodeBlock ? "I" : "E",
AslGbl_IfDepth * 4, " ",
AslGbl_DirectiveInfo[Directive].Name,
Argument, AslGbl_IgnoringThisCodeBlock ? "TRUE" : "FALSE");
/* Push new item */
AslGbl_DirectiveStack = Info;
AslGbl_IfDepth++;
}
/*******************************************************************************
*
* FUNCTION: PrPopDirective
*
* PARAMETERS: None
*
* RETURN: Status. Error if the stack is empty.
*
* DESCRIPTION: Pop an item off the directive stack. Used for processing
* nested #if/#else type conditional compilation directives.
* Specifically: Used on detection of #elif and #endif to remove
* the original #if/#ifdef/#ifndef from the stack and close
* the block.
*
******************************************************************************/
static ACPI_STATUS
PrPopDirective (
void)
{
DIRECTIVE_INFO *Info;
/* Check for empty stack */
Info = AslGbl_DirectiveStack;
if (!Info)
{
return (AE_ERROR);
}
/* Pop one item, keep globals up-to-date */
AslGbl_IfDepth--;
AslGbl_IgnoringThisCodeBlock = Info->IgnoringThisCodeBlock;
AslGbl_DirectiveStack = Info->Next;
DbgPrint (ASL_DEBUG_OUTPUT,
"Pr(%.4u) - [%u %s] %*s Popped [#%s %s]: IgnoreFlag now = %s\n",
AslGbl_CurrentLineNumber, AslGbl_IfDepth,
AslGbl_IgnoringThisCodeBlock ? "I" : "E",
AslGbl_IfDepth * 4, " ",
AslGbl_DirectiveInfo[Info->Directive].Name,
Info->Argument, AslGbl_IgnoringThisCodeBlock ? "TRUE" : "FALSE");
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: PrDbgPrint
*
* PARAMETERS: Action - Action being performed
* DirectiveName - Directive being processed
*
* RETURN: None
*
* DESCRIPTION: Special debug print for directive processing.
*
******************************************************************************/
static void
PrDbgPrint (
char *Action,
char *DirectiveName)
{
DbgPrint (ASL_DEBUG_OUTPUT, "Pr(%.4u) - [%u %s] "
"%*s %s #%s, IfDepth %u\n",
AslGbl_CurrentLineNumber, AslGbl_IfDepth,
AslGbl_IgnoringThisCodeBlock ? "I" : "E",
AslGbl_IfDepth * 4, " ",
Action, DirectiveName, AslGbl_IfDepth);
}
/*******************************************************************************
*
* FUNCTION: PrDoIncludeFile
*
* PARAMETERS: Pathname - Name of the input file
*
* RETURN: None.
*
* DESCRIPTION: Open an include file, from #include.
*
******************************************************************************/
static void
PrDoIncludeFile (
char *Pathname)
{
char *FullPathname;
(void) PrOpenIncludeFile (Pathname, "r", &FullPathname);
}
/*******************************************************************************
*
* FUNCTION: PrDoIncludeBuffer
*
* PARAMETERS: Pathname - Name of the input binary file
* BufferName - ACPI namepath of the buffer
*
* RETURN: None.
*
* DESCRIPTION: Create an ACPI buffer object from a binary file. The contents
* of the file are emitted into the buffer object as ascii
* hex data. From #includebuffer.
*
******************************************************************************/
static void
PrDoIncludeBuffer (
char *Pathname,
char *BufferName)
{
char *FullPathname;
FILE *BinaryBufferFile;
UINT32 i = 0;
UINT8 c;
BinaryBufferFile = PrOpenIncludeFile (Pathname, "rb", &FullPathname);
if (!BinaryBufferFile)
{
return;
}
/* Emit "Name (XXXX, Buffer() {" header */
FlPrintFile (ASL_FILE_PREPROCESSOR, "Name (%s, Buffer()\n{", BufferName);
/* Dump the entire file in ascii hex format */
while (fread (&c, 1, 1, BinaryBufferFile))
{
if (!(i % 8))
{
FlPrintFile (ASL_FILE_PREPROCESSOR, "\n ", c);
}
FlPrintFile (ASL_FILE_PREPROCESSOR, " 0x%2.2X,", c);
i++;
}
DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
"#includebuffer: read %u bytes from %s\n",
AslGbl_CurrentLineNumber, i, FullPathname);
/* Close the Name() operator */
FlPrintFile (ASL_FILE_PREPROCESSOR, "\n})\n", BufferName);
fclose (BinaryBufferFile);
}
|