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