]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - BaseTools/Source/Python/GenFds/FdfParser.py
BaseTools: Move OverrideAttribs to OptRomInfStatement.py
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py
... / ...
CommitLineData
1## @file\r
2# parse FDF file\r
3#\r
4# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
5# Copyright (c) 2015, Hewlett Packard Enterprise Development, L.P.<BR>\r
6#\r
7# This program and the accompanying materials\r
8# are licensed and made available under the terms and conditions of the BSD License\r
9# which accompanies this distribution. The full text of the license may be found at\r
10# http://opensource.org/licenses/bsd-license.php\r
11#\r
12# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14#\r
15\r
16##\r
17# Import Modules\r
18#\r
19from __future__ import print_function\r
20from __future__ import absolute_import\r
21import re\r
22\r
23from . import Fd\r
24from . import Region\r
25from . import Fv\r
26from . import AprioriSection\r
27from . import FfsInfStatement\r
28from . import FfsFileStatement\r
29from . import VerSection\r
30from . import UiSection\r
31from . import FvImageSection\r
32from . import DataSection\r
33from . import DepexSection\r
34from . import CompressSection\r
35from . import GuidSection\r
36from . import Capsule\r
37from . import CapsuleData\r
38from . import Rule\r
39from . import RuleComplexFile\r
40from . import RuleSimpleFile\r
41from . import EfiSection\r
42from . import Vtf\r
43from . import ComponentStatement\r
44from . import OptionRom\r
45from . import OptRomInfStatement\r
46from . import OptRomFileStatement\r
47import string\r
48\r
49from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
50from Common.BuildToolError import *\r
51from Common import EdkLogger\r
52from Common.Misc import PathClass\r
53from Common.StringUtils import NormPath\r
54import Common.GlobalData as GlobalData\r
55from Common.Expression import *\r
56from Common import GlobalData\r
57from Common.DataType import *\r
58from Common.StringUtils import ReplaceMacro\r
59import uuid\r
60from Common.Misc import tdict\r
61from Common.MultipleWorkspace import MultipleWorkspace as mws\r
62import Common.LongFilePathOs as os\r
63from Common.LongFilePathSupport import OpenLongFilePath as open\r
64from .Capsule import EFI_CERT_TYPE_PKCS7_GUID\r
65from .Capsule import EFI_CERT_TYPE_RSA2048_SHA256_GUID\r
66from Common.RangeExpression import RangeExpression\r
67\r
68##define T_CHAR_SPACE ' '\r
69##define T_CHAR_NULL '\0'\r
70##define T_CHAR_CR '\r'\r
71##define T_CHAR_TAB '\t'\r
72##define T_CHAR_LF '\n'\r
73##define T_CHAR_SLASH '/'\r
74##define T_CHAR_BACKSLASH '\\'\r
75##define T_CHAR_DOUBLE_QUOTE '\"'\r
76##define T_CHAR_SINGLE_QUOTE '\''\r
77##define T_CHAR_STAR '*'\r
78##define T_CHAR_HASH '#'\r
79\r
80(T_CHAR_SPACE, T_CHAR_NULL, T_CHAR_CR, T_CHAR_TAB, T_CHAR_LF, T_CHAR_SLASH, \\r
81T_CHAR_BACKSLASH, T_CHAR_DOUBLE_QUOTE, T_CHAR_SINGLE_QUOTE, T_CHAR_STAR, T_CHAR_HASH) = \\r
82(' ', '\0', '\r', '\t', '\n', '/', '\\', '\"', '\'', '*', '#')\r
83\r
84SEPERATOR_TUPLE = ('=', '|', ',', '{', '}')\r
85\r
86RegionSizePattern = re.compile("\s*(?P<base>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<size>(?:0x|0X)?[a-fA-F0-9]+)\s*")\r
87RegionSizeGuidPattern = re.compile("\s*(?P<base>\w+\.\w+[\.\w\[\]]*)\s*\|\s*(?P<size>\w+\.\w+[\.\w\[\]]*)\s*")\r
88RegionOffsetPcdPattern = re.compile("\s*(?P<base>\w+\.\w+[\.\w\[\]]*)\s*$")\r
89ShortcutPcdPattern = re.compile("\s*\w+\s*=\s*(?P<value>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<name>\w+\.\w+)\s*")\r
90BaseAddrValuePattern = re.compile('^0[xX][0-9a-fA-F]+')\r
91FileExtensionPattern = re.compile(r'([a-zA-Z][a-zA-Z0-9]*)')\r
92TokenFindPattern = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')\r
93AllIncludeFileList = []\r
94\r
95# Get the closest parent\r
96def GetParentAtLine (Line):\r
97 for Profile in AllIncludeFileList:\r
98 if Profile.IsLineInFile(Line):\r
99 return Profile\r
100 return None\r
101\r
102# Check include loop\r
103def IsValidInclude (File, Line):\r
104 for Profile in AllIncludeFileList:\r
105 if Profile.IsLineInFile(Line) and Profile.FileName == File:\r
106 return False\r
107\r
108 return True\r
109\r
110def GetRealFileLine (File, Line):\r
111\r
112 InsertedLines = 0\r
113 for Profile in AllIncludeFileList:\r
114 if Profile.IsLineInFile(Line):\r
115 return Profile.GetLineInFile(Line)\r
116 elif Line >= Profile.InsertStartLineNumber and Profile.Level == 1:\r
117 InsertedLines += Profile.GetTotalLines()\r
118\r
119 return (File, Line - InsertedLines)\r
120\r
121## The exception class that used to report error messages when parsing FDF\r
122#\r
123# Currently the "ToolName" is set to be "FDF Parser".\r
124#\r
125class Warning (Exception):\r
126 ## The constructor\r
127 #\r
128 # @param self The object pointer\r
129 # @param Str The message to record\r
130 # @param File The FDF name\r
131 # @param Line The Line number that error occurs\r
132 #\r
133 def __init__(self, Str, File = None, Line = None):\r
134\r
135 FileLineTuple = GetRealFileLine(File, Line)\r
136 self.FileName = FileLineTuple[0]\r
137 self.LineNumber = FileLineTuple[1]\r
138 self.OriginalLineNumber = Line\r
139 self.Message = Str\r
140 self.ToolName = 'FdfParser'\r
141\r
142 def __str__(self):\r
143 return self.Message\r
144\r
145## The Include file content class that used to record file data when parsing include file\r
146#\r
147# May raise Exception when opening file.\r
148#\r
149class IncludeFileProfile :\r
150 ## The constructor\r
151 #\r
152 # @param self The object pointer\r
153 # @param FileName The file that to be parsed\r
154 #\r
155 def __init__(self, FileName):\r
156 self.FileName = FileName\r
157 self.FileLinesList = []\r
158 try:\r
159 fsock = open(FileName, "rb", 0)\r
160 try:\r
161 self.FileLinesList = fsock.readlines()\r
162 for index, line in enumerate(self.FileLinesList):\r
163 if not line.endswith('\n'):\r
164 self.FileLinesList[index] += '\n'\r
165\r
166 finally:\r
167 fsock.close()\r
168\r
169 except:\r
170 EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
171\r
172 self.InsertStartLineNumber = None\r
173 self.InsertAdjust = 0\r
174 self.IncludeFileList = []\r
175 self.Level = 1 # first level include file\r
176\r
177 def GetTotalLines(self):\r
178 TotalLines = self.InsertAdjust + len(self.FileLinesList)\r
179\r
180 for Profile in self.IncludeFileList:\r
181 TotalLines += Profile.GetTotalLines()\r
182\r
183 return TotalLines\r
184\r
185 def IsLineInFile(self, Line):\r
186 if Line >= self.InsertStartLineNumber and Line < self.InsertStartLineNumber + self.GetTotalLines():\r
187 return True\r
188\r
189 return False\r
190\r
191 def GetLineInFile(self, Line):\r
192 if not self.IsLineInFile (Line):\r
193 return (self.FileName, -1)\r
194\r
195 InsertedLines = self.InsertStartLineNumber\r
196\r
197 for Profile in self.IncludeFileList:\r
198 if Profile.IsLineInFile(Line):\r
199 return Profile.GetLineInFile(Line)\r
200 elif Line >= Profile.InsertStartLineNumber:\r
201 InsertedLines += Profile.GetTotalLines()\r
202\r
203 return (self.FileName, Line - InsertedLines + 1)\r
204\r
205\r
206\r
207## The FDF content class that used to record file data when parsing FDF\r
208#\r
209# May raise Exception when opening file.\r
210#\r
211class FileProfile :\r
212 ## The constructor\r
213 #\r
214 # @param self The object pointer\r
215 # @param FileName The file that to be parsed\r
216 #\r
217 def __init__(self, FileName):\r
218 self.FileLinesList = []\r
219 try:\r
220 fsock = open(FileName, "rb", 0)\r
221 try:\r
222 self.FileLinesList = fsock.readlines()\r
223 finally:\r
224 fsock.close()\r
225\r
226 except:\r
227 EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
228\r
229 self.FileName = FileName\r
230 self.PcdDict = {}\r
231 self.PcdLocalDict = {}\r
232 self.InfList = []\r
233 self.InfDict = {'ArchTBD':[]}\r
234 # ECC will use this Dict and List information\r
235 self.PcdFileLineDict = {}\r
236 self.InfFileLineList = []\r
237\r
238 self.FdDict = {}\r
239 self.FdNameNotSet = False\r
240 self.FvDict = {}\r
241 self.CapsuleDict = {}\r
242 self.VtfList = []\r
243 self.RuleDict = {}\r
244 self.OptRomDict = {}\r
245 self.FmpPayloadDict = {}\r
246\r
247## The syntax parser for FDF\r
248#\r
249# PreprocessFile method should be called prior to ParseFile\r
250# CycleReferenceCheck method can detect cycles in FDF contents\r
251#\r
252# GetNext*** procedures mean these procedures will get next token first, then make judgement.\r
253# Get*** procedures mean these procedures will make judgement on current token only.\r
254#\r
255class FdfParser:\r
256 ## The constructor\r
257 #\r
258 # @param self The object pointer\r
259 # @param FileName The file that to be parsed\r
260 #\r
261 def __init__(self, FileName):\r
262 self.Profile = FileProfile(FileName)\r
263 self.FileName = FileName\r
264 self.CurrentLineNumber = 1\r
265 self.CurrentOffsetWithinLine = 0\r
266 self.CurrentFdName = None\r
267 self.CurrentFvName = None\r
268 self.__Token = ""\r
269 self.__SkippedChars = ""\r
270 GlobalData.gFdfParser = self\r
271\r
272 # Used to section info\r
273 self.__CurSection = []\r
274 # Key: [section name, UI name, arch]\r
275 # Value: {MACRO_NAME : MACRO_VALUE}\r
276 self.__MacroDict = tdict(True, 3)\r
277 self.__PcdDict = {}\r
278\r
279 self.__WipeOffArea = []\r
280 if GenFdsGlobalVariable.WorkSpaceDir == '':\r
281 GenFdsGlobalVariable.WorkSpaceDir = os.getenv("WORKSPACE")\r
282\r
283 ## __SkipWhiteSpace() method\r
284 #\r
285 # Skip white spaces from current char, return number of chars skipped\r
286 #\r
287 # @param self The object pointer\r
288 # @retval Count The number of chars skipped\r
289 #\r
290 def __SkipWhiteSpace(self):\r
291 Count = 0\r
292 while not self.__EndOfFile():\r
293 Count += 1\r
294 if self.__CurrentChar() in (T_CHAR_NULL, T_CHAR_CR, T_CHAR_LF, T_CHAR_SPACE, T_CHAR_TAB):\r
295 self.__SkippedChars += str(self.__CurrentChar())\r
296 self.__GetOneChar()\r
297\r
298 else:\r
299 Count = Count - 1\r
300 return Count\r
301\r
302 ## __EndOfFile() method\r
303 #\r
304 # Judge current buffer pos is at file end\r
305 #\r
306 # @param self The object pointer\r
307 # @retval True Current File buffer position is at file end\r
308 # @retval False Current File buffer position is NOT at file end\r
309 #\r
310 def __EndOfFile(self):\r
311 NumberOfLines = len(self.Profile.FileLinesList)\r
312 SizeOfLastLine = len(self.Profile.FileLinesList[-1])\r
313 if self.CurrentLineNumber == NumberOfLines and self.CurrentOffsetWithinLine >= SizeOfLastLine - 1:\r
314 return True\r
315 elif self.CurrentLineNumber > NumberOfLines:\r
316 return True\r
317 else:\r
318 return False\r
319\r
320 ## __EndOfLine() method\r
321 #\r
322 # Judge current buffer pos is at line end\r
323 #\r
324 # @param self The object pointer\r
325 # @retval True Current File buffer position is at line end\r
326 # @retval False Current File buffer position is NOT at line end\r
327 #\r
328 def __EndOfLine(self):\r
329 if self.CurrentLineNumber > len(self.Profile.FileLinesList):\r
330 return True\r
331 SizeOfCurrentLine = len(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
332 if self.CurrentOffsetWithinLine >= SizeOfCurrentLine:\r
333 return True\r
334 else:\r
335 return False\r
336\r
337 ## Rewind() method\r
338 #\r
339 # Reset file data buffer to the initial state\r
340 #\r
341 # @param self The object pointer\r
342 # @param DestLine Optional new destination line number.\r
343 # @param DestOffset Optional new destination offset.\r
344 #\r
345 def Rewind(self, DestLine = 1, DestOffset = 0):\r
346 self.CurrentLineNumber = DestLine\r
347 self.CurrentOffsetWithinLine = DestOffset\r
348\r
349 ## __UndoOneChar() method\r
350 #\r
351 # Go back one char in the file buffer\r
352 #\r
353 # @param self The object pointer\r
354 # @retval True Successfully go back one char\r
355 # @retval False Not able to go back one char as file beginning reached\r
356 #\r
357 def __UndoOneChar(self):\r
358\r
359 if self.CurrentLineNumber == 1 and self.CurrentOffsetWithinLine == 0:\r
360 return False\r
361 elif self.CurrentOffsetWithinLine == 0:\r
362 self.CurrentLineNumber -= 1\r
363 self.CurrentOffsetWithinLine = len(self.__CurrentLine()) - 1\r
364 else:\r
365 self.CurrentOffsetWithinLine -= 1\r
366 return True\r
367\r
368 ## __GetOneChar() method\r
369 #\r
370 # Move forward one char in the file buffer\r
371 #\r
372 # @param self The object pointer\r
373 #\r
374 def __GetOneChar(self):\r
375 if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:\r
376 self.CurrentLineNumber += 1\r
377 self.CurrentOffsetWithinLine = 0\r
378 else:\r
379 self.CurrentOffsetWithinLine += 1\r
380\r
381 ## __CurrentChar() method\r
382 #\r
383 # Get the char pointed to by the file buffer pointer\r
384 #\r
385 # @param self The object pointer\r
386 # @retval Char Current char\r
387 #\r
388 def __CurrentChar(self):\r
389 return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine]\r
390\r
391 ## __NextChar() method\r
392 #\r
393 # Get the one char pass the char pointed to by the file buffer pointer\r
394 #\r
395 # @param self The object pointer\r
396 # @retval Char Next char\r
397 #\r
398 def __NextChar(self):\r
399 if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:\r
400 return self.Profile.FileLinesList[self.CurrentLineNumber][0]\r
401 else:\r
402 return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine + 1]\r
403\r
404 ## __SetCurrentCharValue() method\r
405 #\r
406 # Modify the value of current char\r
407 #\r
408 # @param self The object pointer\r
409 # @param Value The new value of current char\r
410 #\r
411 def __SetCurrentCharValue(self, Value):\r
412 self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine] = Value\r
413\r
414 ## __CurrentLine() method\r
415 #\r
416 # Get the list that contains current line contents\r
417 #\r
418 # @param self The object pointer\r
419 # @retval List current line contents\r
420 #\r
421 def __CurrentLine(self):\r
422 return self.Profile.FileLinesList[self.CurrentLineNumber - 1]\r
423\r
424 def __StringToList(self):\r
425 self.Profile.FileLinesList = [list(s) for s in self.Profile.FileLinesList]\r
426 self.Profile.FileLinesList[-1].append(' ')\r
427\r
428 def __ReplaceFragment(self, StartPos, EndPos, Value = ' '):\r
429 if StartPos[0] == EndPos[0]:\r
430 Offset = StartPos[1]\r
431 while Offset <= EndPos[1]:\r
432 self.Profile.FileLinesList[StartPos[0]][Offset] = Value\r
433 Offset += 1\r
434 return\r
435\r
436 Offset = StartPos[1]\r
437 while self.Profile.FileLinesList[StartPos[0]][Offset] not in ('\r', '\n'):\r
438 self.Profile.FileLinesList[StartPos[0]][Offset] = Value\r
439 Offset += 1\r
440\r
441 Line = StartPos[0]\r
442 while Line < EndPos[0]:\r
443 Offset = 0\r
444 while self.Profile.FileLinesList[Line][Offset] not in ('\r', '\n'):\r
445 self.Profile.FileLinesList[Line][Offset] = Value\r
446 Offset += 1\r
447 Line += 1\r
448\r
449 Offset = 0\r
450 while Offset <= EndPos[1]:\r
451 self.Profile.FileLinesList[EndPos[0]][Offset] = Value\r
452 Offset += 1\r
453\r
454\r
455 def __GetMacroName(self):\r
456 if not self.__GetNextToken():\r
457 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
458 MacroName = self.__Token\r
459 NotFlag = False\r
460 if MacroName.startswith('!'):\r
461 NotFlag = True\r
462 MacroName = MacroName[1:].strip()\r
463\r
464 if not MacroName.startswith('$(') or not MacroName.endswith(')'):\r
465 raise Warning("Macro name expected(Please use '$(%(Token)s)' if '%(Token)s' is a macro.)" % {"Token" : MacroName},\r
466 self.FileName, self.CurrentLineNumber)\r
467 MacroName = MacroName[2:-1]\r
468 return MacroName, NotFlag\r
469\r
470 def __SetMacroValue(self, Macro, Value):\r
471 if not self.__CurSection:\r
472 return\r
473\r
474 MacroDict = {}\r
475 if not self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]]:\r
476 self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]] = MacroDict\r
477 else:\r
478 MacroDict = self.__MacroDict[self.__CurSection[0], self.__CurSection[1], self.__CurSection[2]]\r
479 MacroDict[Macro] = Value\r
480\r
481 def __GetMacroValue(self, Macro):\r
482 # Highest priority\r
483 if Macro in GlobalData.gCommandLineDefines:\r
484 return GlobalData.gCommandLineDefines[Macro]\r
485 if Macro in GlobalData.gGlobalDefines:\r
486 return GlobalData.gGlobalDefines[Macro]\r
487\r
488 if self.__CurSection:\r
489 MacroDict = self.__MacroDict[\r
490 self.__CurSection[0],\r
491 self.__CurSection[1],\r
492 self.__CurSection[2]\r
493 ]\r
494 if MacroDict and Macro in MacroDict:\r
495 return MacroDict[Macro]\r
496\r
497 # Lowest priority\r
498 if Macro in GlobalData.gPlatformDefines:\r
499 return GlobalData.gPlatformDefines[Macro]\r
500 return None\r
501\r
502 def __SectionHeaderParser(self, Section):\r
503 # [Defines]\r
504 # [FD.UiName]: use dummy instead if UI name is optional\r
505 # [FV.UiName]\r
506 # [Capsule.UiName]\r
507 # [Rule]: don't take rule section into account, macro is not allowed in this section\r
508 # [VTF.arch.UiName, arch]\r
509 # [OptionRom.DriverName]\r
510 self.__CurSection = []\r
511 Section = Section.strip()[1:-1].upper().replace(' ', '').strip('.')\r
512 ItemList = Section.split('.')\r
513 Item = ItemList[0]\r
514 if Item == '' or Item == 'RULE':\r
515 return\r
516\r
517 if Item == TAB_COMMON_DEFINES.upper():\r
518 self.__CurSection = [TAB_COMMON, TAB_COMMON, TAB_COMMON]\r
519 elif Item == 'VTF' and len(ItemList) == 3:\r
520 UiName = ItemList[2]\r
521 Pos = UiName.find(',')\r
522 if Pos != -1:\r
523 UiName = UiName[:Pos]\r
524 self.__CurSection = ['VTF', UiName, ItemList[1]]\r
525 elif len(ItemList) > 1:\r
526 self.__CurSection = [ItemList[0], ItemList[1], TAB_COMMON]\r
527 elif len(ItemList) > 0:\r
528 self.__CurSection = [ItemList[0], 'DUMMY', TAB_COMMON]\r
529\r
530 ## PreprocessFile() method\r
531 #\r
532 # Preprocess file contents, replace comments with spaces.\r
533 # In the end, rewind the file buffer pointer to the beginning\r
534 # BUGBUG: No !include statement processing contained in this procedure\r
535 # !include statement should be expanded at the same FileLinesList[CurrentLineNumber - 1]\r
536 #\r
537 # @param self The object pointer\r
538 #\r
539 def PreprocessFile(self):\r
540\r
541 self.Rewind()\r
542 InComment = False\r
543 DoubleSlashComment = False\r
544 HashComment = False\r
545 # HashComment in quoted string " " is ignored.\r
546 InString = False\r
547\r
548 while not self.__EndOfFile():\r
549\r
550 if self.__CurrentChar() == T_CHAR_DOUBLE_QUOTE and not InComment:\r
551 InString = not InString\r
552 # meet new line, then no longer in a comment for // and '#'\r
553 if self.__CurrentChar() == T_CHAR_LF:\r
554 self.CurrentLineNumber += 1\r
555 self.CurrentOffsetWithinLine = 0\r
556 if InComment and DoubleSlashComment:\r
557 InComment = False\r
558 DoubleSlashComment = False\r
559 if InComment and HashComment:\r
560 InComment = False\r
561 HashComment = False\r
562 # check for */ comment end\r
563 elif InComment and not DoubleSlashComment and not HashComment and self.__CurrentChar() == T_CHAR_STAR and self.__NextChar() == T_CHAR_SLASH:\r
564 self.__SetCurrentCharValue(T_CHAR_SPACE)\r
565 self.__GetOneChar()\r
566 self.__SetCurrentCharValue(T_CHAR_SPACE)\r
567 self.__GetOneChar()\r
568 InComment = False\r
569 # set comments to spaces\r
570 elif InComment:\r
571 self.__SetCurrentCharValue(T_CHAR_SPACE)\r
572 self.__GetOneChar()\r
573 # check for // comment\r
574 elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_SLASH and not self.__EndOfLine():\r
575 InComment = True\r
576 DoubleSlashComment = True\r
577 # check for '#' comment\r
578 elif self.__CurrentChar() == T_CHAR_HASH and not self.__EndOfLine() and not InString:\r
579 InComment = True\r
580 HashComment = True\r
581 # check for /* comment start\r
582 elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_STAR:\r
583 self.__SetCurrentCharValue( T_CHAR_SPACE)\r
584 self.__GetOneChar()\r
585 self.__SetCurrentCharValue( T_CHAR_SPACE)\r
586 self.__GetOneChar()\r
587 InComment = True\r
588 else:\r
589 self.__GetOneChar()\r
590\r
591 # restore from ListOfList to ListOfString\r
592 self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]\r
593 self.Rewind()\r
594\r
595 ## PreprocessIncludeFile() method\r
596 #\r
597 # Preprocess file contents, replace !include statements with file contents.\r
598 # In the end, rewind the file buffer pointer to the beginning\r
599 #\r
600 # @param self The object pointer\r
601 #\r
602 def PreprocessIncludeFile(self):\r
603 # nested include support\r
604 Processed = False\r
605 MacroDict = {}\r
606 while self.__GetNextToken():\r
607\r
608 if self.__Token == 'DEFINE':\r
609 if not self.__GetNextToken():\r
610 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
611 Macro = self.__Token\r
612 if not self.__IsToken( "="):\r
613 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
614 Value = self.__GetExpression()\r
615 MacroDict[Macro] = Value\r
616\r
617 elif self.__Token == '!include':\r
618 Processed = True\r
619 IncludeLine = self.CurrentLineNumber\r
620 IncludeOffset = self.CurrentOffsetWithinLine - len('!include')\r
621 if not self.__GetNextToken():\r
622 raise Warning("expected include file name", self.FileName, self.CurrentLineNumber)\r
623 IncFileName = self.__Token\r
624 PreIndex = 0\r
625 StartPos = IncFileName.find('$(', PreIndex)\r
626 EndPos = IncFileName.find(')', StartPos+2)\r
627 while StartPos != -1 and EndPos != -1:\r
628 Macro = IncFileName[StartPos+2 : EndPos]\r
629 MacroVal = self.__GetMacroValue(Macro)\r
630 if not MacroVal:\r
631 if Macro in MacroDict:\r
632 MacroVal = MacroDict[Macro]\r
633 if MacroVal is not None:\r
634 IncFileName = IncFileName.replace('$(' + Macro + ')', MacroVal, 1)\r
635 if MacroVal.find('$(') != -1:\r
636 PreIndex = StartPos\r
637 else:\r
638 PreIndex = StartPos + len(MacroVal)\r
639 else:\r
640 raise Warning("The Macro %s is not defined" %Macro, self.FileName, self.CurrentLineNumber)\r
641 StartPos = IncFileName.find('$(', PreIndex)\r
642 EndPos = IncFileName.find(')', StartPos+2)\r
643\r
644 IncludedFile = NormPath(IncFileName)\r
645 #\r
646 # First search the include file under the same directory as FDF file\r
647 #\r
648 IncludedFile1 = PathClass(IncludedFile, os.path.dirname(self.FileName))\r
649 ErrorCode = IncludedFile1.Validate()[0]\r
650 if ErrorCode != 0:\r
651 #\r
652 # Then search the include file under the same directory as DSC file\r
653 #\r
654 PlatformDir = ''\r
655 if GenFdsGlobalVariable.ActivePlatform:\r
656 PlatformDir = GenFdsGlobalVariable.ActivePlatform.Dir\r
657 elif GlobalData.gActivePlatform:\r
658 PlatformDir = GlobalData.gActivePlatform.MetaFile.Dir\r
659 IncludedFile1 = PathClass(IncludedFile, PlatformDir)\r
660 ErrorCode = IncludedFile1.Validate()[0]\r
661 if ErrorCode != 0:\r
662 #\r
663 # Also search file under the WORKSPACE directory\r
664 #\r
665 IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
666 ErrorCode = IncludedFile1.Validate()[0]\r
667 if ErrorCode != 0:\r
668 raise Warning("The include file does not exist under below directories: \n%s\n%s\n%s\n"%(os.path.dirname(self.FileName), PlatformDir, GlobalData.gWorkspace),\r
669 self.FileName, self.CurrentLineNumber)\r
670\r
671 if not IsValidInclude (IncludedFile1.Path, self.CurrentLineNumber):\r
672 raise Warning("The include file {0} is causing a include loop.\n".format (IncludedFile1.Path), self.FileName, self.CurrentLineNumber)\r
673\r
674 IncFileProfile = IncludeFileProfile(IncludedFile1.Path)\r
675\r
676 CurrentLine = self.CurrentLineNumber\r
677 CurrentOffset = self.CurrentOffsetWithinLine\r
678 # list index of the insertion, note that line number is 'CurrentLine + 1'\r
679 InsertAtLine = CurrentLine\r
680 ParentProfile = GetParentAtLine (CurrentLine)\r
681 if ParentProfile is not None:\r
682 ParentProfile.IncludeFileList.insert(0, IncFileProfile)\r
683 IncFileProfile.Level = ParentProfile.Level + 1\r
684 IncFileProfile.InsertStartLineNumber = InsertAtLine + 1\r
685 # deal with remaining portions after "!include filename", if exists.\r
686 if self.__GetNextToken():\r
687 if self.CurrentLineNumber == CurrentLine:\r
688 RemainingLine = self.__CurrentLine()[CurrentOffset:]\r
689 self.Profile.FileLinesList.insert(self.CurrentLineNumber, RemainingLine)\r
690 IncFileProfile.InsertAdjust += 1\r
691 self.CurrentLineNumber += 1\r
692 self.CurrentOffsetWithinLine = 0\r
693\r
694 for Line in IncFileProfile.FileLinesList:\r
695 self.Profile.FileLinesList.insert(InsertAtLine, Line)\r
696 self.CurrentLineNumber += 1\r
697 InsertAtLine += 1\r
698\r
699 # reversely sorted to better determine error in file\r
700 AllIncludeFileList.insert(0, IncFileProfile)\r
701\r
702 # comment out the processed include file statement\r
703 TempList = list(self.Profile.FileLinesList[IncludeLine - 1])\r
704 TempList.insert(IncludeOffset, '#')\r
705 self.Profile.FileLinesList[IncludeLine - 1] = ''.join(TempList)\r
706 if Processed: # Nested and back-to-back support\r
707 self.Rewind(DestLine = IncFileProfile.InsertStartLineNumber - 1)\r
708 Processed = False\r
709 # Preprocess done.\r
710 self.Rewind()\r
711\r
712 @staticmethod\r
713 def __GetIfListCurrentItemStat(IfList):\r
714 if len(IfList) == 0:\r
715 return True\r
716\r
717 for Item in IfList:\r
718 if Item[1] == False:\r
719 return False\r
720\r
721 return True\r
722\r
723 ## PreprocessConditionalStatement() method\r
724 #\r
725 # Preprocess conditional statement.\r
726 # In the end, rewind the file buffer pointer to the beginning\r
727 #\r
728 # @param self The object pointer\r
729 #\r
730 def PreprocessConditionalStatement(self):\r
731 # IfList is a stack of if branches with elements of list [Pos, CondSatisfied, BranchDetermined]\r
732 IfList = []\r
733 RegionLayoutLine = 0\r
734 ReplacedLine = -1\r
735 while self.__GetNextToken():\r
736 # Determine section name and the location dependent macro\r
737 if self.__GetIfListCurrentItemStat(IfList):\r
738 if self.__Token.startswith('['):\r
739 Header = self.__Token\r
740 if not self.__Token.endswith(']'):\r
741 self.__SkipToToken(']')\r
742 Header += self.__SkippedChars\r
743 if Header.find('$(') != -1:\r
744 raise Warning("macro cannot be used in section header", self.FileName, self.CurrentLineNumber)\r
745 self.__SectionHeaderParser(Header)\r
746 continue\r
747 # Replace macros except in RULE section or out of section\r
748 elif self.__CurSection and ReplacedLine != self.CurrentLineNumber:\r
749 ReplacedLine = self.CurrentLineNumber\r
750 self.__UndoToken()\r
751 CurLine = self.Profile.FileLinesList[ReplacedLine - 1]\r
752 PreIndex = 0\r
753 StartPos = CurLine.find('$(', PreIndex)\r
754 EndPos = CurLine.find(')', StartPos+2)\r
755 while StartPos != -1 and EndPos != -1 and self.__Token not in ['!ifdef', '!ifndef', '!if', '!elseif']:\r
756 MacroName = CurLine[StartPos+2 : EndPos]\r
757 MacorValue = self.__GetMacroValue(MacroName)\r
758 if MacorValue is not None:\r
759 CurLine = CurLine.replace('$(' + MacroName + ')', MacorValue, 1)\r
760 if MacorValue.find('$(') != -1:\r
761 PreIndex = StartPos\r
762 else:\r
763 PreIndex = StartPos + len(MacorValue)\r
764 else:\r
765 PreIndex = EndPos + 1\r
766 StartPos = CurLine.find('$(', PreIndex)\r
767 EndPos = CurLine.find(')', StartPos+2)\r
768 self.Profile.FileLinesList[ReplacedLine - 1] = CurLine\r
769 continue\r
770\r
771 if self.__Token == 'DEFINE':\r
772 if self.__GetIfListCurrentItemStat(IfList):\r
773 if not self.__CurSection:\r
774 raise Warning("macro cannot be defined in Rule section or out of section", self.FileName, self.CurrentLineNumber)\r
775 DefineLine = self.CurrentLineNumber - 1\r
776 DefineOffset = self.CurrentOffsetWithinLine - len('DEFINE')\r
777 if not self.__GetNextToken():\r
778 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)\r
779 Macro = self.__Token\r
780 if not self.__IsToken( "="):\r
781 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
782\r
783 Value = self.__GetExpression()\r
784 self.__SetMacroValue(Macro, Value)\r
785 self.__WipeOffArea.append(((DefineLine, DefineOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
786 elif self.__Token == 'SET':\r
787 if not self.__GetIfListCurrentItemStat(IfList):\r
788 continue\r
789 SetLine = self.CurrentLineNumber - 1\r
790 SetOffset = self.CurrentOffsetWithinLine - len('SET')\r
791 PcdPair = self.__GetNextPcdSettings()\r
792 PcdName = "%s.%s" % (PcdPair[1], PcdPair[0])\r
793 if not self.__IsToken( "="):\r
794 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
795\r
796 Value = self.__GetExpression()\r
797 Value = self.__EvaluateConditional(Value, self.CurrentLineNumber, 'eval', True)\r
798\r
799 self.__PcdDict[PcdName] = Value\r
800\r
801 self.Profile.PcdDict[PcdPair] = Value\r
802 self.SetPcdLocalation(PcdPair)\r
803 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
804 self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
805\r
806 self.__WipeOffArea.append(((SetLine, SetOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
807 elif self.__Token in ('!ifdef', '!ifndef', '!if'):\r
808 IfStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))\r
809 IfList.append([IfStartPos, None, None])\r
810\r
811 CondLabel = self.__Token\r
812 Expression = self.__GetExpression()\r
813\r
814 if CondLabel == '!if':\r
815 ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'eval')\r
816 else:\r
817 ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'in')\r
818 if CondLabel == '!ifndef':\r
819 ConditionSatisfied = not ConditionSatisfied\r
820\r
821 BranchDetermined = ConditionSatisfied\r
822 IfList[-1] = [IfList[-1][0], ConditionSatisfied, BranchDetermined]\r
823 if ConditionSatisfied:\r
824 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
825 elif self.__Token in ('!elseif', '!else'):\r
826 ElseStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))\r
827 if len(IfList) <= 0:\r
828 raise Warning("Missing !if statement", self.FileName, self.CurrentLineNumber)\r
829\r
830 if IfList[-1][1]:\r
831 IfList[-1] = [ElseStartPos, False, True]\r
832 self.__WipeOffArea.append((ElseStartPos, (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
833 else:\r
834 self.__WipeOffArea.append((IfList[-1][0], ElseStartPos))\r
835 IfList[-1] = [ElseStartPos, True, IfList[-1][2]]\r
836 if self.__Token == '!elseif':\r
837 Expression = self.__GetExpression()\r
838 ConditionSatisfied = self.__EvaluateConditional(Expression, IfList[-1][0][0] + 1, 'eval')\r
839 IfList[-1] = [IfList[-1][0], ConditionSatisfied, IfList[-1][2]]\r
840\r
841 if IfList[-1][1]:\r
842 if IfList[-1][2]:\r
843 IfList[-1][1] = False\r
844 else:\r
845 IfList[-1][2] = True\r
846 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
847 elif self.__Token == '!endif':\r
848 if len(IfList) <= 0:\r
849 raise Warning("Missing !if statement", self.FileName, self.CurrentLineNumber)\r
850 if IfList[-1][1]:\r
851 self.__WipeOffArea.append(((self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len('!endif')), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
852 else:\r
853 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))\r
854\r
855 IfList.pop()\r
856 elif not IfList: # Don't use PCDs inside conditional directive\r
857 if self.CurrentLineNumber <= RegionLayoutLine:\r
858 # Don't try the same line twice\r
859 continue\r
860 SetPcd = ShortcutPcdPattern.match(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
861 if SetPcd:\r
862 self.__PcdDict[SetPcd.group('name')] = SetPcd.group('value')\r
863 RegionLayoutLine = self.CurrentLineNumber\r
864 continue\r
865 RegionSize = RegionSizePattern.match(self.Profile.FileLinesList[self.CurrentLineNumber - 1])\r
866 if not RegionSize:\r
867 RegionLayoutLine = self.CurrentLineNumber\r
868 continue\r
869 RegionSizeGuid = RegionSizeGuidPattern.match(self.Profile.FileLinesList[self.CurrentLineNumber])\r
870 if not RegionSizeGuid:\r
871 RegionLayoutLine = self.CurrentLineNumber + 1\r
872 continue\r
873 self.__PcdDict[RegionSizeGuid.group('base')] = RegionSize.group('base')\r
874 self.__PcdDict[RegionSizeGuid.group('size')] = RegionSize.group('size')\r
875 RegionLayoutLine = self.CurrentLineNumber + 1\r
876\r
877 if IfList:\r
878 raise Warning("Missing !endif", self.FileName, self.CurrentLineNumber)\r
879 self.Rewind()\r
880\r
881 def __CollectMacroPcd(self):\r
882 MacroDict = {}\r
883\r
884 # PCD macro\r
885 MacroDict.update(GlobalData.gPlatformPcds)\r
886 MacroDict.update(self.__PcdDict)\r
887\r
888 # Lowest priority\r
889 MacroDict.update(GlobalData.gPlatformDefines)\r
890\r
891 if self.__CurSection:\r
892 # Defines macro\r
893 ScopeMacro = self.__MacroDict[TAB_COMMON, TAB_COMMON, TAB_COMMON]\r
894 if ScopeMacro:\r
895 MacroDict.update(ScopeMacro)\r
896\r
897 # Section macro\r
898 ScopeMacro = self.__MacroDict[\r
899 self.__CurSection[0],\r
900 self.__CurSection[1],\r
901 self.__CurSection[2]\r
902 ]\r
903 if ScopeMacro:\r
904 MacroDict.update(ScopeMacro)\r
905\r
906 MacroDict.update(GlobalData.gGlobalDefines)\r
907 MacroDict.update(GlobalData.gCommandLineDefines)\r
908 if GlobalData.BuildOptionPcd:\r
909 for Item in GlobalData.BuildOptionPcd:\r
910 if isinstance(Item, tuple):\r
911 continue\r
912 PcdName, TmpValue = Item.split("=")\r
913 TmpValue = BuildOptionValue(TmpValue, {})\r
914 MacroDict[PcdName.strip()] = TmpValue\r
915 # Highest priority\r
916\r
917 return MacroDict\r
918\r
919 def __EvaluateConditional(self, Expression, Line, Op = None, Value = None):\r
920 MacroPcdDict = self.__CollectMacroPcd()\r
921 if Op == 'eval':\r
922 try:\r
923 if Value:\r
924 return ValueExpression(Expression, MacroPcdDict)(True)\r
925 else:\r
926 return ValueExpression(Expression, MacroPcdDict)()\r
927 except WrnExpression as Excpt:\r
928 #\r
929 # Catch expression evaluation warning here. We need to report\r
930 # the precise number of line and return the evaluation result\r
931 #\r
932 EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),\r
933 File=self.FileName, ExtraData=self.__CurrentLine(),\r
934 Line=Line)\r
935 return Excpt.result\r
936 except Exception as Excpt:\r
937 if hasattr(Excpt, 'Pcd'):\r
938 if Excpt.Pcd in GlobalData.gPlatformOtherPcds:\r
939 Info = GlobalData.gPlatformOtherPcds[Excpt.Pcd]\r
940 raise Warning("Cannot use this PCD (%s) in an expression as"\r
941 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"\r
942 " of the DSC file (%s), and it is currently defined in this section:"\r
943 " %s, line #: %d." % (Excpt.Pcd, GlobalData.gPlatformOtherPcds['DSCFILE'], Info[0], Info[1]),\r
944 self.FileName, Line)\r
945 else:\r
946 raise Warning("PCD (%s) is not defined in DSC file (%s)" % (Excpt.Pcd, GlobalData.gPlatformOtherPcds['DSCFILE']),\r
947 self.FileName, Line)\r
948 else:\r
949 raise Warning(str(Excpt), self.FileName, Line)\r
950 else:\r
951 if Expression.startswith('$(') and Expression[-1] == ')':\r
952 Expression = Expression[2:-1]\r
953 return Expression in MacroPcdDict\r
954\r
955 ## __IsToken() method\r
956 #\r
957 # Check whether input string is found from current char position along\r
958 # If found, the string value is put into self.__Token\r
959 #\r
960 # @param self The object pointer\r
961 # @param String The string to search\r
962 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive\r
963 # @retval True Successfully find string, file buffer pointer moved forward\r
964 # @retval False Not able to find string, file buffer pointer not changed\r
965 #\r
966 def __IsToken(self, String, IgnoreCase = False):\r
967 self.__SkipWhiteSpace()\r
968\r
969 # Only consider the same line, no multi-line token allowed\r
970 StartPos = self.CurrentOffsetWithinLine\r
971 index = -1\r
972 if IgnoreCase:\r
973 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())\r
974 else:\r
975 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)\r
976 if index == 0:\r
977 self.CurrentOffsetWithinLine += len(String)\r
978 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
979 return True\r
980 return False\r
981\r
982 ## __IsKeyword() method\r
983 #\r
984 # Check whether input keyword is found from current char position along, whole word only!\r
985 # If found, the string value is put into self.__Token\r
986 #\r
987 # @param self The object pointer\r
988 # @param Keyword The string to search\r
989 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive\r
990 # @retval True Successfully find string, file buffer pointer moved forward\r
991 # @retval False Not able to find string, file buffer pointer not changed\r
992 #\r
993 def __IsKeyword(self, KeyWord, IgnoreCase = False):\r
994 self.__SkipWhiteSpace()\r
995\r
996 # Only consider the same line, no multi-line token allowed\r
997 StartPos = self.CurrentOffsetWithinLine\r
998 index = -1\r
999 if IgnoreCase:\r
1000 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(KeyWord.upper())\r
1001 else:\r
1002 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(KeyWord)\r
1003 if index == 0:\r
1004 followingChar = self.__CurrentLine()[self.CurrentOffsetWithinLine + len(KeyWord)]\r
1005 if not str(followingChar).isspace() and followingChar not in SEPERATOR_TUPLE:\r
1006 return False\r
1007 self.CurrentOffsetWithinLine += len(KeyWord)\r
1008 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
1009 return True\r
1010 return False\r
1011\r
1012 def __GetExpression(self):\r
1013 Line = self.Profile.FileLinesList[self.CurrentLineNumber - 1]\r
1014 Index = len(Line) - 1\r
1015 while Line[Index] in ['\r', '\n']:\r
1016 Index -= 1\r
1017 ExpressionString = self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine:Index+1]\r
1018 self.CurrentOffsetWithinLine += len(ExpressionString)\r
1019 ExpressionString = ExpressionString.strip()\r
1020 return ExpressionString\r
1021\r
1022 ## __GetNextWord() method\r
1023 #\r
1024 # Get next C name from file lines\r
1025 # If found, the string value is put into self.__Token\r
1026 #\r
1027 # @param self The object pointer\r
1028 # @retval True Successfully find a C name string, file buffer pointer moved forward\r
1029 # @retval False Not able to find a C name string, file buffer pointer not changed\r
1030 #\r
1031 def __GetNextWord(self):\r
1032 self.__SkipWhiteSpace()\r
1033 if self.__EndOfFile():\r
1034 return False\r
1035\r
1036 TempChar = self.__CurrentChar()\r
1037 StartPos = self.CurrentOffsetWithinLine\r
1038 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') or TempChar == '_':\r
1039 self.__GetOneChar()\r
1040 while not self.__EndOfLine():\r
1041 TempChar = self.__CurrentChar()\r
1042 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') \\r
1043 or (TempChar >= '0' and TempChar <= '9') or TempChar == '_' or TempChar == '-':\r
1044 self.__GetOneChar()\r
1045\r
1046 else:\r
1047 break\r
1048\r
1049 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
1050 return True\r
1051\r
1052 return False\r
1053\r
1054 def __GetNextPcdWord(self):\r
1055 self.__SkipWhiteSpace()\r
1056 if self.__EndOfFile():\r
1057 return False\r
1058\r
1059 TempChar = self.__CurrentChar()\r
1060 StartPos = self.CurrentOffsetWithinLine\r
1061 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') or TempChar == '_' or TempChar == '[' or TempChar == ']':\r
1062 self.__GetOneChar()\r
1063 while not self.__EndOfLine():\r
1064 TempChar = self.__CurrentChar()\r
1065 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') \\r
1066 or (TempChar >= '0' and TempChar <= '9') or TempChar == '_' or TempChar == '-' or TempChar == '[' or TempChar == ']':\r
1067 self.__GetOneChar()\r
1068\r
1069 else:\r
1070 break\r
1071\r
1072 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
1073 return True\r
1074\r
1075 return False\r
1076\r
1077 ## __GetNextToken() method\r
1078 #\r
1079 # Get next token unit before a seperator\r
1080 # If found, the string value is put into self.__Token\r
1081 #\r
1082 # @param self The object pointer\r
1083 # @retval True Successfully find a token unit, file buffer pointer moved forward\r
1084 # @retval False Not able to find a token unit, file buffer pointer not changed\r
1085 #\r
1086 def __GetNextToken(self):\r
1087 # Skip leading spaces, if exist.\r
1088 self.__SkipWhiteSpace()\r
1089 if self.__EndOfFile():\r
1090 return False\r
1091 # Record the token start position, the position of the first non-space char.\r
1092 StartPos = self.CurrentOffsetWithinLine\r
1093 StartLine = self.CurrentLineNumber\r
1094 while StartLine == self.CurrentLineNumber:\r
1095 TempChar = self.__CurrentChar()\r
1096 # Try to find the end char that is not a space and not in seperator tuple.\r
1097 # That is, when we got a space or any char in the tuple, we got the end of token.\r
1098 if not str(TempChar).isspace() and TempChar not in SEPERATOR_TUPLE:\r
1099 self.__GetOneChar()\r
1100 # if we happen to meet a seperator as the first char, we must proceed to get it.\r
1101 # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.\r
1102 elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:\r
1103 self.__GetOneChar()\r
1104 break\r
1105 else:\r
1106 break\r
1107# else:\r
1108# return False\r
1109\r
1110 EndPos = self.CurrentOffsetWithinLine\r
1111 if self.CurrentLineNumber != StartLine:\r
1112 EndPos = len(self.Profile.FileLinesList[StartLine-1])\r
1113 self.__Token = self.Profile.FileLinesList[StartLine-1][StartPos : EndPos]\r
1114 if StartPos != self.CurrentOffsetWithinLine:\r
1115 return True\r
1116 else:\r
1117 return False\r
1118\r
1119 def __GetNextOp(self):\r
1120 # Skip leading spaces, if exist.\r
1121 self.__SkipWhiteSpace()\r
1122 if self.__EndOfFile():\r
1123 return False\r
1124 # Record the token start position, the position of the first non-space char.\r
1125 StartPos = self.CurrentOffsetWithinLine\r
1126 while not self.__EndOfLine():\r
1127 TempChar = self.__CurrentChar()\r
1128 # Try to find the end char that is not a space\r
1129 if not str(TempChar).isspace():\r
1130 self.__GetOneChar()\r
1131 else:\r
1132 break\r
1133 else:\r
1134 return False\r
1135\r
1136 if StartPos != self.CurrentOffsetWithinLine:\r
1137 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]\r
1138 return True\r
1139 else:\r
1140 return False\r
1141 ## __GetNextGuid() method\r
1142 #\r
1143 # Get next token unit before a seperator\r
1144 # If found, the GUID string is put into self.__Token\r
1145 #\r
1146 # @param self The object pointer\r
1147 # @retval True Successfully find a registry format GUID, file buffer pointer moved forward\r
1148 # @retval False Not able to find a registry format GUID, file buffer pointer not changed\r
1149 #\r
1150 def __GetNextGuid(self):\r
1151\r
1152 if not self.__GetNextToken():\r
1153 return False\r
1154 if gGuidPattern.match(self.__Token) is not None:\r
1155 return True\r
1156 else:\r
1157 self.__UndoToken()\r
1158 return False\r
1159\r
1160 @staticmethod\r
1161 def __Verify(Name, Value, Scope):\r
1162 # value verification only applies to numeric values.\r
1163 if Scope not in TAB_PCD_NUMERIC_TYPES:\r
1164 return\r
1165\r
1166 ValueNumber = 0\r
1167 try:\r
1168 ValueNumber = int(Value, 0)\r
1169 except:\r
1170 EdkLogger.error("FdfParser", FORMAT_INVALID, "The value is not valid dec or hex number for %s." % Name)\r
1171 if ValueNumber < 0:\r
1172 EdkLogger.error("FdfParser", FORMAT_INVALID, "The value can't be set to negative value for %s." % Name)\r
1173 if ValueNumber > MAX_VAL_TYPE[Scope]:\r
1174 EdkLogger.error("FdfParser", FORMAT_INVALID, "Too large value for %s." % Name)\r
1175 return True\r
1176\r
1177 ## __UndoToken() method\r
1178 #\r
1179 # Go back one token unit in file buffer\r
1180 #\r
1181 # @param self The object pointer\r
1182 #\r
1183 def __UndoToken(self):\r
1184 self.__UndoOneChar()\r
1185 while self.__CurrentChar().isspace():\r
1186 if not self.__UndoOneChar():\r
1187 self.__GetOneChar()\r
1188 return\r
1189\r
1190\r
1191 StartPos = self.CurrentOffsetWithinLine\r
1192 CurrentLine = self.CurrentLineNumber\r
1193 while CurrentLine == self.CurrentLineNumber:\r
1194\r
1195 TempChar = self.__CurrentChar()\r
1196 # Try to find the end char that is not a space and not in seperator tuple.\r
1197 # That is, when we got a space or any char in the tuple, we got the end of token.\r
1198 if not str(TempChar).isspace() and not TempChar in SEPERATOR_TUPLE:\r
1199 if not self.__UndoOneChar():\r
1200 return\r
1201 # if we happen to meet a seperator as the first char, we must proceed to get it.\r
1202 # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.\r
1203 elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:\r
1204 return\r
1205 else:\r
1206 break\r
1207\r
1208 self.__GetOneChar()\r
1209\r
1210 ## __GetNextHexNumber() method\r
1211 #\r
1212 # Get next HEX data before a seperator\r
1213 # If found, the HEX data is put into self.__Token\r
1214 #\r
1215 # @param self The object pointer\r
1216 # @retval True Successfully find a HEX data, file buffer pointer moved forward\r
1217 # @retval False Not able to find a HEX data, file buffer pointer not changed\r
1218 #\r
1219 def __GetNextHexNumber(self):\r
1220 if not self.__GetNextToken():\r
1221 return False\r
1222 if gHexPatternAll.match(self.__Token):\r
1223 return True\r
1224 else:\r
1225 self.__UndoToken()\r
1226 return False\r
1227\r
1228 ## __GetNextDecimalNumber() method\r
1229 #\r
1230 # Get next decimal data before a seperator\r
1231 # If found, the decimal data is put into self.__Token\r
1232 #\r
1233 # @param self The object pointer\r
1234 # @retval True Successfully find a decimal data, file buffer pointer moved forward\r
1235 # @retval False Not able to find a decimal data, file buffer pointer not changed\r
1236 #\r
1237 def __GetNextDecimalNumber(self):\r
1238 if not self.__GetNextToken():\r
1239 return False\r
1240 if self.__Token.isdigit():\r
1241 return True\r
1242 else:\r
1243 self.__UndoToken()\r
1244 return False\r
1245\r
1246 ## __GetNextPcdName() method\r
1247 #\r
1248 # Get next PCD token space C name and PCD C name pair before a seperator\r
1249 # If found, the decimal data is put into self.__Token\r
1250 #\r
1251 # @param self The object pointer\r
1252 # @retval Tuple PCD C name and PCD token space C name pair\r
1253 #\r
1254 def __GetNextPcdName(self):\r
1255 if not self.__GetNextWord():\r
1256 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1257 pcdTokenSpaceCName = self.__Token\r
1258\r
1259 if not self.__IsToken( "."):\r
1260 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1261\r
1262 if not self.__GetNextWord():\r
1263 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1264 pcdCName = self.__Token\r
1265\r
1266 return (pcdCName, pcdTokenSpaceCName)\r
1267\r
1268 def __GetNextPcdSettings(self):\r
1269 if not self.__GetNextWord():\r
1270 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1271 pcdTokenSpaceCName = self.__Token\r
1272\r
1273 if not self.__IsToken( "."):\r
1274 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1275\r
1276 if not self.__GetNextWord():\r
1277 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1278 pcdCName = self.__Token\r
1279\r
1280 Fields = []\r
1281 while self.__IsToken("."):\r
1282 if not self.__GetNextPcdWord():\r
1283 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)\r
1284 Fields.append(self.__Token)\r
1285\r
1286 return (pcdCName, pcdTokenSpaceCName,".".join(Fields))\r
1287\r
1288 ## __GetStringData() method\r
1289 #\r
1290 # Get string contents quoted in ""\r
1291 # If found, the decimal data is put into self.__Token\r
1292 #\r
1293 # @param self The object pointer\r
1294 # @retval True Successfully find a string data, file buffer pointer moved forward\r
1295 # @retval False Not able to find a string data, file buffer pointer not changed\r
1296 #\r
1297 def __GetStringData(self):\r
1298 if self.__Token.startswith("\"") or self.__Token.startswith("L\""):\r
1299 self.__UndoToken()\r
1300 self.__SkipToToken("\"")\r
1301 currentLineNumber = self.CurrentLineNumber\r
1302\r
1303 if not self.__SkipToToken("\""):\r
1304 raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)\r
1305 if currentLineNumber != self.CurrentLineNumber:\r
1306 raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)\r
1307 self.__Token = self.__SkippedChars.rstrip('\"')\r
1308 return True\r
1309\r
1310 elif self.__Token.startswith("\'") or self.__Token.startswith("L\'"):\r
1311 self.__UndoToken()\r
1312 self.__SkipToToken("\'")\r
1313 currentLineNumber = self.CurrentLineNumber\r
1314\r
1315 if not self.__SkipToToken("\'"):\r
1316 raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)\r
1317 if currentLineNumber != self.CurrentLineNumber:\r
1318 raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)\r
1319 self.__Token = self.__SkippedChars.rstrip('\'')\r
1320 return True\r
1321\r
1322 else:\r
1323 return False\r
1324\r
1325 ## __SkipToToken() method\r
1326 #\r
1327 # Search forward in file buffer for the string\r
1328 # The skipped chars are put into self.__SkippedChars\r
1329 #\r
1330 # @param self The object pointer\r
1331 # @param String The string to search\r
1332 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive\r
1333 # @retval True Successfully find the string, file buffer pointer moved forward\r
1334 # @retval False Not able to find the string, file buffer pointer not changed\r
1335 #\r
1336 def __SkipToToken(self, String, IgnoreCase = False):\r
1337 StartPos = self.GetFileBufferPos()\r
1338\r
1339 self.__SkippedChars = ""\r
1340 while not self.__EndOfFile():\r
1341 index = -1\r
1342 if IgnoreCase:\r
1343 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())\r
1344 else:\r
1345 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)\r
1346 if index == 0:\r
1347 self.CurrentOffsetWithinLine += len(String)\r
1348 self.__SkippedChars += String\r
1349 return True\r
1350 self.__SkippedChars += str(self.__CurrentChar())\r
1351 self.__GetOneChar()\r
1352\r
1353 self.SetFileBufferPos( StartPos)\r
1354 self.__SkippedChars = ""\r
1355 return False\r
1356\r
1357 ## GetFileBufferPos() method\r
1358 #\r
1359 # Return the tuple of current line and offset within the line\r
1360 #\r
1361 # @param self The object pointer\r
1362 # @retval Tuple Line number and offset pair\r
1363 #\r
1364 def GetFileBufferPos(self):\r
1365 return (self.CurrentLineNumber, self.CurrentOffsetWithinLine)\r
1366\r
1367 ## SetFileBufferPos() method\r
1368 #\r
1369 # Restore the file buffer position\r
1370 #\r
1371 # @param self The object pointer\r
1372 # @param Pos The new file buffer position\r
1373 #\r
1374 def SetFileBufferPos(self, Pos):\r
1375 (self.CurrentLineNumber, self.CurrentOffsetWithinLine) = Pos\r
1376\r
1377 ## Preprocess() method\r
1378 #\r
1379 # Preprocess comment, conditional directive, include directive, replace macro.\r
1380 # Exception will be raised if syntax error found\r
1381 #\r
1382 # @param self The object pointer\r
1383 #\r
1384 def Preprocess(self):\r
1385 self.__StringToList()\r
1386 self.PreprocessFile()\r
1387 self.PreprocessIncludeFile()\r
1388 self.__StringToList()\r
1389 self.PreprocessFile()\r
1390 self.PreprocessConditionalStatement()\r
1391 self.__StringToList()\r
1392 for Pos in self.__WipeOffArea:\r
1393 self.__ReplaceFragment(Pos[0], Pos[1])\r
1394 self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]\r
1395\r
1396 while self.__GetDefines():\r
1397 pass\r
1398\r
1399 ## ParseFile() method\r
1400 #\r
1401 # Parse the file profile buffer to extract fd, fv ... information\r
1402 # Exception will be raised if syntax error found\r
1403 #\r
1404 # @param self The object pointer\r
1405 #\r
1406 def ParseFile(self):\r
1407\r
1408 try:\r
1409 self.Preprocess()\r
1410 self.__GetError()\r
1411 #\r
1412 # Keep processing sections of the FDF until no new sections or a syntax error is found\r
1413 #\r
1414 while self.__GetFd() or self.__GetFv() or self.__GetFmp() or self.__GetCapsule() or self.__GetVtf() or self.__GetRule() or self.__GetOptionRom():\r
1415 pass\r
1416\r
1417 except Warning as X:\r
1418 self.__UndoToken()\r
1419 #'\n\tGot Token: \"%s\" from File %s\n' % (self.__Token, FileLineTuple[0]) + \\r
1420 # At this point, the closest parent would be the included file itself\r
1421 Profile = GetParentAtLine(X.OriginalLineNumber)\r
1422 if Profile is not None:\r
1423 X.Message += ' near line %d, column %d: %s' \\r
1424 % (X.LineNumber, 0, Profile.FileLinesList[X.LineNumber-1])\r
1425 else:\r
1426 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1427 X.Message += ' near line %d, column %d: %s' \\r
1428 % (FileLineTuple[1], self.CurrentOffsetWithinLine + 1, self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :].rstrip('\n').rstrip('\r'))\r
1429 raise\r
1430\r
1431 ## SectionParser() method\r
1432 #\r
1433 # Parse the file section info\r
1434 # Exception will be raised if syntax error found\r
1435 #\r
1436 # @param self The object pointer\r
1437 # @param section The section string\r
1438\r
1439 def SectionParser(self, section):\r
1440 S = section.upper()\r
1441 if not S.startswith("[DEFINES") and not S.startswith("[FD.") and not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \\r
1442 and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM.") and not S.startswith('[FMPPAYLOAD.'):\r
1443 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [DEFINES], [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.], [FMPPAYLOAD.])", self.FileName, self.CurrentLineNumber)\r
1444\r
1445 ## __GetDefines() method\r
1446 #\r
1447 # Get Defines section contents and store its data into AllMacrosList\r
1448 #\r
1449 # @param self The object pointer\r
1450 # @retval True Successfully find a Defines\r
1451 # @retval False Not able to find a Defines\r
1452 #\r
1453 def __GetDefines(self):\r
1454\r
1455 if not self.__GetNextToken():\r
1456 return False\r
1457\r
1458 S = self.__Token.upper()\r
1459 if S.startswith("[") and not S.startswith("[DEFINES"):\r
1460 self.SectionParser(S)\r
1461 self.__UndoToken()\r
1462 return False\r
1463\r
1464 self.__UndoToken()\r
1465 if not self.__IsToken("[DEFINES", True):\r
1466 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1467 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
1468 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
1469 raise Warning("expected [DEFINES", self.FileName, self.CurrentLineNumber)\r
1470\r
1471 if not self.__IsToken( "]"):\r
1472 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
1473\r
1474 while self.__GetNextWord():\r
1475 # handle the SET statement\r
1476 if self.__Token == 'SET':\r
1477 self.__UndoToken()\r
1478 self.__GetSetStatement(None)\r
1479 continue\r
1480\r
1481 Macro = self.__Token\r
1482\r
1483 if not self.__IsToken("="):\r
1484 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1485 if not self.__GetNextToken() or self.__Token.startswith('['):\r
1486 raise Warning("expected MACRO value", self.FileName, self.CurrentLineNumber)\r
1487 Value = self.__Token\r
1488\r
1489 return False\r
1490\r
1491 ##__GetError() method\r
1492 def __GetError(self):\r
1493 #save the Current information\r
1494 CurrentLine = self.CurrentLineNumber\r
1495 CurrentOffset = self.CurrentOffsetWithinLine\r
1496 while self.__GetNextToken():\r
1497 if self.__Token == TAB_ERROR:\r
1498 EdkLogger.error('FdfParser', ERROR_STATEMENT, self.__CurrentLine().replace(TAB_ERROR, '', 1), File=self.FileName, Line=self.CurrentLineNumber)\r
1499 self.CurrentLineNumber = CurrentLine\r
1500 self.CurrentOffsetWithinLine = CurrentOffset\r
1501\r
1502 ## __GetFd() method\r
1503 #\r
1504 # Get FD section contents and store its data into FD dictionary of self.Profile\r
1505 #\r
1506 # @param self The object pointer\r
1507 # @retval True Successfully find a FD\r
1508 # @retval False Not able to find a FD\r
1509 #\r
1510 def __GetFd(self):\r
1511\r
1512 if not self.__GetNextToken():\r
1513 return False\r
1514\r
1515 S = self.__Token.upper()\r
1516 if S.startswith("[") and not S.startswith("[FD."):\r
1517 if not S.startswith("[FV.") and not S.startswith('[FMPPAYLOAD.') and not S.startswith("[CAPSULE.") \\r
1518 and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
1519 raise Warning("Unknown section", self.FileName, self.CurrentLineNumber)\r
1520 self.__UndoToken()\r
1521 return False\r
1522\r
1523 self.__UndoToken()\r
1524 if not self.__IsToken("[FD.", True):\r
1525 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1526 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
1527 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
1528 raise Warning("expected [FD.]", self.FileName, self.CurrentLineNumber)\r
1529\r
1530 FdName = self.__GetUiName()\r
1531 if FdName == "":\r
1532 if len (self.Profile.FdDict) == 0:\r
1533 FdName = GenFdsGlobalVariable.PlatformName\r
1534 if FdName == "" and GlobalData.gActivePlatform:\r
1535 FdName = GlobalData.gActivePlatform.PlatformName\r
1536 self.Profile.FdNameNotSet = True\r
1537 else:\r
1538 raise Warning("expected FdName in [FD.] section", self.FileName, self.CurrentLineNumber)\r
1539 self.CurrentFdName = FdName.upper()\r
1540\r
1541 if self.CurrentFdName in self.Profile.FdDict:\r
1542 raise Warning("Unexpected the same FD name", self.FileName, self.CurrentLineNumber)\r
1543\r
1544 if not self.__IsToken( "]"):\r
1545 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
1546\r
1547 FdObj = Fd.FD()\r
1548 FdObj.FdUiName = self.CurrentFdName\r
1549 self.Profile.FdDict[self.CurrentFdName] = FdObj\r
1550\r
1551 if len (self.Profile.FdDict) > 1 and self.Profile.FdNameNotSet:\r
1552 raise Warning("expected all FDs have their name", self.FileName, self.CurrentLineNumber)\r
1553\r
1554 Status = self.__GetCreateFile(FdObj)\r
1555 if not Status:\r
1556 raise Warning("FD name error", self.FileName, self.CurrentLineNumber)\r
1557\r
1558 while self.__GetTokenStatements(FdObj):\r
1559 pass\r
1560 for Attr in ("BaseAddress", "Size", "ErasePolarity"):\r
1561 if getattr(FdObj, Attr) is None:\r
1562 self.__GetNextToken()\r
1563 raise Warning("Keyword %s missing" % Attr, self.FileName, self.CurrentLineNumber)\r
1564\r
1565 if not FdObj.BlockSizeList:\r
1566 FdObj.BlockSizeList.append((1, FdObj.Size, None))\r
1567\r
1568 self.__GetDefineStatements(FdObj)\r
1569\r
1570 self.__GetSetStatements(FdObj)\r
1571\r
1572 if not self.__GetRegionLayout(FdObj):\r
1573 raise Warning("expected region layout", self.FileName, self.CurrentLineNumber)\r
1574\r
1575 while self.__GetRegionLayout(FdObj):\r
1576 pass\r
1577 return True\r
1578\r
1579 ## __GetUiName() method\r
1580 #\r
1581 # Return the UI name of a section\r
1582 #\r
1583 # @param self The object pointer\r
1584 # @retval FdName UI name\r
1585 #\r
1586 def __GetUiName(self):\r
1587 Name = ""\r
1588 if self.__GetNextWord():\r
1589 Name = self.__Token\r
1590\r
1591 return Name\r
1592\r
1593 ## __GetCreateFile() method\r
1594 #\r
1595 # Return the output file name of object\r
1596 #\r
1597 # @param self The object pointer\r
1598 # @param Obj object whose data will be stored in file\r
1599 # @retval FdName UI name\r
1600 #\r
1601 def __GetCreateFile(self, Obj):\r
1602\r
1603 if self.__IsKeyword( "CREATE_FILE"):\r
1604 if not self.__IsToken( "="):\r
1605 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1606\r
1607 if not self.__GetNextToken():\r
1608 raise Warning("expected file name", self.FileName, self.CurrentLineNumber)\r
1609\r
1610 FileName = self.__Token\r
1611 Obj.CreateFileName = FileName\r
1612\r
1613 return True\r
1614\r
1615 def SetPcdLocalation(self,pcdpair):\r
1616 self.Profile.PcdLocalDict[pcdpair] = (self.Profile.FileName,self.CurrentLineNumber)\r
1617\r
1618 ## __GetTokenStatements() method\r
1619 #\r
1620 # Get token statements\r
1621 #\r
1622 # @param self The object pointer\r
1623 # @param Obj for whom token statement is got\r
1624 #\r
1625 def __GetTokenStatements(self, Obj):\r
1626 if self.__IsKeyword( "BaseAddress"):\r
1627 if not self.__IsToken( "="):\r
1628 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1629\r
1630 if not self.__GetNextHexNumber():\r
1631 raise Warning("expected Hex base address", self.FileName, self.CurrentLineNumber)\r
1632\r
1633 Obj.BaseAddress = self.__Token\r
1634\r
1635 if self.__IsToken( "|"):\r
1636 pcdPair = self.__GetNextPcdSettings()\r
1637 Obj.BaseAddressPcd = pcdPair\r
1638 self.Profile.PcdDict[pcdPair] = Obj.BaseAddress\r
1639 self.SetPcdLocalation(pcdPair)\r
1640 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1641 self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
1642 return True\r
1643\r
1644 if self.__IsKeyword( "Size"):\r
1645 if not self.__IsToken( "="):\r
1646 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1647\r
1648 if not self.__GetNextHexNumber():\r
1649 raise Warning("expected Hex size", self.FileName, self.CurrentLineNumber)\r
1650\r
1651 Size = self.__Token\r
1652 if self.__IsToken( "|"):\r
1653 pcdPair = self.__GetNextPcdSettings()\r
1654 Obj.SizePcd = pcdPair\r
1655 self.Profile.PcdDict[pcdPair] = Size\r
1656 self.SetPcdLocalation(pcdPair)\r
1657 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1658 self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
1659 Obj.Size = long(Size, 0)\r
1660 return True\r
1661\r
1662 if self.__IsKeyword( "ErasePolarity"):\r
1663 if not self.__IsToken( "="):\r
1664 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1665\r
1666 if not self.__GetNextToken():\r
1667 raise Warning("expected Erase Polarity", self.FileName, self.CurrentLineNumber)\r
1668\r
1669 if self.__Token != "1" and self.__Token != "0":\r
1670 raise Warning("expected 1 or 0 Erase Polarity", self.FileName, self.CurrentLineNumber)\r
1671\r
1672 Obj.ErasePolarity = self.__Token\r
1673 return True\r
1674\r
1675 return self.__GetBlockStatements(Obj)\r
1676\r
1677 ## __GetAddressStatements() method\r
1678 #\r
1679 # Get address statements\r
1680 #\r
1681 # @param self The object pointer\r
1682 # @param Obj for whom address statement is got\r
1683 # @retval True Successfully find\r
1684 # @retval False Not able to find\r
1685 #\r
1686 def __GetAddressStatements(self, Obj):\r
1687\r
1688 if self.__IsKeyword("BsBaseAddress"):\r
1689 if not self.__IsToken( "="):\r
1690 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1691\r
1692 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
1693 raise Warning("expected address", self.FileName, self.CurrentLineNumber)\r
1694\r
1695 BsAddress = long(self.__Token, 0)\r
1696 Obj.BsBaseAddress = BsAddress\r
1697\r
1698 if self.__IsKeyword("RtBaseAddress"):\r
1699 if not self.__IsToken( "="):\r
1700 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1701\r
1702 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
1703 raise Warning("expected address", self.FileName, self.CurrentLineNumber)\r
1704\r
1705 RtAddress = long(self.__Token, 0)\r
1706 Obj.RtBaseAddress = RtAddress\r
1707\r
1708 ## __GetBlockStatements() method\r
1709 #\r
1710 # Get block statements\r
1711 #\r
1712 # @param self The object pointer\r
1713 # @param Obj for whom block statement is got\r
1714 #\r
1715 def __GetBlockStatements(self, Obj):\r
1716 IsBlock = False\r
1717 while self.__GetBlockStatement(Obj):\r
1718 IsBlock = True\r
1719\r
1720 Item = Obj.BlockSizeList[-1]\r
1721 if Item[0] is None or Item[1] is None:\r
1722 raise Warning("expected block statement", self.FileName, self.CurrentLineNumber)\r
1723 return IsBlock\r
1724\r
1725 ## __GetBlockStatement() method\r
1726 #\r
1727 # Get block statement\r
1728 #\r
1729 # @param self The object pointer\r
1730 # @param Obj for whom block statement is got\r
1731 # @retval True Successfully find\r
1732 # @retval False Not able to find\r
1733 #\r
1734 def __GetBlockStatement(self, Obj):\r
1735 if not self.__IsKeyword( "BlockSize"):\r
1736 return False\r
1737\r
1738 if not self.__IsToken( "="):\r
1739 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1740\r
1741 if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():\r
1742 raise Warning("expected Hex or Integer block size", self.FileName, self.CurrentLineNumber)\r
1743\r
1744 BlockSize = self.__Token\r
1745 BlockSizePcd = None\r
1746 if self.__IsToken( "|"):\r
1747 PcdPair = self.__GetNextPcdSettings()\r
1748 BlockSizePcd = PcdPair\r
1749 self.Profile.PcdDict[PcdPair] = BlockSize\r
1750 self.SetPcdLocalation(PcdPair)\r
1751 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1752 self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
1753 BlockSize = long(BlockSize, 0)\r
1754\r
1755 BlockNumber = None\r
1756 if self.__IsKeyword( "NumBlocks"):\r
1757 if not self.__IsToken( "="):\r
1758 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1759\r
1760 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():\r
1761 raise Warning("expected block numbers", self.FileName, self.CurrentLineNumber)\r
1762\r
1763 BlockNumber = long(self.__Token, 0)\r
1764\r
1765 Obj.BlockSizeList.append((BlockSize, BlockNumber, BlockSizePcd))\r
1766 return True\r
1767\r
1768 ## __GetDefineStatements() method\r
1769 #\r
1770 # Get define statements\r
1771 #\r
1772 # @param self The object pointer\r
1773 # @param Obj for whom define statement is got\r
1774 # @retval True Successfully find\r
1775 # @retval False Not able to find\r
1776 #\r
1777 def __GetDefineStatements(self, Obj):\r
1778 while self.__GetDefineStatement( Obj):\r
1779 pass\r
1780\r
1781 ## __GetDefineStatement() method\r
1782 #\r
1783 # Get define statement\r
1784 #\r
1785 # @param self The object pointer\r
1786 # @param Obj for whom define statement is got\r
1787 # @retval True Successfully find\r
1788 # @retval False Not able to find\r
1789 #\r
1790 def __GetDefineStatement(self, Obj):\r
1791 if self.__IsKeyword("DEFINE"):\r
1792 self.__GetNextToken()\r
1793 Macro = self.__Token\r
1794 if not self.__IsToken( "="):\r
1795 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1796\r
1797 if not self.__GetNextToken():\r
1798 raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
1799\r
1800 Value = self.__Token\r
1801 Macro = '$(' + Macro + ')'\r
1802 Obj.DefineVarDict[Macro] = Value\r
1803 return True\r
1804\r
1805 return False\r
1806\r
1807 ## __GetSetStatements() method\r
1808 #\r
1809 # Get set statements\r
1810 #\r
1811 # @param self The object pointer\r
1812 # @param Obj for whom set statement is got\r
1813 # @retval True Successfully find\r
1814 # @retval False Not able to find\r
1815 #\r
1816 def __GetSetStatements(self, Obj):\r
1817 while self.__GetSetStatement(Obj):\r
1818 pass\r
1819\r
1820 ## __GetSetStatement() method\r
1821 #\r
1822 # Get set statement\r
1823 #\r
1824 # @param self The object pointer\r
1825 # @param Obj for whom set statement is got\r
1826 # @retval True Successfully find\r
1827 # @retval False Not able to find\r
1828 #\r
1829 def __GetSetStatement(self, Obj):\r
1830 if self.__IsKeyword("SET"):\r
1831 PcdPair = self.__GetNextPcdSettings()\r
1832\r
1833 if not self.__IsToken( "="):\r
1834 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1835\r
1836 Value = self.__GetExpression()\r
1837 Value = self.__EvaluateConditional(Value, self.CurrentLineNumber, 'eval', True)\r
1838\r
1839 if Obj:\r
1840 Obj.SetVarDict[PcdPair] = Value\r
1841 self.Profile.PcdDict[PcdPair] = Value\r
1842 self.SetPcdLocalation(PcdPair)\r
1843 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1844 self.Profile.PcdFileLineDict[PcdPair] = FileLineTuple\r
1845 return True\r
1846\r
1847 return False\r
1848\r
1849 ## __CalcRegionExpr(self)\r
1850 #\r
1851 # Calculate expression for offset or size of a region\r
1852 #\r
1853 # @return: None if invalid expression\r
1854 # Calculated number if successfully\r
1855 #\r
1856 def __CalcRegionExpr(self):\r
1857 StartPos = self.GetFileBufferPos()\r
1858 Expr = ''\r
1859 PairCount = 0\r
1860 while not self.__EndOfFile():\r
1861 CurCh = self.__CurrentChar()\r
1862 if CurCh == '(':\r
1863 PairCount += 1\r
1864 elif CurCh == ')':\r
1865 PairCount -= 1\r
1866\r
1867 if CurCh in '|\r\n' and PairCount == 0:\r
1868 break\r
1869 Expr += CurCh\r
1870 self.__GetOneChar()\r
1871 try:\r
1872 return long(\r
1873 ValueExpression(Expr,\r
1874 self.__CollectMacroPcd()\r
1875 )(True), 0)\r
1876 except Exception:\r
1877 self.SetFileBufferPos(StartPos)\r
1878 return None\r
1879\r
1880 ## __GetRegionLayout() method\r
1881 #\r
1882 # Get region layout for FD\r
1883 #\r
1884 # @param self The object pointer\r
1885 # @param Fd for whom region is got\r
1886 # @retval True Successfully find\r
1887 # @retval False Not able to find\r
1888 #\r
1889 def __GetRegionLayout(self, Fd):\r
1890 Offset = self.__CalcRegionExpr()\r
1891 if Offset is None:\r
1892 return False\r
1893\r
1894 RegionObj = Region.Region()\r
1895 RegionObj.Offset = Offset\r
1896 Fd.RegionList.append(RegionObj)\r
1897\r
1898 if not self.__IsToken( "|"):\r
1899 raise Warning("expected '|'", self.FileName, self.CurrentLineNumber)\r
1900\r
1901 Size = self.__CalcRegionExpr()\r
1902 if Size is None:\r
1903 raise Warning("expected Region Size", self.FileName, self.CurrentLineNumber)\r
1904 RegionObj.Size = Size\r
1905\r
1906 if not self.__GetNextWord():\r
1907 return True\r
1908\r
1909 if not self.__Token in ("SET", BINARY_FILE_TYPE_FV, "FILE", "DATA", "CAPSULE", "INF"):\r
1910 #\r
1911 # If next token is a word which is not a valid FV type, it might be part of [PcdOffset[|PcdSize]]\r
1912 # Or it might be next region's offset described by an expression which starts with a PCD.\r
1913 # PcdOffset[|PcdSize] or OffsetPcdExpression|Size\r
1914 #\r
1915 self.__UndoToken()\r
1916 IsRegionPcd = (RegionSizeGuidPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]) or\r
1917 RegionOffsetPcdPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]))\r
1918 if IsRegionPcd:\r
1919 RegionObj.PcdOffset = self.__GetNextPcdSettings()\r
1920 self.Profile.PcdDict[RegionObj.PcdOffset] = "0x%08X" % (RegionObj.Offset + long(Fd.BaseAddress, 0))\r
1921 self.SetPcdLocalation(RegionObj.PcdOffset)\r
1922 self.__PcdDict['%s.%s' % (RegionObj.PcdOffset[1], RegionObj.PcdOffset[0])] = "0x%x" % RegionObj.Offset\r
1923 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1924 self.Profile.PcdFileLineDict[RegionObj.PcdOffset] = FileLineTuple\r
1925 if self.__IsToken( "|"):\r
1926 RegionObj.PcdSize = self.__GetNextPcdSettings()\r
1927 self.Profile.PcdDict[RegionObj.PcdSize] = "0x%08X" % RegionObj.Size\r
1928 self.SetPcdLocalation(RegionObj.PcdSize)\r
1929 self.__PcdDict['%s.%s' % (RegionObj.PcdSize[1], RegionObj.PcdSize[0])] = "0x%x" % RegionObj.Size\r
1930 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
1931 self.Profile.PcdFileLineDict[RegionObj.PcdSize] = FileLineTuple\r
1932\r
1933 if not self.__GetNextWord():\r
1934 return True\r
1935\r
1936 if self.__Token == "SET":\r
1937 self.__UndoToken()\r
1938 self.__GetSetStatements( RegionObj)\r
1939 if not self.__GetNextWord():\r
1940 return True\r
1941\r
1942 elif self.__Token == BINARY_FILE_TYPE_FV:\r
1943 self.__UndoToken()\r
1944 self.__GetRegionFvType( RegionObj)\r
1945\r
1946 elif self.__Token == "CAPSULE":\r
1947 self.__UndoToken()\r
1948 self.__GetRegionCapType( RegionObj)\r
1949\r
1950 elif self.__Token == "FILE":\r
1951 self.__UndoToken()\r
1952 self.__GetRegionFileType(RegionObj)\r
1953\r
1954 elif self.__Token == "INF":\r
1955 self.__UndoToken()\r
1956 RegionObj.RegionType = "INF"\r
1957 while self.__IsKeyword("INF"):\r
1958 self.__UndoToken()\r
1959 ffsInf = self.__ParseInfStatement()\r
1960 if not ffsInf:\r
1961 break\r
1962 RegionObj.RegionDataList.append(ffsInf)\r
1963\r
1964 elif self.__Token == "DATA":\r
1965 self.__UndoToken()\r
1966 self.__GetRegionDataType(RegionObj)\r
1967 else:\r
1968 self.__UndoToken()\r
1969 if self.__GetRegionLayout(Fd):\r
1970 return True\r
1971 raise Warning("A valid region type was not found. "\r
1972 "Valid types are [SET, FV, CAPSULE, FILE, DATA, INF]. This error occurred",\r
1973 self.FileName, self.CurrentLineNumber)\r
1974\r
1975 return True\r
1976\r
1977 ## __GetRegionFvType() method\r
1978 #\r
1979 # Get region fv data for region\r
1980 #\r
1981 # @param self The object pointer\r
1982 # @param RegionObj for whom region data is got\r
1983 #\r
1984 def __GetRegionFvType(self, RegionObj):\r
1985\r
1986 if not self.__IsKeyword( BINARY_FILE_TYPE_FV):\r
1987 raise Warning("expected Keyword BINARY_FILE_TYPE_FV", self.FileName, self.CurrentLineNumber)\r
1988\r
1989 if not self.__IsToken( "="):\r
1990 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
1991\r
1992 if not self.__GetNextToken():\r
1993 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
1994\r
1995 RegionObj.RegionType = BINARY_FILE_TYPE_FV\r
1996 RegionObj.RegionDataList.append((self.__Token).upper())\r
1997\r
1998 while self.__IsKeyword( BINARY_FILE_TYPE_FV):\r
1999\r
2000 if not self.__IsToken( "="):\r
2001 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2002\r
2003 if not self.__GetNextToken():\r
2004 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
2005\r
2006 RegionObj.RegionDataList.append((self.__Token).upper())\r
2007\r
2008 ## __GetRegionCapType() method\r
2009 #\r
2010 # Get region capsule data for region\r
2011 #\r
2012 # @param self The object pointer\r
2013 # @param RegionObj for whom region data is got\r
2014 #\r
2015 def __GetRegionCapType(self, RegionObj):\r
2016\r
2017 if not self.__IsKeyword("CAPSULE"):\r
2018 raise Warning("expected Keyword 'CAPSULE'", self.FileName, self.CurrentLineNumber)\r
2019\r
2020 if not self.__IsToken("="):\r
2021 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2022\r
2023 if not self.__GetNextToken():\r
2024 raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)\r
2025\r
2026 RegionObj.RegionType = "CAPSULE"\r
2027 RegionObj.RegionDataList.append(self.__Token)\r
2028\r
2029 while self.__IsKeyword("CAPSULE"):\r
2030\r
2031 if not self.__IsToken("="):\r
2032 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2033\r
2034 if not self.__GetNextToken():\r
2035 raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)\r
2036\r
2037 RegionObj.RegionDataList.append(self.__Token)\r
2038\r
2039 ## __GetRegionFileType() method\r
2040 #\r
2041 # Get region file data for region\r
2042 #\r
2043 # @param self The object pointer\r
2044 # @param RegionObj for whom region data is got\r
2045 #\r
2046 def __GetRegionFileType(self, RegionObj):\r
2047\r
2048 if not self.__IsKeyword( "FILE"):\r
2049 raise Warning("expected Keyword 'FILE'", self.FileName, self.CurrentLineNumber)\r
2050\r
2051 if not self.__IsToken( "="):\r
2052 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2053\r
2054 if not self.__GetNextToken():\r
2055 raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
2056\r
2057 RegionObj.RegionType = "FILE"\r
2058 RegionObj.RegionDataList.append( self.__Token)\r
2059\r
2060 while self.__IsKeyword( "FILE"):\r
2061\r
2062 if not self.__IsToken( "="):\r
2063 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2064\r
2065 if not self.__GetNextToken():\r
2066 raise Warning("expected FILE name", self.FileName, self.CurrentLineNumber)\r
2067\r
2068 RegionObj.RegionDataList.append(self.__Token)\r
2069\r
2070 ## __GetRegionDataType() method\r
2071 #\r
2072 # Get region array data for region\r
2073 #\r
2074 # @param self The object pointer\r
2075 # @param RegionObj for whom region data is got\r
2076 #\r
2077 def __GetRegionDataType(self, RegionObj):\r
2078\r
2079 if not self.__IsKeyword( "DATA"):\r
2080 raise Warning("expected Region Data type", self.FileName, self.CurrentLineNumber)\r
2081\r
2082 if not self.__IsToken( "="):\r
2083 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2084\r
2085 if not self.__IsToken( "{"):\r
2086 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2087\r
2088 if not self.__GetNextHexNumber():\r
2089 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
2090\r
2091 if len(self.__Token) > 18:\r
2092 raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
2093\r
2094 # convert hex string value to byte hex string array\r
2095 AllString = self.__Token\r
2096 AllStrLen = len (AllString)\r
2097 DataString = ""\r
2098 while AllStrLen > 4:\r
2099 DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
2100 AllStrLen = AllStrLen - 2\r
2101 DataString = DataString + AllString[:AllStrLen] + ","\r
2102\r
2103 # byte value array\r
2104 if len (self.__Token) <= 4:\r
2105 while self.__IsToken(","):\r
2106 if not self.__GetNextHexNumber():\r
2107 raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
2108 if len(self.__Token) > 4:\r
2109 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
2110 DataString += self.__Token\r
2111 DataString += ","\r
2112\r
2113 if not self.__IsToken( "}"):\r
2114 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2115\r
2116 DataString = DataString.rstrip(",")\r
2117 RegionObj.RegionType = "DATA"\r
2118 RegionObj.RegionDataList.append( DataString)\r
2119\r
2120 while self.__IsKeyword( "DATA"):\r
2121\r
2122 if not self.__IsToken( "="):\r
2123 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2124\r
2125 if not self.__IsToken( "{"):\r
2126 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2127\r
2128 if not self.__GetNextHexNumber():\r
2129 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
2130\r
2131 if len(self.__Token) > 18:\r
2132 raise Warning("Hex string can't be converted to a valid UINT64 value", self.FileName, self.CurrentLineNumber)\r
2133\r
2134 # convert hex string value to byte hex string array\r
2135 AllString = self.__Token\r
2136 AllStrLen = len (AllString)\r
2137 DataString = ""\r
2138 while AllStrLen > 4:\r
2139 DataString = DataString + "0x" + AllString[AllStrLen - 2: AllStrLen] + ","\r
2140 AllStrLen = AllStrLen - 2\r
2141 DataString = DataString + AllString[:AllStrLen] + ","\r
2142\r
2143 # byte value array\r
2144 if len (self.__Token) <= 4:\r
2145 while self.__IsToken(","):\r
2146 if not self.__GetNextHexNumber():\r
2147 raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
2148 if len(self.__Token) > 4:\r
2149 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
2150 DataString += self.__Token\r
2151 DataString += ","\r
2152\r
2153 if not self.__IsToken( "}"):\r
2154 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2155\r
2156 DataString = DataString.rstrip(",")\r
2157 RegionObj.RegionDataList.append( DataString)\r
2158\r
2159 ## __GetFv() method\r
2160 #\r
2161 # Get FV section contents and store its data into FV dictionary of self.Profile\r
2162 #\r
2163 # @param self The object pointer\r
2164 # @retval True Successfully find a FV\r
2165 # @retval False Not able to find a FV\r
2166 #\r
2167 def __GetFv(self):\r
2168 if not self.__GetNextToken():\r
2169 return False\r
2170\r
2171 S = self.__Token.upper()\r
2172 if S.startswith("[") and not S.startswith("[FV."):\r
2173 self.SectionParser(S)\r
2174 self.__UndoToken()\r
2175 return False\r
2176\r
2177 self.__UndoToken()\r
2178 if not self.__IsToken("[FV.", True):\r
2179 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
2180 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
2181 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
2182 raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2183\r
2184 FvName = self.__GetUiName()\r
2185 self.CurrentFvName = FvName.upper()\r
2186\r
2187 if not self.__IsToken( "]"):\r
2188 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
2189\r
2190 FvObj = Fv.FV()\r
2191 FvObj.UiFvName = self.CurrentFvName\r
2192 self.Profile.FvDict[self.CurrentFvName] = FvObj\r
2193\r
2194 Status = self.__GetCreateFile(FvObj)\r
2195 if not Status:\r
2196 raise Warning("FV name error", self.FileName, self.CurrentLineNumber)\r
2197\r
2198 self.__GetDefineStatements(FvObj)\r
2199\r
2200 self.__GetAddressStatements(FvObj)\r
2201\r
2202 FvObj.FvExtEntryTypeValue = []\r
2203 FvObj.FvExtEntryType = []\r
2204 FvObj.FvExtEntryData = []\r
2205 while True:\r
2206 self.__GetSetStatements(FvObj)\r
2207\r
2208 if not (self.__GetBlockStatement(FvObj) or self.__GetFvBaseAddress(FvObj) or\r
2209 self.__GetFvForceRebase(FvObj) or self.__GetFvAlignment(FvObj) or\r
2210 self.__GetFvAttributes(FvObj) or self.__GetFvNameGuid(FvObj) or\r
2211 self.__GetFvExtEntryStatement(FvObj) or self.__GetFvNameString(FvObj)):\r
2212 break\r
2213\r
2214 if FvObj.FvNameString == 'TRUE' and not FvObj.FvNameGuid:\r
2215 raise Warning("FvNameString found but FvNameGuid was not found", self.FileName, self.CurrentLineNumber)\r
2216\r
2217 self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())\r
2218 self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())\r
2219\r
2220 while True:\r
2221 isInf = self.__GetInfStatement(FvObj)\r
2222 isFile = self.__GetFileStatement(FvObj, MacroDict = FvObj.DefineVarDict.copy())\r
2223 if not isInf and not isFile:\r
2224 break\r
2225\r
2226 return True\r
2227\r
2228 ## __GetFvAlignment() method\r
2229 #\r
2230 # Get alignment for FV\r
2231 #\r
2232 # @param self The object pointer\r
2233 # @param Obj for whom alignment is got\r
2234 # @retval True Successfully find a alignment statement\r
2235 # @retval False Not able to find a alignment statement\r
2236 #\r
2237 def __GetFvAlignment(self, Obj):\r
2238\r
2239 if not self.__IsKeyword( "FvAlignment"):\r
2240 return False\r
2241\r
2242 if not self.__IsToken( "="):\r
2243 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2244\r
2245 if not self.__GetNextToken():\r
2246 raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)\r
2247\r
2248 if self.__Token.upper() not in ("1", "2", "4", "8", "16", "32", "64", "128", "256", "512", \\r
2249 "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K", "512K", \\r
2250 "1M", "2M", "4M", "8M", "16M", "32M", "64M", "128M", "256M", "512M", \\r
2251 "1G", "2G"):\r
2252 raise Warning("Unknown alignment value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2253 Obj.FvAlignment = self.__Token\r
2254 return True\r
2255\r
2256 ## __GetFvBaseAddress() method\r
2257 #\r
2258 # Get BaseAddress for FV\r
2259 #\r
2260 # @param self The object pointer\r
2261 # @param Obj for whom FvBaseAddress is got\r
2262 # @retval True Successfully find a FvBaseAddress statement\r
2263 # @retval False Not able to find a FvBaseAddress statement\r
2264 #\r
2265 def __GetFvBaseAddress(self, Obj):\r
2266\r
2267 if not self.__IsKeyword("FvBaseAddress"):\r
2268 return False\r
2269\r
2270 if not self.__IsToken( "="):\r
2271 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2272\r
2273 if not self.__GetNextToken():\r
2274 raise Warning("expected FV base address value", self.FileName, self.CurrentLineNumber)\r
2275\r
2276 if not BaseAddrValuePattern.match(self.__Token.upper()):\r
2277 raise Warning("Unknown FV base address value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2278 Obj.FvBaseAddress = self.__Token\r
2279 return True\r
2280\r
2281 ## __GetFvForceRebase() method\r
2282 #\r
2283 # Get FvForceRebase for FV\r
2284 #\r
2285 # @param self The object pointer\r
2286 # @param Obj for whom FvForceRebase is got\r
2287 # @retval True Successfully find a FvForceRebase statement\r
2288 # @retval False Not able to find a FvForceRebase statement\r
2289 #\r
2290 def __GetFvForceRebase(self, Obj):\r
2291\r
2292 if not self.__IsKeyword("FvForceRebase"):\r
2293 return False\r
2294\r
2295 if not self.__IsToken( "="):\r
2296 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2297\r
2298 if not self.__GetNextToken():\r
2299 raise Warning("expected FvForceRebase value", self.FileName, self.CurrentLineNumber)\r
2300\r
2301 if self.__Token.upper() not in ["TRUE", "FALSE", "0", "0X0", "0X00", "1", "0X1", "0X01"]:\r
2302 raise Warning("Unknown FvForceRebase value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2303\r
2304 if self.__Token.upper() in ["TRUE", "1", "0X1", "0X01"]:\r
2305 Obj.FvForceRebase = True\r
2306 elif self.__Token.upper() in ["FALSE", "0", "0X0", "0X00"]:\r
2307 Obj.FvForceRebase = False\r
2308 else:\r
2309 Obj.FvForceRebase = None\r
2310\r
2311 return True\r
2312\r
2313\r
2314 ## __GetFvAttributes() method\r
2315 #\r
2316 # Get attributes for FV\r
2317 #\r
2318 # @param self The object pointer\r
2319 # @param Obj for whom attribute is got\r
2320 # @retval None\r
2321 #\r
2322 def __GetFvAttributes(self, FvObj):\r
2323 IsWordToken = False\r
2324 while self.__GetNextWord():\r
2325 IsWordToken = True\r
2326 name = self.__Token\r
2327 if name not in ("ERASE_POLARITY", "MEMORY_MAPPED", \\r
2328 "STICKY_WRITE", "LOCK_CAP", "LOCK_STATUS", "WRITE_ENABLED_CAP", \\r
2329 "WRITE_DISABLED_CAP", "WRITE_STATUS", "READ_ENABLED_CAP", \\r
2330 "READ_DISABLED_CAP", "READ_STATUS", "READ_LOCK_CAP", \\r
2331 "READ_LOCK_STATUS", "WRITE_LOCK_CAP", "WRITE_LOCK_STATUS", \\r
2332 "WRITE_POLICY_RELIABLE", "WEAK_ALIGNMENT", "FvUsedSizeEnable"):\r
2333 self.__UndoToken()\r
2334 return False\r
2335\r
2336 if not self.__IsToken( "="):\r
2337 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2338\r
2339 if not self.__GetNextToken() or self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):\r
2340 raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)\r
2341\r
2342 FvObj.FvAttributeDict[name] = self.__Token\r
2343\r
2344 return IsWordToken\r
2345\r
2346 ## __GetFvNameGuid() method\r
2347 #\r
2348 # Get FV GUID for FV\r
2349 #\r
2350 # @param self The object pointer\r
2351 # @param Obj for whom GUID is got\r
2352 # @retval None\r
2353 #\r
2354 def __GetFvNameGuid(self, FvObj):\r
2355\r
2356 if not self.__IsKeyword( "FvNameGuid"):\r
2357 return False\r
2358\r
2359 if not self.__IsToken( "="):\r
2360 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2361\r
2362 if not self.__GetNextGuid():\r
2363 raise Warning("expected FV GUID value", self.FileName, self.CurrentLineNumber)\r
2364\r
2365 FvObj.FvNameGuid = self.__Token\r
2366\r
2367 return True\r
2368\r
2369 def __GetFvNameString(self, FvObj):\r
2370\r
2371 if not self.__IsKeyword( "FvNameString"):\r
2372 return False\r
2373\r
2374 if not self.__IsToken( "="):\r
2375 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2376\r
2377 if not self.__GetNextToken() or self.__Token not in ('TRUE', 'FALSE'):\r
2378 raise Warning("expected TRUE or FALSE for FvNameString", self.FileName, self.CurrentLineNumber)\r
2379\r
2380 FvObj.FvNameString = self.__Token\r
2381\r
2382 return True\r
2383\r
2384 def __GetFvExtEntryStatement(self, FvObj):\r
2385\r
2386 if not (self.__IsKeyword( "FV_EXT_ENTRY") or self.__IsKeyword( "FV_EXT_ENTRY_TYPE")):\r
2387 return False\r
2388\r
2389 if not self.__IsKeyword ("TYPE"):\r
2390 raise Warning("expected 'TYPE'", self.FileName, self.CurrentLineNumber)\r
2391\r
2392 if not self.__IsToken( "="):\r
2393 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2394\r
2395 if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():\r
2396 raise Warning("expected Hex FV extension entry type value At Line ", self.FileName, self.CurrentLineNumber)\r
2397\r
2398 FvObj.FvExtEntryTypeValue.append(self.__Token)\r
2399\r
2400 if not self.__IsToken( "{"):\r
2401 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2402\r
2403 if not self.__IsKeyword ("FILE") and not self.__IsKeyword ("DATA"):\r
2404 raise Warning("expected 'FILE' or 'DATA'", self.FileName, self.CurrentLineNumber)\r
2405\r
2406 FvObj.FvExtEntryType.append(self.__Token)\r
2407\r
2408 if self.__Token == 'DATA':\r
2409\r
2410 if not self.__IsToken( "="):\r
2411 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2412\r
2413 if not self.__IsToken( "{"):\r
2414 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2415\r
2416 if not self.__GetNextHexNumber():\r
2417 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)\r
2418\r
2419 if len(self.__Token) > 4:\r
2420 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
2421\r
2422 DataString = self.__Token\r
2423 DataString += ","\r
2424\r
2425 while self.__IsToken(","):\r
2426 if not self.__GetNextHexNumber():\r
2427 raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)\r
2428 if len(self.__Token) > 4:\r
2429 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)\r
2430 DataString += self.__Token\r
2431 DataString += ","\r
2432\r
2433 if not self.__IsToken( "}"):\r
2434 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2435\r
2436 if not self.__IsToken( "}"):\r
2437 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2438\r
2439 DataString = DataString.rstrip(",")\r
2440 FvObj.FvExtEntryData.append(DataString)\r
2441\r
2442 if self.__Token == 'FILE':\r
2443\r
2444 if not self.__IsToken( "="):\r
2445 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2446\r
2447 if not self.__GetNextToken():\r
2448 raise Warning("expected FV Extension Entry file path At Line ", self.FileName, self.CurrentLineNumber)\r
2449\r
2450 FvObj.FvExtEntryData.append(self.__Token)\r
2451\r
2452 if not self.__IsToken( "}"):\r
2453 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2454\r
2455 return True\r
2456\r
2457 ## __GetAprioriSection() method\r
2458 #\r
2459 # Get token statements\r
2460 #\r
2461 # @param self The object pointer\r
2462 # @param FvObj for whom apriori is got\r
2463 # @param MacroDict dictionary used to replace macro\r
2464 # @retval True Successfully find apriori statement\r
2465 # @retval False Not able to find apriori statement\r
2466 #\r
2467 def __GetAprioriSection(self, FvObj, MacroDict = {}):\r
2468\r
2469 if not self.__IsKeyword( "APRIORI"):\r
2470 return False\r
2471\r
2472 if not self.__IsKeyword("PEI") and not self.__IsKeyword("DXE"):\r
2473 raise Warning("expected Apriori file type", self.FileName, self.CurrentLineNumber)\r
2474 AprType = self.__Token\r
2475\r
2476 if not self.__IsToken( "{"):\r
2477 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2478\r
2479 AprSectionObj = AprioriSection.AprioriSection()\r
2480 AprSectionObj.AprioriType = AprType\r
2481\r
2482 self.__GetDefineStatements(AprSectionObj)\r
2483 MacroDict.update(AprSectionObj.DefineVarDict)\r
2484\r
2485 while True:\r
2486 IsInf = self.__GetInfStatement(AprSectionObj)\r
2487 IsFile = self.__GetFileStatement( AprSectionObj)\r
2488 if not IsInf and not IsFile:\r
2489 break\r
2490\r
2491 if not self.__IsToken( "}"):\r
2492 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2493\r
2494 FvObj.AprioriSectionList.append(AprSectionObj)\r
2495 return True\r
2496\r
2497 def __ParseInfStatement(self):\r
2498 if not self.__IsKeyword("INF"):\r
2499 return None\r
2500\r
2501 ffsInf = FfsInfStatement.FfsInfStatement()\r
2502 self.__GetInfOptions(ffsInf)\r
2503\r
2504 if not self.__GetNextToken():\r
2505 raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
2506 ffsInf.InfFileName = self.__Token\r
2507 if not ffsInf.InfFileName.endswith('.inf'):\r
2508 raise Warning("expected .inf file path", self.FileName, self.CurrentLineNumber)\r
2509\r
2510 ffsInf.CurrentLineNum = self.CurrentLineNumber\r
2511 ffsInf.CurrentLineContent = self.__CurrentLine()\r
2512\r
2513 #Replace $(SAPCE) with real space\r
2514 ffsInf.InfFileName = ffsInf.InfFileName.replace('$(SPACE)', ' ')\r
2515\r
2516 if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
2517 #do case sensitive check for file path\r
2518 ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
2519 if ErrorCode != 0:\r
2520 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
2521\r
2522 if not ffsInf.InfFileName in self.Profile.InfList:\r
2523 self.Profile.InfList.append(ffsInf.InfFileName)\r
2524 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
2525 self.Profile.InfFileLineList.append(FileLineTuple)\r
2526 if ffsInf.UseArch:\r
2527 if ffsInf.UseArch not in self.Profile.InfDict:\r
2528 self.Profile.InfDict[ffsInf.UseArch] = [ffsInf.InfFileName]\r
2529 else:\r
2530 self.Profile.InfDict[ffsInf.UseArch].append(ffsInf.InfFileName)\r
2531 else:\r
2532 self.Profile.InfDict['ArchTBD'].append(ffsInf.InfFileName)\r
2533\r
2534 if self.__IsToken('|'):\r
2535 if self.__IsKeyword('RELOCS_STRIPPED'):\r
2536 ffsInf.KeepReloc = False\r
2537 elif self.__IsKeyword('RELOCS_RETAINED'):\r
2538 ffsInf.KeepReloc = True\r
2539 else:\r
2540 raise Warning("Unknown reloc strip flag '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2541 return ffsInf\r
2542\r
2543 ## __GetInfStatement() method\r
2544 #\r
2545 # Get INF statements\r
2546 #\r
2547 # @param self The object pointer\r
2548 # @param Obj for whom inf statement is got\r
2549 # @retval True Successfully find inf statement\r
2550 # @retval False Not able to find inf statement\r
2551 #\r
2552 def __GetInfStatement(self, Obj, ForCapsule=False):\r
2553 ffsInf = self.__ParseInfStatement()\r
2554 if not ffsInf:\r
2555 return False\r
2556\r
2557 if ForCapsule:\r
2558 capsuleFfs = CapsuleData.CapsuleFfs()\r
2559 capsuleFfs.Ffs = ffsInf\r
2560 Obj.CapsuleDataList.append(capsuleFfs)\r
2561 else:\r
2562 Obj.FfsList.append(ffsInf)\r
2563 return True\r
2564\r
2565 ## __GetInfOptions() method\r
2566 #\r
2567 # Get options for INF\r
2568 #\r
2569 # @param self The object pointer\r
2570 # @param FfsInfObj for whom option is got\r
2571 #\r
2572 def __GetInfOptions(self, FfsInfObj):\r
2573 if self.__IsKeyword("FILE_GUID"):\r
2574 if not self.__IsToken("="):\r
2575 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2576 if not self.__GetNextGuid():\r
2577 raise Warning("expected GUID value", self.FileName, self.CurrentLineNumber)\r
2578 FfsInfObj.OverrideGuid = self.__Token\r
2579\r
2580 if self.__IsKeyword( "RuleOverride"):\r
2581 if not self.__IsToken( "="):\r
2582 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2583 if not self.__GetNextToken():\r
2584 raise Warning("expected Rule name", self.FileName, self.CurrentLineNumber)\r
2585 FfsInfObj.Rule = self.__Token\r
2586\r
2587 if self.__IsKeyword( "VERSION"):\r
2588 if not self.__IsToken( "="):\r
2589 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2590 if not self.__GetNextToken():\r
2591 raise Warning("expected Version", self.FileName, self.CurrentLineNumber)\r
2592\r
2593 if self.__GetStringData():\r
2594 FfsInfObj.Version = self.__Token\r
2595\r
2596 if self.__IsKeyword( BINARY_FILE_TYPE_UI):\r
2597 if not self.__IsToken( "="):\r
2598 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2599 if not self.__GetNextToken():\r
2600 raise Warning("expected UI name", self.FileName, self.CurrentLineNumber)\r
2601\r
2602 if self.__GetStringData():\r
2603 FfsInfObj.Ui = self.__Token\r
2604\r
2605 if self.__IsKeyword( "USE"):\r
2606 if not self.__IsToken( "="):\r
2607 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2608 if not self.__GetNextToken():\r
2609 raise Warning("expected ARCH name", self.FileName, self.CurrentLineNumber)\r
2610 FfsInfObj.UseArch = self.__Token\r
2611\r
2612\r
2613 if self.__GetNextToken():\r
2614 p = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\))')\r
2615 if p.match(self.__Token) and p.match(self.__Token).span()[1] == len(self.__Token):\r
2616 FfsInfObj.KeyStringList.append(self.__Token)\r
2617 if not self.__IsToken(","):\r
2618 return\r
2619 else:\r
2620 self.__UndoToken()\r
2621 return\r
2622\r
2623 while self.__GetNextToken():\r
2624 if not p.match(self.__Token):\r
2625 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
2626 FfsInfObj.KeyStringList.append(self.__Token)\r
2627\r
2628 if not self.__IsToken(","):\r
2629 break\r
2630\r
2631 ## __GetFileStatement() method\r
2632 #\r
2633 # Get FILE statements\r
2634 #\r
2635 # @param self The object pointer\r
2636 # @param Obj for whom FILE statement is got\r
2637 # @param MacroDict dictionary used to replace macro\r
2638 # @retval True Successfully find FILE statement\r
2639 # @retval False Not able to find FILE statement\r
2640 #\r
2641 def __GetFileStatement(self, Obj, ForCapsule = False, MacroDict = {}):\r
2642\r
2643 if not self.__IsKeyword( "FILE"):\r
2644 return False\r
2645\r
2646 if not self.__GetNextWord():\r
2647 raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)\r
2648\r
2649 if ForCapsule and self.__Token == 'DATA':\r
2650 self.__UndoToken()\r
2651 self.__UndoToken()\r
2652 return False\r
2653\r
2654 FfsFileObj = FfsFileStatement.FileStatement()\r
2655 FfsFileObj.FvFileType = self.__Token\r
2656\r
2657 if not self.__IsToken( "="):\r
2658 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2659\r
2660 if not self.__GetNextGuid():\r
2661 if not self.__GetNextWord():\r
2662 raise Warning("expected File GUID", self.FileName, self.CurrentLineNumber)\r
2663 if self.__Token == 'PCD':\r
2664 if not self.__IsToken( "("):\r
2665 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
2666 PcdPair = self.__GetNextPcdSettings()\r
2667 if not self.__IsToken( ")"):\r
2668 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
2669 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
2670\r
2671 FfsFileObj.NameGuid = self.__Token\r
2672\r
2673 self.__GetFilePart( FfsFileObj, MacroDict.copy())\r
2674\r
2675 if ForCapsule:\r
2676 capsuleFfs = CapsuleData.CapsuleFfs()\r
2677 capsuleFfs.Ffs = FfsFileObj\r
2678 Obj.CapsuleDataList.append(capsuleFfs)\r
2679 else:\r
2680 Obj.FfsList.append(FfsFileObj)\r
2681\r
2682 return True\r
2683\r
2684 ## __FileCouldHaveRelocFlag() method\r
2685 #\r
2686 # Check whether reloc strip flag can be set for a file type.\r
2687 #\r
2688 # @param FileType The file type to check with\r
2689 # @retval True This type could have relocation strip flag\r
2690 # @retval False No way to have it\r
2691 #\r
2692 @staticmethod\r
2693 def __FileCouldHaveRelocFlag (FileType):\r
2694 if FileType in (SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, 'PEI_DXE_COMBO'):\r
2695 return True\r
2696 else:\r
2697 return False\r
2698\r
2699 ## __SectionCouldHaveRelocFlag() method\r
2700 #\r
2701 # Check whether reloc strip flag can be set for a section type.\r
2702 #\r
2703 # @param SectionType The section type to check with\r
2704 # @retval True This type could have relocation strip flag\r
2705 # @retval False No way to have it\r
2706 #\r
2707 @staticmethod\r
2708 def __SectionCouldHaveRelocFlag (SectionType):\r
2709 if SectionType in (BINARY_FILE_TYPE_TE, BINARY_FILE_TYPE_PE32):\r
2710 return True\r
2711 else:\r
2712 return False\r
2713\r
2714 ## __GetFilePart() method\r
2715 #\r
2716 # Get components for FILE statement\r
2717 #\r
2718 # @param self The object pointer\r
2719 # @param FfsFileObj for whom component is got\r
2720 # @param MacroDict dictionary used to replace macro\r
2721 #\r
2722 def __GetFilePart(self, FfsFileObj, MacroDict = {}):\r
2723\r
2724 self.__GetFileOpts( FfsFileObj)\r
2725\r
2726 if not self.__IsToken("{"):\r
2727 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
2728 if self.__FileCouldHaveRelocFlag(FfsFileObj.FvFileType):\r
2729 if self.__Token == 'RELOCS_STRIPPED':\r
2730 FfsFileObj.KeepReloc = False\r
2731 else:\r
2732 FfsFileObj.KeepReloc = True\r
2733 else:\r
2734 raise Warning("File type %s could not have reloc strip flag%d" % (FfsFileObj.FvFileType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
2735\r
2736 if not self.__IsToken("{"):\r
2737 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
2738\r
2739 if not self.__GetNextToken():\r
2740 raise Warning("expected File name or section data", self.FileName, self.CurrentLineNumber)\r
2741\r
2742 if self.__Token == BINARY_FILE_TYPE_FV:\r
2743 if not self.__IsToken( "="):\r
2744 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2745 if not self.__GetNextToken():\r
2746 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
2747 FfsFileObj.FvName = self.__Token\r
2748\r
2749 elif self.__Token == "FD":\r
2750 if not self.__IsToken( "="):\r
2751 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2752 if not self.__GetNextToken():\r
2753 raise Warning("expected FD name", self.FileName, self.CurrentLineNumber)\r
2754 FfsFileObj.FdName = self.__Token\r
2755\r
2756 elif self.__Token in ("DEFINE", "APRIORI", "SECTION"):\r
2757 self.__UndoToken()\r
2758 self.__GetSectionData( FfsFileObj, MacroDict)\r
2759\r
2760 elif hasattr(FfsFileObj, 'FvFileType') and FfsFileObj.FvFileType == 'RAW':\r
2761 self.__UndoToken()\r
2762 self.__GetRAWData(FfsFileObj, MacroDict)\r
2763\r
2764 else:\r
2765 FfsFileObj.CurrentLineNum = self.CurrentLineNumber\r
2766 FfsFileObj.CurrentLineContent = self.__CurrentLine()\r
2767 FfsFileObj.FileName = self.__Token.replace('$(SPACE)', ' ')\r
2768 self.__VerifyFile(FfsFileObj.FileName)\r
2769\r
2770 if not self.__IsToken( "}"):\r
2771 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2772\r
2773 ## __GetRAWData() method\r
2774 #\r
2775 # Get RAW data for FILE statement\r
2776 #\r
2777 # @param self The object pointer\r
2778 # @param FfsFileObj for whom section is got\r
2779 # @param MacroDict dictionary used to replace macro\r
2780 #\r
2781 def __GetRAWData(self, FfsFileObj, MacroDict = {}):\r
2782 FfsFileObj.FileName = []\r
2783 FfsFileObj.SubAlignment = []\r
2784 while True:\r
2785 AlignValue = None\r
2786 if self.__GetAlignment():\r
2787 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
2788 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
2789 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2790 #For FFS, Auto is default option same to ""\r
2791 if not self.__Token == "Auto":\r
2792 AlignValue = self.__Token\r
2793 if not self.__GetNextToken():\r
2794 raise Warning("expected Filename value", self.FileName, self.CurrentLineNumber)\r
2795\r
2796 FileName = self.__Token.replace('$(SPACE)', ' ')\r
2797 if FileName == '}':\r
2798 self.__UndoToken()\r
2799 raise Warning("expected Filename value", self.FileName, self.CurrentLineNumber)\r
2800\r
2801 self.__VerifyFile(FileName)\r
2802 File = PathClass(NormPath(FileName), GenFdsGlobalVariable.WorkSpaceDir)\r
2803 FfsFileObj.FileName.append(File.Path)\r
2804 FfsFileObj.SubAlignment.append(AlignValue)\r
2805\r
2806 if self.__IsToken( "}"):\r
2807 self.__UndoToken()\r
2808 break\r
2809\r
2810 if len(FfsFileObj.SubAlignment) == 1:\r
2811 FfsFileObj.SubAlignment = FfsFileObj.SubAlignment[0]\r
2812 if len(FfsFileObj.FileName) == 1:\r
2813 FfsFileObj.FileName = FfsFileObj.FileName[0]\r
2814\r
2815 ## __GetFileOpts() method\r
2816 #\r
2817 # Get options for FILE statement\r
2818 #\r
2819 # @param self The object pointer\r
2820 # @param FfsFileObj for whom options is got\r
2821 #\r
2822 def __GetFileOpts(self, FfsFileObj):\r
2823\r
2824 if self.__GetNextToken():\r
2825 if TokenFindPattern.match(self.__Token):\r
2826 FfsFileObj.KeyStringList.append(self.__Token)\r
2827 if self.__IsToken(","):\r
2828 while self.__GetNextToken():\r
2829 if not TokenFindPattern.match(self.__Token):\r
2830 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
2831 FfsFileObj.KeyStringList.append(self.__Token)\r
2832\r
2833 if not self.__IsToken(","):\r
2834 break\r
2835\r
2836 else:\r
2837 self.__UndoToken()\r
2838\r
2839 if self.__IsKeyword( "FIXED", True):\r
2840 FfsFileObj.Fixed = True\r
2841\r
2842 if self.__IsKeyword( "CHECKSUM", True):\r
2843 FfsFileObj.CheckSum = True\r
2844\r
2845 if self.__GetAlignment():\r
2846 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
2847 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
2848 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2849 #For FFS, Auto is default option same to ""\r
2850 if not self.__Token == "Auto":\r
2851 FfsFileObj.Alignment = self.__Token\r
2852\r
2853 ## __GetAlignment() method\r
2854 #\r
2855 # Return the alignment value\r
2856 #\r
2857 # @param self The object pointer\r
2858 # @retval True Successfully find alignment\r
2859 # @retval False Not able to find alignment\r
2860 #\r
2861 def __GetAlignment(self):\r
2862 if self.__IsKeyword( "Align", True):\r
2863 if not self.__IsToken( "="):\r
2864 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2865\r
2866 if not self.__GetNextToken():\r
2867 raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)\r
2868 return True\r
2869\r
2870 return False\r
2871\r
2872 ## __GetFilePart() method\r
2873 #\r
2874 # Get section data for FILE statement\r
2875 #\r
2876 # @param self The object pointer\r
2877 # @param FfsFileObj for whom section is got\r
2878 # @param MacroDict dictionary used to replace macro\r
2879 #\r
2880 def __GetSectionData(self, FfsFileObj, MacroDict = {}):\r
2881 Dict = {}\r
2882 Dict.update(MacroDict)\r
2883\r
2884 self.__GetDefineStatements(FfsFileObj)\r
2885\r
2886 Dict.update(FfsFileObj.DefineVarDict)\r
2887 self.__GetAprioriSection(FfsFileObj, Dict.copy())\r
2888 self.__GetAprioriSection(FfsFileObj, Dict.copy())\r
2889\r
2890 while True:\r
2891 IsLeafSection = self.__GetLeafSection(FfsFileObj, Dict)\r
2892 IsEncapSection = self.__GetEncapsulationSec(FfsFileObj)\r
2893 if not IsLeafSection and not IsEncapSection:\r
2894 break\r
2895\r
2896 ## __GetLeafSection() method\r
2897 #\r
2898 # Get leaf section for Obj\r
2899 #\r
2900 # @param self The object pointer\r
2901 # @param Obj for whom leaf section is got\r
2902 # @param MacroDict dictionary used to replace macro\r
2903 # @retval True Successfully find section statement\r
2904 # @retval False Not able to find section statement\r
2905 #\r
2906 def __GetLeafSection(self, Obj, MacroDict = {}):\r
2907\r
2908 OldPos = self.GetFileBufferPos()\r
2909\r
2910 if not self.__IsKeyword( "SECTION"):\r
2911 if len(Obj.SectionList) == 0:\r
2912 raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)\r
2913 else:\r
2914 return False\r
2915\r
2916 AlignValue = None\r
2917 if self.__GetAlignment():\r
2918 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
2919 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
2920 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
2921 AlignValue = self.__Token\r
2922\r
2923 BuildNum = None\r
2924 if self.__IsKeyword( "BUILD_NUM"):\r
2925 if not self.__IsToken( "="):\r
2926 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2927\r
2928 if not self.__GetNextToken():\r
2929 raise Warning("expected Build number value", self.FileName, self.CurrentLineNumber)\r
2930\r
2931 BuildNum = self.__Token\r
2932\r
2933 if self.__IsKeyword( "VERSION"):\r
2934 if AlignValue == 'Auto':\r
2935 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
2936 if not self.__IsToken( "="):\r
2937 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2938 if not self.__GetNextToken():\r
2939 raise Warning("expected version", self.FileName, self.CurrentLineNumber)\r
2940 VerSectionObj = VerSection.VerSection()\r
2941 VerSectionObj.Alignment = AlignValue\r
2942 VerSectionObj.BuildNum = BuildNum\r
2943 if self.__GetStringData():\r
2944 VerSectionObj.StringData = self.__Token\r
2945 else:\r
2946 VerSectionObj.FileName = self.__Token\r
2947 Obj.SectionList.append(VerSectionObj)\r
2948\r
2949 elif self.__IsKeyword( BINARY_FILE_TYPE_UI):\r
2950 if AlignValue == 'Auto':\r
2951 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
2952 if not self.__IsToken( "="):\r
2953 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2954 if not self.__GetNextToken():\r
2955 raise Warning("expected UI", self.FileName, self.CurrentLineNumber)\r
2956 UiSectionObj = UiSection.UiSection()\r
2957 UiSectionObj.Alignment = AlignValue\r
2958 if self.__GetStringData():\r
2959 UiSectionObj.StringData = self.__Token\r
2960 else:\r
2961 UiSectionObj.FileName = self.__Token\r
2962 Obj.SectionList.append(UiSectionObj)\r
2963\r
2964 elif self.__IsKeyword( "FV_IMAGE"):\r
2965 if AlignValue == 'Auto':\r
2966 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
2967 if not self.__IsToken( "="):\r
2968 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
2969 if not self.__GetNextToken():\r
2970 raise Warning("expected FV name or FV file path", self.FileName, self.CurrentLineNumber)\r
2971\r
2972 FvName = self.__Token\r
2973 FvObj = None\r
2974\r
2975 if self.__IsToken( "{"):\r
2976 FvObj = Fv.FV()\r
2977 FvObj.UiFvName = FvName.upper()\r
2978 self.__GetDefineStatements(FvObj)\r
2979 MacroDict.update(FvObj.DefineVarDict)\r
2980 self.__GetBlockStatement(FvObj)\r
2981 self.__GetSetStatements(FvObj)\r
2982 self.__GetFvAlignment(FvObj)\r
2983 self.__GetFvAttributes(FvObj)\r
2984 self.__GetAprioriSection(FvObj, MacroDict.copy())\r
2985 self.__GetAprioriSection(FvObj, MacroDict.copy())\r
2986\r
2987 while True:\r
2988 IsInf = self.__GetInfStatement(FvObj)\r
2989 IsFile = self.__GetFileStatement(FvObj, MacroDict.copy())\r
2990 if not IsInf and not IsFile:\r
2991 break\r
2992\r
2993 if not self.__IsToken( "}"):\r
2994 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
2995\r
2996 FvImageSectionObj = FvImageSection.FvImageSection()\r
2997 FvImageSectionObj.Alignment = AlignValue\r
2998 if FvObj is not None:\r
2999 FvImageSectionObj.Fv = FvObj\r
3000 FvImageSectionObj.FvName = None\r
3001 else:\r
3002 FvImageSectionObj.FvName = FvName.upper()\r
3003 FvImageSectionObj.FvFileName = FvName\r
3004\r
3005 Obj.SectionList.append(FvImageSectionObj)\r
3006\r
3007 elif self.__IsKeyword("PEI_DEPEX_EXP") or self.__IsKeyword("DXE_DEPEX_EXP") or self.__IsKeyword("SMM_DEPEX_EXP"):\r
3008 if AlignValue == 'Auto':\r
3009 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
3010 DepexSectionObj = DepexSection.DepexSection()\r
3011 DepexSectionObj.Alignment = AlignValue\r
3012 DepexSectionObj.DepexType = self.__Token\r
3013\r
3014 if not self.__IsToken( "="):\r
3015 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3016 if not self.__IsToken( "{"):\r
3017 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
3018 if not self.__SkipToToken( "}"):\r
3019 raise Warning("expected Depex expression ending '}'", self.FileName, self.CurrentLineNumber)\r
3020\r
3021 DepexSectionObj.Expression = self.__SkippedChars.rstrip('}')\r
3022 Obj.SectionList.append(DepexSectionObj)\r
3023\r
3024 else:\r
3025 if not self.__GetNextWord():\r
3026 raise Warning("expected section type", self.FileName, self.CurrentLineNumber)\r
3027\r
3028 # Encapsulation section appear, UndoToken and return\r
3029 if self.__Token == "COMPRESS" or self.__Token == "GUIDED":\r
3030 self.SetFileBufferPos(OldPos)\r
3031 return False\r
3032\r
3033 if self.__Token not in ("COMPAT16", BINARY_FILE_TYPE_PE32, BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_TE, "FV_IMAGE", "RAW", BINARY_FILE_TYPE_DXE_DEPEX,\\r
3034 BINARY_FILE_TYPE_UI, "VERSION", BINARY_FILE_TYPE_PEI_DEPEX, "SUBTYPE_GUID", BINARY_FILE_TYPE_SMM_DEPEX):\r
3035 raise Warning("Unknown section type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3036 if AlignValue == 'Auto'and (not self.__Token == BINARY_FILE_TYPE_PE32) and (not self.__Token == BINARY_FILE_TYPE_TE):\r
3037 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
3038\r
3039 # DataSection\r
3040 DataSectionObj = DataSection.DataSection()\r
3041 DataSectionObj.Alignment = AlignValue\r
3042 DataSectionObj.SecType = self.__Token\r
3043\r
3044 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
3045 if self.__FileCouldHaveRelocFlag(Obj.FvFileType) and self.__SectionCouldHaveRelocFlag(DataSectionObj.SecType):\r
3046 if self.__Token == 'RELOCS_STRIPPED':\r
3047 DataSectionObj.KeepReloc = False\r
3048 else:\r
3049 DataSectionObj.KeepReloc = True\r
3050 else:\r
3051 raise Warning("File type %s, section type %s, could not have reloc strip flag%d" % (Obj.FvFileType, DataSectionObj.SecType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3052\r
3053 if self.__IsToken("="):\r
3054 if not self.__GetNextToken():\r
3055 raise Warning("expected section file path", self.FileName, self.CurrentLineNumber)\r
3056 DataSectionObj.SectFileName = self.__Token\r
3057 self.__VerifyFile(DataSectionObj.SectFileName)\r
3058 else:\r
3059 if not self.__GetCglSection(DataSectionObj):\r
3060 return False\r
3061\r
3062 Obj.SectionList.append(DataSectionObj)\r
3063\r
3064 return True\r
3065\r
3066 ## __VerifyFile\r
3067 #\r
3068 # Check if file exists or not:\r
3069 # If current phase if GenFds, the file must exist;\r
3070 # If current phase is AutoGen and the file is not in $(OUTPUT_DIRECTORY), the file must exist\r
3071 # @param FileName: File path to be verified.\r
3072 #\r
3073 def __VerifyFile(self, FileName):\r
3074 if FileName.replace('$(WORKSPACE)', '').find('$') != -1:\r
3075 return\r
3076 if not GlobalData.gAutoGenPhase or not self.__GetMacroValue("OUTPUT_DIRECTORY") in FileName:\r
3077 ErrorCode, ErrorInfo = PathClass(NormPath(FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
3078 if ErrorCode != 0:\r
3079 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
3080\r
3081 ## __GetCglSection() method\r
3082 #\r
3083 # Get compressed or GUIDed section for Obj\r
3084 #\r
3085 # @param self The object pointer\r
3086 # @param Obj for whom leaf section is got\r
3087 # @param AlignValue alignment value for complex section\r
3088 # @retval True Successfully find section statement\r
3089 # @retval False Not able to find section statement\r
3090 #\r
3091 def __GetCglSection(self, Obj, AlignValue = None):\r
3092\r
3093 if self.__IsKeyword( "COMPRESS"):\r
3094 type = "PI_STD"\r
3095 if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):\r
3096 type = self.__Token\r
3097\r
3098 if not self.__IsToken("{"):\r
3099 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
3100\r
3101 CompressSectionObj = CompressSection.CompressSection()\r
3102 CompressSectionObj.Alignment = AlignValue\r
3103 CompressSectionObj.CompType = type\r
3104 # Recursive sections...\r
3105 while True:\r
3106 IsLeafSection = self.__GetLeafSection(CompressSectionObj)\r
3107 IsEncapSection = self.__GetEncapsulationSec(CompressSectionObj)\r
3108 if not IsLeafSection and not IsEncapSection:\r
3109 break\r
3110\r
3111\r
3112 if not self.__IsToken( "}"):\r
3113 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
3114 Obj.SectionList.append(CompressSectionObj)\r
3115\r
3116# else:\r
3117# raise Warning("Compress type not known")\r
3118\r
3119 return True\r
3120\r
3121 elif self.__IsKeyword( "GUIDED"):\r
3122 GuidValue = None\r
3123 if self.__GetNextGuid():\r
3124 GuidValue = self.__Token\r
3125\r
3126 AttribDict = self.__GetGuidAttrib()\r
3127 if not self.__IsToken("{"):\r
3128 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
3129 GuidSectionObj = GuidSection.GuidSection()\r
3130 GuidSectionObj.Alignment = AlignValue\r
3131 GuidSectionObj.NameGuid = GuidValue\r
3132 GuidSectionObj.SectionType = "GUIDED"\r
3133 GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]\r
3134 GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]\r
3135 GuidSectionObj.ExtraHeaderSize = AttribDict["EXTRA_HEADER_SIZE"]\r
3136 # Recursive sections...\r
3137 while True:\r
3138 IsLeafSection = self.__GetLeafSection(GuidSectionObj)\r
3139 IsEncapSection = self.__GetEncapsulationSec(GuidSectionObj)\r
3140 if not IsLeafSection and not IsEncapSection:\r
3141 break\r
3142\r
3143 if not self.__IsToken( "}"):\r
3144 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
3145 Obj.SectionList.append(GuidSectionObj)\r
3146\r
3147 return True\r
3148\r
3149 return False\r
3150\r
3151 ## __GetGuidAttri() method\r
3152 #\r
3153 # Get attributes for GUID section\r
3154 #\r
3155 # @param self The object pointer\r
3156 # @retval AttribDict Dictionary of key-value pair of section attributes\r
3157 #\r
3158 def __GetGuidAttrib(self):\r
3159\r
3160 AttribDict = {}\r
3161 AttribDict["PROCESSING_REQUIRED"] = "NONE"\r
3162 AttribDict["AUTH_STATUS_VALID"] = "NONE"\r
3163 AttribDict["EXTRA_HEADER_SIZE"] = -1\r
3164 while self.__IsKeyword("PROCESSING_REQUIRED") or self.__IsKeyword("AUTH_STATUS_VALID") \\r
3165 or self.__IsKeyword("EXTRA_HEADER_SIZE"):\r
3166 AttribKey = self.__Token\r
3167\r
3168 if not self.__IsToken("="):\r
3169 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3170\r
3171 if not self.__GetNextToken():\r
3172 raise Warning("expected TRUE(1)/FALSE(0)/Number", self.FileName, self.CurrentLineNumber)\r
3173 elif AttribKey == "EXTRA_HEADER_SIZE":\r
3174 Base = 10\r
3175 if self.__Token[0:2].upper() == "0X":\r
3176 Base = 16\r
3177 try:\r
3178 AttribDict[AttribKey] = int(self.__Token, Base)\r
3179 continue\r
3180 except ValueError:\r
3181 raise Warning("expected Number", self.FileName, self.CurrentLineNumber)\r
3182 elif self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):\r
3183 raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)\r
3184 AttribDict[AttribKey] = self.__Token\r
3185\r
3186 return AttribDict\r
3187\r
3188 ## __GetEncapsulationSec() method\r
3189 #\r
3190 # Get encapsulation section for FILE\r
3191 #\r
3192 # @param self The object pointer\r
3193 # @param FfsFile for whom section is got\r
3194 # @retval True Successfully find section statement\r
3195 # @retval False Not able to find section statement\r
3196 #\r
3197 def __GetEncapsulationSec(self, FfsFileObj):\r
3198\r
3199 OldPos = self.GetFileBufferPos()\r
3200 if not self.__IsKeyword( "SECTION"):\r
3201 if len(FfsFileObj.SectionList) == 0:\r
3202 raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)\r
3203 else:\r
3204 return False\r
3205\r
3206 AlignValue = None\r
3207 if self.__GetAlignment():\r
3208 if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
3209 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
3210 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3211 AlignValue = self.__Token\r
3212\r
3213 if not self.__GetCglSection(FfsFileObj, AlignValue):\r
3214 self.SetFileBufferPos(OldPos)\r
3215 return False\r
3216 else:\r
3217 return True\r
3218\r
3219 def __GetFmp(self):\r
3220 if not self.__GetNextToken():\r
3221 return False\r
3222 S = self.__Token.upper()\r
3223 if S.startswith("[") and not S.startswith("[FMPPAYLOAD."):\r
3224 self.SectionParser(S)\r
3225 self.__UndoToken()\r
3226 return False\r
3227\r
3228 self.__UndoToken()\r
3229 self.__SkipToToken("[FMPPAYLOAD.", True)\r
3230 FmpUiName = self.__GetUiName().upper()\r
3231 if FmpUiName in self.Profile.FmpPayloadDict:\r
3232 raise Warning("Duplicated FMP UI name found: %s" % FmpUiName, self.FileName, self.CurrentLineNumber)\r
3233\r
3234 FmpData = CapsuleData.CapsulePayload()\r
3235 FmpData.UiName = FmpUiName\r
3236\r
3237 if not self.__IsToken( "]"):\r
3238 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
3239\r
3240 if not self.__GetNextToken():\r
3241 raise Warning("The FMP payload section is empty!", self.FileName, self.CurrentLineNumber)\r
3242 FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE', 'CERTIFICATE_GUID', 'MONOTONIC_COUNT']\r
3243 while self.__Token in FmpKeyList:\r
3244 Name = self.__Token\r
3245 FmpKeyList.remove(Name)\r
3246 if not self.__IsToken("="):\r
3247 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3248 if Name == 'IMAGE_TYPE_ID':\r
3249 if not self.__GetNextGuid():\r
3250 raise Warning("expected GUID value for IMAGE_TYPE_ID.", self.FileName, self.CurrentLineNumber)\r
3251 FmpData.ImageTypeId = self.__Token\r
3252 elif Name == 'CERTIFICATE_GUID':\r
3253 if not self.__GetNextGuid():\r
3254 raise Warning("expected GUID value for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
3255 FmpData.Certificate_Guid = self.__Token\r
3256 if uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_RSA2048_SHA256_GUID and uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_PKCS7_GUID:\r
3257 raise Warning("Only support EFI_CERT_TYPE_RSA2048_SHA256_GUID or EFI_CERT_TYPE_PKCS7_GUID for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
3258 else:\r
3259 if not self.__GetNextToken():\r
3260 raise Warning("expected value of %s" % Name, self.FileName, self.CurrentLineNumber)\r
3261 Value = self.__Token\r
3262 if Name == 'IMAGE_HEADER_INIT_VERSION':\r
3263 if FdfParser.__Verify(Name, Value, 'UINT8'):\r
3264 FmpData.Version = Value\r
3265 elif Name == 'IMAGE_INDEX':\r
3266 if FdfParser.__Verify(Name, Value, 'UINT8'):\r
3267 FmpData.ImageIndex = Value\r
3268 elif Name == 'HARDWARE_INSTANCE':\r
3269 if FdfParser.__Verify(Name, Value, 'UINT8'):\r
3270 FmpData.HardwareInstance = Value\r
3271 elif Name == 'MONOTONIC_COUNT':\r
3272 if FdfParser.__Verify(Name, Value, 'UINT64'):\r
3273 FmpData.MonotonicCount = Value\r
3274 if FmpData.MonotonicCount.upper().startswith('0X'):\r
3275 FmpData.MonotonicCount = (long)(FmpData.MonotonicCount, 16)\r
3276 else:\r
3277 FmpData.MonotonicCount = (long)(FmpData.MonotonicCount)\r
3278 if not self.__GetNextToken():\r
3279 break\r
3280 else:\r
3281 self.__UndoToken()\r
3282\r
3283 if (FmpData.MonotonicCount and not FmpData.Certificate_Guid) or (not FmpData.MonotonicCount and FmpData.Certificate_Guid):\r
3284 EdkLogger.error("FdfParser", FORMAT_INVALID, "CERTIFICATE_GUID and MONOTONIC_COUNT must be work as a pair.")\r
3285\r
3286 # Only the IMAGE_TYPE_ID is required item\r
3287 if FmpKeyList and 'IMAGE_TYPE_ID' in FmpKeyList:\r
3288 raise Warning("Missing keywords IMAGE_TYPE_ID in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
3289 # get the Image file and Vendor code file\r
3290 self.__GetFMPCapsuleData(FmpData)\r
3291 if not FmpData.ImageFile:\r
3292 raise Warning("Missing image file in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
3293 # check whether more than one Vendor code file\r
3294 if len(FmpData.VendorCodeFile) > 1:\r
3295 raise Warning("At most one Image file and one Vendor code file are allowed in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
3296 self.Profile.FmpPayloadDict[FmpUiName] = FmpData\r
3297 return True\r
3298\r
3299 ## __GetCapsule() method\r
3300 #\r
3301 # Get capsule section contents and store its data into capsule list of self.Profile\r
3302 #\r
3303 # @param self The object pointer\r
3304 # @retval True Successfully find a capsule\r
3305 # @retval False Not able to find a capsule\r
3306 #\r
3307 def __GetCapsule(self):\r
3308\r
3309 if not self.__GetNextToken():\r
3310 return False\r
3311\r
3312 S = self.__Token.upper()\r
3313 if S.startswith("[") and not S.startswith("[CAPSULE."):\r
3314 self.SectionParser(S)\r
3315 self.__UndoToken()\r
3316 return False\r
3317\r
3318 self.__UndoToken()\r
3319 if not self.__IsToken("[CAPSULE.", True):\r
3320 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
3321 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
3322 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
3323 raise Warning("expected [Capsule.]", self.FileName, self.CurrentLineNumber)\r
3324\r
3325 CapsuleObj = Capsule.Capsule()\r
3326\r
3327 CapsuleName = self.__GetUiName()\r
3328 if not CapsuleName:\r
3329 raise Warning("expected capsule name", self.FileName, self.CurrentLineNumber)\r
3330\r
3331 CapsuleObj.UiCapsuleName = CapsuleName.upper()\r
3332\r
3333 if not self.__IsToken( "]"):\r
3334 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
3335\r
3336 if self.__IsKeyword("CREATE_FILE"):\r
3337 if not self.__IsToken( "="):\r
3338 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3339\r
3340 if not self.__GetNextToken():\r
3341 raise Warning("expected file name", self.FileName, self.CurrentLineNumber)\r
3342\r
3343 CapsuleObj.CreateFile = self.__Token\r
3344\r
3345 self.__GetCapsuleStatements(CapsuleObj)\r
3346 self.Profile.CapsuleDict[CapsuleObj.UiCapsuleName] = CapsuleObj\r
3347 return True\r
3348\r
3349 ## __GetCapsuleStatements() method\r
3350 #\r
3351 # Get statements for capsule\r
3352 #\r
3353 # @param self The object pointer\r
3354 # @param Obj for whom statements are got\r
3355 #\r
3356 def __GetCapsuleStatements(self, Obj):\r
3357 self.__GetCapsuleTokens(Obj)\r
3358 self.__GetDefineStatements(Obj)\r
3359 self.__GetSetStatements(Obj)\r
3360 self.__GetCapsuleData(Obj)\r
3361\r
3362 ## __GetCapsuleTokens() method\r
3363 #\r
3364 # Get token statements for capsule\r
3365 #\r
3366 # @param self The object pointer\r
3367 # @param Obj for whom token statements are got\r
3368 #\r
3369 def __GetCapsuleTokens(self, Obj):\r
3370 if not self.__GetNextToken():\r
3371 return False\r
3372 while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS", "OEM_CAPSULE_FLAGS", "CAPSULE_HEADER_INIT_VERSION"):\r
3373 Name = self.__Token.strip()\r
3374 if not self.__IsToken("="):\r
3375 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3376 if not self.__GetNextToken():\r
3377 raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
3378 if Name == 'CAPSULE_FLAGS':\r
3379 if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):\r
3380 raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)\r
3381 Value = self.__Token.strip()\r
3382 while self.__IsToken(","):\r
3383 Value += ','\r
3384 if not self.__GetNextToken():\r
3385 raise Warning("expected value", self.FileName, self.CurrentLineNumber)\r
3386 if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):\r
3387 raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)\r
3388 Value += self.__Token.strip()\r
3389 elif Name == 'OEM_CAPSULE_FLAGS':\r
3390 Value = self.__Token.strip()\r
3391 if not Value.upper().startswith('0X'):\r
3392 raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
3393 try:\r
3394 Value = int(Value, 0)\r
3395 except ValueError:\r
3396 raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
3397 if not 0x0000 <= Value <= 0xFFFF:\r
3398 raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
3399 Value = self.__Token.strip()\r
3400 else:\r
3401 Value = self.__Token.strip()\r
3402 Obj.TokensDict[Name] = Value\r
3403 if not self.__GetNextToken():\r
3404 return False\r
3405 self.__UndoToken()\r
3406\r
3407 ## __GetCapsuleData() method\r
3408 #\r
3409 # Get capsule data for capsule\r
3410 #\r
3411 # @param self The object pointer\r
3412 # @param Obj for whom capsule data are got\r
3413 #\r
3414 def __GetCapsuleData(self, Obj):\r
3415\r
3416 while True:\r
3417 IsInf = self.__GetInfStatement(Obj, True)\r
3418 IsFile = self.__GetFileStatement(Obj, True)\r
3419 IsFv = self.__GetFvStatement(Obj)\r
3420 IsFd = self.__GetFdStatement(Obj)\r
3421 IsAnyFile = self.__GetAnyFileStatement(Obj)\r
3422 IsAfile = self.__GetAfileStatement(Obj)\r
3423 IsFmp = self.__GetFmpStatement(Obj)\r
3424 if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile or IsFmp):\r
3425 break\r
3426\r
3427 ## __GetFMPCapsuleData() method\r
3428 #\r
3429 # Get capsule data for FMP capsule\r
3430 #\r
3431 # @param self The object pointer\r
3432 # @param Obj for whom capsule data are got\r
3433 #\r
3434 def __GetFMPCapsuleData(self, Obj):\r
3435\r
3436 while True:\r
3437 IsFv = self.__GetFvStatement(Obj, True)\r
3438 IsFd = self.__GetFdStatement(Obj, True)\r
3439 IsAnyFile = self.__GetAnyFileStatement(Obj, True)\r
3440 if not (IsFv or IsFd or IsAnyFile):\r
3441 break\r
3442\r
3443 ## __GetFvStatement() method\r
3444 #\r
3445 # Get FV for capsule\r
3446 #\r
3447 # @param self The object pointer\r
3448 # @param CapsuleObj for whom FV is got\r
3449 # @retval True Successfully find a FV statement\r
3450 # @retval False Not able to find a FV statement\r
3451 #\r
3452 def __GetFvStatement(self, CapsuleObj, FMPCapsule = False):\r
3453\r
3454 if not self.__IsKeyword(BINARY_FILE_TYPE_FV):\r
3455 return False\r
3456\r
3457 if not self.__IsToken("="):\r
3458 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3459\r
3460 if not self.__GetNextToken():\r
3461 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)\r
3462\r
3463 if self.__Token.upper() not in self.Profile.FvDict:\r
3464 raise Warning("FV name does not exist", self.FileName, self.CurrentLineNumber)\r
3465\r
3466 CapsuleFv = CapsuleData.CapsuleFv()\r
3467 CapsuleFv.FvName = self.__Token\r
3468 if FMPCapsule:\r
3469 if not CapsuleObj.ImageFile:\r
3470 CapsuleObj.ImageFile.append(CapsuleFv)\r
3471 else:\r
3472 CapsuleObj.VendorCodeFile.append(CapsuleFv)\r
3473 else:\r
3474 CapsuleObj.CapsuleDataList.append(CapsuleFv)\r
3475 return True\r
3476\r
3477 ## __GetFdStatement() method\r
3478 #\r
3479 # Get FD for capsule\r
3480 #\r
3481 # @param self The object pointer\r
3482 # @param CapsuleObj for whom FD is got\r
3483 # @retval True Successfully find a FD statement\r
3484 # @retval False Not able to find a FD statement\r
3485 #\r
3486 def __GetFdStatement(self, CapsuleObj, FMPCapsule = False):\r
3487\r
3488 if not self.__IsKeyword("FD"):\r
3489 return False\r
3490\r
3491 if not self.__IsToken("="):\r
3492 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3493\r
3494 if not self.__GetNextToken():\r
3495 raise Warning("expected FD name", self.FileName, self.CurrentLineNumber)\r
3496\r
3497 if self.__Token.upper() not in self.Profile.FdDict:\r
3498 raise Warning("FD name does not exist", self.FileName, self.CurrentLineNumber)\r
3499\r
3500 CapsuleFd = CapsuleData.CapsuleFd()\r
3501 CapsuleFd.FdName = self.__Token\r
3502 if FMPCapsule:\r
3503 if not CapsuleObj.ImageFile:\r
3504 CapsuleObj.ImageFile.append(CapsuleFd)\r
3505 else:\r
3506 CapsuleObj.VendorCodeFile.append(CapsuleFd)\r
3507 else:\r
3508 CapsuleObj.CapsuleDataList.append(CapsuleFd)\r
3509 return True\r
3510\r
3511 def __GetFmpStatement(self, CapsuleObj):\r
3512 if not self.__IsKeyword("FMP_PAYLOAD"):\r
3513 if not self.__IsKeyword("FMP"):\r
3514 return False\r
3515\r
3516 if not self.__IsKeyword("PAYLOAD"):\r
3517 self.__UndoToken()\r
3518 return False\r
3519\r
3520 if not self.__IsToken("="):\r
3521 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3522\r
3523 if not self.__GetNextToken():\r
3524 raise Warning("expected payload name after FMP_PAYLOAD =", self.FileName, self.CurrentLineNumber)\r
3525 Payload = self.__Token.upper()\r
3526 if Payload not in self.Profile.FmpPayloadDict:\r
3527 raise Warning("This FMP Payload does not exist: %s" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3528 CapsuleObj.FmpPayloadList.append(self.Profile.FmpPayloadDict[Payload])\r
3529 return True\r
3530\r
3531 def __ParseRawFileStatement(self):\r
3532 if not self.__IsKeyword("FILE"):\r
3533 return None\r
3534\r
3535 if not self.__IsKeyword("DATA"):\r
3536 self.__UndoToken()\r
3537 return None\r
3538\r
3539 if not self.__IsToken("="):\r
3540 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3541\r
3542 if not self.__GetNextToken():\r
3543 raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
3544\r
3545 AnyFileName = self.__Token\r
3546 self.__VerifyFile(AnyFileName)\r
3547\r
3548 if not os.path.isabs(AnyFileName):\r
3549 AnyFileName = mws.join(GenFdsGlobalVariable.WorkSpaceDir, AnyFileName)\r
3550\r
3551 return AnyFileName\r
3552\r
3553 ## __GetAnyFileStatement() method\r
3554 #\r
3555 # Get AnyFile for capsule\r
3556 #\r
3557 # @param self The object pointer\r
3558 # @param CapsuleObj for whom AnyFile is got\r
3559 # @retval True Successfully find a Anyfile statement\r
3560 # @retval False Not able to find a AnyFile statement\r
3561 #\r
3562 def __GetAnyFileStatement(self, CapsuleObj, FMPCapsule = False):\r
3563 AnyFileName = self.__ParseRawFileStatement()\r
3564 if not AnyFileName:\r
3565 return False\r
3566\r
3567 CapsuleAnyFile = CapsuleData.CapsuleAnyFile()\r
3568 CapsuleAnyFile.FileName = AnyFileName\r
3569 if FMPCapsule:\r
3570 if not CapsuleObj.ImageFile:\r
3571 CapsuleObj.ImageFile.append(CapsuleAnyFile)\r
3572 else:\r
3573 CapsuleObj.VendorCodeFile.append(CapsuleAnyFile)\r
3574 else:\r
3575 CapsuleObj.CapsuleDataList.append(CapsuleAnyFile)\r
3576 return True\r
3577\r
3578 ## __GetAfileStatement() method\r
3579 #\r
3580 # Get Afile for capsule\r
3581 #\r
3582 # @param self The object pointer\r
3583 # @param CapsuleObj for whom Afile is got\r
3584 # @retval True Successfully find a Afile statement\r
3585 # @retval False Not able to find a Afile statement\r
3586 #\r
3587 def __GetAfileStatement(self, CapsuleObj):\r
3588\r
3589 if not self.__IsKeyword("APPEND"):\r
3590 return False\r
3591\r
3592 if not self.__IsToken("="):\r
3593 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3594\r
3595 if not self.__GetNextToken():\r
3596 raise Warning("expected Afile name", self.FileName, self.CurrentLineNumber)\r
3597\r
3598 AfileName = self.__Token\r
3599 AfileBaseName = os.path.basename(AfileName)\r
3600\r
3601 if os.path.splitext(AfileBaseName)[1] not in [".bin", ".BIN", ".Bin", ".dat", ".DAT", ".Dat", ".data", ".DATA", ".Data"]:\r
3602 raise Warning('invalid binary file type, should be one of "bin",BINARY_FILE_TYPE_BIN,"Bin","dat","DAT","Dat","data","DATA","Data"', \\r
3603 self.FileName, self.CurrentLineNumber)\r
3604\r
3605 if not os.path.isabs(AfileName):\r
3606 AfileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(AfileName)\r
3607 self.__VerifyFile(AfileName)\r
3608 else:\r
3609 if not os.path.exists(AfileName):\r
3610 raise Warning('%s does not exist' % AfileName, self.FileName, self.CurrentLineNumber)\r
3611 else:\r
3612 pass\r
3613\r
3614 CapsuleAfile = CapsuleData.CapsuleAfile()\r
3615 CapsuleAfile.FileName = AfileName\r
3616 CapsuleObj.CapsuleDataList.append(CapsuleAfile)\r
3617 return True\r
3618\r
3619 ## __GetRule() method\r
3620 #\r
3621 # Get Rule section contents and store its data into rule list of self.Profile\r
3622 #\r
3623 # @param self The object pointer\r
3624 # @retval True Successfully find a Rule\r
3625 # @retval False Not able to find a Rule\r
3626 #\r
3627 def __GetRule(self):\r
3628\r
3629 if not self.__GetNextToken():\r
3630 return False\r
3631\r
3632 S = self.__Token.upper()\r
3633 if S.startswith("[") and not S.startswith("[RULE."):\r
3634 self.SectionParser(S)\r
3635 self.__UndoToken()\r
3636 return False\r
3637 self.__UndoToken()\r
3638 if not self.__IsToken("[Rule.", True):\r
3639 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
3640 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
3641 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
3642 raise Warning("expected [Rule.]", self.FileName, self.CurrentLineNumber)\r
3643\r
3644 if not self.__SkipToToken("."):\r
3645 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
3646\r
3647 Arch = self.__SkippedChars.rstrip(".")\r
3648 if Arch.upper() not in ARCH_SET_FULL:\r
3649 raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)\r
3650\r
3651 ModuleType = self.__GetModuleType()\r
3652\r
3653 TemplateName = ""\r
3654 if self.__IsToken("."):\r
3655 if not self.__GetNextWord():\r
3656 raise Warning("expected template name", self.FileName, self.CurrentLineNumber)\r
3657 TemplateName = self.__Token\r
3658\r
3659 if not self.__IsToken( "]"):\r
3660 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
3661\r
3662 RuleObj = self.__GetRuleFileStatements()\r
3663 RuleObj.Arch = Arch.upper()\r
3664 RuleObj.ModuleType = ModuleType\r
3665 RuleObj.TemplateName = TemplateName\r
3666 if TemplateName == '' :\r
3667 self.Profile.RuleDict['RULE' + \\r
3668 '.' + \\r
3669 Arch.upper() + \\r
3670 '.' + \\r
3671 ModuleType.upper() ] = RuleObj\r
3672 else :\r
3673 self.Profile.RuleDict['RULE' + \\r
3674 '.' + \\r
3675 Arch.upper() + \\r
3676 '.' + \\r
3677 ModuleType.upper() + \\r
3678 '.' + \\r
3679 TemplateName.upper() ] = RuleObj\r
3680# self.Profile.RuleList.append(rule)\r
3681 return True\r
3682\r
3683 ## __GetModuleType() method\r
3684 #\r
3685 # Return the module type\r
3686 #\r
3687 # @param self The object pointer\r
3688 # @retval string module type\r
3689 #\r
3690 def __GetModuleType(self):\r
3691\r
3692 if not self.__GetNextWord():\r
3693 raise Warning("expected Module type", self.FileName, self.CurrentLineNumber)\r
3694 if self.__Token.upper() not in (SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, SUP_MODULE_DXE_CORE, \\r
3695 SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, \\r
3696 SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER, \\r
3697 SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_USER_DEFINED, "DEFAULT", SUP_MODULE_BASE, \\r
3698 EDK_COMPONENT_TYPE_SECURITY_CORE, EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER, EDK_COMPONENT_TYPE_PIC_PEIM, EDK_COMPONENT_TYPE_RELOCATABLE_PEIM, \\r
3699 "PE32_PEIM", EDK_COMPONENT_TYPE_BS_DRIVER, EDK_COMPONENT_TYPE_RT_DRIVER, EDK_COMPONENT_TYPE_SAL_RT_DRIVER, EDK_COMPONENT_TYPE_APPLICATION, "ACPITABLE", SUP_MODULE_SMM_CORE, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE):\r
3700 raise Warning("Unknown Module type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3701 return self.__Token\r
3702\r
3703 ## __GetFileExtension() method\r
3704 #\r
3705 # Return the file extension\r
3706 #\r
3707 # @param self The object pointer\r
3708 # @retval string file name extension\r
3709 #\r
3710 def __GetFileExtension(self):\r
3711 if not self.__IsToken("."):\r
3712 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
3713\r
3714 Ext = ""\r
3715 if self.__GetNextToken():\r
3716 if FileExtensionPattern.match(self.__Token):\r
3717 Ext = self.__Token\r
3718 return '.' + Ext\r
3719 else:\r
3720 raise Warning("Unknown file extension '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3721\r
3722 else:\r
3723 raise Warning("expected file extension", self.FileName, self.CurrentLineNumber)\r
3724\r
3725 ## __GetRuleFileStatement() method\r
3726 #\r
3727 # Get rule contents\r
3728 #\r
3729 # @param self The object pointer\r
3730 # @retval Rule Rule object\r
3731 #\r
3732 def __GetRuleFileStatements(self):\r
3733\r
3734 if not self.__IsKeyword("FILE"):\r
3735 raise Warning("expected FILE", self.FileName, self.CurrentLineNumber)\r
3736\r
3737 if not self.__GetNextWord():\r
3738 raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)\r
3739\r
3740 Type = self.__Token.strip().upper()\r
3741 if Type not in ("RAW", "FREEFORM", SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM,\\r
3742 "PEI_DXE_COMBO", "DRIVER", SUP_MODULE_DXE_CORE, EDK_COMPONENT_TYPE_APPLICATION, "FV_IMAGE", "SMM", SUP_MODULE_SMM_CORE, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE):\r
3743 raise Warning("Unknown FV type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3744\r
3745 if not self.__IsToken("="):\r
3746 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3747\r
3748 if not self.__IsKeyword("$(NAMED_GUID)"):\r
3749 if not self.__GetNextWord():\r
3750 raise Warning("expected $(NAMED_GUID)", self.FileName, self.CurrentLineNumber)\r
3751 if self.__Token == 'PCD':\r
3752 if not self.__IsToken( "("):\r
3753 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
3754 PcdPair = self.__GetNextPcdSettings()\r
3755 if not self.__IsToken( ")"):\r
3756 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
3757 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
3758\r
3759 NameGuid = self.__Token\r
3760\r
3761 KeepReloc = None\r
3762 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
3763 if self.__FileCouldHaveRelocFlag(Type):\r
3764 if self.__Token == 'RELOCS_STRIPPED':\r
3765 KeepReloc = False\r
3766 else:\r
3767 KeepReloc = True\r
3768 else:\r
3769 raise Warning("File type %s could not have reloc strip flag%d" % (Type, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3770\r
3771 KeyStringList = []\r
3772 if self.__GetNextToken():\r
3773 if TokenFindPattern.match(self.__Token):\r
3774 KeyStringList.append(self.__Token)\r
3775 if self.__IsToken(","):\r
3776 while self.__GetNextToken():\r
3777 if not TokenFindPattern.match(self.__Token):\r
3778 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)\r
3779 KeyStringList.append(self.__Token)\r
3780\r
3781 if not self.__IsToken(","):\r
3782 break\r
3783\r
3784 else:\r
3785 self.__UndoToken()\r
3786\r
3787\r
3788 Fixed = False\r
3789 if self.__IsKeyword("Fixed", True):\r
3790 Fixed = True\r
3791\r
3792 CheckSum = False\r
3793 if self.__IsKeyword("CheckSum", True):\r
3794 CheckSum = True\r
3795\r
3796 AlignValue = ""\r
3797 if self.__GetAlignment():\r
3798 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
3799 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
3800 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3801 #For FFS, Auto is default option same to ""\r
3802 if not self.__Token == "Auto":\r
3803 AlignValue = self.__Token\r
3804\r
3805 if self.__IsToken("{"):\r
3806 # Complex file rule expected\r
3807 Rule = RuleComplexFile.RuleComplexFile()\r
3808 Rule.FvFileType = Type\r
3809 Rule.NameGuid = NameGuid\r
3810 Rule.Alignment = AlignValue\r
3811 Rule.CheckSum = CheckSum\r
3812 Rule.Fixed = Fixed\r
3813 Rule.KeyStringList = KeyStringList\r
3814 if KeepReloc is not None:\r
3815 Rule.KeepReloc = KeepReloc\r
3816\r
3817 while True:\r
3818 IsEncapsulate = self.__GetRuleEncapsulationSection(Rule)\r
3819 IsLeaf = self.__GetEfiSection(Rule)\r
3820 if not IsEncapsulate and not IsLeaf:\r
3821 break\r
3822\r
3823 if not self.__IsToken("}"):\r
3824 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
3825\r
3826 return Rule\r
3827\r
3828 else:\r
3829 # Simple file rule expected\r
3830 if not self.__GetNextWord():\r
3831 raise Warning("expected leaf section type", self.FileName, self.CurrentLineNumber)\r
3832\r
3833 SectionName = self.__Token\r
3834\r
3835 if SectionName not in ("COMPAT16", BINARY_FILE_TYPE_PE32, BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_TE, "FV_IMAGE", "RAW", BINARY_FILE_TYPE_DXE_DEPEX,\\r
3836 BINARY_FILE_TYPE_UI, BINARY_FILE_TYPE_PEI_DEPEX, "VERSION", "SUBTYPE_GUID", BINARY_FILE_TYPE_SMM_DEPEX):\r
3837 raise Warning("Unknown leaf section name '%s'" % SectionName, self.FileName, self.CurrentLineNumber)\r
3838\r
3839\r
3840 if self.__IsKeyword("Fixed", True):\r
3841 Fixed = True\r
3842\r
3843 if self.__IsKeyword("CheckSum", True):\r
3844 CheckSum = True\r
3845\r
3846 SectAlignment = ""\r
3847 if self.__GetAlignment():\r
3848 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
3849 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
3850 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3851 if self.__Token == 'Auto' and (not SectionName == BINARY_FILE_TYPE_PE32) and (not SectionName == BINARY_FILE_TYPE_TE):\r
3852 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
3853 SectAlignment = self.__Token\r
3854\r
3855 Ext = None\r
3856 if self.__IsToken('|'):\r
3857 Ext = self.__GetFileExtension()\r
3858 elif not self.__GetNextToken():\r
3859 raise Warning("expected File name", self.FileName, self.CurrentLineNumber)\r
3860\r
3861 Rule = RuleSimpleFile.RuleSimpleFile()\r
3862 Rule.SectionType = SectionName\r
3863 Rule.FvFileType = Type\r
3864 Rule.NameGuid = NameGuid\r
3865 Rule.Alignment = AlignValue\r
3866 Rule.SectAlignment = SectAlignment\r
3867 Rule.CheckSum = CheckSum\r
3868 Rule.Fixed = Fixed\r
3869 Rule.KeyStringList = KeyStringList\r
3870 if KeepReloc is not None:\r
3871 Rule.KeepReloc = KeepReloc\r
3872 Rule.FileExtension = Ext\r
3873 Rule.FileName = self.__Token\r
3874 return Rule\r
3875\r
3876 ## __GetEfiSection() method\r
3877 #\r
3878 # Get section list for Rule\r
3879 #\r
3880 # @param self The object pointer\r
3881 # @param Obj for whom section is got\r
3882 # @retval True Successfully find section statement\r
3883 # @retval False Not able to find section statement\r
3884 #\r
3885 def __GetEfiSection(self, Obj):\r
3886\r
3887 OldPos = self.GetFileBufferPos()\r
3888 if not self.__GetNextWord():\r
3889 return False\r
3890 SectionName = self.__Token\r
3891\r
3892 if SectionName not in ("COMPAT16", BINARY_FILE_TYPE_PE32, BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_TE, "FV_IMAGE", "RAW", BINARY_FILE_TYPE_DXE_DEPEX,\\r
3893 BINARY_FILE_TYPE_UI, "VERSION", BINARY_FILE_TYPE_PEI_DEPEX, BINARY_FILE_TYPE_GUID, BINARY_FILE_TYPE_SMM_DEPEX):\r
3894 self.__UndoToken()\r
3895 return False\r
3896\r
3897 if SectionName == "FV_IMAGE":\r
3898 FvImageSectionObj = FvImageSection.FvImageSection()\r
3899 if self.__IsKeyword("FV_IMAGE"):\r
3900 pass\r
3901 if self.__IsToken( "{"):\r
3902 FvObj = Fv.FV()\r
3903 self.__GetDefineStatements(FvObj)\r
3904 self.__GetBlockStatement(FvObj)\r
3905 self.__GetSetStatements(FvObj)\r
3906 self.__GetFvAlignment(FvObj)\r
3907 self.__GetFvAttributes(FvObj)\r
3908 self.__GetAprioriSection(FvObj)\r
3909 self.__GetAprioriSection(FvObj)\r
3910\r
3911 while True:\r
3912 IsInf = self.__GetInfStatement(FvObj)\r
3913 IsFile = self.__GetFileStatement(FvObj)\r
3914 if not IsInf and not IsFile:\r
3915 break\r
3916\r
3917 if not self.__IsToken( "}"):\r
3918 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
3919 FvImageSectionObj.Fv = FvObj\r
3920 FvImageSectionObj.FvName = None\r
3921\r
3922 else:\r
3923 if not self.__IsKeyword(BINARY_FILE_TYPE_FV):\r
3924 raise Warning("expected BINARY_FILE_TYPE_FV", self.FileName, self.CurrentLineNumber)\r
3925 FvImageSectionObj.FvFileType = self.__Token\r
3926\r
3927 if self.__GetAlignment():\r
3928 if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
3929 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
3930 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3931 FvImageSectionObj.Alignment = self.__Token\r
3932\r
3933 if self.__IsToken('|'):\r
3934 FvImageSectionObj.FvFileExtension = self.__GetFileExtension()\r
3935 elif self.__GetNextToken():\r
3936 if self.__Token not in ("}", "COMPAT16", BINARY_FILE_TYPE_PE32, BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_TE, "FV_IMAGE", "RAW", BINARY_FILE_TYPE_DXE_DEPEX,\\r
3937 BINARY_FILE_TYPE_UI, "VERSION", BINARY_FILE_TYPE_PEI_DEPEX, BINARY_FILE_TYPE_GUID, BINARY_FILE_TYPE_SMM_DEPEX):\r
3938 FvImageSectionObj.FvFileName = self.__Token\r
3939 else:\r
3940 self.__UndoToken()\r
3941 else:\r
3942 raise Warning("expected FV file name", self.FileName, self.CurrentLineNumber)\r
3943\r
3944 Obj.SectionList.append(FvImageSectionObj)\r
3945 return True\r
3946\r
3947 EfiSectionObj = EfiSection.EfiSection()\r
3948 EfiSectionObj.SectionType = SectionName\r
3949\r
3950 if not self.__GetNextToken():\r
3951 raise Warning("expected file type", self.FileName, self.CurrentLineNumber)\r
3952\r
3953 if self.__Token == "STRING":\r
3954 if not self.__RuleSectionCouldHaveString(EfiSectionObj.SectionType):\r
3955 raise Warning("%s section could NOT have string data%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3956\r
3957 if not self.__IsToken('='):\r
3958 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3959\r
3960 if not self.__GetNextToken():\r
3961 raise Warning("expected Quoted String", self.FileName, self.CurrentLineNumber)\r
3962\r
3963 if self.__GetStringData():\r
3964 EfiSectionObj.StringData = self.__Token\r
3965\r
3966 if self.__IsKeyword("BUILD_NUM"):\r
3967 if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):\r
3968 raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3969\r
3970 if not self.__IsToken("="):\r
3971 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3972 if not self.__GetNextToken():\r
3973 raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)\r
3974 EfiSectionObj.BuildNum = self.__Token\r
3975\r
3976 else:\r
3977 EfiSectionObj.FileType = self.__Token\r
3978 self.__CheckRuleSectionFileType(EfiSectionObj.SectionType, EfiSectionObj.FileType)\r
3979\r
3980 if self.__IsKeyword("Optional"):\r
3981 if not self.__RuleSectionCouldBeOptional(EfiSectionObj.SectionType):\r
3982 raise Warning("%s section could NOT be optional%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3983 EfiSectionObj.Optional = True\r
3984\r
3985 if self.__IsKeyword("BUILD_NUM"):\r
3986 if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):\r
3987 raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)\r
3988\r
3989 if not self.__IsToken("="):\r
3990 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
3991 if not self.__GetNextToken():\r
3992 raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)\r
3993 EfiSectionObj.BuildNum = self.__Token\r
3994\r
3995 if self.__GetAlignment():\r
3996 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K", "64K", "128K",\r
3997 "256K", "512K", "1M", "2M", "4M", "8M", "16M"):\r
3998 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
3999 if self.__Token == 'Auto' and (not SectionName == BINARY_FILE_TYPE_PE32) and (not SectionName == BINARY_FILE_TYPE_TE):\r
4000 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)\r
4001 EfiSectionObj.Alignment = self.__Token\r
4002\r
4003 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):\r
4004 if self.__SectionCouldHaveRelocFlag(EfiSectionObj.SectionType):\r
4005 if self.__Token == 'RELOCS_STRIPPED':\r
4006 EfiSectionObj.KeepReloc = False\r
4007 else:\r
4008 EfiSectionObj.KeepReloc = True\r
4009 if Obj.KeepReloc is not None and Obj.KeepReloc != EfiSectionObj.KeepReloc:\r
4010 raise Warning("Section type %s has reloc strip flag conflict with Rule" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)\r
4011 else:\r
4012 raise Warning("Section type %s could not have reloc strip flag" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)\r
4013\r
4014\r
4015 if self.__IsToken('|'):\r
4016 EfiSectionObj.FileExtension = self.__GetFileExtension()\r
4017 elif self.__GetNextToken():\r
4018 if self.__Token not in ("}", "COMPAT16", BINARY_FILE_TYPE_PE32, BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_TE, "FV_IMAGE", "RAW", BINARY_FILE_TYPE_DXE_DEPEX,\\r
4019 BINARY_FILE_TYPE_UI, "VERSION", BINARY_FILE_TYPE_PEI_DEPEX, BINARY_FILE_TYPE_GUID, BINARY_FILE_TYPE_SMM_DEPEX):\r
4020\r
4021 if self.__Token.startswith('PCD'):\r
4022 self.__UndoToken()\r
4023 self.__GetNextWord()\r
4024\r
4025 if self.__Token == 'PCD':\r
4026 if not self.__IsToken( "("):\r
4027 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)\r
4028 PcdPair = self.__GetNextPcdSettings()\r
4029 if not self.__IsToken( ")"):\r
4030 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)\r
4031 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'\r
4032\r
4033 EfiSectionObj.FileName = self.__Token\r
4034\r
4035 else:\r
4036 self.__UndoToken()\r
4037 else:\r
4038 raise Warning("expected section file name", self.FileName, self.CurrentLineNumber)\r
4039\r
4040 Obj.SectionList.append(EfiSectionObj)\r
4041 return True\r
4042\r
4043 ## __RuleSectionCouldBeOptional() method\r
4044 #\r
4045 # Get whether a section could be optional\r
4046 #\r
4047 # @param SectionType The section type to check\r
4048 # @retval True section could be optional\r
4049 # @retval False section never optional\r
4050 #\r
4051 @staticmethod\r
4052 def __RuleSectionCouldBeOptional(SectionType):\r
4053 if SectionType in (BINARY_FILE_TYPE_DXE_DEPEX, BINARY_FILE_TYPE_UI, "VERSION", BINARY_FILE_TYPE_PEI_DEPEX, "RAW", BINARY_FILE_TYPE_SMM_DEPEX):\r
4054 return True\r
4055 else:\r
4056 return False\r
4057\r
4058 ## __RuleSectionCouldHaveBuildNum() method\r
4059 #\r
4060 # Get whether a section could have build number information\r
4061 #\r
4062 # @param SectionType The section type to check\r
4063 # @retval True section could have build number information\r
4064 # @retval False section never have build number information\r
4065 #\r
4066 @staticmethod\r
4067 def __RuleSectionCouldHaveBuildNum(SectionType):\r
4068 if SectionType in ("VERSION"):\r
4069 return True\r
4070 else:\r
4071 return False\r
4072\r
4073 ## __RuleSectionCouldHaveString() method\r
4074 #\r
4075 # Get whether a section could have string\r
4076 #\r
4077 # @param SectionType The section type to check\r
4078 # @retval True section could have string\r
4079 # @retval False section never have string\r
4080 #\r
4081 @staticmethod\r
4082 def __RuleSectionCouldHaveString(SectionType):\r
4083 if SectionType in (BINARY_FILE_TYPE_UI, "VERSION"):\r
4084 return True\r
4085 else:\r
4086 return False\r
4087\r
4088 ## __CheckRuleSectionFileType() method\r
4089 #\r
4090 # Get whether a section matches a file type\r
4091 #\r
4092 # @param self The object pointer\r
4093 # @param SectionType The section type to check\r
4094 # @param FileType The file type to check\r
4095 #\r
4096 def __CheckRuleSectionFileType(self, SectionType, FileType):\r
4097 if SectionType == "COMPAT16":\r
4098 if FileType not in ("COMPAT16", "SEC_COMPAT16"):\r
4099 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4100 elif SectionType == BINARY_FILE_TYPE_PE32:\r
4101 if FileType not in (BINARY_FILE_TYPE_PE32, "SEC_PE32"):\r
4102 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4103 elif SectionType == BINARY_FILE_TYPE_PIC:\r
4104 if FileType not in (BINARY_FILE_TYPE_PIC, BINARY_FILE_TYPE_PIC):\r
4105 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4106 elif SectionType == BINARY_FILE_TYPE_TE:\r
4107 if FileType not in (BINARY_FILE_TYPE_TE, "SEC_TE"):\r
4108 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4109 elif SectionType == "RAW":\r
4110 if FileType not in (BINARY_FILE_TYPE_BIN, "SEC_BIN", "RAW", "ASL", "ACPI"):\r
4111 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4112 elif SectionType == BINARY_FILE_TYPE_DXE_DEPEX or SectionType == BINARY_FILE_TYPE_SMM_DEPEX:\r
4113 if FileType not in (BINARY_FILE_TYPE_DXE_DEPEX, "SEC_DXE_DEPEX", BINARY_FILE_TYPE_SMM_DEPEX):\r
4114 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4115 elif SectionType == BINARY_FILE_TYPE_UI:\r
4116 if FileType not in (BINARY_FILE_TYPE_UI, "SEC_UI"):\r
4117 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4118 elif SectionType == "VERSION":\r
4119 if FileType not in ("VERSION", "SEC_VERSION"):\r
4120 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4121 elif SectionType == BINARY_FILE_TYPE_PEI_DEPEX:\r
4122 if FileType not in (BINARY_FILE_TYPE_PEI_DEPEX, "SEC_PEI_DEPEX"):\r
4123 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4124 elif SectionType == BINARY_FILE_TYPE_GUID:\r
4125 if FileType not in (BINARY_FILE_TYPE_PE32, "SEC_GUID"):\r
4126 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)\r
4127\r
4128 ## __GetRuleEncapsulationSection() method\r
4129 #\r
4130 # Get encapsulation section for Rule\r
4131 #\r
4132 # @param self The object pointer\r
4133 # @param Rule for whom section is got\r
4134 # @retval True Successfully find section statement\r
4135 # @retval False Not able to find section statement\r
4136 #\r
4137 def __GetRuleEncapsulationSection(self, Rule):\r
4138\r
4139 if self.__IsKeyword( "COMPRESS"):\r
4140 Type = "PI_STD"\r
4141 if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):\r
4142 Type = self.__Token\r
4143\r
4144 if not self.__IsToken("{"):\r
4145 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
4146\r
4147 CompressSectionObj = CompressSection.CompressSection()\r
4148\r
4149 CompressSectionObj.CompType = Type\r
4150 # Recursive sections...\r
4151 while True:\r
4152 IsEncapsulate = self.__GetRuleEncapsulationSection(CompressSectionObj)\r
4153 IsLeaf = self.__GetEfiSection(CompressSectionObj)\r
4154 if not IsEncapsulate and not IsLeaf:\r
4155 break\r
4156\r
4157 if not self.__IsToken( "}"):\r
4158 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
4159 Rule.SectionList.append(CompressSectionObj)\r
4160\r
4161 return True\r
4162\r
4163 elif self.__IsKeyword( "GUIDED"):\r
4164 GuidValue = None\r
4165 if self.__GetNextGuid():\r
4166 GuidValue = self.__Token\r
4167\r
4168 if self.__IsKeyword( "$(NAMED_GUID)"):\r
4169 GuidValue = self.__Token\r
4170\r
4171 AttribDict = self.__GetGuidAttrib()\r
4172\r
4173 if not self.__IsToken("{"):\r
4174 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)\r
4175 GuidSectionObj = GuidSection.GuidSection()\r
4176 GuidSectionObj.NameGuid = GuidValue\r
4177 GuidSectionObj.SectionType = "GUIDED"\r
4178 GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]\r
4179 GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]\r
4180 GuidSectionObj.ExtraHeaderSize = AttribDict["EXTRA_HEADER_SIZE"]\r
4181\r
4182 # Efi sections...\r
4183 while True:\r
4184 IsEncapsulate = self.__GetRuleEncapsulationSection(GuidSectionObj)\r
4185 IsLeaf = self.__GetEfiSection(GuidSectionObj)\r
4186 if not IsEncapsulate and not IsLeaf:\r
4187 break\r
4188\r
4189 if not self.__IsToken( "}"):\r
4190 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
4191 Rule.SectionList.append(GuidSectionObj)\r
4192\r
4193 return True\r
4194\r
4195 return False\r
4196\r
4197 ## __GetVtf() method\r
4198 #\r
4199 # Get VTF section contents and store its data into VTF list of self.Profile\r
4200 #\r
4201 # @param self The object pointer\r
4202 # @retval True Successfully find a VTF\r
4203 # @retval False Not able to find a VTF\r
4204 #\r
4205 def __GetVtf(self):\r
4206\r
4207 if not self.__GetNextToken():\r
4208 return False\r
4209\r
4210 S = self.__Token.upper()\r
4211 if S.startswith("[") and not S.startswith("[VTF."):\r
4212 self.SectionParser(S)\r
4213 self.__UndoToken()\r
4214 return False\r
4215\r
4216 self.__UndoToken()\r
4217 if not self.__IsToken("[VTF.", True):\r
4218 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
4219 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \\r
4220 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)\r
4221 raise Warning("expected [VTF.]", self.FileName, self.CurrentLineNumber)\r
4222\r
4223 if not self.__SkipToToken("."):\r
4224 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)\r
4225\r
4226 Arch = self.__SkippedChars.rstrip(".").upper()\r
4227 if Arch not in ("IA32", "X64", "IPF", "ARM", "AARCH64"):\r
4228 raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)\r
4229\r
4230 if not self.__GetNextWord():\r
4231 raise Warning("expected VTF name", self.FileName, self.CurrentLineNumber)\r
4232 Name = self.__Token.upper()\r
4233\r
4234 VtfObj = Vtf.Vtf()\r
4235 VtfObj.UiName = Name\r
4236 VtfObj.KeyArch = Arch\r
4237\r
4238 if self.__IsToken(","):\r
4239 if not self.__GetNextWord():\r
4240 raise Warning("expected Arch list", self.FileName, self.CurrentLineNumber)\r
4241 if self.__Token.upper() not in ("IA32", "X64", "IPF", "ARM", "AARCH64"):\r
4242 raise Warning("Unknown Arch '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4243 VtfObj.ArchList = self.__Token.upper()\r
4244\r
4245 if not self.__IsToken( "]"):\r
4246 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
4247\r
4248 if self.__IsKeyword("IA32_RST_BIN"):\r
4249 if not self.__IsToken("="):\r
4250 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4251\r
4252 if not self.__GetNextToken():\r
4253 raise Warning("expected Reset file", self.FileName, self.CurrentLineNumber)\r
4254\r
4255 VtfObj.ResetBin = self.__Token\r
4256 if VtfObj.ResetBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
4257 #check for file path\r
4258 ErrorCode, ErrorInfo = PathClass(NormPath(VtfObj.ResetBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
4259 if ErrorCode != 0:\r
4260 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
4261\r
4262 while self.__GetComponentStatement(VtfObj):\r
4263 pass\r
4264\r
4265 self.Profile.VtfList.append(VtfObj)\r
4266 return True\r
4267\r
4268 ## __GetComponentStatement() method\r
4269 #\r
4270 # Get components in VTF\r
4271 #\r
4272 # @param self The object pointer\r
4273 # @param VtfObj for whom component is got\r
4274 # @retval True Successfully find a component\r
4275 # @retval False Not able to find a component\r
4276 #\r
4277 def __GetComponentStatement(self, VtfObj):\r
4278\r
4279 if not self.__IsKeyword("COMP_NAME"):\r
4280 return False\r
4281\r
4282 if not self.__IsToken("="):\r
4283 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4284\r
4285 if not self.__GetNextWord():\r
4286 raise Warning("expected Component Name", self.FileName, self.CurrentLineNumber)\r
4287\r
4288 CompStatementObj = ComponentStatement.ComponentStatement()\r
4289 CompStatementObj.CompName = self.__Token\r
4290\r
4291 if not self.__IsKeyword("COMP_LOC"):\r
4292 raise Warning("expected COMP_LOC", self.FileName, self.CurrentLineNumber)\r
4293\r
4294 if not self.__IsToken("="):\r
4295 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4296\r
4297 CompStatementObj.CompLoc = ""\r
4298 if self.__GetNextWord():\r
4299 CompStatementObj.CompLoc = self.__Token\r
4300 if self.__IsToken('|'):\r
4301 if not self.__GetNextWord():\r
4302 raise Warning("Expected Region Name", self.FileName, self.CurrentLineNumber)\r
4303\r
4304 if self.__Token not in ("F", "N", "S"): #, "H", "L", "PH", "PL"): not support\r
4305 raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4306\r
4307 CompStatementObj.FilePos = self.__Token\r
4308 else:\r
4309 self.CurrentLineNumber += 1\r
4310 self.CurrentOffsetWithinLine = 0\r
4311\r
4312 if not self.__IsKeyword("COMP_TYPE"):\r
4313 raise Warning("expected COMP_TYPE", self.FileName, self.CurrentLineNumber)\r
4314\r
4315 if not self.__IsToken("="):\r
4316 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4317\r
4318 if not self.__GetNextToken():\r
4319 raise Warning("expected Component type", self.FileName, self.CurrentLineNumber)\r
4320 if self.__Token not in ("FIT", "PAL_B", "PAL_A", "OEM"):\r
4321 if not self.__Token.startswith("0x") or len(self.__Token) < 3 or len(self.__Token) > 4 or \\r
4322 not self.__Token[2] in string.hexdigits or not self.__Token[-1] in string.hexdigits:\r
4323 raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4324 CompStatementObj.CompType = self.__Token\r
4325\r
4326 if not self.__IsKeyword("COMP_VER"):\r
4327 raise Warning("expected COMP_VER", self.FileName, self.CurrentLineNumber)\r
4328\r
4329 if not self.__IsToken("="):\r
4330 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4331\r
4332 if not self.__GetNextToken():\r
4333 raise Warning("expected Component version", self.FileName, self.CurrentLineNumber)\r
4334\r
4335 Pattern = re.compile('-$|[0-9a-fA-F]{1,2}\.[0-9a-fA-F]{1,2}$', re.DOTALL)\r
4336 if Pattern.match(self.__Token) is None:\r
4337 raise Warning("Unknown version format '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4338 CompStatementObj.CompVer = self.__Token\r
4339\r
4340 if not self.__IsKeyword("COMP_CS"):\r
4341 raise Warning("expected COMP_CS", self.FileName, self.CurrentLineNumber)\r
4342\r
4343 if not self.__IsToken("="):\r
4344 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4345\r
4346 if not self.__GetNextToken():\r
4347 raise Warning("expected Component CS", self.FileName, self.CurrentLineNumber)\r
4348 if self.__Token not in ("1", "0"):\r
4349 raise Warning("Unknown Component CS '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4350 CompStatementObj.CompCs = self.__Token\r
4351\r
4352\r
4353 if not self.__IsKeyword("COMP_BIN"):\r
4354 raise Warning("expected COMP_BIN", self.FileName, self.CurrentLineNumber)\r
4355\r
4356 if not self.__IsToken("="):\r
4357 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4358\r
4359 if not self.__GetNextToken():\r
4360 raise Warning("expected Component file", self.FileName, self.CurrentLineNumber)\r
4361\r
4362 CompStatementObj.CompBin = self.__Token\r
4363 if CompStatementObj.CompBin != '-' and CompStatementObj.CompBin.replace('$(WORKSPACE)', '').find('$') == -1:\r
4364 #check for file path\r
4365 ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompBin), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
4366 if ErrorCode != 0:\r
4367 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
4368\r
4369 if not self.__IsKeyword("COMP_SYM"):\r
4370 raise Warning("expected COMP_SYM", self.FileName, self.CurrentLineNumber)\r
4371\r
4372 if not self.__IsToken("="):\r
4373 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4374\r
4375 if not self.__GetNextToken():\r
4376 raise Warning("expected Component symbol file", self.FileName, self.CurrentLineNumber)\r
4377\r
4378 CompStatementObj.CompSym = self.__Token\r
4379 if CompStatementObj.CompSym != '-' and CompStatementObj.CompSym.replace('$(WORKSPACE)', '').find('$') == -1:\r
4380 #check for file path\r
4381 ErrorCode, ErrorInfo = PathClass(NormPath(CompStatementObj.CompSym), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
4382 if ErrorCode != 0:\r
4383 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
4384\r
4385 if not self.__IsKeyword("COMP_SIZE"):\r
4386 raise Warning("expected COMP_SIZE", self.FileName, self.CurrentLineNumber)\r
4387\r
4388 if not self.__IsToken("="):\r
4389 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4390\r
4391 if self.__IsToken("-"):\r
4392 CompStatementObj.CompSize = self.__Token\r
4393 elif self.__GetNextDecimalNumber():\r
4394 CompStatementObj.CompSize = self.__Token\r
4395 elif self.__GetNextHexNumber():\r
4396 CompStatementObj.CompSize = self.__Token\r
4397 else:\r
4398 raise Warning("Unknown size '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4399\r
4400 VtfObj.ComponentStatementList.append(CompStatementObj)\r
4401 return True\r
4402\r
4403 ## __GetOptionRom() method\r
4404 #\r
4405 # Get OptionROM section contents and store its data into OptionROM list of self.Profile\r
4406 #\r
4407 # @param self The object pointer\r
4408 # @retval True Successfully find a OptionROM\r
4409 # @retval False Not able to find a OptionROM\r
4410 #\r
4411 def __GetOptionRom(self):\r
4412\r
4413 if not self.__GetNextToken():\r
4414 return False\r
4415\r
4416 S = self.__Token.upper()\r
4417 if S.startswith("[") and not S.startswith("[OPTIONROM."):\r
4418 self.SectionParser(S)\r
4419 self.__UndoToken()\r
4420 return False\r
4421\r
4422 self.__UndoToken()\r
4423 if not self.__IsToken("[OptionRom.", True):\r
4424 raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)\r
4425\r
4426 OptRomName = self.__GetUiName()\r
4427\r
4428 if not self.__IsToken( "]"):\r
4429 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
4430\r
4431 OptRomObj = OptionRom.OPTIONROM()\r
4432 OptRomObj.DriverName = OptRomName\r
4433 self.Profile.OptRomDict[OptRomName] = OptRomObj\r
4434\r
4435 while True:\r
4436 isInf = self.__GetOptRomInfStatement(OptRomObj)\r
4437 isFile = self.__GetOptRomFileStatement(OptRomObj)\r
4438 if not isInf and not isFile:\r
4439 break\r
4440\r
4441 return True\r
4442\r
4443 ## __GetOptRomInfStatement() method\r
4444 #\r
4445 # Get INF statements\r
4446 #\r
4447 # @param self The object pointer\r
4448 # @param Obj for whom inf statement is got\r
4449 # @retval True Successfully find inf statement\r
4450 # @retval False Not able to find inf statement\r
4451 #\r
4452 def __GetOptRomInfStatement(self, Obj):\r
4453\r
4454 if not self.__IsKeyword( "INF"):\r
4455 return False\r
4456\r
4457 ffsInf = OptRomInfStatement.OptRomInfStatement()\r
4458 self.__GetInfOptions( ffsInf)\r
4459\r
4460 if not self.__GetNextToken():\r
4461 raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)\r
4462 ffsInf.InfFileName = self.__Token\r
4463 if ffsInf.InfFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
4464 #check for file path\r
4465 ErrorCode, ErrorInfo = PathClass(NormPath(ffsInf.InfFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
4466 if ErrorCode != 0:\r
4467 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
4468\r
4469 if not ffsInf.InfFileName in self.Profile.InfList:\r
4470 self.Profile.InfList.append(ffsInf.InfFileName)\r
4471 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
4472 self.Profile.InfFileLineList.append(FileLineTuple)\r
4473 if ffsInf.UseArch:\r
4474 if ffsInf.UseArch not in self.Profile.InfDict:\r
4475 self.Profile.InfDict[ffsInf.UseArch] = [ffsInf.InfFileName]\r
4476 else:\r
4477 self.Profile.InfDict[ffsInf.UseArch].append(ffsInf.InfFileName)\r
4478 else:\r
4479 self.Profile.InfDict['ArchTBD'].append(ffsInf.InfFileName)\r
4480\r
4481\r
4482 self.__GetOptRomOverrides (ffsInf)\r
4483\r
4484 Obj.FfsList.append(ffsInf)\r
4485 return True\r
4486\r
4487 ## __GetOptRomOverrides() method\r
4488 #\r
4489 # Get overrides for OptROM INF & FILE\r
4490 #\r
4491 # @param self The object pointer\r
4492 # @param FfsInfObj for whom overrides is got\r
4493 #\r
4494 def __GetOptRomOverrides(self, Obj):\r
4495 if self.__IsToken('{'):\r
4496 Overrides = OptRomInfStatement.OverrideAttribs()\r
4497 while True:\r
4498 if self.__IsKeyword( "PCI_VENDOR_ID"):\r
4499 if not self.__IsToken( "="):\r
4500 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4501 if not self.__GetNextHexNumber():\r
4502 raise Warning("expected Hex vendor id", self.FileName, self.CurrentLineNumber)\r
4503 Overrides.PciVendorId = self.__Token\r
4504 continue\r
4505\r
4506 if self.__IsKeyword( "PCI_CLASS_CODE"):\r
4507 if not self.__IsToken( "="):\r
4508 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4509 if not self.__GetNextHexNumber():\r
4510 raise Warning("expected Hex class code", self.FileName, self.CurrentLineNumber)\r
4511 Overrides.PciClassCode = self.__Token\r
4512 continue\r
4513\r
4514 if self.__IsKeyword( "PCI_DEVICE_ID"):\r
4515 if not self.__IsToken( "="):\r
4516 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4517 if not self.__GetNextHexNumber():\r
4518 raise Warning("expected Hex device id", self.FileName, self.CurrentLineNumber)\r
4519\r
4520 Overrides.PciDeviceId = self.__Token\r
4521 continue\r
4522\r
4523 if self.__IsKeyword( "PCI_REVISION"):\r
4524 if not self.__IsToken( "="):\r
4525 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4526 if not self.__GetNextHexNumber():\r
4527 raise Warning("expected Hex revision", self.FileName, self.CurrentLineNumber)\r
4528 Overrides.PciRevision = self.__Token\r
4529 continue\r
4530\r
4531 if self.__IsKeyword( "PCI_COMPRESS"):\r
4532 if not self.__IsToken( "="):\r
4533 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
4534 if not self.__GetNextToken():\r
4535 raise Warning("expected TRUE/FALSE for compress", self.FileName, self.CurrentLineNumber)\r
4536 Overrides.NeedCompress = self.__Token.upper() == 'TRUE'\r
4537 continue\r
4538\r
4539 if self.__IsToken( "}"):\r
4540 break\r
4541 else:\r
4542 EdkLogger.error("FdfParser", FORMAT_INVALID, File=self.FileName, Line=self.CurrentLineNumber)\r
4543\r
4544 Obj.OverrideAttribs = Overrides\r
4545\r
4546 ## __GetOptRomFileStatement() method\r
4547 #\r
4548 # Get FILE statements\r
4549 #\r
4550 # @param self The object pointer\r
4551 # @param Obj for whom FILE statement is got\r
4552 # @retval True Successfully find FILE statement\r
4553 # @retval False Not able to find FILE statement\r
4554 #\r
4555 def __GetOptRomFileStatement(self, Obj):\r
4556\r
4557 if not self.__IsKeyword( "FILE"):\r
4558 return False\r
4559\r
4560 FfsFileObj = OptRomFileStatement.OptRomFileStatement()\r
4561\r
4562 if not self.__IsKeyword("EFI") and not self.__IsKeyword(BINARY_FILE_TYPE_BIN):\r
4563 raise Warning("expected Binary type (EFI/BIN)", self.FileName, self.CurrentLineNumber)\r
4564 FfsFileObj.FileType = self.__Token\r
4565\r
4566 if not self.__GetNextToken():\r
4567 raise Warning("expected File path", self.FileName, self.CurrentLineNumber)\r
4568 FfsFileObj.FileName = self.__Token\r
4569 if FfsFileObj.FileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
4570 #check for file path\r
4571 ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
4572 if ErrorCode != 0:\r
4573 EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
4574\r
4575 if FfsFileObj.FileType == 'EFI':\r
4576 self.__GetOptRomOverrides(FfsFileObj)\r
4577\r
4578 Obj.FfsList.append(FfsFileObj)\r
4579\r
4580 return True\r
4581\r
4582 ## __GetCapInFd() method\r
4583 #\r
4584 # Get Cap list contained in FD\r
4585 #\r
4586 # @param self The object pointer\r
4587 # @param FdName FD name\r
4588 # @retval CapList List of Capsule in FD\r
4589 #\r
4590 def __GetCapInFd (self, FdName):\r
4591\r
4592 CapList = []\r
4593 if FdName.upper() in self.Profile.FdDict:\r
4594 FdObj = self.Profile.FdDict[FdName.upper()]\r
4595 for elementRegion in FdObj.RegionList:\r
4596 if elementRegion.RegionType == 'CAPSULE':\r
4597 for elementRegionData in elementRegion.RegionDataList:\r
4598 if elementRegionData.endswith(".cap"):\r
4599 continue\r
4600 if elementRegionData is not None and elementRegionData.upper() not in CapList:\r
4601 CapList.append(elementRegionData.upper())\r
4602 return CapList\r
4603\r
4604 ## __GetReferencedFdCapTuple() method\r
4605 #\r
4606 # Get FV and FD list referenced by a capsule image\r
4607 #\r
4608 # @param self The object pointer\r
4609 # @param CapObj Capsule section to be searched\r
4610 # @param RefFdList referenced FD by section\r
4611 # @param RefFvList referenced FV by section\r
4612 #\r
4613 def __GetReferencedFdCapTuple(self, CapObj, RefFdList = [], RefFvList = []):\r
4614\r
4615 for CapsuleDataObj in CapObj.CapsuleDataList :\r
4616 if hasattr(CapsuleDataObj, 'FvName') and CapsuleDataObj.FvName is not None and CapsuleDataObj.FvName.upper() not in RefFvList:\r
4617 RefFvList.append (CapsuleDataObj.FvName.upper())\r
4618 elif hasattr(CapsuleDataObj, 'FdName') and CapsuleDataObj.FdName is not None and CapsuleDataObj.FdName.upper() not in RefFdList:\r
4619 RefFdList.append (CapsuleDataObj.FdName.upper())\r
4620 elif CapsuleDataObj.Ffs is not None:\r
4621 if isinstance(CapsuleDataObj.Ffs, FfsFileStatement.FileStatement):\r
4622 if CapsuleDataObj.Ffs.FvName is not None and CapsuleDataObj.Ffs.FvName.upper() not in RefFvList:\r
4623 RefFvList.append(CapsuleDataObj.Ffs.FvName.upper())\r
4624 elif CapsuleDataObj.Ffs.FdName is not None and CapsuleDataObj.Ffs.FdName.upper() not in RefFdList:\r
4625 RefFdList.append(CapsuleDataObj.Ffs.FdName.upper())\r
4626 else:\r
4627 self.__GetReferencedFdFvTupleFromSection(CapsuleDataObj.Ffs, RefFdList, RefFvList)\r
4628\r
4629 ## __GetFvInFd() method\r
4630 #\r
4631 # Get FV list contained in FD\r
4632 #\r
4633 # @param self The object pointer\r
4634 # @param FdName FD name\r
4635 # @retval FvList list of FV in FD\r
4636 #\r
4637 def __GetFvInFd (self, FdName):\r
4638\r
4639 FvList = []\r
4640 if FdName.upper() in self.Profile.FdDict:\r
4641 FdObj = self.Profile.FdDict[FdName.upper()]\r
4642 for elementRegion in FdObj.RegionList:\r
4643 if elementRegion.RegionType == BINARY_FILE_TYPE_FV:\r
4644 for elementRegionData in elementRegion.RegionDataList:\r
4645 if elementRegionData.endswith(".fv"):\r
4646 continue\r
4647 if elementRegionData is not None and elementRegionData.upper() not in FvList:\r
4648 FvList.append(elementRegionData.upper())\r
4649 return FvList\r
4650\r
4651 ## __GetReferencedFdFvTuple() method\r
4652 #\r
4653 # Get FD and FV list referenced by a FFS file\r
4654 #\r
4655 # @param self The object pointer\r
4656 # @param FfsFile contains sections to be searched\r
4657 # @param RefFdList referenced FD by section\r
4658 # @param RefFvList referenced FV by section\r
4659 #\r
4660 def __GetReferencedFdFvTuple(self, FvObj, RefFdList = [], RefFvList = []):\r
4661\r
4662 for FfsObj in FvObj.FfsList:\r
4663 if isinstance(FfsObj, FfsFileStatement.FileStatement):\r
4664 if FfsObj.FvName is not None and FfsObj.FvName.upper() not in RefFvList:\r
4665 RefFvList.append(FfsObj.FvName.upper())\r
4666 elif FfsObj.FdName is not None and FfsObj.FdName.upper() not in RefFdList:\r
4667 RefFdList.append(FfsObj.FdName.upper())\r
4668 else:\r
4669 self.__GetReferencedFdFvTupleFromSection(FfsObj, RefFdList, RefFvList)\r
4670\r
4671 ## __GetReferencedFdFvTupleFromSection() method\r
4672 #\r
4673 # Get FD and FV list referenced by a FFS section\r
4674 #\r
4675 # @param self The object pointer\r
4676 # @param FfsFile contains sections to be searched\r
4677 # @param FdList referenced FD by section\r
4678 # @param FvList referenced FV by section\r
4679 #\r
4680 def __GetReferencedFdFvTupleFromSection(self, FfsFile, FdList = [], FvList = []):\r
4681\r
4682 SectionStack = []\r
4683 SectionStack.extend(FfsFile.SectionList)\r
4684 while SectionStack != []:\r
4685 SectionObj = SectionStack.pop()\r
4686 if isinstance(SectionObj, FvImageSection.FvImageSection):\r
4687 if SectionObj.FvName is not None and SectionObj.FvName.upper() not in FvList:\r
4688 FvList.append(SectionObj.FvName.upper())\r
4689 if SectionObj.Fv is not None and SectionObj.Fv.UiFvName is not None and SectionObj.Fv.UiFvName.upper() not in FvList:\r
4690 FvList.append(SectionObj.Fv.UiFvName.upper())\r
4691 self.__GetReferencedFdFvTuple(SectionObj.Fv, FdList, FvList)\r
4692\r
4693 if isinstance(SectionObj, CompressSection.CompressSection) or isinstance(SectionObj, GuidSection.GuidSection):\r
4694 SectionStack.extend(SectionObj.SectionList)\r
4695\r
4696 ## CycleReferenceCheck() method\r
4697 #\r
4698 # Check whether cycle reference exists in FDF\r
4699 #\r
4700 # @param self The object pointer\r
4701 # @retval True cycle reference exists\r
4702 # @retval False Not exists cycle reference\r
4703 #\r
4704 def CycleReferenceCheck(self):\r
4705 #\r
4706 # Check the cycle between FV and FD image\r
4707 #\r
4708 MaxLength = len (self.Profile.FvDict)\r
4709 for FvName in self.Profile.FvDict:\r
4710 LogStr = "\nCycle Reference Checking for FV: %s\n" % FvName\r
4711 RefFvStack = []\r
4712 RefFvStack.append(FvName)\r
4713 FdAnalyzedList = []\r
4714\r
4715 Index = 0\r
4716 while RefFvStack != [] and Index < MaxLength:\r
4717 Index = Index + 1\r
4718 FvNameFromStack = RefFvStack.pop()\r
4719 if FvNameFromStack.upper() in self.Profile.FvDict:\r
4720 FvObj = self.Profile.FvDict[FvNameFromStack.upper()]\r
4721 else:\r
4722 continue\r
4723\r
4724 RefFdList = []\r
4725 RefFvList = []\r
4726 self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)\r
4727\r
4728 for RefFdName in RefFdList:\r
4729 if RefFdName in FdAnalyzedList:\r
4730 continue\r
4731\r
4732 LogStr += "FV %s contains FD %s\n" % (FvNameFromStack, RefFdName)\r
4733 FvInFdList = self.__GetFvInFd(RefFdName)\r
4734 if FvInFdList != []:\r
4735 for FvNameInFd in FvInFdList:\r
4736 LogStr += "FD %s contains FV %s\n" % (RefFdName, FvNameInFd)\r
4737 if FvNameInFd not in RefFvStack:\r
4738 RefFvStack.append(FvNameInFd)\r
4739\r
4740 if FvName in RefFvStack or FvNameFromStack in RefFvStack:\r
4741 EdkLogger.info(LogStr)\r
4742 return True\r
4743 FdAnalyzedList.append(RefFdName)\r
4744\r
4745 for RefFvName in RefFvList:\r
4746 LogStr += "FV %s contains FV %s\n" % (FvNameFromStack, RefFvName)\r
4747 if RefFvName not in RefFvStack:\r
4748 RefFvStack.append(RefFvName)\r
4749\r
4750 if FvName in RefFvStack or FvNameFromStack in RefFvStack:\r
4751 EdkLogger.info(LogStr)\r
4752 return True\r
4753\r
4754 #\r
4755 # Check the cycle between Capsule and FD image\r
4756 #\r
4757 MaxLength = len (self.Profile.CapsuleDict)\r
4758 for CapName in self.Profile.CapsuleDict:\r
4759 #\r
4760 # Capsule image to be checked.\r
4761 #\r
4762 LogStr = "\n\n\nCycle Reference Checking for Capsule: %s\n" % CapName\r
4763 RefCapStack = []\r
4764 RefCapStack.append(CapName)\r
4765 FdAnalyzedList = []\r
4766 FvAnalyzedList = []\r
4767\r
4768 Index = 0\r
4769 while RefCapStack != [] and Index < MaxLength:\r
4770 Index = Index + 1\r
4771 CapNameFromStack = RefCapStack.pop()\r
4772 if CapNameFromStack.upper() in self.Profile.CapsuleDict:\r
4773 CapObj = self.Profile.CapsuleDict[CapNameFromStack.upper()]\r
4774 else:\r
4775 continue\r
4776\r
4777 RefFvList = []\r
4778 RefFdList = []\r
4779 self.__GetReferencedFdCapTuple(CapObj, RefFdList, RefFvList)\r
4780\r
4781 FvListLength = 0\r
4782 FdListLength = 0\r
4783 while FvListLength < len (RefFvList) or FdListLength < len (RefFdList):\r
4784 for RefFdName in RefFdList:\r
4785 if RefFdName in FdAnalyzedList:\r
4786 continue\r
4787\r
4788 LogStr += "Capsule %s contains FD %s\n" % (CapNameFromStack, RefFdName)\r
4789 CapInFdList = self.__GetCapInFd(RefFdName)\r
4790 if CapInFdList != []:\r
4791 for CapNameInFd in CapInFdList:\r
4792 LogStr += "FD %s contains Capsule %s\n" % (RefFdName, CapNameInFd)\r
4793 if CapNameInFd not in RefCapStack:\r
4794 RefCapStack.append(CapNameInFd)\r
4795\r
4796 if CapName in RefCapStack or CapNameFromStack in RefCapStack:\r
4797 EdkLogger.info(LogStr)\r
4798 return True\r
4799\r
4800 FvInFdList = self.__GetFvInFd(RefFdName)\r
4801 if FvInFdList != []:\r
4802 for FvNameInFd in FvInFdList:\r
4803 LogStr += "FD %s contains FV %s\n" % (RefFdName, FvNameInFd)\r
4804 if FvNameInFd not in RefFvList:\r
4805 RefFvList.append(FvNameInFd)\r
4806\r
4807 FdAnalyzedList.append(RefFdName)\r
4808 #\r
4809 # the number of the parsed FV and FD image\r
4810 #\r
4811 FvListLength = len (RefFvList)\r
4812 FdListLength = len (RefFdList)\r
4813 for RefFvName in RefFvList:\r
4814 if RefFvName in FvAnalyzedList:\r
4815 continue\r
4816 LogStr += "Capsule %s contains FV %s\n" % (CapNameFromStack, RefFvName)\r
4817 if RefFvName.upper() in self.Profile.FvDict:\r
4818 FvObj = self.Profile.FvDict[RefFvName.upper()]\r
4819 else:\r
4820 continue\r
4821 self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)\r
4822 FvAnalyzedList.append(RefFvName)\r
4823\r
4824 return False\r
4825\r
4826 def GetAllIncludedFile (self):\r
4827 global AllIncludeFileList\r
4828 return AllIncludeFileList\r
4829\r
4830if __name__ == "__main__":\r
4831 import sys\r
4832 try:\r
4833 test_file = sys.argv[1]\r
4834 except IndexError as v:\r
4835 print("Usage: %s filename" % sys.argv[0])\r
4836 sys.exit(1)\r
4837\r
4838 parser = FdfParser(test_file)\r
4839 try:\r
4840 parser.ParseFile()\r
4841 parser.CycleReferenceCheck()\r
4842 except Warning as X:\r
4843 print(str(X))\r
4844 else:\r
4845 print("Success!")\r
4846\r