2 # This file is used to parse meta files
4 # Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 import Common
.EdkLogger
as EdkLogger
23 import Common
.GlobalData
as GlobalData
25 from CommonDataClass
.DataClass
import *
26 from Common
.DataType
import *
27 from Common
.String
import *
28 from Common
.Misc
import GuidStructureStringToGuidString
, CheckPcdDatum
, PathClass
, AnalyzePcdData
, AnalyzeDscPcd
29 from Common
.Expression
import *
30 from CommonDataClass
.Exceptions
import *
32 from MetaFileTable
import MetaFileStorage
34 ## A decorator used to parse macro definition
35 def ParseMacro(Parser
):
36 def MacroParser(self
):
37 Match
= gMacroDefPattern
.match(self
._CurrentLine
)
39 # Not 'DEFINE/EDK_GLOBAL' statement, call decorated method
43 TokenList
= GetSplitValueList(self
._CurrentLine
[Match
.end(1):], TAB_EQUAL_SPLIT
, 1)
46 EdkLogger
.error('Parser', FORMAT_INVALID
, "No macro name given",
47 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
48 if len(TokenList
) < 2:
52 Name
, Value
= TokenList
53 # Global macros can be only defined via environment variable
54 if Name
in GlobalData
.gGlobalDefines
:
55 EdkLogger
.error('Parser', FORMAT_INVALID
, "%s can only be defined via environment variable" % Name
,
56 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
57 # Only upper case letters, digit and '_' are allowed
58 if not gMacroNamePattern
.match(Name
):
59 EdkLogger
.error('Parser', FORMAT_INVALID
, "The macro name must be in the pattern [A-Z][A-Z0-9_]*",
60 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
62 Value
= ReplaceMacro(Value
, self
._Macros
)
63 if Type
in self
.DataType
:
64 self
._ItemType
= self
.DataType
[Type
]
66 self
._ItemType
= MODEL_META_DATA_DEFINE
67 # DEFINE defined macros
68 if Type
== TAB_DSC_DEFINES_DEFINE
:
70 # First judge whether this DEFINE is in conditional directive statements or not.
72 if type(self
) == DscParser
and self
._InDirective
> -1:
75 if type(self
) == DecParser
:
76 if MODEL_META_DATA_HEADER
in self
._SectionType
:
77 self
._FileLocalMacros
[Name
] = Value
79 self
._ConstructSectionMacroDict
(Name
, Value
)
80 elif self
._SectionType
== MODEL_META_DATA_HEADER
:
81 self
._FileLocalMacros
[Name
] = Value
83 self
._ConstructSectionMacroDict
(Name
, Value
)
85 # EDK_GLOBAL defined macros
86 elif type(self
) != DscParser
:
87 EdkLogger
.error('Parser', FORMAT_INVALID
, "EDK_GLOBAL can only be used in .dsc file",
88 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
89 elif self
._SectionType
!= MODEL_META_DATA_HEADER
:
90 EdkLogger
.error('Parser', FORMAT_INVALID
, "EDK_GLOBAL can only be used under [Defines] section",
91 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
92 elif (Name
in self
._FileLocalMacros
) and (self
._FileLocalMacros
[Name
] != Value
):
93 EdkLogger
.error('Parser', FORMAT_INVALID
, "EDK_GLOBAL defined a macro with the same name and different value as one defined by 'DEFINE'",
94 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
96 self
._ValueList
= [Type
, Name
, Value
]
100 ## Base class of parser
102 # This class is used for derivation purpose. The specific parser for one kind
103 # type file must derive this class and implement some public interfaces.
105 # @param FilePath The path of platform description file
106 # @param FileType The raw data of DSC file
107 # @param Table Database used to retrieve module/package information
108 # @param Macros Macros used for replacement in file
109 # @param Owner Owner ID (for sub-section parsing)
110 # @param From ID from which the data comes (for !INCLUDE directive)
112 class MetaFileParser(object):
113 # data type (file content) for specific file type
116 # Parser objects used to implement singleton
121 # One file, one parser object. This factory method makes sure that there's
122 # only one object constructed for one meta file.
124 # @param Class class object of real AutoGen class
125 # (InfParser, DecParser or DscParser)
126 # @param FilePath The path of meta file
127 # @param *args The specific class related parameters
128 # @param **kwargs The specific class related dict parameters
130 def __new__(Class
, FilePath
, *args
, **kwargs
):
131 if FilePath
in Class
.MetaFiles
:
132 return Class
.MetaFiles
[FilePath
]
134 ParserObject
= super(MetaFileParser
, Class
).__new
__(Class
)
135 Class
.MetaFiles
[FilePath
] = ParserObject
138 ## Constructor of MetaFileParser
140 # Initialize object of MetaFileParser
142 # @param FilePath The path of platform description file
143 # @param FileType The raw data of DSC file
144 # @param Table Database used to retrieve module/package information
145 # @param Macros Macros used for replacement in file
146 # @param Owner Owner ID (for sub-section parsing)
147 # @param From ID from which the data comes (for !INCLUDE directive)
149 def __init__(self
, FilePath
, FileType
, Table
, Owner
= -1, From
= -1):
151 self
._RawTable
= Table
152 self
._FileType
= FileType
153 self
.MetaFile
= FilePath
154 self
._FileDir
= self
.MetaFile
.Dir
156 self
._FileLocalMacros
= {}
157 self
._SectionsMacroDict
= {}
159 # for recursive parsing
160 self
._Owner
= [Owner
]
163 # parsr status for parsing
164 self
._ValueList
= ['', '', '', '', '']
167 self
._CurrentLine
= ''
168 self
._SectionType
= MODEL_UNKNOWN
169 self
._SectionName
= ''
170 self
._InSubsection
= False
171 self
._SubsectionType
= MODEL_UNKNOWN
172 self
._SubsectionName
= ''
173 self
._ItemType
= MODEL_UNKNOWN
176 self
._Finished
= False
177 self
._PostProcessed
= False
178 # Different version of meta-file has different way to parse.
181 ## Store the parsed data in table
182 def _Store(self
, *Args
):
183 return self
._Table
.Insert(*Args
)
185 ## Virtual method for starting parse
187 raise NotImplementedError
189 ## Notify a post-process is needed
190 def DoPostProcess(self
):
191 self
._PostProcessed
= False
193 ## Set parsing complete flag in both class and table
195 self
._Finished
= True
196 ## Do not set end flag when processing included files
198 self
._Table
.SetEndFlag()
200 def _PostProcess(self
):
201 self
._PostProcessed
= True
203 ## Get the parse complete flag
204 def _GetFinished(self
):
205 return self
._Finished
207 ## Set the complete flag
208 def _SetFinished(self
, Value
):
209 self
._Finished
= Value
211 ## Use [] style to query data in table, just for readability
213 # DataInfo = [data_type, scope1(arch), scope2(platform/moduletype)]
215 def __getitem__(self
, DataInfo
):
216 if type(DataInfo
) != type(()):
217 DataInfo
= (DataInfo
,)
219 # Parse the file first, if necessary
220 if not self
._Finished
:
221 if self
._RawTable
.IsIntegrity():
222 self
._Finished
= True
224 self
._Table
= self
._RawTable
225 self
._PostProcessed
= False
228 # No specific ARCH or Platform given, use raw data
229 if self
._RawTable
and (len(DataInfo
) == 1 or DataInfo
[1] == None):
230 return self
._RawTable
.Query(*DataInfo
)
232 # Do post-process if necessary
233 if not self
._PostProcessed
:
236 return self
._Table
.Query(*DataInfo
)
238 ## Data parser for the common format in different type of file
240 # The common format in the meatfile is like
245 def _CommonParser(self
):
246 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
247 self
._ValueList
[0:len(TokenList
)] = TokenList
249 ## Data parser for the format in which there's path
251 # Only path can have macro used. So we need to replace them before use.
254 def _PathParser(self
):
255 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
256 self
._ValueList
[0:len(TokenList
)] = TokenList
257 # Don't do macro replacement for dsc file at this point
258 if type(self
) != DscParser
:
259 Macros
= self
._Macros
260 self
._ValueList
= [ReplaceMacro(Value
, Macros
) for Value
in self
._ValueList
]
262 ## Skip unsupported data
264 EdkLogger
.warn("Parser", "Unrecognized content", File
=self
.MetaFile
,
265 Line
=self
._LineIndex
+ 1, ExtraData
=self
._CurrentLine
);
266 self
._ValueList
[0:1] = [self
._CurrentLine
]
268 ## Section header parser
270 # The section header is always in following format:
272 # [section_name.arch<.platform|module_type>]
274 def _SectionHeaderParser(self
):
276 self
._SectionName
= ''
278 for Item
in GetSplitValueList(self
._CurrentLine
[1:-1], TAB_COMMA_SPLIT
):
281 ItemList
= GetSplitValueList(Item
, TAB_SPLIT
)
282 # different section should not mix in one section
283 if self
._SectionName
!= '' and self
._SectionName
!= ItemList
[0].upper():
284 EdkLogger
.error('Parser', FORMAT_INVALID
, "Different section names in the same section",
285 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1, ExtraData
=self
._CurrentLine
)
286 self
._SectionName
= ItemList
[0].upper()
287 if self
._SectionName
in self
.DataType
:
288 self
._SectionType
= self
.DataType
[self
._SectionName
]
289 # Check if the section name is valid
290 if self
._SectionName
not in SECTIONS_HAVE_ITEM_AFTER_ARCH
and len(ItemList
) > 2:
291 EdkLogger
.error("Parser", FORMAT_UNKNOWN_ERROR
, "%s is not a valid section name" % Item
,
292 self
.MetaFile
, self
._LineIndex
+ 1, self
._CurrentLine
)
293 elif self
._Version
>= 0x00010005:
294 EdkLogger
.error("Parser", FORMAT_UNKNOWN_ERROR
, "%s is not a valid section name" % Item
,
295 self
.MetaFile
, self
._LineIndex
+ 1, self
._CurrentLine
)
297 self
._SectionType
= MODEL_UNKNOWN
300 if len(ItemList
) > 1:
301 S1
= ItemList
[1].upper()
306 # S2 may be Platform or ModuleType
307 if len(ItemList
) > 2:
308 S2
= ItemList
[2].upper()
311 self
._Scope
.append([S1
, S2
])
313 # 'COMMON' must not be used with specific ARCHs at the same section
314 if 'COMMON' in ArchList
and len(ArchList
) > 1:
315 EdkLogger
.error('Parser', FORMAT_INVALID
, "'common' ARCH must not be used with specific ARCHs",
316 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1, ExtraData
=self
._CurrentLine
)
317 # If the section information is needed later, it should be stored in database
318 self
._ValueList
[0] = self
._SectionName
320 ## [defines] section parser
322 def _DefineParser(self
):
323 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
324 self
._ValueList
[1:len(TokenList
)] = TokenList
325 if not self
._ValueList
[1]:
326 EdkLogger
.error('Parser', FORMAT_INVALID
, "No name specified",
327 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
328 if not self
._ValueList
[2]:
329 EdkLogger
.error('Parser', FORMAT_INVALID
, "No value specified",
330 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
332 self
._ValueList
= [ReplaceMacro(Value
, self
._Macros
) for Value
in self
._ValueList
]
333 Name
, Value
= self
._ValueList
[1], self
._ValueList
[2]
334 # Sometimes, we need to make differences between EDK and EDK2 modules
335 if Name
== 'INF_VERSION':
337 self
._Version
= int(Value
, 0)
339 EdkLogger
.error('Parser', FORMAT_INVALID
, "Invalid version number",
340 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
342 if type(self
) == InfParser
and self
._Version
< 0x00010005:
343 # EDK module allows using defines as macros
344 self
._FileLocalMacros
[Name
] = Value
345 self
._Defines
[Name
] = Value
347 ## [BuildOptions] section parser
349 def _BuildOptionParser(self
):
350 self
._CurrentLine
= CleanString(self
._CurrentLine
, BuildOption
=True)
351 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
352 TokenList2
= GetSplitValueList(TokenList
[0], ':', 1)
353 if len(TokenList2
) == 2:
354 self
._ValueList
[0] = TokenList2
[0] # toolchain family
355 self
._ValueList
[1] = TokenList2
[1] # keys
357 self
._ValueList
[1] = TokenList
[0]
358 if len(TokenList
) == 2 and type(self
) != DscParser
: # value
359 self
._ValueList
[2] = ReplaceMacro(TokenList
[1], self
._Macros
)
361 if self
._ValueList
[1].count('_') != 4:
365 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self
._ValueList
[1],
366 ExtraData
=self
._CurrentLine
,
368 Line
=self
._LineIndex
+ 1
371 def _GetMacros(self
):
373 Macros
.update(self
._FileLocalMacros
)
374 Macros
.update(self
._GetApplicableSectionMacro
())
377 ## Construct section Macro dict
378 def _ConstructSectionMacroDict(self
, Name
, Value
):
379 ScopeKey
= [(Scope
[0], Scope
[1]) for Scope
in self
._Scope
]
380 ScopeKey
= tuple(ScopeKey
)
381 SectionDictKey
= self
._SectionType
, ScopeKey
383 # DecParser SectionType is a list, will contain more than one item only in Pcd Section
384 # As Pcd section macro usage is not alllowed, so here it is safe
386 if type(self
) == DecParser
:
387 SectionDictKey
= self
._SectionType
[0], ScopeKey
388 if SectionDictKey
not in self
._SectionsMacroDict
:
389 self
._SectionsMacroDict
[SectionDictKey
] = {}
390 SectionLocalMacros
= self
._SectionsMacroDict
[SectionDictKey
]
391 SectionLocalMacros
[Name
] = Value
393 ## Get section Macros that are applicable to current line, which may come from other sections
394 ## that share the same name while scope is wider
395 def _GetApplicableSectionMacro(self
):
402 ActiveSectionType
= self
._SectionType
403 if type(self
) == DecParser
:
404 ActiveSectionType
= self
._SectionType
[0]
406 for (SectionType
, Scope
) in self
._SectionsMacroDict
:
407 if SectionType
!= ActiveSectionType
:
410 for ActiveScope
in self
._Scope
:
411 Scope0
, Scope1
= ActiveScope
[0], ActiveScope
[1]
412 if(Scope0
, Scope1
) not in Scope
:
415 SpeSpeMacroDict
.update(self
._SectionsMacroDict
[(SectionType
, Scope
)])
417 for ActiveScope
in self
._Scope
:
418 Scope0
, Scope1
= ActiveScope
[0], ActiveScope
[1]
419 if(Scope0
, Scope1
) not in Scope
and (Scope0
, "COMMON") not in Scope
and ("COMMON", Scope1
) not in Scope
:
422 ComSpeMacroDict
.update(self
._SectionsMacroDict
[(SectionType
, Scope
)])
424 if ("COMMON", "COMMON") in Scope
:
425 ComComMacroDict
.update(self
._SectionsMacroDict
[(SectionType
, Scope
)])
427 Macros
.update(ComComMacroDict
)
428 Macros
.update(ComSpeMacroDict
)
429 Macros
.update(SpeSpeMacroDict
)
434 Finished
= property(_GetFinished
, _SetFinished
)
435 _Macros
= property(_GetMacros
)
438 ## INF file parser class
440 # @param FilePath The path of platform description file
441 # @param FileType The raw data of DSC file
442 # @param Table Database used to retrieve module/package information
443 # @param Macros Macros used for replacement in file
445 class InfParser(MetaFileParser
):
446 # INF file supported data types (one type per section)
448 TAB_UNKNOWN
.upper() : MODEL_UNKNOWN
,
449 TAB_INF_DEFINES
.upper() : MODEL_META_DATA_HEADER
,
450 TAB_DSC_DEFINES_DEFINE
: MODEL_META_DATA_DEFINE
,
451 TAB_BUILD_OPTIONS
.upper() : MODEL_META_DATA_BUILD_OPTION
,
452 TAB_INCLUDES
.upper() : MODEL_EFI_INCLUDE
,
453 TAB_LIBRARIES
.upper() : MODEL_EFI_LIBRARY_INSTANCE
,
454 TAB_LIBRARY_CLASSES
.upper() : MODEL_EFI_LIBRARY_CLASS
,
455 TAB_PACKAGES
.upper() : MODEL_META_DATA_PACKAGE
,
456 TAB_NMAKE
.upper() : MODEL_META_DATA_NMAKE
,
457 TAB_INF_FIXED_PCD
.upper() : MODEL_PCD_FIXED_AT_BUILD
,
458 TAB_INF_PATCH_PCD
.upper() : MODEL_PCD_PATCHABLE_IN_MODULE
,
459 TAB_INF_FEATURE_PCD
.upper() : MODEL_PCD_FEATURE_FLAG
,
460 TAB_INF_PCD_EX
.upper() : MODEL_PCD_DYNAMIC_EX
,
461 TAB_INF_PCD
.upper() : MODEL_PCD_DYNAMIC
,
462 TAB_SOURCES
.upper() : MODEL_EFI_SOURCE_FILE
,
463 TAB_GUIDS
.upper() : MODEL_EFI_GUID
,
464 TAB_PROTOCOLS
.upper() : MODEL_EFI_PROTOCOL
,
465 TAB_PPIS
.upper() : MODEL_EFI_PPI
,
466 TAB_DEPEX
.upper() : MODEL_EFI_DEPEX
,
467 TAB_BINARIES
.upper() : MODEL_EFI_BINARY_FILE
,
468 TAB_USER_EXTENSIONS
.upper() : MODEL_META_DATA_USER_EXTENSION
471 ## Constructor of InfParser
473 # Initialize object of InfParser
475 # @param FilePath The path of module description file
476 # @param FileType The raw data of DSC file
477 # @param Table Database used to retrieve module/package information
478 # @param Macros Macros used for replacement in file
480 def __init__(self
, FilePath
, FileType
, Table
):
481 # prevent re-initialization
482 if hasattr(self
, "_Table"):
484 MetaFileParser
.__init
__(self
, FilePath
, FileType
, Table
)
492 Content
= open(str(self
.MetaFile
), 'r').readlines()
494 EdkLogger
.error("Parser", FILE_READ_FAILURE
, ExtraData
=self
.MetaFile
)
496 # parse the file line by line
497 IsFindBlockComment
= False
499 for Index
in range(0, len(Content
)):
500 # skip empty, commented, block commented lines
501 Line
= CleanString(Content
[Index
], AllowCppStyleComment
=True)
503 if Index
+ 1 < len(Content
):
504 NextLine
= CleanString(Content
[Index
+ 1])
507 if Line
.find(DataType
.TAB_COMMENT_EDK_START
) > -1:
508 IsFindBlockComment
= True
510 if Line
.find(DataType
.TAB_COMMENT_EDK_END
) > -1:
511 IsFindBlockComment
= False
513 if IsFindBlockComment
:
516 self
._LineIndex
= Index
517 self
._CurrentLine
= Line
520 if Line
[0] == TAB_SECTION_START
and Line
[-1] == TAB_SECTION_END
:
521 self
._SectionHeaderParser
()
522 # Check invalid sections
523 if self
._Version
< 0x00010005:
524 if self
._SectionType
in [MODEL_META_DATA_BUILD_OPTION
,
525 MODEL_EFI_LIBRARY_CLASS
,
526 MODEL_META_DATA_PACKAGE
,
527 MODEL_PCD_FIXED_AT_BUILD
,
528 MODEL_PCD_PATCHABLE_IN_MODULE
,
529 MODEL_PCD_FEATURE_FLAG
,
530 MODEL_PCD_DYNAMIC_EX
,
535 MODEL_META_DATA_USER_EXTENSION
]:
536 EdkLogger
.error('Parser', FORMAT_INVALID
,
537 "Section [%s] is not allowed in inf file without version" % (self
._SectionName
),
538 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
539 elif self
._SectionType
in [MODEL_EFI_INCLUDE
,
540 MODEL_EFI_LIBRARY_INSTANCE
,
541 MODEL_META_DATA_NMAKE
]:
542 EdkLogger
.error('Parser', FORMAT_INVALID
,
543 "Section [%s] is not allowed in inf file with version 0x%08x" % (self
._SectionName
, self
._Version
),
544 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
546 # merge two lines specified by '\' in section NMAKE
547 elif self
._SectionType
== MODEL_META_DATA_NMAKE
:
550 self
._CurrentLine
= NmakeLine
+ Line
[0:-1]
553 if NextLine
[0] == TAB_SECTION_START
and NextLine
[-1] == TAB_SECTION_END
:
554 self
._CurrentLine
= NmakeLine
+ Line
[0:-1]
557 NmakeLine
= NmakeLine
+ ' ' + Line
[0:-1]
560 self
._CurrentLine
= NmakeLine
+ Line
564 self
._ValueList
= ['', '', '']
565 # parse current line, result will be put in self._ValueList
566 self
._SectionParser
[self
._SectionType
](self
)
567 if self
._ValueList
== None or self
._ItemType
== MODEL_META_DATA_DEFINE
:
571 # Model, Value1, Value2, Value3, Arch, Platform, BelongsToItem=-1,
572 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
574 for Arch
, Platform
in self
._Scope
:
575 self
._Store
(self
._SectionType
,
588 if IsFindBlockComment
:
589 EdkLogger
.error("Parser", FORMAT_INVALID
, "Open block comments (starting with /*) are expected to end with */",
593 ## Data parser for the format in which there's path
595 # Only path can have macro used. So we need to replace them before use.
597 def _IncludeParser(self
):
598 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
599 self
._ValueList
[0:len(TokenList
)] = TokenList
600 Macros
= self
._Macros
602 for Index
in range(0, len(self
._ValueList
)):
603 Value
= self
._ValueList
[Index
]
607 if Value
.upper().find('$(EFI_SOURCE)\Edk'.upper()) > -1 or Value
.upper().find('$(EFI_SOURCE)/Edk'.upper()) > -1:
608 Value
= '$(EDK_SOURCE)' + Value
[17:]
609 if Value
.find('$(EFI_SOURCE)') > -1 or Value
.find('$(EDK_SOURCE)') > -1:
611 elif Value
.startswith('.'):
613 elif Value
.startswith('$('):
616 Value
= '$(EFI_SOURCE)/' + Value
618 self
._ValueList
[Index
] = ReplaceMacro(Value
, Macros
)
620 ## Parse [Sources] section
622 # Only path can have macro used. So we need to replace them before use.
625 def _SourceFileParser(self
):
626 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
627 self
._ValueList
[0:len(TokenList
)] = TokenList
628 Macros
= self
._Macros
629 # For Acpi tables, remove macro like ' TABLE_NAME=Sata1'
630 if 'COMPONENT_TYPE' in Macros
:
631 if self
._Defines
['COMPONENT_TYPE'].upper() == 'ACPITABLE':
632 self
._ValueList
[0] = GetSplitValueList(self
._ValueList
[0], ' ', 1)[0]
633 if self
._Defines
['BASE_NAME'] == 'Microcode':
635 self
._ValueList
= [ReplaceMacro(Value
, Macros
) for Value
in self
._ValueList
]
637 ## Parse [Binaries] section
639 # Only path can have macro used. So we need to replace them before use.
642 def _BinaryFileParser(self
):
643 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
, 2)
644 if len(TokenList
) < 2:
645 EdkLogger
.error('Parser', FORMAT_INVALID
, "No file type or path specified",
646 ExtraData
=self
._CurrentLine
+ " (<FileType> | <FilePath> [| <Target>])",
647 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
649 EdkLogger
.error('Parser', FORMAT_INVALID
, "No file type specified",
650 ExtraData
=self
._CurrentLine
+ " (<FileType> | <FilePath> [| <Target>])",
651 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
653 EdkLogger
.error('Parser', FORMAT_INVALID
, "No file path specified",
654 ExtraData
=self
._CurrentLine
+ " (<FileType> | <FilePath> [| <Target>])",
655 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
656 self
._ValueList
[0:len(TokenList
)] = TokenList
657 self
._ValueList
[1] = ReplaceMacro(self
._ValueList
[1], self
._Macros
)
659 ## [nmake] section parser (Edk.x style only)
660 def _NmakeParser(self
):
661 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
662 self
._ValueList
[0:len(TokenList
)] = TokenList
664 self
._ValueList
[1] = ReplaceMacro(self
._ValueList
[1], self
._Macros
)
665 # remove self-reference in macro setting
666 #self._ValueList[1] = ReplaceMacro(self._ValueList[1], {self._ValueList[0]:''})
668 ## [FixedPcd], [FeaturePcd], [PatchPcd], [Pcd] and [PcdEx] sections parser
670 def _PcdParser(self
):
671 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
, 1)
672 ValueList
= GetSplitValueList(TokenList
[0], TAB_SPLIT
)
673 if len(ValueList
) != 2:
674 EdkLogger
.error('Parser', FORMAT_INVALID
, "Illegal token space GUID and PCD name format",
675 ExtraData
=self
._CurrentLine
+ " (<TokenSpaceGuidCName>.<PcdCName>)",
676 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
677 self
._ValueList
[0:1] = ValueList
678 if len(TokenList
) > 1:
679 self
._ValueList
[2] = TokenList
[1]
680 if self
._ValueList
[0] == '' or self
._ValueList
[1] == '':
681 EdkLogger
.error('Parser', FORMAT_INVALID
, "No token space GUID or PCD name specified",
682 ExtraData
=self
._CurrentLine
+ " (<TokenSpaceGuidCName>.<PcdCName>)",
683 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
685 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.
686 if self
._ValueList
[2] != '':
687 InfPcdValueList
= GetSplitValueList(TokenList
[1], TAB_VALUE_SPLIT
, 1)
688 if InfPcdValueList
[0] in ['True', 'true', 'TRUE']:
689 self
._ValueList
[2] = TokenList
[1].replace(InfPcdValueList
[0], '1', 1);
690 elif InfPcdValueList
[0] in ['False', 'false', 'FALSE']:
691 self
._ValueList
[2] = TokenList
[1].replace(InfPcdValueList
[0], '0', 1);
692 if (self
._ValueList
[0], self
._ValueList
[1]) not in self
.PcdsDict
:
693 self
.PcdsDict
[self
._ValueList
[0], self
._ValueList
[1]] = self
._SectionType
694 elif self
.PcdsDict
[self
._ValueList
[0], self
._ValueList
[1]] != self
._SectionType
:
695 EdkLogger
.error('Parser', FORMAT_INVALID
, "It is not permissible to list a specified PCD in different PCD type sections.",
696 ExtraData
=self
._CurrentLine
+ " (<TokenSpaceGuidCName>.<PcdCName>)",
697 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
699 ## [depex] section parser
701 def _DepexParser(self
):
702 self
._ValueList
[0:1] = [self
._CurrentLine
]
705 MODEL_UNKNOWN
: MetaFileParser
._Skip
,
706 MODEL_META_DATA_HEADER
: MetaFileParser
._DefineParser
,
707 MODEL_META_DATA_BUILD_OPTION
: MetaFileParser
._BuildOptionParser
,
708 MODEL_EFI_INCLUDE
: _IncludeParser
, # for Edk.x modules
709 MODEL_EFI_LIBRARY_INSTANCE
: MetaFileParser
._CommonParser
, # for Edk.x modules
710 MODEL_EFI_LIBRARY_CLASS
: MetaFileParser
._PathParser
,
711 MODEL_META_DATA_PACKAGE
: MetaFileParser
._PathParser
,
712 MODEL_META_DATA_NMAKE
: _NmakeParser
, # for Edk.x modules
713 MODEL_PCD_FIXED_AT_BUILD
: _PcdParser
,
714 MODEL_PCD_PATCHABLE_IN_MODULE
: _PcdParser
,
715 MODEL_PCD_FEATURE_FLAG
: _PcdParser
,
716 MODEL_PCD_DYNAMIC_EX
: _PcdParser
,
717 MODEL_PCD_DYNAMIC
: _PcdParser
,
718 MODEL_EFI_SOURCE_FILE
: _SourceFileParser
,
719 MODEL_EFI_GUID
: MetaFileParser
._CommonParser
,
720 MODEL_EFI_PROTOCOL
: MetaFileParser
._CommonParser
,
721 MODEL_EFI_PPI
: MetaFileParser
._CommonParser
,
722 MODEL_EFI_DEPEX
: _DepexParser
,
723 MODEL_EFI_BINARY_FILE
: _BinaryFileParser
,
724 MODEL_META_DATA_USER_EXTENSION
: MetaFileParser
._Skip
,
727 ## DSC file parser class
729 # @param FilePath The path of platform description file
730 # @param FileType The raw data of DSC file
731 # @param Table Database used to retrieve module/package information
732 # @param Macros Macros used for replacement in file
733 # @param Owner Owner ID (for sub-section parsing)
734 # @param From ID from which the data comes (for !INCLUDE directive)
736 class DscParser(MetaFileParser
):
737 # DSC file supported data types (one type per section)
739 TAB_SKUIDS
.upper() : MODEL_EFI_SKU_ID
,
740 TAB_LIBRARIES
.upper() : MODEL_EFI_LIBRARY_INSTANCE
,
741 TAB_LIBRARY_CLASSES
.upper() : MODEL_EFI_LIBRARY_CLASS
,
742 TAB_BUILD_OPTIONS
.upper() : MODEL_META_DATA_BUILD_OPTION
,
743 TAB_PCDS_FIXED_AT_BUILD_NULL
.upper() : MODEL_PCD_FIXED_AT_BUILD
,
744 TAB_PCDS_PATCHABLE_IN_MODULE_NULL
.upper() : MODEL_PCD_PATCHABLE_IN_MODULE
,
745 TAB_PCDS_FEATURE_FLAG_NULL
.upper() : MODEL_PCD_FEATURE_FLAG
,
746 TAB_PCDS_DYNAMIC_DEFAULT_NULL
.upper() : MODEL_PCD_DYNAMIC_DEFAULT
,
747 TAB_PCDS_DYNAMIC_HII_NULL
.upper() : MODEL_PCD_DYNAMIC_HII
,
748 TAB_PCDS_DYNAMIC_VPD_NULL
.upper() : MODEL_PCD_DYNAMIC_VPD
,
749 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL
.upper() : MODEL_PCD_DYNAMIC_EX_DEFAULT
,
750 TAB_PCDS_DYNAMIC_EX_HII_NULL
.upper() : MODEL_PCD_DYNAMIC_EX_HII
,
751 TAB_PCDS_DYNAMIC_EX_VPD_NULL
.upper() : MODEL_PCD_DYNAMIC_EX_VPD
,
752 TAB_COMPONENTS
.upper() : MODEL_META_DATA_COMPONENT
,
753 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH
.upper() : MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH
,
754 TAB_DSC_DEFINES
.upper() : MODEL_META_DATA_HEADER
,
755 TAB_DSC_DEFINES_DEFINE
: MODEL_META_DATA_DEFINE
,
756 TAB_DSC_DEFINES_EDKGLOBAL
: MODEL_META_DATA_GLOBAL_DEFINE
,
757 TAB_INCLUDE
.upper() : MODEL_META_DATA_INCLUDE
,
758 TAB_IF
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
,
759 TAB_IF_DEF
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF
,
760 TAB_IF_N_DEF
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
,
761 TAB_ELSE_IF
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF
,
762 TAB_ELSE
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE
,
763 TAB_END_IF
.upper() : MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF
,
766 # Valid names in define section
773 "SUPPORTED_ARCHITECTURES",
782 "FIX_LOAD_TOP_MEMORY_ADDRESS"
785 SymbolPattern
= ValueExpression
.SymbolPattern
787 ## Constructor of DscParser
789 # Initialize object of DscParser
791 # @param FilePath The path of platform description file
792 # @param FileType The raw data of DSC file
793 # @param Table Database used to retrieve module/package information
794 # @param Macros Macros used for replacement in file
795 # @param Owner Owner ID (for sub-section parsing)
796 # @param From ID from which the data comes (for !INCLUDE directive)
798 def __init__(self
, FilePath
, FileType
, Table
, Owner
= -1, From
= -1):
799 # prevent re-initialization
800 if hasattr(self
, "_Table"):
802 MetaFileParser
.__init
__(self
, FilePath
, FileType
, Table
, Owner
, From
)
803 self
._Version
= 0x00010005 # Only EDK2 dsc file is supported
804 # to store conditional directive evaluation result
805 self
._DirectiveStack
= []
806 self
._DirectiveEvalStack
= []
810 # Specify whether current line is in uncertain condition
812 self
._InDirective
= -1
814 # Final valid replacable symbols
817 # Map the ID between the original table and new table to track
820 self
._IdMapping
= {-1:-1}
826 Content
= open(str(self
.MetaFile
), 'r').readlines()
828 EdkLogger
.error("Parser", FILE_READ_FAILURE
, ExtraData
=self
.MetaFile
)
831 for Index
in range(0, len(Content
)):
832 Line
= CleanString(Content
[Index
])
837 self
._CurrentLine
= Line
838 self
._LineIndex
= Index
839 if self
._InSubsection
and self
._Owner
[-1] == -1:
840 self
._Owner
.append(self
._LastItem
)
843 if Line
[0] == TAB_SECTION_START
and Line
[-1] == TAB_SECTION_END
:
844 self
._SectionType
= MODEL_META_DATA_SECTION_HEADER
846 elif Line
[0] == '}' and self
._InSubsection
:
847 self
._InSubsection
= False
848 self
._SubsectionType
= MODEL_UNKNOWN
849 self
._SubsectionName
= ''
854 elif Line
[0] == TAB_OPTION_START
and Line
[-1] == TAB_OPTION_END
:
855 self
._SubsectionType
= MODEL_META_DATA_SUBSECTION_HEADER
858 self
._DirectiveParser
()
861 if self
._InSubsection
:
862 SectionType
= self
._SubsectionType
864 SectionType
= self
._SectionType
865 self
._ItemType
= SectionType
867 self
._ValueList
= ['', '', '']
868 self
._SectionParser
[SectionType
](self
)
869 if self
._ValueList
== None:
872 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,
873 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
875 for Arch
, ModuleType
in self
._Scope
:
876 Owner
= self
._Owner
[-1]
877 if self
._SubsectionType
!= MODEL_UNKNOWN
:
878 Owner
= OwnerId
[Arch
]
879 self
._LastItem
= self
._Store
(
894 if self
._SubsectionType
== MODEL_UNKNOWN
and self
._InSubsection
:
895 OwnerId
[Arch
] = self
._LastItem
897 if self
._DirectiveStack
:
898 Type
, Line
, Text
= self
._DirectiveStack
[-1]
899 EdkLogger
.error('Parser', FORMAT_INVALID
, "No matching '!endif' found",
900 ExtraData
=Text
, File
=self
.MetaFile
, Line
=Line
)
903 ## <subsection_header> parser
904 def _SubsectionHeaderParser(self
):
905 self
._SubsectionName
= self
._CurrentLine
[1:-1].upper()
906 if self
._SubsectionName
in self
.DataType
:
907 self
._SubsectionType
= self
.DataType
[self
._SubsectionName
]
909 self
._SubsectionType
= MODEL_UNKNOWN
910 EdkLogger
.warn("Parser", "Unrecognized sub-section", File
=self
.MetaFile
,
911 Line
=self
._LineIndex
+ 1, ExtraData
=self
._CurrentLine
)
912 self
._ValueList
[0] = self
._SubsectionName
914 ## Directive statement parser
915 def _DirectiveParser(self
):
916 self
._ValueList
= ['', '', '']
917 TokenList
= GetSplitValueList(self
._CurrentLine
, ' ', 1)
918 self
._ValueList
[0:len(TokenList
)] = TokenList
921 DirectiveName
= self
._ValueList
[0].upper()
922 if DirectiveName
not in self
.DataType
:
923 EdkLogger
.error("Parser", FORMAT_INVALID
, "Unknown directive [%s]" % DirectiveName
,
924 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
926 if DirectiveName
in ['!IF', '!IFDEF', '!IFNDEF']:
927 self
._InDirective
+= 1
929 if DirectiveName
in ['!ENDIF']:
930 self
._InDirective
-= 1
932 if DirectiveName
in ['!IF', '!IFDEF', '!INCLUDE', '!IFNDEF', '!ELSEIF'] and self
._ValueList
[1] == '':
933 EdkLogger
.error("Parser", FORMAT_INVALID
, "Missing expression",
934 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1,
935 ExtraData
=self
._CurrentLine
)
937 ItemType
= self
.DataType
[DirectiveName
]
938 Scope
= [['COMMON', 'COMMON']]
939 if ItemType
== MODEL_META_DATA_INCLUDE
:
941 if ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF
:
942 # Remove all directives between !if and !endif, including themselves
943 while self
._DirectiveStack
:
944 # Remove any !else or !elseif
945 DirectiveInfo
= self
._DirectiveStack
.pop()
946 if DirectiveInfo
[0] in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
,
947 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF
,
948 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
]:
951 EdkLogger
.error("Parser", FORMAT_INVALID
, "Redundant '!endif'",
952 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1,
953 ExtraData
=self
._CurrentLine
)
954 elif ItemType
!= MODEL_META_DATA_INCLUDE
:
955 # Break if there's a !else is followed by a !elseif
956 if ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF
and \
957 self
._DirectiveStack
and \
958 self
._DirectiveStack
[-1][0] == MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE
:
959 EdkLogger
.error("Parser", FORMAT_INVALID
, "'!elseif' after '!else'",
960 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1,
961 ExtraData
=self
._CurrentLine
)
962 self
._DirectiveStack
.append((ItemType
, self
._LineIndex
+ 1, self
._CurrentLine
))
964 EdkLogger
.error('Parser', FORMAT_INVALID
,
965 "No '!include' allowed in included file",
966 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
,
967 Line
=self
._LineIndex
+ 1)
970 # Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1, BelongsToFile=-1,
971 # LineBegin=-1, ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, Enabled=-1
973 for Arch
, ModuleType
in Scope
:
974 self
._LastItem
= self
._Store
(
990 ## [defines] section parser
992 def _DefineParser(self
):
993 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
994 self
._ValueList
[1:len(TokenList
)] = TokenList
997 if not self
._ValueList
[1]:
998 EdkLogger
.error('Parser', FORMAT_INVALID
, "No name specified",
999 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1000 if not self
._ValueList
[2]:
1001 EdkLogger
.error('Parser', FORMAT_INVALID
, "No value specified",
1002 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1003 if not self
._ValueList
[1] in self
.DefineKeywords
:
1004 EdkLogger
.error('Parser', FORMAT_INVALID
,
1005 "Unknown keyword found: %s. "
1006 "If this is a macro you must "
1007 "add it as a DEFINE in the DSC" % self
._ValueList
[1],
1008 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1009 self
._Defines
[self
._ValueList
[1]] = self
._ValueList
[2]
1010 self
._ItemType
= self
.DataType
[TAB_DSC_DEFINES
.upper()]
1013 def _SkuIdParser(self
):
1014 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
1015 if len(TokenList
) != 2:
1016 EdkLogger
.error('Parser', FORMAT_INVALID
, "Correct format is '<Integer>|<UiName>'",
1017 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1018 self
._ValueList
[0:len(TokenList
)] = TokenList
1020 ## Parse Edk style of library modules
1022 def _LibraryInstanceParser(self
):
1023 self
._ValueList
[0] = self
._CurrentLine
1025 ## PCD sections parser
1027 # [PcdsFixedAtBuild]
1028 # [PcdsPatchableInModule]
1031 # [PcdsDynamicExDefault]
1032 # [PcdsDynamicExVpd]
1033 # [PcdsDynamicExHii]
1035 # [PcdsDynamicDefault]
1040 def _PcdParser(self
):
1041 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
, 1)
1042 self
._ValueList
[0:1] = GetSplitValueList(TokenList
[0], TAB_SPLIT
)
1043 if len(TokenList
) == 2:
1044 self
._ValueList
[2] = TokenList
[1]
1045 if self
._ValueList
[0] == '' or self
._ValueList
[1] == '':
1046 EdkLogger
.error('Parser', FORMAT_INVALID
, "No token space GUID or PCD name specified",
1047 ExtraData
=self
._CurrentLine
+ " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",
1048 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1049 if self
._ValueList
[2] == '':
1051 # The PCD values are optional for FIXEDATBUILD and PATCHABLEINMODULE
1053 if self
._SectionType
in (MODEL_PCD_FIXED_AT_BUILD
, MODEL_PCD_PATCHABLE_IN_MODULE
):
1055 EdkLogger
.error('Parser', FORMAT_INVALID
, "No PCD value given",
1056 ExtraData
=self
._CurrentLine
+ " (<TokenSpaceGuidCName>.<TokenCName>|<PcdValue>)",
1057 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1059 # Validate the datum type of Dynamic Defaul PCD and DynamicEx Default PCD
1060 ValueList
= GetSplitValueList(self
._ValueList
[2])
1061 if len(ValueList
) > 1 and ValueList
[1] != TAB_VOID \
1062 and self
._ItemType
in [MODEL_PCD_DYNAMIC_DEFAULT
, MODEL_PCD_DYNAMIC_EX_DEFAULT
]:
1063 EdkLogger
.error('Parser', FORMAT_INVALID
, "The datum type '%s' of PCD is wrong" % ValueList
[1],
1064 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1066 # if value are 'True', 'true', 'TRUE' or 'False', 'false', 'FALSE', replace with integer 1 or 0.
1067 DscPcdValueList
= GetSplitValueList(TokenList
[1], TAB_VALUE_SPLIT
, 1)
1068 if DscPcdValueList
[0] in ['True', 'true', 'TRUE']:
1069 self
._ValueList
[2] = TokenList
[1].replace(DscPcdValueList
[0], '1', 1);
1070 elif DscPcdValueList
[0] in ['False', 'false', 'FALSE']:
1071 self
._ValueList
[2] = TokenList
[1].replace(DscPcdValueList
[0], '0', 1);
1074 ## [components] section parser
1076 def _ComponentParser(self
):
1077 if self
._CurrentLine
[-1] == '{':
1078 self
._ValueList
[0] = self
._CurrentLine
[0:-1].strip()
1079 self
._InSubsection
= True
1081 self
._ValueList
[0] = self
._CurrentLine
1083 ## [LibraryClasses] section
1085 def _LibraryClassParser(self
):
1086 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
)
1087 if len(TokenList
) < 2:
1088 EdkLogger
.error('Parser', FORMAT_INVALID
, "No library class or instance specified",
1089 ExtraData
=self
._CurrentLine
+ " (<LibraryClassName>|<LibraryInstancePath>)",
1090 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1091 if TokenList
[0] == '':
1092 EdkLogger
.error('Parser', FORMAT_INVALID
, "No library class specified",
1093 ExtraData
=self
._CurrentLine
+ " (<LibraryClassName>|<LibraryInstancePath>)",
1094 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1095 if TokenList
[1] == '':
1096 EdkLogger
.error('Parser', FORMAT_INVALID
, "No library instance specified",
1097 ExtraData
=self
._CurrentLine
+ " (<LibraryClassName>|<LibraryInstancePath>)",
1098 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1100 self
._ValueList
[0:len(TokenList
)] = TokenList
1102 def _CompponentSourceOverridePathParser(self
):
1103 self
._ValueList
[0] = self
._CurrentLine
1105 ## [BuildOptions] section parser
1107 def _BuildOptionParser(self
):
1108 self
._CurrentLine
= CleanString(self
._CurrentLine
, BuildOption
=True)
1109 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
1110 TokenList2
= GetSplitValueList(TokenList
[0], ':', 1)
1111 if len(TokenList2
) == 2:
1112 self
._ValueList
[0] = TokenList2
[0] # toolchain family
1113 self
._ValueList
[1] = TokenList2
[1] # keys
1115 self
._ValueList
[1] = TokenList
[0]
1116 if len(TokenList
) == 2: # value
1117 self
._ValueList
[2] = TokenList
[1]
1119 if self
._ValueList
[1].count('_') != 4:
1123 "'%s' must be in format of <TARGET>_<TOOLCHAIN>_<ARCH>_<TOOL>_FLAGS" % self
._ValueList
[1],
1124 ExtraData
=self
._CurrentLine
,
1126 Line
=self
._LineIndex
+ 1
1129 ## Override parent's method since we'll do all macro replacements in parser
1130 def _GetMacros(self
):
1132 Macros
.update(self
._FileLocalMacros
)
1133 Macros
.update(self
._GetApplicableSectionMacro
())
1134 Macros
.update(GlobalData
.gEdkGlobal
)
1135 Macros
.update(GlobalData
.gPlatformDefines
)
1136 Macros
.update(GlobalData
.gCommandLineDefines
)
1137 # PCD cannot be referenced in macro definition
1138 if self
._ItemType
not in [MODEL_META_DATA_DEFINE
, MODEL_META_DATA_GLOBAL_DEFINE
]:
1139 Macros
.update(self
._Symbols
)
1142 def _PostProcess(self
):
1144 MODEL_META_DATA_SECTION_HEADER
: self
.__ProcessSectionHeader
,
1145 MODEL_META_DATA_SUBSECTION_HEADER
: self
.__ProcessSubsectionHeader
,
1146 MODEL_META_DATA_HEADER
: self
.__ProcessDefine
,
1147 MODEL_META_DATA_DEFINE
: self
.__ProcessDefine
,
1148 MODEL_META_DATA_GLOBAL_DEFINE
: self
.__ProcessDefine
,
1149 MODEL_META_DATA_INCLUDE
: self
.__ProcessDirective
,
1150 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
: self
.__ProcessDirective
,
1151 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE
: self
.__ProcessDirective
,
1152 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF
: self
.__ProcessDirective
,
1153 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
: self
.__ProcessDirective
,
1154 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF
: self
.__ProcessDirective
,
1155 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF
: self
.__ProcessDirective
,
1156 MODEL_EFI_SKU_ID
: self
.__ProcessSkuId
,
1157 MODEL_EFI_LIBRARY_INSTANCE
: self
.__ProcessLibraryInstance
,
1158 MODEL_EFI_LIBRARY_CLASS
: self
.__ProcessLibraryClass
,
1159 MODEL_PCD_FIXED_AT_BUILD
: self
.__ProcessPcd
,
1160 MODEL_PCD_PATCHABLE_IN_MODULE
: self
.__ProcessPcd
,
1161 MODEL_PCD_FEATURE_FLAG
: self
.__ProcessPcd
,
1162 MODEL_PCD_DYNAMIC_DEFAULT
: self
.__ProcessPcd
,
1163 MODEL_PCD_DYNAMIC_HII
: self
.__ProcessPcd
,
1164 MODEL_PCD_DYNAMIC_VPD
: self
.__ProcessPcd
,
1165 MODEL_PCD_DYNAMIC_EX_DEFAULT
: self
.__ProcessPcd
,
1166 MODEL_PCD_DYNAMIC_EX_HII
: self
.__ProcessPcd
,
1167 MODEL_PCD_DYNAMIC_EX_VPD
: self
.__ProcessPcd
,
1168 MODEL_META_DATA_COMPONENT
: self
.__ProcessComponent
,
1169 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH
: self
.__ProcessSourceOverridePath
,
1170 MODEL_META_DATA_BUILD_OPTION
: self
.__ProcessBuildOption
,
1171 MODEL_UNKNOWN
: self
._Skip
,
1172 MODEL_META_DATA_USER_EXTENSION
: self
._Skip
,
1175 self
._Table
= MetaFileStorage(self
._RawTable
.Cur
, self
.MetaFile
, MODEL_FILE_DSC
, True)
1176 self
._Table
.Create()
1177 self
._DirectiveStack
= []
1178 self
._DirectiveEvalStack
= []
1179 self
._FileWithError
= self
.MetaFile
1180 self
._FileLocalMacros
= {}
1181 self
._SectionsMacroDict
= {}
1182 GlobalData
.gPlatformDefines
= {}
1184 # Get all macro and PCD which has straitforward value
1185 self
.__RetrievePcdValue
()
1186 self
._Content
= self
._RawTable
.GetAll()
1187 self
._ContentIndex
= 0
1188 while self
._ContentIndex
< len(self
._Content
) :
1189 Id
, self
._ItemType
, V1
, V2
, V3
, S1
, S2
, Owner
, self
._From
, \
1190 LineStart
, ColStart
, LineEnd
, ColEnd
, Enabled
= self
._Content
[self
._ContentIndex
]
1193 self
._FileWithError
= self
.MetaFile
1195 self
._ContentIndex
+= 1
1197 self
._Scope
= [[S1
, S2
]]
1199 # For !include directive, handle it specially,
1200 # merge arch and module type in case of duplicate items
1202 while self
._ItemType
== MODEL_META_DATA_INCLUDE
:
1203 if self
._ContentIndex
>= len(self
._Content
):
1205 Record
= self
._Content
[self
._ContentIndex
]
1206 if LineStart
== Record
[9] and LineEnd
== Record
[11]:
1207 if [Record
[5], Record
[6]] not in self
._Scope
:
1208 self
._Scope
.append([Record
[5], Record
[6]])
1209 self
._ContentIndex
+= 1
1213 self
._LineIndex
= LineStart
- 1
1214 self
._ValueList
= [V1
, V2
, V3
]
1217 Processer
[self
._ItemType
]()
1218 except EvaluationException
, Excpt
:
1220 # Only catch expression evaluation error here. We need to report
1221 # the precise number of line on which the error occurred
1223 if hasattr(Excpt
, 'Pcd'):
1224 if Excpt
.Pcd
in GlobalData
.gPlatformOtherPcds
:
1225 Info
= GlobalData
.gPlatformOtherPcds
[Excpt
.Pcd
]
1226 EdkLogger
.error('Parser', FORMAT_INVALID
, "Cannot use this PCD (%s) in an expression as"
1227 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"
1228 " of the DSC file, and it is currently defined in this section:"
1229 " %s, line #: %d." % (Excpt
.Pcd
, Info
[0], Info
[1]),
1230 File
=self
._FileWithError
, ExtraData
=' '.join(self
._ValueList
),
1231 Line
=self
._LineIndex
+ 1)
1233 EdkLogger
.error('Parser', FORMAT_INVALID
, "PCD (%s) is not defined in DSC file" % Excpt
.Pcd
,
1234 File
=self
._FileWithError
, ExtraData
=' '.join(self
._ValueList
),
1235 Line
=self
._LineIndex
+ 1)
1237 EdkLogger
.error('Parser', FORMAT_INVALID
, "Invalid expression: %s" % str(Excpt
),
1238 File
=self
._FileWithError
, ExtraData
=' '.join(self
._ValueList
),
1239 Line
=self
._LineIndex
+ 1)
1240 except MacroException
, Excpt
:
1241 EdkLogger
.error('Parser', FORMAT_INVALID
, str(Excpt
),
1242 File
=self
._FileWithError
, ExtraData
=' '.join(self
._ValueList
),
1243 Line
=self
._LineIndex
+ 1)
1245 if self
._ValueList
== None:
1248 NewOwner
= self
._IdMapping
.get(Owner
, -1)
1249 self
._Enabled
= int((not self
._DirectiveEvalStack
) or (False not in self
._DirectiveEvalStack
))
1250 self
._LastItem
= self
._Store
(
1259 self
._LineIndex
+ 1,
1261 self
._LineIndex
+ 1,
1265 self
._IdMapping
[Id
] = self
._LastItem
1267 GlobalData
.gPlatformDefines
.update(self
._FileLocalMacros
)
1268 self
._PostProcessed
= True
1269 self
._Content
= None
1271 def __ProcessSectionHeader(self
):
1272 self
._SectionName
= self
._ValueList
[0]
1273 if self
._SectionName
in self
.DataType
:
1274 self
._SectionType
= self
.DataType
[self
._SectionName
]
1276 self
._SectionType
= MODEL_UNKNOWN
1278 def __ProcessSubsectionHeader(self
):
1279 self
._SubsectionName
= self
._ValueList
[0]
1280 if self
._SubsectionName
in self
.DataType
:
1281 self
._SubsectionType
= self
.DataType
[self
._SubsectionName
]
1283 self
._SubsectionType
= MODEL_UNKNOWN
1285 def __RetrievePcdValue(self
):
1286 Records
= self
._RawTable
.Query(MODEL_PCD_FEATURE_FLAG
, BelongsToItem
= -1.0)
1287 for TokenSpaceGuid
, PcdName
, Value
, Dummy2
, Dummy3
, ID
, Line
in Records
:
1288 Name
= TokenSpaceGuid
+ '.' + PcdName
1289 ValList
, Valid
, Index
= AnalyzeDscPcd(Value
, MODEL_PCD_FEATURE_FLAG
)
1290 self
._Symbols
[Name
] = ValList
[Index
]
1292 Records
= self
._RawTable
.Query(MODEL_PCD_FIXED_AT_BUILD
, BelongsToItem
= -1.0)
1293 for TokenSpaceGuid
, PcdName
, Value
, Dummy2
, Dummy3
, ID
, Line
in Records
:
1294 Name
= TokenSpaceGuid
+ '.' + PcdName
1295 ValList
, Valid
, Index
= AnalyzeDscPcd(Value
, MODEL_PCD_FIXED_AT_BUILD
)
1296 self
._Symbols
[Name
] = ValList
[Index
]
1298 Content
= open(str(self
.MetaFile
), 'r').readlines()
1299 GlobalData
.gPlatformOtherPcds
['DSCFILE'] = str(self
.MetaFile
)
1300 for PcdType
in (MODEL_PCD_PATCHABLE_IN_MODULE
, MODEL_PCD_DYNAMIC_DEFAULT
, MODEL_PCD_DYNAMIC_HII
,
1301 MODEL_PCD_DYNAMIC_VPD
, MODEL_PCD_DYNAMIC_EX_DEFAULT
, MODEL_PCD_DYNAMIC_EX_HII
,
1302 MODEL_PCD_DYNAMIC_EX_VPD
):
1303 Records
= self
._RawTable
.Query(PcdType
, BelongsToItem
= -1.0)
1304 for TokenSpaceGuid
, PcdName
, Value
, Dummy2
, Dummy3
, ID
, Line
in Records
:
1305 Name
= TokenSpaceGuid
+ '.' + PcdName
1306 if Name
not in GlobalData
.gPlatformOtherPcds
:
1308 while not Content
[Line
- 1].lstrip().startswith(TAB_SECTION_START
):
1310 GlobalData
.gPlatformOtherPcds
[Name
] = (CleanString(Content
[Line
- 1]), PcdLine
, PcdType
)
1312 def __ProcessDefine(self
):
1313 if not self
._Enabled
:
1316 Type
, Name
, Value
= self
._ValueList
1317 Value
= ReplaceMacro(Value
, self
._Macros
, False)
1318 if self
._ItemType
== MODEL_META_DATA_DEFINE
:
1319 if self
._SectionType
== MODEL_META_DATA_HEADER
:
1320 self
._FileLocalMacros
[Name
] = Value
1322 self
._ConstructSectionMacroDict
(Name
, Value
)
1323 elif self
._ItemType
== MODEL_META_DATA_GLOBAL_DEFINE
:
1324 GlobalData
.gEdkGlobal
[Name
] = Value
1327 # Keyword in [Defines] section can be used as Macros
1329 if (self
._ItemType
== MODEL_META_DATA_HEADER
) and (self
._SectionType
== MODEL_META_DATA_HEADER
):
1330 self
._FileLocalMacros
[Name
] = Value
1332 self
._ValueList
= [Type
, Name
, Value
]
1334 def __ProcessDirective(self
):
1336 if self
._ItemType
in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
,
1337 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF
]:
1338 Macros
= self
._Macros
1339 Macros
.update(GlobalData
.gGlobalDefines
)
1341 Result
= ValueExpression(self
._ValueList
[1], Macros
)()
1342 except SymbolNotFound
, Exc
:
1343 EdkLogger
.debug(EdkLogger
.DEBUG_5
, str(Exc
), self
._ValueList
[1])
1345 except WrnExpression
, Excpt
:
1347 # Catch expression evaluation warning here. We need to report
1348 # the precise number of line and return the evaluation result
1350 EdkLogger
.warn('Parser', "Suspicious expression: %s" % str(Excpt
),
1351 File
=self
._FileWithError
, ExtraData
=' '.join(self
._ValueList
),
1352 Line
=self
._LineIndex
+ 1)
1353 Result
= Excpt
.result
1355 if self
._ItemType
in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
,
1356 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF
,
1357 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
]:
1358 self
._DirectiveStack
.append(self
._ItemType
)
1359 if self
._ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
:
1360 Result
= bool(Result
)
1362 Macro
= self
._ValueList
[1]
1363 Macro
= Macro
[2:-1] if (Macro
.startswith("$(") and Macro
.endswith(")")) else Macro
1364 Result
= Macro
in self
._Macros
1365 if self
._ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
:
1367 self
._DirectiveEvalStack
.append(Result
)
1368 elif self
._ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF
:
1369 self
._DirectiveStack
.append(self
._ItemType
)
1370 self
._DirectiveEvalStack
[-1] = not self
._DirectiveEvalStack
[-1]
1371 self
._DirectiveEvalStack
.append(bool(Result
))
1372 elif self
._ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE
:
1373 self
._DirectiveStack
.append(self
._ItemType
)
1374 self
._DirectiveEvalStack
[-1] = not self
._DirectiveEvalStack
[-1]
1375 self
._DirectiveEvalStack
.append(True)
1376 elif self
._ItemType
== MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF
:
1377 # Back to the nearest !if/!ifdef/!ifndef
1378 while self
._DirectiveStack
:
1379 self
._DirectiveEvalStack
.pop()
1380 Directive
= self
._DirectiveStack
.pop()
1381 if Directive
in [MODEL_META_DATA_CONDITIONAL_STATEMENT_IF
,
1382 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF
,
1383 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF
]:
1385 elif self
._ItemType
== MODEL_META_DATA_INCLUDE
:
1386 # The included file must be relative to workspace or same directory as DSC file
1387 __IncludeMacros
= {}
1389 # Allow using system environment variables in path after !include
1391 __IncludeMacros
['WORKSPACE'] = GlobalData
.gGlobalDefines
['WORKSPACE']
1392 if "ECP_SOURCE" in GlobalData
.gGlobalDefines
.keys():
1393 __IncludeMacros
['ECP_SOURCE'] = GlobalData
.gGlobalDefines
['ECP_SOURCE']
1395 # During GenFds phase call DSC parser, will go into this branch.
1397 elif "ECP_SOURCE" in GlobalData
.gCommandLineDefines
.keys():
1398 __IncludeMacros
['ECP_SOURCE'] = GlobalData
.gCommandLineDefines
['ECP_SOURCE']
1400 __IncludeMacros
['EFI_SOURCE'] = GlobalData
.gGlobalDefines
['EFI_SOURCE']
1401 __IncludeMacros
['EDK_SOURCE'] = GlobalData
.gGlobalDefines
['EDK_SOURCE']
1403 # Allow using MACROs comes from [Defines] section to keep compatible.
1405 __IncludeMacros
.update(self
._Macros
)
1407 IncludedFile
= NormPath(ReplaceMacro(self
._ValueList
[1], __IncludeMacros
, RaiseError
=True))
1409 # First search the include file under the same directory as DSC file
1411 IncludedFile1
= PathClass(IncludedFile
, self
.MetaFile
.Dir
)
1412 ErrorCode
, ErrorInfo1
= IncludedFile1
.Validate()
1415 # Also search file under the WORKSPACE directory
1417 IncludedFile1
= PathClass(IncludedFile
, GlobalData
.gWorkspace
)
1418 ErrorCode
, ErrorInfo2
= IncludedFile1
.Validate()
1420 EdkLogger
.error('parser', ErrorCode
, File
=self
._FileWithError
,
1421 Line
=self
._LineIndex
+ 1, ExtraData
=ErrorInfo1
+ "\n" + ErrorInfo2
)
1423 self
._FileWithError
= IncludedFile1
1425 IncludedFileTable
= MetaFileStorage(self
._Table
.Cur
, IncludedFile1
, MODEL_FILE_DSC
, False)
1426 Owner
= self
._Content
[self
._ContentIndex
- 1][0]
1427 Parser
= DscParser(IncludedFile1
, self
._FileType
, IncludedFileTable
,
1428 Owner
=Owner
, From
=Owner
)
1430 # set the parser status with current status
1431 Parser
._SectionName
= self
._SectionName
1432 Parser
._SectionType
= self
._SectionType
1433 Parser
._Scope
= self
._Scope
1434 Parser
._Enabled
= self
._Enabled
1435 # Parse the included file
1438 # update current status with sub-parser's status
1439 self
._SectionName
= Parser
._SectionName
1440 self
._SectionType
= Parser
._SectionType
1441 self
._Scope
= Parser
._Scope
1442 self
._Enabled
= Parser
._Enabled
1444 # Insert all records in the table for the included file into dsc file table
1445 Records
= IncludedFileTable
.GetAll()
1447 self
._Content
[self
._ContentIndex
:self
._ContentIndex
] = Records
1448 self
._Content
.pop(self
._ContentIndex
- 1)
1449 self
._ValueList
= None
1450 self
._ContentIndex
-= 1
1452 def __ProcessSkuId(self
):
1453 self
._ValueList
= [ReplaceMacro(Value
, self
._Macros
, RaiseError
=True)
1454 for Value
in self
._ValueList
]
1456 def __ProcessLibraryInstance(self
):
1457 self
._ValueList
= [ReplaceMacro(Value
, self
._Macros
) for Value
in self
._ValueList
]
1459 def __ProcessLibraryClass(self
):
1460 self
._ValueList
[1] = ReplaceMacro(self
._ValueList
[1], self
._Macros
, RaiseError
=True)
1462 def __ProcessPcd(self
):
1463 if self
._ItemType
not in [MODEL_PCD_FEATURE_FLAG
, MODEL_PCD_FIXED_AT_BUILD
]:
1464 self
._ValueList
[2] = ReplaceMacro(self
._ValueList
[2], self
._Macros
, RaiseError
=True)
1467 ValList
, Valid
, Index
= AnalyzeDscPcd(self
._ValueList
[2], self
._ItemType
)
1469 EdkLogger
.error('build', FORMAT_INVALID
, "Pcd format incorrect.", File
=self
._FileWithError
, Line
=self
._LineIndex
+1,
1470 ExtraData
="%s.%s|%s" % (self
._ValueList
[0], self
._ValueList
[1], self
._ValueList
[2]))
1471 PcdValue
= ValList
[Index
]
1474 ValList
[Index
] = ValueExpression(PcdValue
, self
._Macros
)(True)
1475 except WrnExpression
, Value
:
1476 ValList
[Index
] = Value
.result
1478 if ValList
[Index
] == 'True':
1479 ValList
[Index
] = '1'
1480 if ValList
[Index
] == 'False':
1481 ValList
[Index
] = '0'
1483 GlobalData
.gPlatformPcds
[TAB_SPLIT
.join(self
._ValueList
[0:2])] = PcdValue
1484 self
._ValueList
[2] = '|'.join(ValList
)
1486 def __ProcessComponent(self
):
1487 self
._ValueList
[0] = ReplaceMacro(self
._ValueList
[0], self
._Macros
)
1489 def __ProcessSourceOverridePath(self
):
1490 self
._ValueList
[0] = ReplaceMacro(self
._ValueList
[0], self
._Macros
)
1492 def __ProcessBuildOption(self
):
1493 self
._ValueList
= [ReplaceMacro(Value
, self
._Macros
, RaiseError
=False)
1494 for Value
in self
._ValueList
]
1497 MODEL_META_DATA_HEADER
: _DefineParser
,
1498 MODEL_EFI_SKU_ID
: _SkuIdParser
,
1499 MODEL_EFI_LIBRARY_INSTANCE
: _LibraryInstanceParser
,
1500 MODEL_EFI_LIBRARY_CLASS
: _LibraryClassParser
,
1501 MODEL_PCD_FIXED_AT_BUILD
: _PcdParser
,
1502 MODEL_PCD_PATCHABLE_IN_MODULE
: _PcdParser
,
1503 MODEL_PCD_FEATURE_FLAG
: _PcdParser
,
1504 MODEL_PCD_DYNAMIC_DEFAULT
: _PcdParser
,
1505 MODEL_PCD_DYNAMIC_HII
: _PcdParser
,
1506 MODEL_PCD_DYNAMIC_VPD
: _PcdParser
,
1507 MODEL_PCD_DYNAMIC_EX_DEFAULT
: _PcdParser
,
1508 MODEL_PCD_DYNAMIC_EX_HII
: _PcdParser
,
1509 MODEL_PCD_DYNAMIC_EX_VPD
: _PcdParser
,
1510 MODEL_META_DATA_COMPONENT
: _ComponentParser
,
1511 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH
: _CompponentSourceOverridePathParser
,
1512 MODEL_META_DATA_BUILD_OPTION
: _BuildOptionParser
,
1513 MODEL_UNKNOWN
: MetaFileParser
._Skip
,
1514 MODEL_META_DATA_USER_EXTENSION
: MetaFileParser
._Skip
,
1515 MODEL_META_DATA_SECTION_HEADER
: MetaFileParser
._SectionHeaderParser
,
1516 MODEL_META_DATA_SUBSECTION_HEADER
: _SubsectionHeaderParser
,
1519 _Macros
= property(_GetMacros
)
1521 ## DEC file parser class
1523 # @param FilePath The path of platform description file
1524 # @param FileType The raw data of DSC file
1525 # @param Table Database used to retrieve module/package information
1526 # @param Macros Macros used for replacement in file
1528 class DecParser(MetaFileParser
):
1529 # DEC file supported data types (one type per section)
1531 TAB_DEC_DEFINES
.upper() : MODEL_META_DATA_HEADER
,
1532 TAB_DSC_DEFINES_DEFINE
: MODEL_META_DATA_DEFINE
,
1533 TAB_INCLUDES
.upper() : MODEL_EFI_INCLUDE
,
1534 TAB_LIBRARY_CLASSES
.upper() : MODEL_EFI_LIBRARY_CLASS
,
1535 TAB_GUIDS
.upper() : MODEL_EFI_GUID
,
1536 TAB_PPIS
.upper() : MODEL_EFI_PPI
,
1537 TAB_PROTOCOLS
.upper() : MODEL_EFI_PROTOCOL
,
1538 TAB_PCDS_FIXED_AT_BUILD_NULL
.upper() : MODEL_PCD_FIXED_AT_BUILD
,
1539 TAB_PCDS_PATCHABLE_IN_MODULE_NULL
.upper() : MODEL_PCD_PATCHABLE_IN_MODULE
,
1540 TAB_PCDS_FEATURE_FLAG_NULL
.upper() : MODEL_PCD_FEATURE_FLAG
,
1541 TAB_PCDS_DYNAMIC_NULL
.upper() : MODEL_PCD_DYNAMIC
,
1542 TAB_PCDS_DYNAMIC_EX_NULL
.upper() : MODEL_PCD_DYNAMIC_EX
,
1545 ## Constructor of DecParser
1547 # Initialize object of DecParser
1549 # @param FilePath The path of platform description file
1550 # @param FileType The raw data of DSC file
1551 # @param Table Database used to retrieve module/package information
1552 # @param Macros Macros used for replacement in file
1554 def __init__(self
, FilePath
, FileType
, Table
):
1555 # prevent re-initialization
1556 if hasattr(self
, "_Table"):
1558 MetaFileParser
.__init
__(self
, FilePath
, FileType
, Table
, -1)
1560 self
._Version
= 0x00010005 # Only EDK2 dec file is supported
1561 self
._AllPCDs
= [] # Only for check duplicate PCD
1567 Content
= open(str(self
.MetaFile
), 'r').readlines()
1569 EdkLogger
.error("Parser", FILE_READ_FAILURE
, ExtraData
=self
.MetaFile
)
1571 for Index
in range(0, len(Content
)):
1572 Line
, Comment
= CleanString2(Content
[Index
])
1573 self
._CurrentLine
= Line
1574 self
._LineIndex
= Index
1576 # save comment for later use
1578 self
._Comments
.append((Comment
, self
._LineIndex
+ 1))
1584 if Line
[0] == TAB_SECTION_START
and Line
[-1] == TAB_SECTION_END
:
1585 self
._SectionHeaderParser
()
1588 elif len(self
._SectionType
) == 0:
1593 self
._ValueList
= ['', '', '']
1594 self
._SectionParser
[self
._SectionType
[0]](self
)
1595 if self
._ValueList
== None or self
._ItemType
== MODEL_META_DATA_DEFINE
:
1601 # Model, Value1, Value2, Value3, Arch, BelongsToItem=-1, LineBegin=-1,
1602 # ColumnBegin=-1, LineEnd=-1, ColumnEnd=-1, FeatureFlag='', Enabled=-1
1604 for Arch
, ModuleType
, Type
in self
._Scope
:
1605 self
._LastItem
= self
._Store
(
1613 self
._LineIndex
+ 1,
1615 self
._LineIndex
+ 1,
1619 for Comment
, LineNo
in self
._Comments
:
1621 MODEL_META_DATA_COMMENT
,
1638 ## Section header parser
1640 # The section header is always in following format:
1642 # [section_name.arch<.platform|module_type>]
1644 def _SectionHeaderParser(self
):
1646 self
._SectionName
= ''
1647 self
._SectionType
= []
1649 Line
= self
._CurrentLine
.replace("%s%s" % (TAB_COMMA_SPLIT
, TAB_SPACE_SPLIT
), TAB_COMMA_SPLIT
)
1650 for Item
in Line
[1:-1].split(TAB_COMMA_SPLIT
):
1652 EdkLogger
.error("Parser", FORMAT_UNKNOWN_ERROR
,
1653 "section name can NOT be empty or incorrectly use separator comma",
1654 self
.MetaFile
, self
._LineIndex
+ 1, self
._CurrentLine
)
1655 ItemList
= Item
.split(TAB_SPLIT
)
1657 # different types of PCD are permissible in one section
1658 self
._SectionName
= ItemList
[0].upper()
1659 if self
._SectionName
in self
.DataType
:
1660 if self
.DataType
[self
._SectionName
] not in self
._SectionType
:
1661 self
._SectionType
.append(self
.DataType
[self
._SectionName
])
1663 EdkLogger
.error("Parser", FORMAT_UNKNOWN_ERROR
, "%s is not a valid section name" % Item
,
1664 self
.MetaFile
, self
._LineIndex
+ 1, self
._CurrentLine
)
1666 if MODEL_PCD_FEATURE_FLAG
in self
._SectionType
and len(self
._SectionType
) > 1:
1670 "%s must not be in the same section of other types of PCD" % TAB_PCDS_FEATURE_FLAG_NULL
,
1672 Line
=self
._LineIndex
+ 1,
1673 ExtraData
=self
._CurrentLine
1676 if len(ItemList
) > 1:
1677 S1
= ItemList
[1].upper()
1681 # S2 may be Platform or ModuleType
1682 if len(ItemList
) > 2:
1683 S2
= ItemList
[2].upper()
1686 if [S1
, S2
, self
.DataType
[self
._SectionName
]] not in self
._Scope
:
1687 self
._Scope
.append([S1
, S2
, self
.DataType
[self
._SectionName
]])
1689 # 'COMMON' must not be used with specific ARCHs at the same section
1690 if 'COMMON' in ArchList
and len(ArchList
) > 1:
1691 EdkLogger
.error('Parser', FORMAT_INVALID
, "'common' ARCH must not be used with specific ARCHs",
1692 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1, ExtraData
=self
._CurrentLine
)
1694 ## [guids], [ppis] and [protocols] section parser
1696 def _GuidParser(self
):
1697 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_EQUAL_SPLIT
, 1)
1698 if len(TokenList
) < 2:
1699 EdkLogger
.error('Parser', FORMAT_INVALID
, "No GUID name or value specified",
1700 ExtraData
=self
._CurrentLine
+ " (<CName> = <GuidValueInCFormat>)",
1701 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1702 if TokenList
[0] == '':
1703 EdkLogger
.error('Parser', FORMAT_INVALID
, "No GUID name specified",
1704 ExtraData
=self
._CurrentLine
+ " (<CName> = <GuidValueInCFormat>)",
1705 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1706 if TokenList
[1] == '':
1707 EdkLogger
.error('Parser', FORMAT_INVALID
, "No GUID value specified",
1708 ExtraData
=self
._CurrentLine
+ " (<CName> = <GuidValueInCFormat>)",
1709 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1710 if TokenList
[1][0] != '{' or TokenList
[1][-1] != '}' or GuidStructureStringToGuidString(TokenList
[1]) == '':
1711 EdkLogger
.error('Parser', FORMAT_INVALID
, "Invalid GUID value format",
1712 ExtraData
=self
._CurrentLine
+ \
1713 " (<CName> = <GuidValueInCFormat:{8,4,4,{2,2,2,2,2,2,2,2}}>)",
1714 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1715 self
._ValueList
[0] = TokenList
[0]
1716 self
._ValueList
[1] = TokenList
[1]
1718 ## PCD sections parser
1720 # [PcdsFixedAtBuild]
1721 # [PcdsPatchableInModule]
1727 def _PcdParser(self
):
1728 TokenList
= GetSplitValueList(self
._CurrentLine
, TAB_VALUE_SPLIT
, 1)
1729 self
._ValueList
[0:1] = GetSplitValueList(TokenList
[0], TAB_SPLIT
)
1730 ValueRe
= re
.compile(r
'^[a-zA-Z_][a-zA-Z0-9_]*')
1731 # check PCD information
1732 if self
._ValueList
[0] == '' or self
._ValueList
[1] == '':
1733 EdkLogger
.error('Parser', FORMAT_INVALID
, "No token space GUID or PCD name specified",
1734 ExtraData
=self
._CurrentLine
+ \
1735 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1736 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1737 # check format of token space GUID CName
1738 if not ValueRe
.match(self
._ValueList
[0]):
1739 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_]*'",
1740 ExtraData
=self
._CurrentLine
+ \
1741 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1742 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1743 # check format of PCD CName
1744 if not ValueRe
.match(self
._ValueList
[1]):
1745 EdkLogger
.error('Parser', FORMAT_INVALID
, "The format of the PCD CName is invalid. The correct format is '(a-zA-Z_)[a-zA-Z0-9_]*'",
1746 ExtraData
=self
._CurrentLine
+ \
1747 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1748 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1749 # check PCD datum information
1750 if len(TokenList
) < 2 or TokenList
[1] == '':
1751 EdkLogger
.error('Parser', FORMAT_INVALID
, "No PCD Datum information given",
1752 ExtraData
=self
._CurrentLine
+ \
1753 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1754 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1757 ValueRe
= re
.compile(r
'^\s*L?\".*\|.*\"')
1758 PtrValue
= ValueRe
.findall(TokenList
[1])
1760 # Has VOID* type string, may contain "|" character in the string.
1761 if len(PtrValue
) != 0:
1762 ptrValueList
= re
.sub(ValueRe
, '', TokenList
[1])
1763 ValueList
= GetSplitValueList(ptrValueList
)
1764 ValueList
[0] = PtrValue
[0]
1766 ValueList
= GetSplitValueList(TokenList
[1])
1769 # check if there's enough datum information given
1770 if len(ValueList
) != 3:
1771 EdkLogger
.error('Parser', FORMAT_INVALID
, "Invalid PCD Datum information given",
1772 ExtraData
=self
._CurrentLine
+ \
1773 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1774 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1775 # check default value
1776 if ValueList
[0] == '':
1777 EdkLogger
.error('Parser', FORMAT_INVALID
, "Missing DefaultValue in PCD Datum information",
1778 ExtraData
=self
._CurrentLine
+ \
1779 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1780 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1782 if ValueList
[1] == '':
1783 EdkLogger
.error('Parser', FORMAT_INVALID
, "Missing DatumType in PCD Datum information",
1784 ExtraData
=self
._CurrentLine
+ \
1785 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1786 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1787 # check token of the PCD
1788 if ValueList
[2] == '':
1789 EdkLogger
.error('Parser', FORMAT_INVALID
, "Missing Token in PCD Datum information",
1790 ExtraData
=self
._CurrentLine
+ \
1791 " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",
1792 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1793 # check format of default value against the datum type
1794 IsValid
, Cause
= CheckPcdDatum(ValueList
[1], ValueList
[0])
1796 EdkLogger
.error('Parser', FORMAT_INVALID
, Cause
, ExtraData
=self
._CurrentLine
,
1797 File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1799 if ValueList
[0] in ['True', 'true', 'TRUE']:
1801 elif ValueList
[0] in ['False', 'false', 'FALSE']:
1804 # check for duplicate PCD definition
1805 if (self
._Scope
[0], self
._ValueList
[0], self
._ValueList
[1]) in self
._AllPCDs
:
1806 EdkLogger
.error('Parser', FORMAT_INVALID
,
1807 "The same PCD name and GUID have been already defined",
1808 ExtraData
=self
._CurrentLine
, File
=self
.MetaFile
, Line
=self
._LineIndex
+ 1)
1810 self
._AllPCDs
.append((self
._Scope
[0], self
._ValueList
[0], self
._ValueList
[1]))
1812 self
._ValueList
[2] = ValueList
[0].strip() + '|' + ValueList
[1].strip() + '|' + ValueList
[2].strip()
1815 MODEL_META_DATA_HEADER
: MetaFileParser
._DefineParser
,
1816 MODEL_EFI_INCLUDE
: MetaFileParser
._PathParser
,
1817 MODEL_EFI_LIBRARY_CLASS
: MetaFileParser
._PathParser
,
1818 MODEL_EFI_GUID
: _GuidParser
,
1819 MODEL_EFI_PPI
: _GuidParser
,
1820 MODEL_EFI_PROTOCOL
: _GuidParser
,
1821 MODEL_PCD_FIXED_AT_BUILD
: _PcdParser
,
1822 MODEL_PCD_PATCHABLE_IN_MODULE
: _PcdParser
,
1823 MODEL_PCD_FEATURE_FLAG
: _PcdParser
,
1824 MODEL_PCD_DYNAMIC
: _PcdParser
,
1825 MODEL_PCD_DYNAMIC_EX
: _PcdParser
,
1826 MODEL_UNKNOWN
: MetaFileParser
._Skip
,
1827 MODEL_META_DATA_USER_EXTENSION
: MetaFileParser
._Skip
,
1832 # This acts like the main() function for the script, unless it is 'import'ed into another
1835 if __name__
== '__main__':