]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Workspace/MetaFileParser.py
BaseTools: fix imports
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / MetaFileParser.py
1 ## @file
2 # This file is used to parse meta files
3 #
4 # Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>
5 # (C) Copyright 2015-2018 Hewlett Packard Enterprise Development LP<BR>
6 # This program and the accompanying materials
7 # are licensed and made available under the terms and conditions of the BSD License
8 # which accompanies this distribution. The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
10 #
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 #
14
15 ##
16 # Import Modules
17 #
18 from __future__ import print_function
19 from __future__ import absolute_import
20 import Common.LongFilePathOs as os
21 import re
22 import time
23 import copy
24 from hashlib import md5
25
26 import Common.EdkLogger as EdkLogger
27 import Common.GlobalData as GlobalData
28
29 from CommonDataClass.DataClass import *
30 from Common.DataType import *
31 from Common.StringUtils import *
32 from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData, AnalyzeDscPcd, AnalyzePcdExpression, ParseFieldValue, StructPattern
33 from Common.Expression import *
34 from CommonDataClass.Exceptions import *
35 from Common.LongFilePathSupport import OpenLongFilePath as open
36 from collections import defaultdict
37 from .MetaFileTable import MetaFileStorage
38 from .MetaFileCommentParser import CheckInfComment
39 from Common.DataType import TAB_COMMENT_EDK_START, TAB_COMMENT_EDK_END
40
41 ## RegEx for finding file versions
42 hexVersionPattern = re.compile(r'0[xX][\da-f-A-F]{5,8}')
43 decVersionPattern = re.compile(r'\d+\.\d+')
44 CODEPattern = re.compile(r"{CODE\([a-fA-F0-9Xx\{\},\s]*\)}")
45
46 ## A decorator used to parse macro definition
47 def ParseMacro(Parser):
48 def MacroParser(self):
49 Match = GlobalData.gMacroDefPattern.match(self._CurrentLine)
50 if not Match:
51 # Not 'DEFINE/EDK_GLOBAL' statement, call decorated method
52 Parser(self)
53 return
54
55 TokenList = GetSplitValueList(self._CurrentLine[Match.end(1):], TAB_EQUAL_SPLIT, 1)
56 # Syntax check
57 if not TokenList[0]:
58 EdkLogger.error('Parser', FORMAT_INVALID, "No macro name given",
59 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
60 if len(TokenList) < 2:
61 TokenList.append('')
62
63 Type = Match.group(1)
64 Name, Value = TokenList
65 # Global macros can be only defined via environment variable
66 if Name in GlobalData.gGlobalDefines:
67 EdkLogger.error('Parser', FORMAT_INVALID, "%s can only be defined via environment variable" % Name,
68 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
69 # Only upper case letters, digit and '_' are allowed
70 if not GlobalData.gMacroNamePattern.match(Name):
71 EdkLogger.error('Parser', FORMAT_INVALID, "The macro name must be in the pattern [A-Z][A-Z0-9_]*",
72 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
73
74 Value = ReplaceMacro(Value, self._Macros)
75 if Type in self.DataType:
76 self._ItemType = self.DataType[Type]
77 else:
78 self._ItemType = MODEL_META_DATA_DEFINE
79 # DEFINE defined macros
80 if Type == TAB_DSC_DEFINES_DEFINE:
81 #
82 # First judge whether this DEFINE is in conditional directive statements or not.
83 #
84 if isinstance(self, DscParser) and self._InDirective > -1:
85 pass
86 else:
87 if isinstance(self, DecParser):
88 if MODEL_META_DATA_HEADER in self._SectionType:
89 self._FileLocalMacros[Name] = Value
90 else:
91 self._ConstructSectionMacroDict(Name, Value)
92 elif self._SectionType == MODEL_META_DATA_HEADER:
93 self._FileLocalMacros[Name] = Value
94 else:
95 self._ConstructSectionMacroDict(Name, Value)
96
97 # EDK_GLOBAL defined macros
98 elif not isinstance(self, DscParser):
99 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL can only be used in .dsc file",
100 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
101 elif self._SectionType != MODEL_META_DATA_HEADER:
102 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL can only be used under [Defines] section",
103 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
104 elif (Name in self._FileLocalMacros) and (self._FileLocalMacros[Name] != Value):
105 EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL defined a macro with the same name and different value as one defined by 'DEFINE'",
106 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
107
108 self._ValueList = [Type, Name, Value]
109
110 return MacroParser
111
112 ## Base class of parser
113 #
114 # This class is used for derivation purpose. The specific parser for one kind
115 # type file must derive this class and implement some public interfaces.
116 #
117 # @param FilePath The path of platform description file
118 # @param FileType The raw data of DSC file
119 # @param Table Database used to retrieve module/package information
120 # @param Macros Macros used for replacement in file
121 # @param Owner Owner ID (for sub-section parsing)
122 # @param From ID from which the data comes (for !INCLUDE directive)
123 #
124 class MetaFileParser(object):
125 # data type (file content) for specific file type
126 DataType = {}
127
128 # Parser objects used to implement singleton
129 MetaFiles = {}
130
131 ## Factory method
132 #
133 # One file, one parser object. This factory method makes sure that there's
134 # only one object constructed for one meta file.
135 #
136 # @param Class class object of real AutoGen class
137 # (InfParser, DecParser or DscParser)
138 # @param FilePath The path of meta file
139 # @param *args The specific class related parameters
140 # @param **kwargs The specific class related dict parameters
141 #
142 def __new__(Class, FilePath, *args, **kwargs):
143 if FilePath in Class.MetaFiles:
144 return Class.MetaFiles[FilePath]
145 else:
146 ParserObject = super(MetaFileParser, Class).__new__(Class)
147 Class.MetaFiles[FilePath] = ParserObject
148 return ParserObject
149
150 ## Constructor of MetaFileParser
151 #
152 # Initialize object of MetaFileParser
153 #
154 # @param FilePath The path of platform description file
155 # @param FileType The raw data of DSC file
156 # @param Arch Default Arch value for filtering sections
157 # @param Table Database used to retrieve module/package information
158 # @param Owner Owner ID (for sub-section parsing)
159 # @param From ID from which the data comes (for !INCLUDE directive)
160 #
161 def __init__(self, FilePath, FileType, Arch, Table, Owner= -1, From= -1):
162 self._Table = Table
163 self._RawTable = Table
164 self._Arch = Arch
165 self._FileType = FileType
166 self.MetaFile = FilePath
167 self._FileDir = self.MetaFile.Dir
168 self._Defines = {}
169 self._FileLocalMacros = {}
170 self._SectionsMacroDict = defaultdict(dict)
171
172 # for recursive parsing
173 self._Owner = [Owner]
174 self._From = From
175
176 # parsr status for parsing
177 self._ValueList = ['', '', '', '', '']
178 self._Scope = []
179 self._LineIndex = 0
180 self._CurrentLine = ''
181 self._SectionType = MODEL_UNKNOWN
182 self._SectionName = ''
183 self._InSubsection = False
184 self._SubsectionType = MODEL_UNKNOWN
185 self._SubsectionName = ''
186 self._ItemType = MODEL_UNKNOWN
187 self._LastItem = -1
188 self._Enabled = 0
189 self._Finished = False
190 self._PostProcessed = False
191 # Different version of meta-file has different way to parse.
192 self._Version = 0
193 self._GuidDict = {} # for Parser PCD value {GUID(gTokeSpaceGuidName)}
194
195 ## Store the parsed data in table
196 def _Store(self, *Args):
197 return self._Table.Insert(*Args)
198
199 ## Virtual method for starting parse
200 def Start(self):
201 raise NotImplementedError
202
203 ## Notify a post-process is needed
204 def DoPostProcess(self):
205 self._PostProcessed = False
206
207 ## Set parsing complete flag in both class and table
208 def _Done(self):
209 self._Finished = True
210 self._Table.SetEndFlag()
211
212 def _PostProcess(self):
213 self._PostProcessed = True
214
215 ## Get the parse complete flag
216 @property
217 def Finished(self):
218 return self._Finished
219
220 ## Set the complete flag
221 @Finished.setter
222 def Finished(self, Value):
223 self._Finished = Value
224
225 ## Remove records that do not match given Filter Arch
226 def _FilterRecordList(self, RecordList, FilterArch):
227 NewRecordList = []
228 for Record in RecordList:
229 Arch = Record[3]
230 if Arch == TAB_ARCH_COMMON or Arch == FilterArch:
231 NewRecordList.append(Record)
232 return NewRecordList
233
234 ## Use [] style to query data in table, just for readability
235 #
236 # DataInfo = [data_type, scope1(arch), scope2(platform/moduletype)]
237 #
238 def __getitem__(self, DataInfo):
239 if not isinstance(DataInfo, type(())):
240 DataInfo = (DataInfo,)
241
242 # Parse the file first, if necessary
243 self.StartParse()
244
245 # No specific ARCH or Platform given, use raw data
246 if self._RawTable and (len(DataInfo) == 1 or DataInfo[1] is None):
247 return self._FilterRecordList(self._RawTable.Query(*DataInfo), self._Arch)
248
249 # Do post-process if necessary
250 if not self._PostProcessed:
251 self._PostProcess()
252
253 return self._FilterRecordList(self._Table.Query(*DataInfo), DataInfo[1])
254
255 def StartParse(self):
256 if not self._Finished:
257 if self._RawTable.IsIntegrity():
258 self._Finished = True
259 else:
260 self._Table = self._RawTable
261 self._PostProcessed = False
262 self.Start()
263 ## Data parser for the common format in different type of file
264 #
265 # The common format in the meatfile is like
266 #
267 # xxx1 | xxx2 | xxx3
268 #
269 @ParseMacro
270 def _CommonParser(self):
271 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
272 self._ValueList[0:len(TokenList)] = TokenList
273
274 ## Data parser for the format in which there's path
275 #
276 # Only path can have macro used. So we need to replace them before use.
277 #
278 @ParseMacro
279 def _PathParser(self):
280 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
281 self._ValueList[0:len(TokenList)] = TokenList
282 # Don't do macro replacement for dsc file at this point
283 if not isinstance(self, DscParser):
284 Macros = self._Macros
285 self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]
286
287 ## Skip unsupported data
288 def _Skip(self):
289 EdkLogger.warn("Parser", "Unrecognized content", File=self.MetaFile,
290 Line=self._LineIndex + 1, ExtraData=self._CurrentLine);
291 self._ValueList[0:1] = [self._CurrentLine]
292
293 ## Skip unsupported data for UserExtension Section
294 def _SkipUserExtension(self):
295 self._ValueList[0:1] = [self._CurrentLine]
296
297 ## Section header parser
298 #
299 # The section header is always in following format:
300 #
301 # [section_name.arch<.platform|module_type>]
302 #
303 def _SectionHeaderParser(self):
304 self._Scope = []
305 self._SectionName = ''
306 ArchList = set()
307 for Item in GetSplitValueList(self._CurrentLine[1:-1], TAB_COMMA_SPLIT):
308 if Item == '':
309 continue
310 ItemList = GetSplitValueList(Item, TAB_SPLIT, 3)
311 # different section should not mix in one section
312 if self._SectionName != '' and self._SectionName != ItemList[0].upper():
313 EdkLogger.error('Parser', FORMAT_INVALID, "Different section names in the same section",
314 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
315 self._SectionName = ItemList[0].upper()
316 if self._SectionName in self.DataType:
317 self._SectionType = self.DataType[self._SectionName]
318 # Check if the section name is valid
319 if self._SectionName not in SECTIONS_HAVE_ITEM_AFTER_ARCH_SET and len(ItemList) > 3:
320 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,
321 self.MetaFile, self._LineIndex + 1, self._CurrentLine)
322 elif self._Version >= 0x00010005:
323 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,
324 self.MetaFile, self._LineIndex + 1, self._CurrentLine)
325 else:
326 self._SectionType = MODEL_UNKNOWN
327
328 # S1 is always Arch
329 if len(ItemList) > 1:
330 S1 = ItemList[1].upper()
331 else:
332 S1 = TAB_ARCH_COMMON
333 ArchList.add(S1)
334
335 # S2 may be Platform or ModuleType
336 if len(ItemList) > 2:
337 if self._SectionName.upper() in SECTIONS_HAVE_ITEM_PCD_SET:
338 S2 = ItemList[2]
339 else:
340 S2 = ItemList[2].upper()
341 else:
342 S2 = TAB_COMMON
343 if len(ItemList) > 3:
344 S3 = ItemList[3]
345 else:
346 S3 = TAB_COMMON
347 self._Scope.append([S1, S2, S3])
348
349 # 'COMMON' must not be used with specific ARCHs at the same section
350 if TAB_ARCH_COMMON in ArchList and len(ArchList) > 1:
351 EdkLogger.error('Parser', FORMAT_INVALID, "'common' ARCH must not be used with specific ARCHs",
352 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
353 # If the section information is needed later, it should be stored in database
354 self._ValueList[0] = self._SectionName
355
356 ## [defines] section parser
357 @ParseMacro
358 def _DefineParser(self):
359 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
360 self._ValueList[1:len(TokenList)] = TokenList
361 if not self._ValueList[1]:
362 EdkLogger.error('Parser', FORMAT_INVALID, "No name specified",
363 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
364 if not self._ValueList[2]:
365 EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",
366 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
367
368 self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]
369 Name, Value = self._ValueList[1], self._ValueList[2]
370 MacroUsed = GlobalData.gMacroRefPattern.findall(Value)
371 if len(MacroUsed) != 0:
372 for Macro in MacroUsed:
373 if Macro in GlobalData.gGlobalDefines:
374 EdkLogger.error("Parser", FORMAT_INVALID, "Global macro %s is not permitted." % (Macro), ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
375 else:
376 EdkLogger.error("Parser", FORMAT_INVALID, "%s not defined" % (Macro), ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
377 # Sometimes, we need to make differences between EDK and EDK2 modules
378 if Name == 'INF_VERSION':
379 if hexVersionPattern.match(Value):
380 self._Version = int(Value, 0)
381 elif decVersionPattern.match(Value):
382 ValueList = Value.split('.')
383 Major = int(ValueList[0], 0)
384 Minor = int(ValueList[1], 0)
385 if Major > 0xffff or Minor > 0xffff:
386 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid version number",
387 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
388 self._Version = int('0x{0:04x}{1:04x}'.format(Major, Minor), 0)
389 else:
390 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid version number",
391 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
392
393 if isinstance(self, InfParser) and self._Version < 0x00010005:
394 # EDK module allows using defines as macros
395 self._FileLocalMacros[Name] = Value
396 self._Defines[Name] = Value
397
398 ## [BuildOptions] section parser
399 @ParseMacro
400 def _BuildOptionParser(self):
401 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)
402 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
403 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)
404 if len(TokenList2) == 2:
405 self._ValueList[0] = TokenList2[0] # toolchain family
406 self._ValueList[1] = TokenList2[1] # keys
407 else:
408 self._ValueList[1] = TokenList[0]
409 if len(TokenList) == 2 and not isinstance(self, DscParser): # value
410 self._ValueList[2] = ReplaceMacro(TokenList[1], self._Macros)
411
412 if self._ValueList[1].count('_') != 4:
413 EdkLogger.error(
414 'Parser',
415 FORMAT_INVALID,
416 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],
417 ExtraData=self._CurrentLine,
418 File=self.MetaFile,
419 Line=self._LineIndex + 1
420 )
421 def GetValidExpression(self, TokenSpaceGuid, PcdCName):
422 return self._Table.GetValidExpression(TokenSpaceGuid, PcdCName)
423
424 @property
425 def _Macros(self):
426 Macros = {}
427 Macros.update(self._FileLocalMacros)
428 Macros.update(self._GetApplicableSectionMacro())
429 return Macros
430
431 ## Construct section Macro dict
432 def _ConstructSectionMacroDict(self, Name, Value):
433 ScopeKey = [(Scope[0], Scope[1], Scope[2]) for Scope in self._Scope]
434 ScopeKey = tuple(ScopeKey)
435 #
436 # DecParser SectionType is a list, will contain more than one item only in Pcd Section
437 # As Pcd section macro usage is not alllowed, so here it is safe
438 #
439 if isinstance(self, DecParser):
440 SectionDictKey = self._SectionType[0], ScopeKey
441 else:
442 SectionDictKey = self._SectionType, ScopeKey
443
444 self._SectionsMacroDict[SectionDictKey][Name] = Value
445
446 ## Get section Macros that are applicable to current line, which may come from other sections
447 ## that share the same name while scope is wider
448 def _GetApplicableSectionMacro(self):
449 Macros = {}
450
451 ComComMacroDict = {}
452 ComSpeMacroDict = {}
453 SpeSpeMacroDict = {}
454
455 ActiveSectionType = self._SectionType
456 if isinstance(self, DecParser):
457 ActiveSectionType = self._SectionType[0]
458
459 for (SectionType, Scope) in self._SectionsMacroDict:
460 if SectionType != ActiveSectionType:
461 continue
462
463 for ActiveScope in self._Scope:
464 Scope0, Scope1, Scope2= ActiveScope[0], ActiveScope[1], ActiveScope[2]
465 if(Scope0, Scope1, Scope2) not in Scope:
466 break
467 else:
468 SpeSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])
469
470 for ActiveScope in self._Scope:
471 Scope0, Scope1, Scope2 = ActiveScope[0], ActiveScope[1], ActiveScope[2]
472 if(Scope0, Scope1, Scope2) not in Scope and (Scope0, TAB_COMMON, TAB_COMMON) not in Scope and (TAB_COMMON, Scope1, TAB_COMMON) not in Scope:
473 break
474 else:
475 ComSpeMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])
476
477 if (TAB_COMMON, TAB_COMMON, TAB_COMMON) in Scope:
478 ComComMacroDict.update(self._SectionsMacroDict[(SectionType, Scope)])
479
480 Macros.update(ComComMacroDict)
481 Macros.update(ComSpeMacroDict)
482 Macros.update(SpeSpeMacroDict)
483
484 return Macros
485
486 _SectionParser = {}
487
488 ## INF file parser class
489 #
490 # @param FilePath The path of platform description file
491 # @param FileType The raw data of DSC file
492 # @param Table Database used to retrieve module/package information
493 # @param Macros Macros used for replacement in file
494 #
495 class InfParser(MetaFileParser):
496 # INF file supported data types (one type per section)
497 DataType = {
498 TAB_UNKNOWN.upper() : MODEL_UNKNOWN,
499 TAB_INF_DEFINES.upper() : MODEL_META_DATA_HEADER,
500 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,
501 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,
502 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,
503 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,
504 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,
505 TAB_PACKAGES.upper() : MODEL_META_DATA_PACKAGE,
506 TAB_NMAKE.upper() : MODEL_META_DATA_NMAKE,
507 TAB_INF_FIXED_PCD.upper() : MODEL_PCD_FIXED_AT_BUILD,
508 TAB_INF_PATCH_PCD.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,
509 TAB_INF_FEATURE_PCD.upper() : MODEL_PCD_FEATURE_FLAG,
510 TAB_INF_PCD_EX.upper() : MODEL_PCD_DYNAMIC_EX,
511 TAB_INF_PCD.upper() : MODEL_PCD_DYNAMIC,
512 TAB_SOURCES.upper() : MODEL_EFI_SOURCE_FILE,
513 TAB_GUIDS.upper() : MODEL_EFI_GUID,
514 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,
515 TAB_PPIS.upper() : MODEL_EFI_PPI,
516 TAB_DEPEX.upper() : MODEL_EFI_DEPEX,
517 TAB_BINARIES.upper() : MODEL_EFI_BINARY_FILE,
518 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION
519 }
520
521 ## Constructor of InfParser
522 #
523 # Initialize object of InfParser
524 #
525 # @param FilePath The path of module description file
526 # @param FileType The raw data of DSC file
527 # @param Arch Default Arch value for filtering sections
528 # @param Table Database used to retrieve module/package information
529 #
530 def __init__(self, FilePath, FileType, Arch, Table):
531 # prevent re-initialization
532 if hasattr(self, "_Table"):
533 return
534 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table)
535 self.PcdsDict = {}
536
537 ## Parser starter
538 def Start(self):
539 NmakeLine = ''
540 Content = ''
541 try:
542 Content = open(str(self.MetaFile), 'r').readlines()
543 except:
544 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)
545
546 # parse the file line by line
547 IsFindBlockComment = False
548 GetHeaderComment = False
549 TailComments = []
550 SectionComments = []
551 Comments = []
552
553 for Index in range(0, len(Content)):
554 # skip empty, commented, block commented lines
555 Line, Comment = CleanString2(Content[Index], AllowCppStyleComment=True)
556 NextLine = ''
557 if Index + 1 < len(Content):
558 NextLine, NextComment = CleanString2(Content[Index + 1])
559 if Line == '':
560 if Comment:
561 Comments.append((Comment, Index + 1))
562 elif GetHeaderComment:
563 SectionComments.extend(Comments)
564 Comments = []
565 continue
566 if Line.find(TAB_COMMENT_EDK_START) > -1:
567 IsFindBlockComment = True
568 continue
569 if Line.find(TAB_COMMENT_EDK_END) > -1:
570 IsFindBlockComment = False
571 continue
572 if IsFindBlockComment:
573 continue
574
575 self._LineIndex = Index
576 self._CurrentLine = Line
577
578 # section header
579 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:
580 if not GetHeaderComment:
581 for Cmt, LNo in Comments:
582 self._Store(MODEL_META_DATA_HEADER_COMMENT, Cmt, '', '', TAB_COMMON,
583 TAB_COMMON, self._Owner[-1], LNo, -1, LNo, -1, 0)
584 GetHeaderComment = True
585 else:
586 TailComments.extend(SectionComments + Comments)
587 Comments = []
588 self._SectionHeaderParser()
589 # Check invalid sections
590 if self._Version < 0x00010005:
591 if self._SectionType in [MODEL_META_DATA_BUILD_OPTION,
592 MODEL_EFI_LIBRARY_CLASS,
593 MODEL_META_DATA_PACKAGE,
594 MODEL_PCD_FIXED_AT_BUILD,
595 MODEL_PCD_PATCHABLE_IN_MODULE,
596 MODEL_PCD_FEATURE_FLAG,
597 MODEL_PCD_DYNAMIC_EX,
598 MODEL_PCD_DYNAMIC,
599 MODEL_EFI_GUID,
600 MODEL_EFI_PROTOCOL,
601 MODEL_EFI_PPI,
602 MODEL_META_DATA_USER_EXTENSION]:
603 EdkLogger.error('Parser', FORMAT_INVALID,
604 "Section [%s] is not allowed in inf file without version" % (self._SectionName),
605 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
606 elif self._SectionType in [MODEL_EFI_INCLUDE,
607 MODEL_EFI_LIBRARY_INSTANCE,
608 MODEL_META_DATA_NMAKE]:
609 EdkLogger.error('Parser', FORMAT_INVALID,
610 "Section [%s] is not allowed in inf file with version 0x%08x" % (self._SectionName, self._Version),
611 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
612 continue
613 # merge two lines specified by '\' in section NMAKE
614 elif self._SectionType == MODEL_META_DATA_NMAKE:
615 if Line[-1] == '\\':
616 if NextLine == '':
617 self._CurrentLine = NmakeLine + Line[0:-1]
618 NmakeLine = ''
619 else:
620 if NextLine[0] == TAB_SECTION_START and NextLine[-1] == TAB_SECTION_END:
621 self._CurrentLine = NmakeLine + Line[0:-1]
622 NmakeLine = ''
623 else:
624 NmakeLine = NmakeLine + ' ' + Line[0:-1]
625 continue
626 else:
627 self._CurrentLine = NmakeLine + Line
628 NmakeLine = ''
629
630 # section content
631 self._ValueList = ['', '', '']
632 # parse current line, result will be put in self._ValueList
633 self._SectionParser[self._SectionType](self)
634 if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:
635 self._ItemType = -1
636 Comments = []
637 continue
638 if Comment:
639 Comments.append((Comment, Index + 1))
640 if GlobalData.gOptions and GlobalData.gOptions.CheckUsage:
641 CheckInfComment(self._SectionType, Comments, str(self.MetaFile), Index + 1, self._ValueList)
642 #
643 # Model, Value1, Value2, Value3, Arch, Platform, BelongsToItem=-1,
644 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
645 #
646 for Arch, Platform, _ in self._Scope:
647 LastItem = self._Store(self._SectionType,
648 self._ValueList[0],
649 self._ValueList[1],
650 self._ValueList[2],
651 Arch,
652 Platform,
653 self._Owner[-1],
654 self._LineIndex + 1,
655 - 1,
656 self._LineIndex + 1,
657 - 1,
658 0
659 )
660 for Comment, LineNo in Comments:
661 self._Store(MODEL_META_DATA_COMMENT, Comment, '', '', Arch, Platform,
662 LastItem, LineNo, -1, LineNo, -1, 0)
663 Comments = []
664 SectionComments = []
665 TailComments.extend(SectionComments + Comments)
666 if IsFindBlockComment:
667 EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */",
668 File=self.MetaFile)
669
670 # If there are tail comments in INF file, save to database whatever the comments are
671 for Comment in TailComments:
672 self._Store(MODEL_META_DATA_TAIL_COMMENT, Comment[0], '', '', TAB_COMMON,
673 TAB_COMMON, self._Owner[-1], -1, -1, -1, -1, 0)
674 self._Done()
675
676 ## Data parser for the format in which there's path
677 #
678 # Only path can have macro used. So we need to replace them before use.
679 #
680 def _IncludeParser(self):
681 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
682 self._ValueList[0:len(TokenList)] = TokenList
683 Macros = self._Macros
684 if Macros:
685 for Index in range(0, len(self._ValueList)):
686 Value = self._ValueList[Index]
687 if not Value:
688 continue
689
690 if Value.upper().find('$(EFI_SOURCE)\Edk'.upper()) > -1 or Value.upper().find('$(EFI_SOURCE)/Edk'.upper()) > -1:
691 Value = '$(EDK_SOURCE)' + Value[17:]
692 if Value.find('$(EFI_SOURCE)') > -1 or Value.find('$(EDK_SOURCE)') > -1:
693 pass
694 elif Value.startswith('.'):
695 pass
696 elif Value.startswith('$('):
697 pass
698 else:
699 Value = '$(EFI_SOURCE)/' + Value
700
701 self._ValueList[Index] = ReplaceMacro(Value, Macros)
702
703 ## Parse [Sources] section
704 #
705 # Only path can have macro used. So we need to replace them before use.
706 #
707 @ParseMacro
708 def _SourceFileParser(self):
709 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
710 self._ValueList[0:len(TokenList)] = TokenList
711 Macros = self._Macros
712 # For Acpi tables, remove macro like ' TABLE_NAME=Sata1'
713 if 'COMPONENT_TYPE' in Macros:
714 if self._Defines['COMPONENT_TYPE'].upper() == 'ACPITABLE':
715 self._ValueList[0] = GetSplitValueList(self._ValueList[0], ' ', 1)[0]
716 if self._Defines['BASE_NAME'] == 'Microcode':
717 pass
718 self._ValueList = [ReplaceMacro(Value, Macros) for Value in self._ValueList]
719
720 ## Parse [Binaries] section
721 #
722 # Only path can have macro used. So we need to replace them before use.
723 #
724 @ParseMacro
725 def _BinaryFileParser(self):
726 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 2)
727 if len(TokenList) < 2:
728 EdkLogger.error('Parser', FORMAT_INVALID, "No file type or path specified",
729 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",
730 File=self.MetaFile, Line=self._LineIndex + 1)
731 if not TokenList[0]:
732 EdkLogger.error('Parser', FORMAT_INVALID, "No file type specified",
733 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",
734 File=self.MetaFile, Line=self._LineIndex + 1)
735 if not TokenList[1]:
736 EdkLogger.error('Parser', FORMAT_INVALID, "No file path specified",
737 ExtraData=self._CurrentLine + " (<FileType> | <FilePath> [| <Target>])",
738 File=self.MetaFile, Line=self._LineIndex + 1)
739 self._ValueList[0:len(TokenList)] = TokenList
740 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)
741
742 ## [nmake] section parser (Edk.x style only)
743 def _NmakeParser(self):
744 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
745 self._ValueList[0:len(TokenList)] = TokenList
746 # remove macros
747 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros)
748 # remove self-reference in macro setting
749 #self._ValueList[1] = ReplaceMacro(self._ValueList[1], {self._ValueList[0]:''})
750
751 ## [FixedPcd], [FeaturePcd], [PatchPcd], [Pcd] and [PcdEx] sections parser
752 @ParseMacro
753 def _PcdParser(self):
754 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)
755 ValueList = GetSplitValueList(TokenList[0], TAB_SPLIT)
756 if len(ValueList) != 2:
757 EdkLogger.error('Parser', FORMAT_INVALID, "Illegal token space GUID and PCD name format",
758 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",
759 File=self.MetaFile, Line=self._LineIndex + 1)
760 self._ValueList[0:1] = ValueList
761 if len(TokenList) > 1:
762 self._ValueList[2] = TokenList[1]
763 if self._ValueList[0] == '' or self._ValueList[1] == '':
764 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",
765 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",
766 File=self.MetaFile, Line=self._LineIndex + 1)
767
768 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.
769 if self._ValueList[2] != '':
770 InfPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)
771 if InfPcdValueList[0] in ['True', 'true', 'TRUE']:
772 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '1', 1);
773 elif InfPcdValueList[0] in ['False', 'false', 'FALSE']:
774 self._ValueList[2] = TokenList[1].replace(InfPcdValueList[0], '0', 1);
775 if (self._ValueList[0], self._ValueList[1]) not in self.PcdsDict:
776 self.PcdsDict[self._ValueList[0], self._ValueList[1]] = self._SectionType
777 elif self.PcdsDict[self._ValueList[0], self._ValueList[1]] != self._SectionType:
778 EdkLogger.error('Parser', FORMAT_INVALID, "It is not permissible to list a specified PCD in different PCD type sections.",
779 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<PcdCName>)",
780 File=self.MetaFile, Line=self._LineIndex + 1)
781
782 ## [depex] section parser
783 @ParseMacro
784 def _DepexParser(self):
785 self._ValueList[0:1] = [self._CurrentLine]
786
787 _SectionParser = {
788 MODEL_UNKNOWN : MetaFileParser._Skip,
789 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,
790 MODEL_META_DATA_BUILD_OPTION : MetaFileParser._BuildOptionParser,
791 MODEL_EFI_INCLUDE : _IncludeParser, # for Edk.x modules
792 MODEL_EFI_LIBRARY_INSTANCE : MetaFileParser._CommonParser, # for Edk.x modules
793 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,
794 MODEL_META_DATA_PACKAGE : MetaFileParser._PathParser,
795 MODEL_META_DATA_NMAKE : _NmakeParser, # for Edk.x modules
796 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,
797 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,
798 MODEL_PCD_FEATURE_FLAG : _PcdParser,
799 MODEL_PCD_DYNAMIC_EX : _PcdParser,
800 MODEL_PCD_DYNAMIC : _PcdParser,
801 MODEL_EFI_SOURCE_FILE : _SourceFileParser,
802 MODEL_EFI_GUID : MetaFileParser._CommonParser,
803 MODEL_EFI_PROTOCOL : MetaFileParser._CommonParser,
804 MODEL_EFI_PPI : MetaFileParser._CommonParser,
805 MODEL_EFI_DEPEX : _DepexParser,
806 MODEL_EFI_BINARY_FILE : _BinaryFileParser,
807 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,
808 }
809
810 ## DSC file parser class
811 #
812 # @param FilePath The path of platform description file
813 # @param FileType The raw data of DSC file
814 # @param Table Database used to retrieve module/package information
815 # @param Macros Macros used for replacement in file
816 # @param Owner Owner ID (for sub-section parsing)
817 # @param From ID from which the data comes (for !INCLUDE directive)
818 #
819 class DscParser(MetaFileParser):
820 # DSC file supported data types (one type per section)
821 DataType = {
822 TAB_SKUIDS.upper() : MODEL_EFI_SKU_ID,
823 TAB_DEFAULT_STORES.upper() : MODEL_EFI_DEFAULT_STORES,
824 TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,
825 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,
826 TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,
827 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,
828 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,
829 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,
830 TAB_PCDS_DYNAMIC_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_DEFAULT,
831 TAB_PCDS_DYNAMIC_HII_NULL.upper() : MODEL_PCD_DYNAMIC_HII,
832 TAB_PCDS_DYNAMIC_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_VPD,
833 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL.upper() : MODEL_PCD_DYNAMIC_EX_DEFAULT,
834 TAB_PCDS_DYNAMIC_EX_HII_NULL.upper() : MODEL_PCD_DYNAMIC_EX_HII,
835 TAB_PCDS_DYNAMIC_EX_VPD_NULL.upper() : MODEL_PCD_DYNAMIC_EX_VPD,
836 TAB_COMPONENTS.upper() : MODEL_META_DATA_COMPONENT,
837 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH.upper() : MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH,
838 TAB_DSC_DEFINES.upper() : MODEL_META_DATA_HEADER,
839 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,
840 TAB_DSC_DEFINES_EDKGLOBAL : MODEL_META_DATA_GLOBAL_DEFINE,
841 TAB_INCLUDE.upper() : MODEL_META_DATA_INCLUDE,
842 TAB_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,
843 TAB_IF_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,
844 TAB_IF_N_DEF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF,
845 TAB_ELSE_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF,
846 TAB_ELSE.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE,
847 TAB_END_IF.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF,
848 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,
849 TAB_ERROR.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR,
850 }
851
852 # Valid names in define section
853 DefineKeywords = [
854 "DSC_SPECIFICATION",
855 "PLATFORM_NAME",
856 "PLATFORM_GUID",
857 "PLATFORM_VERSION",
858 "SKUID_IDENTIFIER",
859 "PCD_INFO_GENERATION",
860 "PCD_VAR_CHECK_GENERATION",
861 "SUPPORTED_ARCHITECTURES",
862 "BUILD_TARGETS",
863 "OUTPUT_DIRECTORY",
864 "FLASH_DEFINITION",
865 "BUILD_NUMBER",
866 "RFC_LANGUAGES",
867 "ISO_LANGUAGES",
868 "TIME_STAMP_FILE",
869 "VPD_TOOL_GUID",
870 "FIX_LOAD_TOP_MEMORY_ADDRESS",
871 "PREBUILD",
872 "POSTBUILD"
873 ]
874
875 SubSectionDefineKeywords = [
876 "FILE_GUID"
877 ]
878
879 SymbolPattern = ValueExpression.SymbolPattern
880
881 IncludedFiles = set()
882
883 ## Constructor of DscParser
884 #
885 # Initialize object of DscParser
886 #
887 # @param FilePath The path of platform description file
888 # @param FileType The raw data of DSC file
889 # @param Arch Default Arch value for filtering sections
890 # @param Table Database used to retrieve module/package information
891 # @param Owner Owner ID (for sub-section parsing)
892 # @param From ID from which the data comes (for !INCLUDE directive)
893 #
894 def __init__(self, FilePath, FileType, Arch, Table, Owner= -1, From= -1):
895 # prevent re-initialization
896 if hasattr(self, "_Table") and self._Table is Table:
897 return
898 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, Owner, From)
899 self._Version = 0x00010005 # Only EDK2 dsc file is supported
900 # to store conditional directive evaluation result
901 self._DirectiveStack = []
902 self._DirectiveEvalStack = []
903 self._Enabled = 1
904
905 #
906 # Specify whether current line is in uncertain condition
907 #
908 self._InDirective = -1
909
910 # Final valid replacable symbols
911 self._Symbols = {}
912 #
913 # Map the ID between the original table and new table to track
914 # the owner item
915 #
916 self._IdMapping = {-1:-1}
917
918 self._PcdCodeValue = ""
919 self._PcdDataTypeCODE = False
920 self._CurrentPcdName = ""
921 self._Content = None
922
923 ## Parser starter
924 def Start(self):
925 Content = ''
926 try:
927 Content = open(str(self.MetaFile), 'r').readlines()
928 except:
929 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)
930
931 OwnerId = {}
932
933 Content = self.ProcessMultipleLineCODEValue(Content)
934
935 for Index in range(0, len(Content)):
936 Line = CleanString(Content[Index])
937 # skip empty line
938 if Line == '':
939 continue
940
941 self._CurrentLine = Line
942 self._LineIndex = Index
943 if self._InSubsection and self._Owner[-1] == -1:
944 self._Owner.append(self._LastItem)
945
946 # section header
947 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:
948 self._SectionType = MODEL_META_DATA_SECTION_HEADER
949 # subsection ending
950 elif Line[0] == '}' and self._InSubsection:
951 self._InSubsection = False
952 self._SubsectionType = MODEL_UNKNOWN
953 self._SubsectionName = ''
954 self._Owner[-1] = -1
955 OwnerId.clear()
956 continue
957 # subsection header
958 elif Line[0] == TAB_OPTION_START and Line[-1] == TAB_OPTION_END:
959 self._SubsectionType = MODEL_META_DATA_SUBSECTION_HEADER
960 # directive line
961 elif Line[0] == '!':
962 TokenList = GetSplitValueList(Line, ' ', 1)
963 if TokenList[0] == TAB_INCLUDE:
964 for Arch, ModuleType, DefaultStore in self._Scope:
965 if self._SubsectionType != MODEL_UNKNOWN and Arch in OwnerId:
966 self._Owner[-1] = OwnerId[Arch]
967 self._DirectiveParser()
968 else:
969 self._DirectiveParser()
970 continue
971 if Line[0] == TAB_OPTION_START and not self._InSubsection:
972 EdkLogger.error("Parser", FILE_READ_FAILURE, "Missing the '{' before %s in Line %s" % (Line, Index+1), ExtraData=self.MetaFile)
973
974 if self._InSubsection:
975 SectionType = self._SubsectionType
976 else:
977 SectionType = self._SectionType
978 self._ItemType = SectionType
979
980 self._ValueList = ['', '', '']
981 self._SectionParser[SectionType](self)
982 if self._ValueList is None:
983 continue
984 #
985 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,
986 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
987 #
988 for Arch, ModuleType, DefaultStore in self._Scope:
989 Owner = self._Owner[-1]
990 if self._SubsectionType != MODEL_UNKNOWN and Arch in OwnerId:
991 Owner = OwnerId[Arch]
992 self._LastItem = self._Store(
993 self._ItemType,
994 self._ValueList[0],
995 self._ValueList[1],
996 self._ValueList[2],
997 Arch,
998 ModuleType,
999 DefaultStore,
1000 Owner,
1001 self._From,
1002 self._LineIndex + 1,
1003 - 1,
1004 self._LineIndex + 1,
1005 - 1,
1006 self._Enabled
1007 )
1008 if self._SubsectionType == MODEL_UNKNOWN and self._InSubsection:
1009 OwnerId[Arch] = self._LastItem
1010
1011 if self._DirectiveStack:
1012 Type, Line, Text = self._DirectiveStack[-1]
1013 EdkLogger.error('Parser', FORMAT_INVALID, "No matching '!endif' found",
1014 ExtraData=Text, File=self.MetaFile, Line=Line)
1015 self._Done()
1016
1017 ## <subsection_header> parser
1018 def _SubsectionHeaderParser(self):
1019 self._SubsectionName = self._CurrentLine[1:-1].upper()
1020 if self._SubsectionName in self.DataType:
1021 self._SubsectionType = self.DataType[self._SubsectionName]
1022 else:
1023 self._SubsectionType = MODEL_UNKNOWN
1024 EdkLogger.warn("Parser", "Unrecognized sub-section", File=self.MetaFile,
1025 Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
1026 self._ValueList[0] = self._SubsectionName
1027
1028 ## Directive statement parser
1029 def _DirectiveParser(self):
1030 self._ValueList = ['', '', '']
1031 TokenList = GetSplitValueList(self._CurrentLine, ' ', 1)
1032 self._ValueList[0:len(TokenList)] = TokenList
1033
1034 # Syntax check
1035 DirectiveName = self._ValueList[0].upper()
1036 if DirectiveName not in self.DataType:
1037 EdkLogger.error("Parser", FORMAT_INVALID, "Unknown directive [%s]" % DirectiveName,
1038 File=self.MetaFile, Line=self._LineIndex + 1)
1039
1040 if DirectiveName in ['!IF', '!IFDEF', '!IFNDEF']:
1041 self._InDirective += 1
1042
1043 if DirectiveName in ['!ENDIF']:
1044 self._InDirective -= 1
1045
1046 if DirectiveName in ['!IF', '!IFDEF', '!INCLUDE', '!IFNDEF', '!ELSEIF'] and self._ValueList[1] == '':
1047 EdkLogger.error("Parser", FORMAT_INVALID, "Missing expression",
1048 File=self.MetaFile, Line=self._LineIndex + 1,
1049 ExtraData=self._CurrentLine)
1050
1051 ItemType = self.DataType[DirectiveName]
1052 Scope = [[TAB_COMMON, TAB_COMMON, TAB_COMMON]]
1053 if ItemType == MODEL_META_DATA_INCLUDE:
1054 Scope = self._Scope
1055 elif ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR:
1056 Scope = self._Scope
1057 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:
1058 # Remove all directives between !if and !endif, including themselves
1059 while self._DirectiveStack:
1060 # Remove any !else or !elseif
1061 DirectiveInfo = self._DirectiveStack.pop()
1062 if DirectiveInfo[0] in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,
1063 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,
1064 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:
1065 break
1066 else:
1067 EdkLogger.error("Parser", FORMAT_INVALID, "Redundant '!endif'",
1068 File=self.MetaFile, Line=self._LineIndex + 1,
1069 ExtraData=self._CurrentLine)
1070 elif ItemType not in {MODEL_META_DATA_INCLUDE, MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR}:
1071 # Break if there's a !else is followed by a !elseif
1072 if ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF and \
1073 self._DirectiveStack and \
1074 self._DirectiveStack[-1][0] == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:
1075 EdkLogger.error("Parser", FORMAT_INVALID, "'!elseif' after '!else'",
1076 File=self.MetaFile, Line=self._LineIndex + 1,
1077 ExtraData=self._CurrentLine)
1078 self._DirectiveStack.append((ItemType, self._LineIndex + 1, self._CurrentLine))
1079
1080 #
1081 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,
1082 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
1083 #
1084 for Arch, ModuleType, DefaultStore in Scope:
1085 self._LastItem = self._Store(
1086 ItemType,
1087 self._ValueList[0],
1088 self._ValueList[1],
1089 self._ValueList[2],
1090 Arch,
1091 ModuleType,
1092 DefaultStore,
1093 self._Owner[-1],
1094 self._From,
1095 self._LineIndex + 1,
1096 - 1,
1097 self._LineIndex + 1,
1098 - 1,
1099 0
1100 )
1101
1102 ## [defines] section parser
1103 @ParseMacro
1104 def _DefineParser(self):
1105 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
1106 self._ValueList[1:len(TokenList)] = TokenList
1107
1108 # Syntax check
1109 if not self._ValueList[1]:
1110 EdkLogger.error('Parser', FORMAT_INVALID, "No name specified",
1111 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1112 if not self._ValueList[2]:
1113 EdkLogger.error('Parser', FORMAT_INVALID, "No value specified",
1114 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1115 if (not self._ValueList[1] in self.DefineKeywords and
1116 (self._InSubsection and self._ValueList[1] not in self.SubSectionDefineKeywords)):
1117 EdkLogger.error('Parser', FORMAT_INVALID,
1118 "Unknown keyword found: %s. "
1119 "If this is a macro you must "
1120 "add it as a DEFINE in the DSC" % self._ValueList[1],
1121 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1122 if not self._InSubsection:
1123 self._Defines[self._ValueList[1]] = self._ValueList[2]
1124 self._ItemType = self.DataType[TAB_DSC_DEFINES.upper()]
1125
1126 @ParseMacro
1127 def _SkuIdParser(self):
1128 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
1129 if len(TokenList) not in (2, 3):
1130 EdkLogger.error('Parser', FORMAT_INVALID, "Correct format is '<Number>|<UiName>[|<UiName>]'",
1131 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1132 self._ValueList[0:len(TokenList)] = TokenList
1133 @ParseMacro
1134 def _DefaultStoresParser(self):
1135 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
1136 if len(TokenList) != 2:
1137 EdkLogger.error('Parser', FORMAT_INVALID, "Correct format is '<Number>|<UiName>'",
1138 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1139 self._ValueList[0:len(TokenList)] = TokenList
1140
1141 ## Parse Edk style of library modules
1142 @ParseMacro
1143 def _LibraryInstanceParser(self):
1144 self._ValueList[0] = self._CurrentLine
1145
1146 def ProcessMultipleLineCODEValue(self,Content):
1147 CODEBegin = False
1148 CODELine = ""
1149 continuelinecount = 0
1150 newContent = []
1151 for Index in range(0, len(Content)):
1152 Line = Content[Index]
1153 if CODEBegin:
1154 CODELine = CODELine + Line
1155 continuelinecount +=1
1156 if ")}" in Line:
1157 newContent.append(CODELine)
1158 for _ in range(continuelinecount):
1159 newContent.append("")
1160 CODEBegin = False
1161 CODELine = ""
1162 continuelinecount = 0
1163 else:
1164 if not Line:
1165 newContent.append(Line)
1166 continue
1167 if "{CODE(" not in Line:
1168 newContent.append(Line)
1169 continue
1170 elif CODEPattern.findall(Line):
1171 newContent.append(Line)
1172 continue
1173 else:
1174 CODEBegin = True
1175 CODELine = Line
1176
1177 return newContent
1178
1179 def _DecodeCODEData(self):
1180 pass
1181 ## PCD sections parser
1182 #
1183 # [PcdsFixedAtBuild]
1184 # [PcdsPatchableInModule]
1185 # [PcdsFeatureFlag]
1186 # [PcdsDynamicEx
1187 # [PcdsDynamicExDefault]
1188 # [PcdsDynamicExVpd]
1189 # [PcdsDynamicExHii]
1190 # [PcdsDynamic]
1191 # [PcdsDynamicDefault]
1192 # [PcdsDynamicVpd]
1193 # [PcdsDynamicHii]
1194 #
1195 @ParseMacro
1196 def _PcdParser(self):
1197 if self._PcdDataTypeCODE:
1198 self._PcdCodeValue = self._PcdCodeValue + "\n " + self._CurrentLine
1199 if self._CurrentLine.endswith(")}"):
1200 self._CurrentLine = "|".join((self._CurrentPcdName, self._PcdCodeValue))
1201 self._PcdDataTypeCODE = False
1202 self._PcdCodeValue = ""
1203 else:
1204 self._ValueList = None
1205 return
1206 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)
1207 self._CurrentPcdName = TokenList[0]
1208 if len(TokenList) == 2 and TokenList[1].strip().startswith("{CODE"):
1209 self._PcdDataTypeCODE = True
1210 self._PcdCodeValue = TokenList[1].strip()
1211
1212 if self._PcdDataTypeCODE:
1213 if self._CurrentLine.endswith(")}"):
1214 self._PcdDataTypeCODE = False
1215 self._PcdCodeValue = ""
1216 else:
1217 self._ValueList = None
1218 return
1219 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)
1220 PcdNameTockens = GetSplitValueList(TokenList[0], TAB_SPLIT)
1221 if len(PcdNameTockens) == 2:
1222 self._ValueList[0], self._ValueList[1] = PcdNameTockens[0], PcdNameTockens[1]
1223 elif len(PcdNameTockens) == 3:
1224 self._ValueList[0], self._ValueList[1] = ".".join((PcdNameTockens[0], PcdNameTockens[1])), PcdNameTockens[2]
1225 elif len(PcdNameTockens) > 3:
1226 self._ValueList[0], self._ValueList[1] = ".".join((PcdNameTockens[0], PcdNameTockens[1])), ".".join(PcdNameTockens[2:])
1227 if len(TokenList) == 2:
1228 self._ValueList[2] = TokenList[1]
1229 if self._ValueList[0] == '' or self._ValueList[1] == '':
1230 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",
1231 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",
1232 File=self.MetaFile, Line=self._LineIndex + 1)
1233 if self._ValueList[2] == '':
1234 #
1235 # The PCD values are optional for FIXEDATBUILD, PATCHABLEINMODULE, Dynamic/DynamicEx default
1236 #
1237 if self._SectionType in (MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT):
1238 return
1239 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD value given",
1240 ExtraData=self._CurrentLine + " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",
1241 File=self.MetaFile, Line=self._LineIndex + 1)
1242
1243 # Validate the datum type of Dynamic Defaul PCD and DynamicEx Default PCD
1244 ValueList = GetSplitValueList(self._ValueList[2])
1245 if len(ValueList) > 1 and ValueList[1] in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64] \
1246 and self._ItemType in [MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT]:
1247 EdkLogger.error('Parser', FORMAT_INVALID, "The datum type '%s' of PCD is wrong" % ValueList[1],
1248 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1249
1250 # Validate the VariableName of DynamicHii and DynamicExHii for PCD Entry must not be an empty string
1251 if self._ItemType in [MODEL_PCD_DYNAMIC_HII, MODEL_PCD_DYNAMIC_EX_HII]:
1252 DscPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)
1253 if len(DscPcdValueList[0].replace('L', '').replace('"', '').strip()) == 0:
1254 EdkLogger.error('Parser', FORMAT_INVALID, "The VariableName field in the HII format PCD entry must not be an empty string",
1255 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
1256
1257 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.
1258 DscPcdValueList = GetSplitValueList(TokenList[1], TAB_VALUE_SPLIT, 1)
1259 if DscPcdValueList[0] in ['True', 'true', 'TRUE']:
1260 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '1', 1);
1261 elif DscPcdValueList[0] in ['False', 'false', 'FALSE']:
1262 self._ValueList[2] = TokenList[1].replace(DscPcdValueList[0], '0', 1);
1263
1264
1265 ## [components] section parser
1266 @ParseMacro
1267 def _ComponentParser(self):
1268 if self._CurrentLine[-1] == '{':
1269 self._ValueList[0] = self._CurrentLine[0:-1].strip()
1270 self._InSubsection = True
1271 self._SubsectionType = MODEL_UNKNOWN
1272 else:
1273 self._ValueList[0] = self._CurrentLine
1274
1275 ## [LibraryClasses] section
1276 @ParseMacro
1277 def _LibraryClassParser(self):
1278 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT)
1279 if len(TokenList) < 2:
1280 EdkLogger.error('Parser', FORMAT_INVALID, "No library class or instance specified",
1281 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",
1282 File=self.MetaFile, Line=self._LineIndex + 1)
1283 if TokenList[0] == '':
1284 EdkLogger.error('Parser', FORMAT_INVALID, "No library class specified",
1285 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",
1286 File=self.MetaFile, Line=self._LineIndex + 1)
1287 if TokenList[1] == '':
1288 EdkLogger.error('Parser', FORMAT_INVALID, "No library instance specified",
1289 ExtraData=self._CurrentLine + " (<LibraryClassName>|<LibraryInstancePath>)",
1290 File=self.MetaFile, Line=self._LineIndex + 1)
1291
1292 self._ValueList[0:len(TokenList)] = TokenList
1293
1294 def _CompponentSourceOverridePathParser(self):
1295 self._ValueList[0] = self._CurrentLine
1296
1297 ## [BuildOptions] section parser
1298 @ParseMacro
1299 def _BuildOptionParser(self):
1300 self._CurrentLine = CleanString(self._CurrentLine, BuildOption=True)
1301 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
1302 TokenList2 = GetSplitValueList(TokenList[0], ':', 1)
1303 if len(TokenList2) == 2:
1304 self._ValueList[0] = TokenList2[0] # toolchain family
1305 self._ValueList[1] = TokenList2[1] # keys
1306 else:
1307 self._ValueList[1] = TokenList[0]
1308 if len(TokenList) == 2: # value
1309 self._ValueList[2] = TokenList[1]
1310
1311 if self._ValueList[1].count('_') != 4:
1312 EdkLogger.error(
1313 'Parser',
1314 FORMAT_INVALID,
1315 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self._ValueList[1],
1316 ExtraData=self._CurrentLine,
1317 File=self.MetaFile,
1318 Line=self._LineIndex + 1
1319 )
1320
1321 ## Override parent's method since we'll do all macro replacements in parser
1322 @property
1323 def _Macros(self):
1324 Macros = {}
1325 Macros.update(self._FileLocalMacros)
1326 Macros.update(self._GetApplicableSectionMacro())
1327 Macros.update(GlobalData.gEdkGlobal)
1328 Macros.update(GlobalData.gPlatformDefines)
1329 Macros.update(GlobalData.gCommandLineDefines)
1330 # PCD cannot be referenced in macro definition
1331 if self._ItemType not in [MODEL_META_DATA_DEFINE, MODEL_META_DATA_GLOBAL_DEFINE]:
1332 Macros.update(self._Symbols)
1333 if GlobalData.BuildOptionPcd:
1334 for Item in GlobalData.BuildOptionPcd:
1335 if isinstance(Item, tuple):
1336 continue
1337 PcdName, TmpValue = Item.split("=")
1338 TmpValue = BuildOptionValue(TmpValue, self._GuidDict)
1339 Macros[PcdName.strip()] = TmpValue
1340 return Macros
1341
1342 def _PostProcess(self):
1343 Processer = {
1344 MODEL_META_DATA_SECTION_HEADER : self.__ProcessSectionHeader,
1345 MODEL_META_DATA_SUBSECTION_HEADER : self.__ProcessSubsectionHeader,
1346 MODEL_META_DATA_HEADER : self.__ProcessDefine,
1347 MODEL_META_DATA_DEFINE : self.__ProcessDefine,
1348 MODEL_META_DATA_GLOBAL_DEFINE : self.__ProcessDefine,
1349 MODEL_META_DATA_INCLUDE : self.__ProcessDirective,
1350 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF : self.__ProcessDirective,
1351 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE : self.__ProcessDirective,
1352 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF : self.__ProcessDirective,
1353 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF : self.__ProcessDirective,
1354 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF : self.__ProcessDirective,
1355 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF : self.__ProcessDirective,
1356 MODEL_EFI_SKU_ID : self.__ProcessSkuId,
1357 MODEL_EFI_DEFAULT_STORES : self.__ProcessDefaultStores,
1358 MODEL_EFI_LIBRARY_INSTANCE : self.__ProcessLibraryInstance,
1359 MODEL_EFI_LIBRARY_CLASS : self.__ProcessLibraryClass,
1360 MODEL_PCD_FIXED_AT_BUILD : self.__ProcessPcd,
1361 MODEL_PCD_PATCHABLE_IN_MODULE : self.__ProcessPcd,
1362 MODEL_PCD_FEATURE_FLAG : self.__ProcessPcd,
1363 MODEL_PCD_DYNAMIC_DEFAULT : self.__ProcessPcd,
1364 MODEL_PCD_DYNAMIC_HII : self.__ProcessPcd,
1365 MODEL_PCD_DYNAMIC_VPD : self.__ProcessPcd,
1366 MODEL_PCD_DYNAMIC_EX_DEFAULT : self.__ProcessPcd,
1367 MODEL_PCD_DYNAMIC_EX_HII : self.__ProcessPcd,
1368 MODEL_PCD_DYNAMIC_EX_VPD : self.__ProcessPcd,
1369 MODEL_META_DATA_COMPONENT : self.__ProcessComponent,
1370 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : self.__ProcessSourceOverridePath,
1371 MODEL_META_DATA_BUILD_OPTION : self.__ProcessBuildOption,
1372 MODEL_UNKNOWN : self._Skip,
1373 MODEL_META_DATA_USER_EXTENSION : self._SkipUserExtension,
1374 MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR : self._ProcessError,
1375 }
1376
1377 self._Table = MetaFileStorage(self._RawTable.DB, self.MetaFile, MODEL_FILE_DSC, True)
1378 self._DirectiveStack = []
1379 self._DirectiveEvalStack = []
1380 self._FileWithError = self.MetaFile
1381 self._FileLocalMacros = {}
1382 self._SectionsMacroDict.clear()
1383 GlobalData.gPlatformDefines = {}
1384
1385 # Get all macro and PCD which has straitforward value
1386 self.__RetrievePcdValue()
1387 self._Content = self._RawTable.GetAll()
1388 self._ContentIndex = 0
1389 self._InSubsection = False
1390 while self._ContentIndex < len(self._Content) :
1391 Id, self._ItemType, V1, V2, V3, S1, S2, S3, Owner, self._From, \
1392 LineStart, ColStart, LineEnd, ColEnd, Enabled = self._Content[self._ContentIndex]
1393
1394 if self._From < 0:
1395 self._FileWithError = self.MetaFile
1396
1397 self._ContentIndex += 1
1398
1399 self._Scope = [[S1, S2, S3]]
1400 #
1401 # For !include directive, handle it specially,
1402 # merge arch and module type in case of duplicate items
1403 #
1404 while self._ItemType == MODEL_META_DATA_INCLUDE:
1405 if self._ContentIndex >= len(self._Content):
1406 break
1407 Record = self._Content[self._ContentIndex]
1408 if LineStart == Record[10] and LineEnd == Record[12]:
1409 if [Record[5], Record[6], Record[7]] not in self._Scope:
1410 self._Scope.append([Record[5], Record[6], Record[7]])
1411 self._ContentIndex += 1
1412 else:
1413 break
1414
1415 self._LineIndex = LineStart - 1
1416 self._ValueList = [V1, V2, V3]
1417
1418 if Owner > 0 and Owner in self._IdMapping:
1419 self._InSubsection = True
1420 else:
1421 self._InSubsection = False
1422 try:
1423 Processer[self._ItemType]()
1424 except EvaluationException as Excpt:
1425 #
1426 # Only catch expression evaluation error here. We need to report
1427 # the precise number of line on which the error occurred
1428 #
1429 if hasattr(Excpt, 'Pcd'):
1430 if Excpt.Pcd in GlobalData.gPlatformOtherPcds:
1431 Info = GlobalData.gPlatformOtherPcds[Excpt.Pcd]
1432 EdkLogger.error('Parser', FORMAT_INVALID, "Cannot use this PCD (%s) in an expression as"
1433 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"
1434 " of the DSC file, and it is currently defined in this section:"
1435 " %s, line #: %d." % (Excpt.Pcd, Info[0], Info[1]),
1436 File=self._FileWithError, ExtraData=' '.join(self._ValueList),
1437 Line=self._LineIndex + 1)
1438 else:
1439 EdkLogger.error('Parser', FORMAT_INVALID, "PCD (%s) is not defined in DSC file" % Excpt.Pcd,
1440 File=self._FileWithError, ExtraData=' '.join(self._ValueList),
1441 Line=self._LineIndex + 1)
1442 else:
1443 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid expression: %s" % str(Excpt),
1444 File=self._FileWithError, ExtraData=' '.join(self._ValueList),
1445 Line=self._LineIndex + 1)
1446 except MacroException as Excpt:
1447 EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),
1448 File=self._FileWithError, ExtraData=' '.join(self._ValueList),
1449 Line=self._LineIndex + 1)
1450
1451 if self._ValueList is None:
1452 continue
1453
1454 NewOwner = self._IdMapping.get(Owner, -1)
1455 self._Enabled = int((not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack))
1456 self._LastItem = self._Store(
1457 self._ItemType,
1458 self._ValueList[0],
1459 self._ValueList[1],
1460 self._ValueList[2],
1461 S1,
1462 S2,
1463 S3,
1464 NewOwner,
1465 self._From,
1466 self._LineIndex + 1,
1467 - 1,
1468 self._LineIndex + 1,
1469 - 1,
1470 self._Enabled
1471 )
1472 self._IdMapping[Id] = self._LastItem
1473
1474 GlobalData.gPlatformDefines.update(self._FileLocalMacros)
1475 self._PostProcessed = True
1476 self._Content = None
1477 def _ProcessError(self):
1478 if not self._Enabled:
1479 return
1480 EdkLogger.error('Parser', ERROR_STATEMENT, self._ValueList[1], File=self.MetaFile, Line=self._LineIndex + 1)
1481
1482 def __ProcessSectionHeader(self):
1483 self._SectionName = self._ValueList[0]
1484 if self._SectionName in self.DataType:
1485 self._SectionType = self.DataType[self._SectionName]
1486 else:
1487 self._SectionType = MODEL_UNKNOWN
1488
1489 def __ProcessSubsectionHeader(self):
1490 self._SubsectionName = self._ValueList[0]
1491 if self._SubsectionName in self.DataType:
1492 self._SubsectionType = self.DataType[self._SubsectionName]
1493 else:
1494 self._SubsectionType = MODEL_UNKNOWN
1495
1496 def __RetrievePcdValue(self):
1497 Content = open(str(self.MetaFile), 'r').readlines()
1498 GlobalData.gPlatformOtherPcds['DSCFILE'] = str(self.MetaFile)
1499 for PcdType in (MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_HII,
1500 MODEL_PCD_DYNAMIC_VPD, MODEL_PCD_DYNAMIC_EX_DEFAULT, MODEL_PCD_DYNAMIC_EX_HII,
1501 MODEL_PCD_DYNAMIC_EX_VPD):
1502 Records = self._RawTable.Query(PcdType, BelongsToItem= -1.0)
1503 for TokenSpaceGuid, PcdName, Value, Dummy2, Dummy3, Dummy4, ID, Line in Records:
1504 Name = TokenSpaceGuid + '.' + PcdName
1505 if Name not in GlobalData.gPlatformOtherPcds:
1506 PcdLine = Line
1507 while not Content[Line - 1].lstrip().startswith(TAB_SECTION_START):
1508 Line -= 1
1509 GlobalData.gPlatformOtherPcds[Name] = (CleanString(Content[Line - 1]), PcdLine, PcdType)
1510
1511 def __ProcessDefine(self):
1512 if not self._Enabled:
1513 return
1514
1515 Type, Name, Value = self._ValueList
1516 Value = ReplaceMacro(Value, self._Macros, False)
1517 #
1518 # If it is <Defines>, return
1519 #
1520 if self._InSubsection:
1521 self._ValueList = [Type, Name, Value]
1522 return
1523
1524 if self._ItemType == MODEL_META_DATA_DEFINE:
1525 if self._SectionType == MODEL_META_DATA_HEADER:
1526 self._FileLocalMacros[Name] = Value
1527 else:
1528 self._ConstructSectionMacroDict(Name, Value)
1529 elif self._ItemType == MODEL_META_DATA_GLOBAL_DEFINE:
1530 GlobalData.gEdkGlobal[Name] = Value
1531
1532 #
1533 # Keyword in [Defines] section can be used as Macros
1534 #
1535 if (self._ItemType == MODEL_META_DATA_HEADER) and (self._SectionType == MODEL_META_DATA_HEADER):
1536 self._FileLocalMacros[Name] = Value
1537
1538 self._ValueList = [Type, Name, Value]
1539
1540 def __ProcessDirective(self):
1541 Result = None
1542 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,
1543 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF]:
1544 Macros = self._Macros
1545 Macros.update(GlobalData.gGlobalDefines)
1546 try:
1547 Result = ValueExpression(self._ValueList[1], Macros)()
1548 except SymbolNotFound as Exc:
1549 EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])
1550 Result = False
1551 except WrnExpression as Excpt:
1552 #
1553 # Catch expression evaluation warning here. We need to report
1554 # the precise number of line and return the evaluation result
1555 #
1556 EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),
1557 File=self._FileWithError, ExtraData=' '.join(self._ValueList),
1558 Line=self._LineIndex + 1)
1559 Result = Excpt.result
1560
1561 if self._ItemType in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,
1562 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,
1563 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:
1564 self._DirectiveStack.append(self._ItemType)
1565 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IF:
1566 Result = bool(Result)
1567 else:
1568 Macro = self._ValueList[1]
1569 Macro = Macro[2:-1] if (Macro.startswith("$(") and Macro.endswith(")")) else Macro
1570 Result = Macro in self._Macros
1571 if self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF:
1572 Result = not Result
1573 self._DirectiveEvalStack.append(Result)
1574 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF:
1575 self._DirectiveStack.append(self._ItemType)
1576 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]
1577 self._DirectiveEvalStack.append(bool(Result))
1578 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE:
1579 self._DirectiveStack.append(self._ItemType)
1580 self._DirectiveEvalStack[-1] = not self._DirectiveEvalStack[-1]
1581 self._DirectiveEvalStack.append(True)
1582 elif self._ItemType == MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF:
1583 # Back to the nearest !if/!ifdef/!ifndef
1584 while self._DirectiveStack:
1585 self._DirectiveEvalStack.pop()
1586 Directive = self._DirectiveStack.pop()
1587 if Directive in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF,
1588 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF,
1589 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF]:
1590 break
1591 elif self._ItemType == MODEL_META_DATA_INCLUDE:
1592 # The included file must be relative to workspace or same directory as DSC file
1593 __IncludeMacros = {}
1594 #
1595 # Allow using system environment variables in path after !include
1596 #
1597 __IncludeMacros['WORKSPACE'] = GlobalData.gGlobalDefines['WORKSPACE']
1598 if "ECP_SOURCE" in GlobalData.gGlobalDefines:
1599 __IncludeMacros['ECP_SOURCE'] = GlobalData.gGlobalDefines['ECP_SOURCE']
1600 #
1601 # During GenFds phase call DSC parser, will go into this branch.
1602 #
1603 elif "ECP_SOURCE" in GlobalData.gCommandLineDefines:
1604 __IncludeMacros['ECP_SOURCE'] = GlobalData.gCommandLineDefines['ECP_SOURCE']
1605
1606 __IncludeMacros['EFI_SOURCE'] = GlobalData.gGlobalDefines['EFI_SOURCE']
1607 __IncludeMacros['EDK_SOURCE'] = GlobalData.gGlobalDefines['EDK_SOURCE']
1608 #
1609 # Allow using MACROs comes from [Defines] section to keep compatible.
1610 #
1611 __IncludeMacros.update(self._Macros)
1612
1613 IncludedFile = NormPath(ReplaceMacro(self._ValueList[1], __IncludeMacros, RaiseError=True))
1614 #
1615 # First search the include file under the same directory as DSC file
1616 #
1617 IncludedFile1 = PathClass(IncludedFile, self.MetaFile.Dir)
1618 ErrorCode, ErrorInfo1 = IncludedFile1.Validate()
1619 if ErrorCode != 0:
1620 #
1621 # Also search file under the WORKSPACE directory
1622 #
1623 IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)
1624 ErrorCode, ErrorInfo2 = IncludedFile1.Validate()
1625 if ErrorCode != 0:
1626 EdkLogger.error('parser', ErrorCode, File=self._FileWithError,
1627 Line=self._LineIndex + 1, ExtraData=ErrorInfo1 + "\n" + ErrorInfo2)
1628
1629 self._FileWithError = IncludedFile1
1630
1631 FromItem = self._Content[self._ContentIndex - 1][0]
1632 if self._InSubsection:
1633 Owner = self._Content[self._ContentIndex - 1][8]
1634 else:
1635 Owner = self._Content[self._ContentIndex - 1][0]
1636 IncludedFileTable = MetaFileStorage(self._RawTable.DB, IncludedFile1, MODEL_FILE_DSC, False, FromItem=FromItem)
1637 Parser = DscParser(IncludedFile1, self._FileType, self._Arch, IncludedFileTable,
1638 Owner=Owner, From=FromItem)
1639
1640 self.IncludedFiles.add (IncludedFile1)
1641
1642 # set the parser status with current status
1643 Parser._SectionName = self._SectionName
1644 Parser._SubsectionType = self._SubsectionType
1645 Parser._InSubsection = self._InSubsection
1646 Parser._SectionType = self._SectionType
1647 Parser._Scope = self._Scope
1648 Parser._Enabled = self._Enabled
1649 # Parse the included file
1650 Parser.StartParse()
1651 # Insert all records in the table for the included file into dsc file table
1652 Records = IncludedFileTable.GetAll()
1653 if Records:
1654 self._Content[self._ContentIndex:self._ContentIndex] = Records
1655 self._Content.pop(self._ContentIndex - 1)
1656 self._ValueList = None
1657 self._ContentIndex -= 1
1658
1659 def __ProcessSkuId(self):
1660 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)
1661 for Value in self._ValueList]
1662 def __ProcessDefaultStores(self):
1663 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)
1664 for Value in self._ValueList]
1665
1666 def __ProcessLibraryInstance(self):
1667 self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]
1668
1669 def __ProcessLibraryClass(self):
1670 self._ValueList[1] = ReplaceMacro(self._ValueList[1], self._Macros, RaiseError=True)
1671
1672 def __ProcessPcd(self):
1673 if self._ItemType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:
1674 self._ValueList[2] = ReplaceMacro(self._ValueList[2], self._Macros, RaiseError=True)
1675 return
1676
1677 ValList, Valid, Index = AnalyzeDscPcd(self._ValueList[2], self._ItemType)
1678 if not Valid:
1679 if self._ItemType in (MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT, MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE):
1680 if ValList[1] != TAB_VOID and StructPattern.match(ValList[1]) is None and ValList[2]:
1681 EdkLogger.error('build', FORMAT_INVALID, "Pcd format incorrect. The datum type info should be VOID* or a valid struct name.", File=self._FileWithError,
1682 Line=self._LineIndex + 1, ExtraData="%s.%s|%s" % (self._ValueList[0], self._ValueList[1], self._ValueList[2]))
1683 EdkLogger.error('build', FORMAT_INVALID, "Pcd format incorrect.", File=self._FileWithError, Line=self._LineIndex + 1,
1684 ExtraData="%s.%s|%s" % (self._ValueList[0], self._ValueList[1], self._ValueList[2]))
1685 PcdValue = ValList[Index]
1686 if PcdValue and "." not in self._ValueList[0]:
1687 try:
1688 ValList[Index] = ValueExpression(PcdValue, self._Macros)(True)
1689 except WrnExpression as Value:
1690 ValList[Index] = Value.result
1691 except:
1692 pass
1693
1694 if ValList[Index] == 'True':
1695 ValList[Index] = '1'
1696 if ValList[Index] == 'False':
1697 ValList[Index] = '0'
1698
1699 if (not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack):
1700 GlobalData.gPlatformPcds[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue
1701 self._Symbols[TAB_SPLIT.join(self._ValueList[0:2])] = PcdValue
1702 try:
1703 self._ValueList[2] = '|'.join(ValList)
1704 except Exception:
1705 print(ValList)
1706
1707 def __ProcessComponent(self):
1708 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)
1709
1710 def __ProcessSourceOverridePath(self):
1711 self._ValueList[0] = ReplaceMacro(self._ValueList[0], self._Macros)
1712
1713 def __ProcessBuildOption(self):
1714 self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=False)
1715 for Value in self._ValueList]
1716
1717 _SectionParser = {
1718 MODEL_META_DATA_HEADER : _DefineParser,
1719 MODEL_EFI_SKU_ID : _SkuIdParser,
1720 MODEL_EFI_DEFAULT_STORES : _DefaultStoresParser,
1721 MODEL_EFI_LIBRARY_INSTANCE : _LibraryInstanceParser,
1722 MODEL_EFI_LIBRARY_CLASS : _LibraryClassParser,
1723 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,
1724 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,
1725 MODEL_PCD_FEATURE_FLAG : _PcdParser,
1726 MODEL_PCD_DYNAMIC_DEFAULT : _PcdParser,
1727 MODEL_PCD_DYNAMIC_HII : _PcdParser,
1728 MODEL_PCD_DYNAMIC_VPD : _PcdParser,
1729 MODEL_PCD_DYNAMIC_EX_DEFAULT : _PcdParser,
1730 MODEL_PCD_DYNAMIC_EX_HII : _PcdParser,
1731 MODEL_PCD_DYNAMIC_EX_VPD : _PcdParser,
1732 MODEL_META_DATA_COMPONENT : _ComponentParser,
1733 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH : _CompponentSourceOverridePathParser,
1734 MODEL_META_DATA_BUILD_OPTION : _BuildOptionParser,
1735 MODEL_UNKNOWN : MetaFileParser._Skip,
1736 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,
1737 MODEL_META_DATA_SECTION_HEADER : MetaFileParser._SectionHeaderParser,
1738 MODEL_META_DATA_SUBSECTION_HEADER : _SubsectionHeaderParser,
1739 }
1740
1741 ## DEC file parser class
1742 #
1743 # @param FilePath The path of platform description file
1744 # @param FileType The raw data of DSC file
1745 # @param Table Database used to retrieve module/package information
1746 # @param Macros Macros used for replacement in file
1747 #
1748 class DecParser(MetaFileParser):
1749 # DEC file supported data types (one type per section)
1750 DataType = {
1751 TAB_DEC_DEFINES.upper() : MODEL_META_DATA_HEADER,
1752 TAB_DSC_DEFINES_DEFINE : MODEL_META_DATA_DEFINE,
1753 TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,
1754 TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,
1755 TAB_GUIDS.upper() : MODEL_EFI_GUID,
1756 TAB_PPIS.upper() : MODEL_EFI_PPI,
1757 TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,
1758 TAB_PCDS_FIXED_AT_BUILD_NULL.upper() : MODEL_PCD_FIXED_AT_BUILD,
1759 TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,
1760 TAB_PCDS_FEATURE_FLAG_NULL.upper() : MODEL_PCD_FEATURE_FLAG,
1761 TAB_PCDS_DYNAMIC_NULL.upper() : MODEL_PCD_DYNAMIC,
1762 TAB_PCDS_DYNAMIC_EX_NULL.upper() : MODEL_PCD_DYNAMIC_EX,
1763 TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION,
1764 }
1765
1766 ## Constructor of DecParser
1767 #
1768 # Initialize object of DecParser
1769 #
1770 # @param FilePath The path of platform description file
1771 # @param FileType The raw data of DSC file
1772 # @param Arch Default Arch value for filtering sections
1773 # @param Table Database used to retrieve module/package information
1774 #
1775 def __init__(self, FilePath, FileType, Arch, Table):
1776 # prevent re-initialization
1777 if hasattr(self, "_Table"):
1778 return
1779 MetaFileParser.__init__(self, FilePath, FileType, Arch, Table, -1)
1780 self._Comments = []
1781 self._Version = 0x00010005 # Only EDK2 dec file is supported
1782 self._AllPCDs = [] # Only for check duplicate PCD
1783 self._AllPcdDict = {}
1784
1785 self._CurrentStructurePcdName = ""
1786 self._include_flag = False
1787 self._package_flag = False
1788
1789 ## Parser starter
1790 def Start(self):
1791 Content = ''
1792 try:
1793 Content = open(str(self.MetaFile), 'r').readlines()
1794 except:
1795 EdkLogger.error("Parser", FILE_READ_FAILURE, ExtraData=self.MetaFile)
1796
1797 self._DefinesCount = 0
1798 for Index in range(0, len(Content)):
1799 Line, Comment = CleanString2(Content[Index])
1800 self._CurrentLine = Line
1801 self._LineIndex = Index
1802
1803 # save comment for later use
1804 if Comment:
1805 self._Comments.append((Comment, self._LineIndex + 1))
1806 # skip empty line
1807 if Line == '':
1808 continue
1809
1810 # section header
1811 if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:
1812 self._SectionHeaderParser()
1813 if self._SectionName == TAB_DEC_DEFINES.upper():
1814 self._DefinesCount += 1
1815 self._Comments = []
1816 continue
1817 if self._SectionType == MODEL_UNKNOWN:
1818 EdkLogger.error("Parser", FORMAT_INVALID,
1819 ""
1820 "Not able to determine \"%s\" in which section."%self._CurrentLine,
1821 self.MetaFile, self._LineIndex + 1)
1822 elif len(self._SectionType) == 0:
1823 self._Comments = []
1824 continue
1825
1826 # section content
1827 self._ValueList = ['', '', '']
1828 self._SectionParser[self._SectionType[0]](self)
1829 if self._ValueList is None or self._ItemType == MODEL_META_DATA_DEFINE:
1830 self._ItemType = -1
1831 self._Comments = []
1832 continue
1833
1834 #
1835 # Model, Value1, Value2, Value3, Arch, BelongsToItem=-1, LineBegin=-1,
1836 # ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, FeatureFlag='', Enabled=-1
1837 #
1838 for Arch, ModuleType, Type in self._Scope:
1839 self._LastItem = self._Store(
1840 Type,
1841 self._ValueList[0],
1842 self._ValueList[1],
1843 self._ValueList[2],
1844 Arch,
1845 ModuleType,
1846 self._Owner[-1],
1847 self._LineIndex + 1,
1848 - 1,
1849 self._LineIndex + 1,
1850 - 1,
1851 0
1852 )
1853 for Comment, LineNo in self._Comments:
1854 self._Store(
1855 MODEL_META_DATA_COMMENT,
1856 Comment,
1857 self._ValueList[0],
1858 self._ValueList[1],
1859 Arch,
1860 ModuleType,
1861 self._LastItem,
1862 LineNo,
1863 - 1,
1864 LineNo,
1865 - 1,
1866 0
1867 )
1868 self._Comments = []
1869 if self._DefinesCount > 1:
1870 EdkLogger.error('Parser', FORMAT_INVALID, 'Multiple [Defines] section is exist.', self.MetaFile )
1871 if self._DefinesCount == 0:
1872 EdkLogger.error('Parser', FORMAT_INVALID, 'No [Defines] section exist.', self.MetaFile)
1873 self._Done()
1874
1875
1876 ## Section header parser
1877 #
1878 # The section header is always in following format:
1879 #
1880 # [section_name.arch<.platform|module_type>]
1881 #
1882 def _SectionHeaderParser(self):
1883 self._Scope = []
1884 self._SectionName = ''
1885 self._SectionType = []
1886 ArchList = set()
1887 PrivateList = set()
1888 Line = re.sub(',[\s]*', TAB_COMMA_SPLIT, self._CurrentLine)
1889 for Item in Line[1:-1].split(TAB_COMMA_SPLIT):
1890 if Item == '':
1891 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR,
1892 "section name can NOT be empty or incorrectly use separator comma",
1893 self.MetaFile, self._LineIndex + 1, self._CurrentLine)
1894 ItemList = Item.split(TAB_SPLIT)
1895
1896 # different types of PCD are permissible in one section
1897 self._SectionName = ItemList[0].upper()
1898 if self._SectionName == TAB_DEC_DEFINES.upper() and (len(ItemList) > 1 or len(Line.split(TAB_COMMA_SPLIT)) > 1):
1899 EdkLogger.error("Parser", FORMAT_INVALID, "Defines section format is invalid",
1900 self.MetaFile, self._LineIndex + 1, self._CurrentLine)
1901 if self._SectionName in self.DataType:
1902 if self.DataType[self._SectionName] not in self._SectionType:
1903 self._SectionType.append(self.DataType[self._SectionName])
1904 else:
1905 EdkLogger.error("Parser", FORMAT_UNKNOWN_ERROR, "%s is not a valid section name" % Item,
1906 self.MetaFile, self._LineIndex + 1, self._CurrentLine)
1907
1908 if MODEL_PCD_FEATURE_FLAG in self._SectionType and len(self._SectionType) > 1:
1909 EdkLogger.error(
1910 'Parser',
1911 FORMAT_INVALID,
1912 "%s must not be in the same section of other types of PCD" % TAB_PCDS_FEATURE_FLAG_NULL,
1913 File=self.MetaFile,
1914 Line=self._LineIndex + 1,
1915 ExtraData=self._CurrentLine
1916 )
1917 # S1 is always Arch
1918 if len(ItemList) > 1:
1919 S1 = ItemList[1].upper()
1920 else:
1921 S1 = TAB_ARCH_COMMON
1922 ArchList.add(S1)
1923 # S2 may be Platform or ModuleType
1924 if len(ItemList) > 2:
1925 S2 = ItemList[2].upper()
1926 # only Includes, GUIDs, PPIs, Protocols section have Private tag
1927 if self._SectionName in [TAB_INCLUDES.upper(), TAB_GUIDS.upper(), TAB_PROTOCOLS.upper(), TAB_PPIS.upper()]:
1928 if S2 != 'PRIVATE':
1929 EdkLogger.error("Parser", FORMAT_INVALID, 'Please use keyword "Private" as section tag modifier.',
1930 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
1931 else:
1932 S2 = TAB_COMMON
1933 PrivateList.add(S2)
1934 if [S1, S2, self.DataType[self._SectionName]] not in self._Scope:
1935 self._Scope.append([S1, S2, self.DataType[self._SectionName]])
1936
1937 # 'COMMON' must not be used with specific ARCHs at the same section
1938 if TAB_ARCH_COMMON in ArchList and len(ArchList) > 1:
1939 EdkLogger.error('Parser', FORMAT_INVALID, "'common' ARCH must not be used with specific ARCHs",
1940 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
1941
1942 # It is not permissible to mix section tags without the Private attribute with section tags with the Private attribute
1943 if TAB_COMMON in PrivateList and len(PrivateList) > 1:
1944 EdkLogger.error('Parser', FORMAT_INVALID, "Can't mix section tags without the Private attribute with section tags with the Private attribute",
1945 File=self.MetaFile, Line=self._LineIndex + 1, ExtraData=self._CurrentLine)
1946
1947 ## [guids], [ppis] and [protocols] section parser
1948 @ParseMacro
1949 def _GuidParser(self):
1950 TokenList = GetSplitValueList(self._CurrentLine, TAB_EQUAL_SPLIT, 1)
1951 if len(TokenList) < 2:
1952 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name or value specified",
1953 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",
1954 File=self.MetaFile, Line=self._LineIndex + 1)
1955 if TokenList[0] == '':
1956 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID name specified",
1957 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",
1958 File=self.MetaFile, Line=self._LineIndex + 1)
1959 if TokenList[1] == '':
1960 EdkLogger.error('Parser', FORMAT_INVALID, "No GUID value specified",
1961 ExtraData=self._CurrentLine + " (<CName> = <GuidValueInCFormat>)",
1962 File=self.MetaFile, Line=self._LineIndex + 1)
1963 if TokenList[1][0] != '{' or TokenList[1][-1] != '}' or GuidStructureStringToGuidString(TokenList[1]) == '':
1964 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid GUID value format",
1965 ExtraData=self._CurrentLine + \
1966 " (<CName> = <GuidValueInCFormat:{8,4,4,{2,2,2,2,2,2,2,2}}>)",
1967 File=self.MetaFile, Line=self._LineIndex + 1)
1968 self._ValueList[0] = TokenList[0]
1969 self._ValueList[1] = TokenList[1]
1970 if self._ValueList[0] not in self._GuidDict:
1971 self._GuidDict[self._ValueList[0]] = self._ValueList[1]
1972
1973 def ParsePcdName(self,namelist):
1974 if "[" in namelist[1]:
1975 pcdname = namelist[1][:namelist[1].index("[")]
1976 arrayindex = namelist[1][namelist[1].index("["):]
1977 namelist[1] = pcdname
1978 if len(namelist) == 2:
1979 namelist.append(arrayindex)
1980 else:
1981 namelist[2] = ".".join((arrayindex,namelist[2]))
1982 return namelist
1983
1984 ## PCD sections parser
1985 #
1986 # [PcdsFixedAtBuild]
1987 # [PcdsPatchableInModule]
1988 # [PcdsFeatureFlag]
1989 # [PcdsDynamicEx
1990 # [PcdsDynamic]
1991 #
1992 @ParseMacro
1993 def _PcdParser(self):
1994 if self._CurrentStructurePcdName:
1995 self._ValueList[0] = self._CurrentStructurePcdName
1996
1997 if "|" not in self._CurrentLine:
1998 if "<HeaderFiles>" == self._CurrentLine:
1999 self._include_flag = True
2000 self._package_flag = False
2001 self._ValueList = None
2002 return
2003 if "<Packages>" == self._CurrentLine:
2004 self._package_flag = True
2005 self._ValueList = None
2006 self._include_flag = False
2007 return
2008
2009 if self._include_flag:
2010 self._ValueList[1] = "<HeaderFiles>_" + md5(self._CurrentLine).hexdigest()
2011 self._ValueList[2] = self._CurrentLine
2012 if self._package_flag and "}" != self._CurrentLine:
2013 self._ValueList[1] = "<Packages>_" + md5(self._CurrentLine).hexdigest()
2014 self._ValueList[2] = self._CurrentLine
2015 if self._CurrentLine == "}":
2016 self._package_flag = False
2017 self._include_flag = False
2018 self._ValueList = None
2019 return
2020 else:
2021 PcdTockens = self._CurrentLine.split(TAB_VALUE_SPLIT)
2022 PcdNames = self.ParsePcdName(PcdTockens[0].split(TAB_SPLIT))
2023 if len(PcdNames) == 2:
2024 if PcdNames[1].strip().endswith("]"):
2025 PcdName = PcdNames[1][:PcdNames[1].index('[')]
2026 Index = PcdNames[1][PcdNames[1].index('['):]
2027 self._ValueList[0] = TAB_SPLIT.join((PcdNames[0],PcdName))
2028 self._ValueList[1] = Index
2029 self._ValueList[2] = PcdTockens[1]
2030 else:
2031 self._CurrentStructurePcdName = ""
2032 else:
2033 if self._CurrentStructurePcdName != TAB_SPLIT.join(PcdNames[:2]):
2034 EdkLogger.error('Parser', FORMAT_INVALID, "Pcd Name does not match: %s and %s " % (self._CurrentStructurePcdName, TAB_SPLIT.join(PcdNames[:2])),
2035 File=self.MetaFile, Line=self._LineIndex + 1)
2036 self._ValueList[1] = TAB_SPLIT.join(PcdNames[2:])
2037 self._ValueList[2] = PcdTockens[1]
2038 if not self._CurrentStructurePcdName:
2039 TokenList = GetSplitValueList(self._CurrentLine, TAB_VALUE_SPLIT, 1)
2040 self._ValueList[0:1] = GetSplitValueList(TokenList[0], TAB_SPLIT)
2041 ValueRe = re.compile(r'^[a-zA-Z_][a-zA-Z0-9_]*')
2042 # check PCD information
2043 if self._ValueList[0] == '' or self._ValueList[1] == '':
2044 EdkLogger.error('Parser', FORMAT_INVALID, "No token space GUID or PCD name specified",
2045 ExtraData=self._CurrentLine + \
2046 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2047 File=self.MetaFile, Line=self._LineIndex + 1)
2048 # check format of token space GUID CName
2049 if not ValueRe.match(self._ValueList[0]):
2050 EdkLogger.error('Parser', FORMAT_INVALID, "The format of the token space GUID CName is invalid. The correct format is '(a-zA-Z_)[a-zA-Z0-9_]*'",
2051 ExtraData=self._CurrentLine + \
2052 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2053 File=self.MetaFile, Line=self._LineIndex + 1)
2054 # check format of PCD CName
2055 if not ValueRe.match(self._ValueList[1]):
2056 EdkLogger.error('Parser', FORMAT_INVALID, "The format of the PCD CName is invalid. The correct format is '(a-zA-Z_)[a-zA-Z0-9_]*'",
2057 ExtraData=self._CurrentLine + \
2058 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2059 File=self.MetaFile, Line=self._LineIndex + 1)
2060 # check PCD datum information
2061 if len(TokenList) < 2 or TokenList[1] == '':
2062 EdkLogger.error('Parser', FORMAT_INVALID, "No PCD Datum information given",
2063 ExtraData=self._CurrentLine + \
2064 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2065 File=self.MetaFile, Line=self._LineIndex + 1)
2066
2067
2068 ValueRe = re.compile(r'^\s*L?\".*\|.*\"')
2069 PtrValue = ValueRe.findall(TokenList[1])
2070
2071 # Has VOID* type string, may contain "|" character in the string.
2072 if len(PtrValue) != 0:
2073 ptrValueList = re.sub(ValueRe, '', TokenList[1])
2074 ValueList = AnalyzePcdExpression(ptrValueList)
2075 ValueList[0] = PtrValue[0]
2076 else:
2077 ValueList = AnalyzePcdExpression(TokenList[1])
2078
2079
2080 # check if there's enough datum information given
2081 if len(ValueList) != 3:
2082 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid PCD Datum information given",
2083 ExtraData=self._CurrentLine + \
2084 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2085 File=self.MetaFile, Line=self._LineIndex + 1)
2086 # check default value
2087 if ValueList[0] == '':
2088 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DefaultValue in PCD Datum information",
2089 ExtraData=self._CurrentLine + \
2090 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2091 File=self.MetaFile, Line=self._LineIndex + 1)
2092 # check datum type
2093 if ValueList[1] == '':
2094 EdkLogger.error('Parser', FORMAT_INVALID, "Missing DatumType in PCD Datum information",
2095 ExtraData=self._CurrentLine + \
2096 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2097 File=self.MetaFile, Line=self._LineIndex + 1)
2098 # check token of the PCD
2099 if ValueList[2] == '':
2100 EdkLogger.error('Parser', FORMAT_INVALID, "Missing Token in PCD Datum information",
2101 ExtraData=self._CurrentLine + \
2102 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
2103 File=self.MetaFile, Line=self._LineIndex + 1)
2104
2105 PcdValue = ValueList[0]
2106 if PcdValue:
2107 try:
2108 self._GuidDict.update(self._AllPcdDict)
2109 ValueList[0] = ValueExpressionEx(ValueList[0], ValueList[1], self._GuidDict)(True)
2110 except BadExpression as Value:
2111 EdkLogger.error('Parser', FORMAT_INVALID, Value, ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
2112 # check format of default value against the datum type
2113 IsValid, Cause = CheckPcdDatum(ValueList[1], ValueList[0])
2114 if not IsValid:
2115 EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,
2116 File=self.MetaFile, Line=self._LineIndex + 1)
2117
2118 if Cause == "StructurePcd":
2119 self._CurrentStructurePcdName = TAB_SPLIT.join(self._ValueList[0:2])
2120 self._ValueList[0] = self._CurrentStructurePcdName
2121 self._ValueList[1] = ValueList[1].strip()
2122
2123 if ValueList[0] in ['True', 'true', 'TRUE']:
2124 ValueList[0] = '1'
2125 elif ValueList[0] in ['False', 'false', 'FALSE']:
2126 ValueList[0] = '0'
2127
2128 # check for duplicate PCD definition
2129 if (self._Scope[0], self._ValueList[0], self._ValueList[1]) in self._AllPCDs:
2130 EdkLogger.error('Parser', FORMAT_INVALID,
2131 "The same PCD name and GUID have been already defined",
2132 ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex + 1)
2133 else:
2134 self._AllPCDs.append((self._Scope[0], self._ValueList[0], self._ValueList[1]))
2135 self._AllPcdDict[TAB_SPLIT.join(self._ValueList[0:2])] = ValueList[0]
2136
2137 self._ValueList[2] = ValueList[0].strip() + '|' + ValueList[1].strip() + '|' + ValueList[2].strip()
2138
2139 _SectionParser = {
2140 MODEL_META_DATA_HEADER : MetaFileParser._DefineParser,
2141 MODEL_EFI_INCLUDE : MetaFileParser._PathParser,
2142 MODEL_EFI_LIBRARY_CLASS : MetaFileParser._PathParser,
2143 MODEL_EFI_GUID : _GuidParser,
2144 MODEL_EFI_PPI : _GuidParser,
2145 MODEL_EFI_PROTOCOL : _GuidParser,
2146 MODEL_PCD_FIXED_AT_BUILD : _PcdParser,
2147 MODEL_PCD_PATCHABLE_IN_MODULE : _PcdParser,
2148 MODEL_PCD_FEATURE_FLAG : _PcdParser,
2149 MODEL_PCD_DYNAMIC : _PcdParser,
2150 MODEL_PCD_DYNAMIC_EX : _PcdParser,
2151 MODEL_UNKNOWN : MetaFileParser._Skip,
2152 MODEL_META_DATA_USER_EXTENSION : MetaFileParser._SkipUserExtension,
2153 }
2154
2155 ##
2156 #
2157 # This acts like the main() function for the script, unless it is 'import'ed into another
2158 # script.
2159 #
2160 if __name__ == '__main__':
2161 pass
2162