]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/GenFds/FdfParser.py
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Sync EDKII BaseTools to BaseTools project r1903.
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py
1 ## @file
2 # parse FDF file
3 #
4 # Copyright (c) 2007, Intel Corporation
5 #
6 # All rights reserved. This program and the accompanying materials
7 # are licensed and made available under the terms and conditions of the BSD License
8 # which accompanies this distribution. The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
10 #
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 #
14
15 ##
16 # Import Modules
17 #
18 import Fd
19 import Region
20 import Fv
21 import AprioriSection
22 import FfsInfStatement
23 import FfsFileStatement
24 import VerSection
25 import UiSection
26 import FvImageSection
27 import DataSection
28 import DepexSection
29 import CompressSection
30 import GuidSection
31 import Capsule
32 import CapsuleData
33 import Rule
34 import RuleComplexFile
35 import RuleSimpleFile
36 import EfiSection
37 import Vtf
38 import ComponentStatement
39 import OptionRom
40 import OptRomInfStatement
41 import OptRomFileStatement
42
43 from GenFdsGlobalVariable import GenFdsGlobalVariable
44 from Common.BuildToolError import *
45 from Common import EdkLogger
46
47 import re
48 import os
49
50 ##define T_CHAR_SPACE ' '
51 ##define T_CHAR_NULL '\0'
52 ##define T_CHAR_CR '\r'
53 ##define T_CHAR_TAB '\t'
54 ##define T_CHAR_LF '\n'
55 ##define T_CHAR_SLASH '/'
56 ##define T_CHAR_BACKSLASH '\\'
57 ##define T_CHAR_DOUBLE_QUOTE '\"'
58 ##define T_CHAR_SINGLE_QUOTE '\''
59 ##define T_CHAR_STAR '*'
60 ##define T_CHAR_HASH '#'
61
62 (T_CHAR_SPACE, T_CHAR_NULL, T_CHAR_CR, T_CHAR_TAB, T_CHAR_LF, T_CHAR_SLASH, \
63 T_CHAR_BACKSLASH, T_CHAR_DOUBLE_QUOTE, T_CHAR_SINGLE_QUOTE, T_CHAR_STAR, T_CHAR_HASH) = \
64 (' ', '\0', '\r', '\t', '\n', '/', '\\', '\"', '\'', '*', '#')
65
66 SEPERATOR_TUPLE = ('=', '|', ',', '{', '}')
67
68 IncludeFileList = []
69 # Macro passed from command line, which has greatest priority and can NOT be overridden by those in FDF
70 InputMacroDict = {}
71 # All Macro values when parsing file, not replace existing Macro
72 AllMacroList = []
73
74 def GetRealFileLine (File, Line):
75
76 InsertedLines = 0
77 for Profile in IncludeFileList:
78 if Line >= Profile.InsertStartLineNumber and Line < Profile.InsertStartLineNumber + Profile.InsertAdjust + len(Profile.FileLinesList):
79 return (Profile.FileName, Line - Profile.InsertStartLineNumber + 1)
80 if Line >= Profile.InsertStartLineNumber + Profile.InsertAdjust + len(Profile.FileLinesList):
81 InsertedLines += Profile.InsertAdjust + len(Profile.FileLinesList)
82
83 return (File, Line - InsertedLines)
84
85 ## The exception class that used to report error messages when parsing FDF
86 #
87 # Currently the "ToolName" is set to be "FDF Parser".
88 #
89 class Warning (Exception):
90 ## The constructor
91 #
92 # @param self The object pointer
93 # @param Str The message to record
94 # @param File The FDF name
95 # @param Line The Line number that error occurs
96 #
97 def __init__(self, Str, File = None, Line = None):
98
99 FileLineTuple = GetRealFileLine(File, Line)
100 self.FileName = FileLineTuple[0]
101 self.LineNumber = FileLineTuple[1]
102 self.Message = Str
103 self.ToolName = 'FdfParser'
104
105 def __str__(self):
106 return self.Message
107
108 ## The MACRO class that used to record macro value data when parsing include file
109 #
110 #
111 class MacroProfile :
112 ## The constructor
113 #
114 # @param self The object pointer
115 # @param FileName The file that to be parsed
116 #
117 def __init__(self, FileName, Line):
118 self.FileName = FileName
119 self.DefinedAtLine = Line
120 self.MacroName = None
121 self.MacroValue = None
122
123 ## The Include file content class that used to record file data when parsing include file
124 #
125 # May raise Exception when opening file.
126 #
127 class IncludeFileProfile :
128 ## The constructor
129 #
130 # @param self The object pointer
131 # @param FileName The file that to be parsed
132 #
133 def __init__(self, FileName):
134 self.FileName = FileName
135 self.FileLinesList = []
136 try:
137 fsock = open(FileName, "rb", 0)
138 try:
139 self.FileLinesList = fsock.readlines()
140 finally:
141 fsock.close()
142
143 except:
144 EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)
145
146 self.InsertStartLineNumber = None
147 self.InsertAdjust = 0
148
149 ## The FDF content class that used to record file data when parsing FDF
150 #
151 # May raise Exception when opening file.
152 #
153 class FileProfile :
154 ## The constructor
155 #
156 # @param self The object pointer
157 # @param FileName The file that to be parsed
158 #
159 def __init__(self, FileName):
160 self.FileLinesList = []
161 try:
162 fsock = open(FileName, "rb", 0)
163 try:
164 self.FileLinesList = fsock.readlines()
165 finally:
166 fsock.close()
167
168 except:
169 EdkLogger.error("FdfParser", FILE_OPEN_FAILURE, ExtraData=FileName)
170
171
172 self.PcdDict = {}
173 self.InfList = []
174
175 self.FdDict = {}
176 self.FdNameNotSet = False
177 self.FvDict = {}
178 self.CapsuleDict = {}
179 self.VtfList = []
180 self.RuleDict = {}
181 self.OptRomDict = {}
182
183 ## The syntax parser for FDF
184 #
185 # PreprocessFile method should be called prior to ParseFile
186 # CycleReferenceCheck method can detect cycles in FDF contents
187 #
188 # GetNext*** procedures mean these procedures will get next token first, then make judgement.
189 # Get*** procedures mean these procedures will make judgement on current token only.
190 #
191 class FdfParser:
192 ## The constructor
193 #
194 # @param self The object pointer
195 # @param FileName The file that to be parsed
196 #
197 def __init__(self, FileName):
198 self.Profile = FileProfile(FileName)
199 self.FileName = FileName
200 self.CurrentLineNumber = 1
201 self.CurrentOffsetWithinLine = 0
202 self.CurrentFdName = None
203 self.CurrentFvName = None
204 self.__Token = ""
205 self.__SkippedChars = ""
206
207 self.__WipeOffArea = []
208
209 ## __IsWhiteSpace() method
210 #
211 # Whether char at current FileBufferPos is whitespace
212 #
213 # @param self The object pointer
214 # @param Char The char to test
215 # @retval True The char is a kind of white space
216 # @retval False The char is NOT a kind of white space
217 #
218 def __IsWhiteSpace(self, Char):
219 if Char in (T_CHAR_NULL, T_CHAR_CR, T_CHAR_SPACE, T_CHAR_TAB, T_CHAR_LF):
220 return True
221 else:
222 return False
223
224 ## __SkipWhiteSpace() method
225 #
226 # Skip white spaces from current char, return number of chars skipped
227 #
228 # @param self The object pointer
229 # @retval Count The number of chars skipped
230 #
231 def __SkipWhiteSpace(self):
232 Count = 0
233 while not self.__EndOfFile():
234 Count += 1
235 if self.__CurrentChar() in (T_CHAR_NULL, T_CHAR_CR, T_CHAR_LF, T_CHAR_SPACE, T_CHAR_TAB):
236 self.__SkippedChars += str(self.__CurrentChar())
237 self.__GetOneChar()
238
239 else:
240 Count = Count - 1
241 return Count
242
243 ## __EndOfFile() method
244 #
245 # Judge current buffer pos is at file end
246 #
247 # @param self The object pointer
248 # @retval True Current File buffer position is at file end
249 # @retval False Current File buffer position is NOT at file end
250 #
251 def __EndOfFile(self):
252 NumberOfLines = len(self.Profile.FileLinesList)
253 SizeOfLastLine = len(self.Profile.FileLinesList[-1])
254 if self.CurrentLineNumber == NumberOfLines and self.CurrentOffsetWithinLine >= SizeOfLastLine - 1:
255 return True
256 elif self.CurrentLineNumber > NumberOfLines:
257 return True
258 else:
259 return False
260
261 ## __EndOfLine() method
262 #
263 # Judge current buffer pos is at line end
264 #
265 # @param self The object pointer
266 # @retval True Current File buffer position is at line end
267 # @retval False Current File buffer position is NOT at line end
268 #
269 def __EndOfLine(self):
270 if self.CurrentLineNumber > len(self.Profile.FileLinesList):
271 return True
272 SizeOfCurrentLine = len(self.Profile.FileLinesList[self.CurrentLineNumber - 1])
273 if self.CurrentOffsetWithinLine >= SizeOfCurrentLine:
274 return True
275 else:
276 return False
277
278 ## Rewind() method
279 #
280 # Reset file data buffer to the initial state
281 #
282 # @param self The object pointer
283 #
284 def Rewind(self):
285 self.CurrentLineNumber = 1
286 self.CurrentOffsetWithinLine = 0
287
288 ## __UndoOneChar() method
289 #
290 # Go back one char in the file buffer
291 #
292 # @param self The object pointer
293 # @retval True Successfully go back one char
294 # @retval False Not able to go back one char as file beginning reached
295 #
296 def __UndoOneChar(self):
297
298 if self.CurrentLineNumber == 1 and self.CurrentOffsetWithinLine == 0:
299 return False
300 elif self.CurrentOffsetWithinLine == 0:
301 self.CurrentLineNumber -= 1
302 self.CurrentOffsetWithinLine = len(self.__CurrentLine()) - 1
303 else:
304 self.CurrentOffsetWithinLine -= 1
305 return True
306
307 ## __GetOneChar() method
308 #
309 # Move forward one char in the file buffer
310 #
311 # @param self The object pointer
312 #
313 def __GetOneChar(self):
314 if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:
315 self.CurrentLineNumber += 1
316 self.CurrentOffsetWithinLine = 0
317 else:
318 self.CurrentOffsetWithinLine += 1
319
320 ## __CurrentChar() method
321 #
322 # Get the char pointed to by the file buffer pointer
323 #
324 # @param self The object pointer
325 # @retval Char Current char
326 #
327 def __CurrentChar(self):
328 return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine]
329
330 ## __NextChar() method
331 #
332 # Get the one char pass the char pointed to by the file buffer pointer
333 #
334 # @param self The object pointer
335 # @retval Char Next char
336 #
337 def __NextChar(self):
338 if self.CurrentOffsetWithinLine == len(self.Profile.FileLinesList[self.CurrentLineNumber - 1]) - 1:
339 return self.Profile.FileLinesList[self.CurrentLineNumber][0]
340 else:
341 return self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine + 1]
342
343 ## __SetCurrentCharValue() method
344 #
345 # Modify the value of current char
346 #
347 # @param self The object pointer
348 # @param Value The new value of current char
349 #
350 def __SetCurrentCharValue(self, Value):
351 self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine] = Value
352
353 ## __CurrentLine() method
354 #
355 # Get the list that contains current line contents
356 #
357 # @param self The object pointer
358 # @retval List current line contents
359 #
360 def __CurrentLine(self):
361 return self.Profile.FileLinesList[self.CurrentLineNumber - 1]
362
363 def __StringToList(self):
364 self.Profile.FileLinesList = [list(s) for s in self.Profile.FileLinesList]
365 self.Profile.FileLinesList[-1].append(' ')
366
367 def __ReplaceMacros(self, Str, File, Line):
368 MacroEnd = 0
369 while Str.find('$(', MacroEnd) >= 0:
370 MacroStart = Str.find('$(', MacroEnd)
371 if Str.find(')', MacroStart) > 0:
372 MacroEnd = Str.find(')', MacroStart)
373 Name = Str[MacroStart + 2 : MacroEnd]
374 Value = None
375 if Name in InputMacroDict:
376 Value = InputMacroDict[Name]
377
378 else:
379 for Profile in AllMacroList:
380 if Profile.FileName == File and Profile.MacroName == Name and Profile.DefinedAtLine <= Line:
381 Value = Profile.MacroValue
382
383 if Value != None:
384 Str = Str.replace('$(' + Name + ')', Value)
385 MacroEnd = MacroStart + len(Value)
386
387 else:
388 raise Warning("Macro not complete", self.FileName, self.CurrentLineNumber)
389 return Str
390
391 def __ReplaceFragment(self, StartPos, EndPos, Value = ' '):
392 if StartPos[0] == EndPos[0]:
393 Offset = StartPos[1]
394 while Offset <= EndPos[1]:
395 self.Profile.FileLinesList[StartPos[0]][Offset] = Value
396 Offset += 1
397 return
398
399 Offset = StartPos[1]
400 while self.Profile.FileLinesList[StartPos[0]][Offset] not in ('\r', '\n'):
401 self.Profile.FileLinesList[StartPos[0]][Offset] = Value
402 Offset += 1
403
404 Line = StartPos[0]
405 while Line < EndPos[0]:
406 Offset = 0
407 while self.Profile.FileLinesList[Line][Offset] not in ('\r', '\n'):
408 self.Profile.FileLinesList[Line][Offset] = Value
409 Offset += 1
410 Line += 1
411
412 Offset = 0
413 while Offset <= EndPos[1]:
414 self.Profile.FileLinesList[EndPos[0]][Offset] = Value
415 Offset += 1
416
417
418 ## PreprocessFile() method
419 #
420 # Preprocess file contents, replace comments with spaces.
421 # In the end, rewind the file buffer pointer to the beginning
422 # BUGBUG: No !include statement processing contained in this procedure
423 # !include statement should be expanded at the same FileLinesList[CurrentLineNumber - 1]
424 #
425 # @param self The object pointer
426 #
427 def PreprocessFile(self):
428
429 self.Rewind()
430 InComment = False
431 DoubleSlashComment = False
432 HashComment = False
433 # HashComment in quoted string " " is ignored.
434 InString = False
435
436 while not self.__EndOfFile():
437
438 if self.__CurrentChar() == T_CHAR_DOUBLE_QUOTE and not InComment:
439 InString = not InString
440 # meet new line, then no longer in a comment for // and '#'
441 if self.__CurrentChar() == T_CHAR_LF:
442 self.CurrentLineNumber += 1
443 self.CurrentOffsetWithinLine = 0
444 if InComment and DoubleSlashComment:
445 InComment = False
446 DoubleSlashComment = False
447 if InComment and HashComment:
448 InComment = False
449 HashComment = False
450 # check for */ comment end
451 elif InComment and not DoubleSlashComment and not HashComment and self.__CurrentChar() == T_CHAR_STAR and self.__NextChar() == T_CHAR_SLASH:
452 self.__SetCurrentCharValue(T_CHAR_SPACE)
453 self.__GetOneChar()
454 self.__SetCurrentCharValue(T_CHAR_SPACE)
455 self.__GetOneChar()
456 InComment = False
457 # set comments to spaces
458 elif InComment:
459 self.__SetCurrentCharValue(T_CHAR_SPACE)
460 self.__GetOneChar()
461 # check for // comment
462 elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_SLASH and not self.__EndOfLine():
463 InComment = True
464 DoubleSlashComment = True
465 # check for '#' comment
466 elif self.__CurrentChar() == T_CHAR_HASH and not self.__EndOfLine() and not InString:
467 InComment = True
468 HashComment = True
469 # check for /* comment start
470 elif self.__CurrentChar() == T_CHAR_SLASH and self.__NextChar() == T_CHAR_STAR:
471 self.__SetCurrentCharValue( T_CHAR_SPACE)
472 self.__GetOneChar()
473 self.__SetCurrentCharValue( T_CHAR_SPACE)
474 self.__GetOneChar()
475 InComment = True
476 else:
477 self.__GetOneChar()
478
479 # restore from ListOfList to ListOfString
480 self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]
481 self.Rewind()
482
483 ## PreprocessIncludeFile() method
484 #
485 # Preprocess file contents, replace !include statements with file contents.
486 # In the end, rewind the file buffer pointer to the beginning
487 #
488 # @param self The object pointer
489 #
490 def PreprocessIncludeFile(self):
491
492 while self.__GetNextToken():
493
494 if self.__Token == '!include':
495 IncludeLine = self.CurrentLineNumber
496 IncludeOffset = self.CurrentOffsetWithinLine - len('!include')
497 if not self.__GetNextToken():
498 raise Warning("expected include file name", self.FileName, self.CurrentLineNumber)
499 IncFileName = self.__Token
500 if not os.path.isabs(IncFileName):
501 if IncFileName.startswith('$(WORKSPACE)'):
502 Str = IncFileName.replace('$(WORKSPACE)', os.environ.get('WORKSPACE'))
503 if os.path.exists(Str):
504 if not os.path.isabs(Str):
505 Str = os.path.abspath(Str)
506 IncFileName = Str
507 else:
508 # file is in the same dir with FDF file
509 FullFdf = self.FileName
510 if not os.path.isabs(self.FileName):
511 FullFdf = os.path.join(os.environ.get('WORKSPACE'), self.FileName)
512
513 IncFileName = os.path.join(os.path.dirname(FullFdf), IncFileName)
514
515 if not os.path.exists(os.path.normpath(IncFileName)):
516 raise Warning("Include file not exists", self.FileName, self.CurrentLineNumber)
517
518 IncFileProfile = IncludeFileProfile(os.path.normpath(IncFileName))
519
520 CurrentLine = self.CurrentLineNumber
521 CurrentOffset = self.CurrentOffsetWithinLine
522 # list index of the insertion, note that line number is 'CurrentLine + 1'
523 InsertAtLine = CurrentLine
524 IncFileProfile.InsertStartLineNumber = InsertAtLine + 1
525 # deal with remaining portions after "!include filename", if exists.
526 if self.__GetNextToken():
527 if self.CurrentLineNumber == CurrentLine:
528 RemainingLine = self.__CurrentLine()[CurrentOffset:]
529 self.Profile.FileLinesList.insert(self.CurrentLineNumber, RemainingLine)
530 IncFileProfile.InsertAdjust += 1
531 self.CurrentLineNumber += 1
532 self.CurrentOffsetWithinLine = 0
533
534 for Line in IncFileProfile.FileLinesList:
535 self.Profile.FileLinesList.insert(InsertAtLine, Line)
536 self.CurrentLineNumber += 1
537 InsertAtLine += 1
538
539 IncludeFileList.append(IncFileProfile)
540
541 # comment out the processed include file statement
542 TempList = list(self.Profile.FileLinesList[IncludeLine - 1])
543 TempList.insert(IncludeOffset, '#')
544 self.Profile.FileLinesList[IncludeLine - 1] = ''.join(TempList)
545
546 self.Rewind()
547
548 ## PreprocessIncludeFile() method
549 #
550 # Preprocess file contents, replace !include statements with file contents.
551 # In the end, rewind the file buffer pointer to the beginning
552 #
553 # @param self The object pointer
554 #
555 def PreprocessConditionalStatement(self):
556 # IfList is a stack of if branches with elements of list [Pos, CondSatisfied, BranchDetermined]
557 IfList = []
558 while self.__GetNextToken():
559 if self.__Token == 'DEFINE':
560 DefineLine = self.CurrentLineNumber - 1
561 DefineOffset = self.CurrentOffsetWithinLine - len('DEFINE')
562 if not self.__GetNextToken():
563 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)
564 Macro = self.__Token
565 if not self.__IsToken( "="):
566 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
567
568 if not self.__GetNextToken():
569 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
570
571 if self.__GetStringData():
572 pass
573 Value = self.__Token
574 if not Macro in InputMacroDict:
575 FileLineTuple = GetRealFileLine(self.FileName, DefineLine + 1)
576 MacProfile = MacroProfile(FileLineTuple[0], FileLineTuple[1])
577 MacProfile.MacroName = Macro
578 MacProfile.MacroValue = Value
579 AllMacroList.append(MacProfile)
580 self.__WipeOffArea.append(((DefineLine, DefineOffset), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
581
582 elif self.__Token in ('!ifdef', '!ifndef', '!if'):
583 IfStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))
584 IfList.append([IfStartPos, None, None])
585 CondLabel = self.__Token
586
587 if not self.__GetNextToken():
588 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)
589 MacroName = self.__Token
590 NotFlag = False
591 if MacroName.startswith('!'):
592 NotFlag = True
593 MacroName = MacroName[1:]
594
595 NotDefineFlag = False
596 if CondLabel == '!ifndef':
597 NotDefineFlag = True
598 if CondLabel == '!ifdef' or CondLabel == '!ifndef':
599 if NotFlag:
600 raise Warning("'NOT' operation not allowed for Macro name", self.FileName, self.CurrentLineNumber)
601
602 if CondLabel == '!if':
603
604 if not self.__GetNextOp():
605 raise Warning("expected !endif", self.FileName, self.CurrentLineNumber)
606
607 if self.__Token in ('!=', '==', '>', '<', '>=', '<='):
608 Op = self.__Token
609 if not self.__GetNextToken():
610 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
611 if self.__GetStringData():
612 pass
613 MacroValue = self.__Token
614 ConditionSatisfied = self.__EvaluateConditional(MacroName, IfList[-1][0][0] + 1, Op, MacroValue)
615 if NotFlag:
616 ConditionSatisfied = not ConditionSatisfied
617 BranchDetermined = ConditionSatisfied
618 else:
619 self.CurrentOffsetWithinLine -= len(self.__Token)
620 ConditionSatisfied = self.__EvaluateConditional(MacroName, IfList[-1][0][0] + 1, None, 'Bool')
621 if NotFlag:
622 ConditionSatisfied = not ConditionSatisfied
623 BranchDetermined = ConditionSatisfied
624 IfList[-1] = [IfList[-1][0], ConditionSatisfied, BranchDetermined]
625 if ConditionSatisfied:
626 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
627
628 else:
629 ConditionSatisfied = self.__EvaluateConditional(MacroName, IfList[-1][0][0] + 1)
630 if NotDefineFlag:
631 ConditionSatisfied = not ConditionSatisfied
632 BranchDetermined = ConditionSatisfied
633 IfList[-1] = [IfList[-1][0], ConditionSatisfied, BranchDetermined]
634 if ConditionSatisfied:
635 self.__WipeOffArea.append((IfStartPos, (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
636
637 elif self.__Token in ('!elseif', '!else'):
638 ElseStartPos = (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len(self.__Token))
639 if len(IfList) <= 0:
640 raise Warning("Missing !if statement", self.FileName, self.CurrentLineNumber)
641 if IfList[-1][1]:
642 IfList[-1] = [ElseStartPos, False, True]
643 self.__WipeOffArea.append((ElseStartPos, (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
644 else:
645 self.__WipeOffArea.append((IfList[-1][0], ElseStartPos))
646 IfList[-1] = [ElseStartPos, True, IfList[-1][2]]
647 if self.__Token == '!elseif':
648 if not self.__GetNextToken():
649 raise Warning("expected Macro name", self.FileName, self.CurrentLineNumber)
650 MacroName = self.__Token
651 NotFlag = False
652 if MacroName.startswith('!'):
653 NotFlag = True
654 MacroName = MacroName[1:]
655
656 if not self.__GetNextOp():
657 raise Warning("expected !endif", self.FileName, self.CurrentLineNumber)
658
659 if self.__Token in ('!=', '==', '>', '<', '>=', '<='):
660 Op = self.__Token
661 if not self.__GetNextToken():
662 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
663 if self.__GetStringData():
664 pass
665 MacroValue = self.__Token
666 ConditionSatisfied = self.__EvaluateConditional(MacroName, IfList[-1][0][0] + 1, Op, MacroValue)
667 if NotFlag:
668 ConditionSatisfied = not ConditionSatisfied
669
670 else:
671 self.CurrentOffsetWithinLine -= len(self.__Token)
672 ConditionSatisfied = self.__EvaluateConditional(MacroName, IfList[-1][0][0] + 1, None, 'Bool')
673 if NotFlag:
674 ConditionSatisfied = not ConditionSatisfied
675
676 IfList[-1] = [IfList[-1][0], ConditionSatisfied, IfList[-1][2]]
677
678 if IfList[-1][1]:
679 if IfList[-1][2]:
680 IfList[-1][1] = False
681 else:
682 IfList[-1][2] = True
683 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
684
685
686 elif self.__Token == '!endif':
687 if IfList[-1][1]:
688 self.__WipeOffArea.append(((self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - len('!endif')), (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
689 else:
690 self.__WipeOffArea.append((IfList[-1][0], (self.CurrentLineNumber - 1, self.CurrentOffsetWithinLine - 1)))
691
692 IfList.pop()
693
694
695 if len(IfList) > 0:
696 raise Warning("Missing !endif", self.FileName, self.CurrentLineNumber)
697 self.Rewind()
698
699 def __EvaluateConditional(self, Name, Line, Op = None, Value = None):
700
701 FileLineTuple = GetRealFileLine(self.FileName, Line)
702 if Name in InputMacroDict:
703 MacroValue = InputMacroDict[Name]
704 if Op == None:
705 if Value == 'Bool' and MacroValue == None or MacroValue.upper() == 'FALSE':
706 return False
707 return True
708 elif Op == '!=':
709 if Value != MacroValue:
710 return True
711 else:
712 return False
713 elif Op == '==':
714 if Value == MacroValue:
715 return True
716 else:
717 return False
718 else:
719 if (self.__IsHex(Value) or Value.isdigit()) and (self.__IsHex(MacroValue) or (MacroValue != None and MacroValue.isdigit())):
720 InputVal = long(Value, 0)
721 MacroVal = long(MacroValue, 0)
722 if Op == '>':
723 if MacroVal > InputVal:
724 return True
725 else:
726 return False
727 elif Op == '>=':
728 if MacroVal >= InputVal:
729 return True
730 else:
731 return False
732 elif Op == '<':
733 if MacroVal < InputVal:
734 return True
735 else:
736 return False
737 elif Op == '<=':
738 if MacroVal <= InputVal:
739 return True
740 else:
741 return False
742 else:
743 return False
744 else:
745 raise Warning("Value %s is not a number", self.FileName, Line)
746
747 for Profile in AllMacroList:
748 if Profile.FileName == FileLineTuple[0] and Profile.MacroName == Name and Profile.DefinedAtLine <= FileLineTuple[1]:
749 if Op == None:
750 if Value == 'Bool' and Profile.MacroValue == None or Profile.MacroValue.upper() == 'FALSE':
751 return False
752 return True
753 elif Op == '!=':
754 if Value != Profile.MacroValue:
755 return True
756 else:
757 return False
758 elif Op == '==':
759 if Value == Profile.MacroValue:
760 return True
761 else:
762 return False
763 else:
764 if (self.__IsHex(Value) or Value.isdigit()) and (self.__IsHex(Profile.MacroValue) or (Profile.MacroValue != None and Profile.MacroValue.isdigit())):
765 InputVal = long(Value, 0)
766 MacroVal = long(Profile.MacroValue, 0)
767 if Op == '>':
768 if MacroVal > InputVal:
769 return True
770 else:
771 return False
772 elif Op == '>=':
773 if MacroVal >= InputVal:
774 return True
775 else:
776 return False
777 elif Op == '<':
778 if MacroVal < InputVal:
779 return True
780 else:
781 return False
782 elif Op == '<=':
783 if MacroVal <= InputVal:
784 return True
785 else:
786 return False
787 else:
788 return False
789 else:
790 raise Warning("Value %s is not a number", self.FileName, Line)
791
792 return False
793
794 ## __IsToken() method
795 #
796 # Check whether input string is found from current char position along
797 # If found, the string value is put into self.__Token
798 #
799 # @param self The object pointer
800 # @param String The string to search
801 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive
802 # @retval True Successfully find string, file buffer pointer moved forward
803 # @retval False Not able to find string, file buffer pointer not changed
804 #
805 def __IsToken(self, String, IgnoreCase = False):
806 self.__SkipWhiteSpace()
807
808 # Only consider the same line, no multi-line token allowed
809 StartPos = self.CurrentOffsetWithinLine
810 index = -1
811 if IgnoreCase:
812 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())
813 else:
814 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)
815 if index == 0:
816 self.CurrentOffsetWithinLine += len(String)
817 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]
818 return True
819 return False
820
821 ## __IsKeyword() method
822 #
823 # Check whether input keyword is found from current char position along, whole word only!
824 # If found, the string value is put into self.__Token
825 #
826 # @param self The object pointer
827 # @param Keyword The string to search
828 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive
829 # @retval True Successfully find string, file buffer pointer moved forward
830 # @retval False Not able to find string, file buffer pointer not changed
831 #
832 def __IsKeyword(self, KeyWord, IgnoreCase = False):
833 self.__SkipWhiteSpace()
834
835 # Only consider the same line, no multi-line token allowed
836 StartPos = self.CurrentOffsetWithinLine
837 index = -1
838 if IgnoreCase:
839 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(KeyWord.upper())
840 else:
841 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(KeyWord)
842 if index == 0:
843 followingChar = self.__CurrentLine()[self.CurrentOffsetWithinLine + len(KeyWord)]
844 if not str(followingChar).isspace() and followingChar not in SEPERATOR_TUPLE:
845 return False
846 self.CurrentOffsetWithinLine += len(KeyWord)
847 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]
848 return True
849 return False
850
851 ## __GetNextWord() method
852 #
853 # Get next C name from file lines
854 # If found, the string value is put into self.__Token
855 #
856 # @param self The object pointer
857 # @retval True Successfully find a C name string, file buffer pointer moved forward
858 # @retval False Not able to find a C name string, file buffer pointer not changed
859 #
860 def __GetNextWord(self):
861 self.__SkipWhiteSpace()
862 if self.__EndOfFile():
863 return False
864
865 TempChar = self.__CurrentChar()
866 StartPos = self.CurrentOffsetWithinLine
867 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') or TempChar == '_':
868 self.__GetOneChar()
869 while not self.__EndOfLine():
870 TempChar = self.__CurrentChar()
871 if (TempChar >= 'a' and TempChar <= 'z') or (TempChar >= 'A' and TempChar <= 'Z') \
872 or (TempChar >= '0' and TempChar <= '9') or TempChar == '_' or TempChar == '-':
873 self.__GetOneChar()
874
875 else:
876 break
877
878 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]
879 return True
880
881 return False
882
883 ## __GetNextToken() method
884 #
885 # Get next token unit before a seperator
886 # If found, the string value is put into self.__Token
887 #
888 # @param self The object pointer
889 # @retval True Successfully find a token unit, file buffer pointer moved forward
890 # @retval False Not able to find a token unit, file buffer pointer not changed
891 #
892 def __GetNextToken(self):
893 # Skip leading spaces, if exist.
894 self.__SkipWhiteSpace()
895 if self.__EndOfFile():
896 return False
897 # Record the token start position, the position of the first non-space char.
898 StartPos = self.CurrentOffsetWithinLine
899 StartLine = self.CurrentLineNumber
900 while not self.__EndOfLine():
901 TempChar = self.__CurrentChar()
902 # Try to find the end char that is not a space and not in seperator tuple.
903 # That is, when we got a space or any char in the tuple, we got the end of token.
904 if not str(TempChar).isspace() and TempChar not in SEPERATOR_TUPLE:
905 self.__GetOneChar()
906 # if we happen to meet a seperator as the first char, we must proceed to get it.
907 # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.
908 elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:
909 self.__GetOneChar()
910 break
911 else:
912 break
913 # else:
914 # return False
915
916 EndPos = self.CurrentOffsetWithinLine
917 if self.CurrentLineNumber != StartLine:
918 EndPos = len(self.Profile.FileLinesList[StartLine-1])
919 self.__Token = self.Profile.FileLinesList[StartLine-1][StartPos : EndPos]
920 if StartPos != self.CurrentOffsetWithinLine:
921 return True
922 else:
923 return False
924
925 def __GetNextOp(self):
926 # Skip leading spaces, if exist.
927 self.__SkipWhiteSpace()
928 if self.__EndOfFile():
929 return False
930 # Record the token start position, the position of the first non-space char.
931 StartPos = self.CurrentOffsetWithinLine
932 while not self.__EndOfLine():
933 TempChar = self.__CurrentChar()
934 # Try to find the end char that is not a space
935 if not str(TempChar).isspace():
936 self.__GetOneChar()
937 else:
938 break
939 else:
940 return False
941
942 if StartPos != self.CurrentOffsetWithinLine:
943 self.__Token = self.__CurrentLine()[StartPos : self.CurrentOffsetWithinLine]
944 return True
945 else:
946 return False
947 ## __GetNextGuid() method
948 #
949 # Get next token unit before a seperator
950 # If found, the GUID string is put into self.__Token
951 #
952 # @param self The object pointer
953 # @retval True Successfully find a registry format GUID, file buffer pointer moved forward
954 # @retval False Not able to find a registry format GUID, file buffer pointer not changed
955 #
956 def __GetNextGuid(self):
957
958 if not self.__GetNextToken():
959 return False
960 p = re.compile('[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}')
961 if p.match(self.__Token) != None:
962 return True
963 else:
964 self.__UndoToken()
965 return False
966
967 ## __UndoToken() method
968 #
969 # Go back one token unit in file buffer
970 #
971 # @param self The object pointer
972 #
973 def __UndoToken(self):
974 self.__UndoOneChar()
975 while self.__CurrentChar().isspace():
976 if not self.__UndoOneChar():
977 self.__GetOneChar()
978 return
979
980
981 StartPos = self.CurrentOffsetWithinLine
982 CurrentLine = self.CurrentLineNumber
983 while CurrentLine == self.CurrentLineNumber:
984
985 TempChar = self.__CurrentChar()
986 # Try to find the end char that is not a space and not in seperator tuple.
987 # That is, when we got a space or any char in the tuple, we got the end of token.
988 if not str(TempChar).isspace() and not TempChar in SEPERATOR_TUPLE:
989 if not self.__UndoOneChar():
990 break
991 # if we happen to meet a seperator as the first char, we must proceed to get it.
992 # That is, we get a token that is a seperator char. nomally it is the boundary of other tokens.
993 elif StartPos == self.CurrentOffsetWithinLine and TempChar in SEPERATOR_TUPLE:
994 return
995 else:
996 break
997
998 self.__GetOneChar()
999
1000 ## __HexDigit() method
1001 #
1002 # Whether char input is a Hex data bit
1003 #
1004 # @param self The object pointer
1005 # @param TempChar The char to test
1006 # @retval True The char is a Hex data bit
1007 # @retval False The char is NOT a Hex data bit
1008 #
1009 def __HexDigit(self, TempChar):
1010 if (TempChar >= 'a' and TempChar <= 'f') or (TempChar >= 'A' and TempChar <= 'F') \
1011 or (TempChar >= '0' and TempChar <= '9'):
1012 return True
1013 else:
1014 return False
1015
1016 def __IsHex(self, HexStr):
1017 if not HexStr.upper().startswith("0X"):
1018 return False
1019 if len(self.__Token) <= 2:
1020 return False
1021 charList = [c for c in HexStr[2 : ] if not self.__HexDigit( c)]
1022 if len(charList) == 0:
1023 return True
1024 else:
1025 return False
1026 ## __GetNextHexNumber() method
1027 #
1028 # Get next HEX data before a seperator
1029 # If found, the HEX data is put into self.__Token
1030 #
1031 # @param self The object pointer
1032 # @retval True Successfully find a HEX data, file buffer pointer moved forward
1033 # @retval False Not able to find a HEX data, file buffer pointer not changed
1034 #
1035 def __GetNextHexNumber(self):
1036 if not self.__GetNextToken():
1037 return False
1038 if self.__IsHex(self.__Token):
1039 return True
1040 else:
1041 self.__UndoToken()
1042 return False
1043
1044 ## __GetNextDecimalNumber() method
1045 #
1046 # Get next decimal data before a seperator
1047 # If found, the decimal data is put into self.__Token
1048 #
1049 # @param self The object pointer
1050 # @retval True Successfully find a decimal data, file buffer pointer moved forward
1051 # @retval False Not able to find a decimal data, file buffer pointer not changed
1052 #
1053 def __GetNextDecimalNumber(self):
1054 if not self.__GetNextToken():
1055 return False
1056 if self.__Token.isdigit():
1057 return True
1058 else:
1059 self.__UndoToken()
1060 return False
1061
1062 ## __GetNextPcdName() method
1063 #
1064 # Get next PCD token space C name and PCD C name pair before a seperator
1065 # If found, the decimal data is put into self.__Token
1066 #
1067 # @param self The object pointer
1068 # @retval Tuple PCD C name and PCD token space C name pair
1069 #
1070 def __GetNextPcdName(self):
1071 if not self.__GetNextWord():
1072 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)
1073 pcdTokenSpaceCName = self.__Token
1074
1075 if not self.__IsToken( "."):
1076 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)
1077
1078 if not self.__GetNextWord():
1079 raise Warning("expected format of <PcdTokenSpaceCName>.<PcdCName>", self.FileName, self.CurrentLineNumber)
1080 pcdCName = self.__Token
1081
1082 return (pcdCName, pcdTokenSpaceCName)
1083
1084 ## __GetStringData() method
1085 #
1086 # Get string contents quoted in ""
1087 # If found, the decimal data is put into self.__Token
1088 #
1089 # @param self The object pointer
1090 # @retval True Successfully find a string data, file buffer pointer moved forward
1091 # @retval False Not able to find a string data, file buffer pointer not changed
1092 #
1093 def __GetStringData(self):
1094 if self.__Token.startswith("\"") or self.__Token.startswith("L\""):
1095 self.__UndoToken()
1096 self.__SkipToToken("\"")
1097 currentLineNumber = self.CurrentLineNumber
1098
1099 if not self.__SkipToToken("\""):
1100 raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)
1101 if currentLineNumber != self.CurrentLineNumber:
1102 raise Warning("Missing Quote \" for String", self.FileName, self.CurrentLineNumber)
1103 self.__Token = self.__SkippedChars.rstrip('\"')
1104 return True
1105
1106 elif self.__Token.startswith("\'") or self.__Token.startswith("L\'"):
1107 self.__UndoToken()
1108 self.__SkipToToken("\'")
1109 currentLineNumber = self.CurrentLineNumber
1110
1111 if not self.__SkipToToken("\'"):
1112 raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)
1113 if currentLineNumber != self.CurrentLineNumber:
1114 raise Warning("Missing Quote \' for String", self.FileName, self.CurrentLineNumber)
1115 self.__Token = self.__SkippedChars.rstrip('\'')
1116 return True
1117
1118 else:
1119 return False
1120
1121 ## __SkipToToken() method
1122 #
1123 # Search forward in file buffer for the string
1124 # The skipped chars are put into self.__SkippedChars
1125 #
1126 # @param self The object pointer
1127 # @param String The string to search
1128 # @param IgnoreCase Indicate case sensitive/non-sensitive search, default is case sensitive
1129 # @retval True Successfully find the string, file buffer pointer moved forward
1130 # @retval False Not able to find the string, file buffer pointer not changed
1131 #
1132 def __SkipToToken(self, String, IgnoreCase = False):
1133 StartPos = self.GetFileBufferPos()
1134
1135 self.__SkippedChars = ""
1136 while not self.__EndOfFile():
1137 index = -1
1138 if IgnoreCase:
1139 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].upper().find(String.upper())
1140 else:
1141 index = self.__CurrentLine()[self.CurrentOffsetWithinLine : ].find(String)
1142 if index == 0:
1143 self.CurrentOffsetWithinLine += len(String)
1144 self.__SkippedChars += String
1145 return True
1146 self.__SkippedChars += str(self.__CurrentChar())
1147 self.__GetOneChar()
1148
1149 self.SetFileBufferPos( StartPos)
1150 self.__SkippedChars = ""
1151 return False
1152
1153 ## GetFileBufferPos() method
1154 #
1155 # Return the tuple of current line and offset within the line
1156 #
1157 # @param self The object pointer
1158 # @retval Tuple Line number and offset pair
1159 #
1160 def GetFileBufferPos(self):
1161 return (self.CurrentLineNumber, self.CurrentOffsetWithinLine)
1162
1163 ## SetFileBufferPos() method
1164 #
1165 # Restore the file buffer position
1166 #
1167 # @param self The object pointer
1168 # @param Pos The new file buffer position
1169 #
1170 def SetFileBufferPos(self, Pos):
1171 (self.CurrentLineNumber, self.CurrentOffsetWithinLine) = Pos
1172
1173 ## ParseFile() method
1174 #
1175 # Parse the file profile buffer to extract fd, fv ... information
1176 # Exception will be raised if syntax error found
1177 #
1178 # @param self The object pointer
1179 #
1180 def ParseFile(self):
1181
1182 try:
1183 self.__StringToList()
1184 self.PreprocessFile()
1185 self.PreprocessIncludeFile()
1186 self.__StringToList()
1187 self.PreprocessFile()
1188 self.PreprocessConditionalStatement()
1189 self.__StringToList()
1190 for Pos in self.__WipeOffArea:
1191 self.__ReplaceFragment(Pos[0], Pos[1])
1192 self.Profile.FileLinesList = ["".join(list) for list in self.Profile.FileLinesList]
1193
1194 while self.__GetDefines():
1195 pass
1196
1197 Index = 0
1198 while Index < len(self.Profile.FileLinesList):
1199 FileLineTuple = GetRealFileLine(self.FileName, Index + 1)
1200 self.Profile.FileLinesList[Index] = self.__ReplaceMacros(self.Profile.FileLinesList[Index], FileLineTuple[0], FileLineTuple[1])
1201 Index += 1
1202
1203 while self.__GetFd():
1204 pass
1205
1206 while self.__GetFv():
1207 pass
1208
1209 while self.__GetCapsule():
1210 pass
1211
1212 while self.__GetVtf():
1213 pass
1214
1215 while self.__GetRule():
1216 pass
1217
1218 while self.__GetOptionRom():
1219 pass
1220
1221 except Warning, X:
1222 self.__UndoToken()
1223 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
1224 #'\n\tGot Token: \"%s\" from File %s\n' % (self.__Token, FileLineTuple[0]) + \
1225 X.Message += ' near line %d, column %d: %s' \
1226 % (FileLineTuple[1], self.CurrentOffsetWithinLine + 1, self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :].rstrip('\n').rstrip('\r'))
1227 raise
1228
1229 ## __GetDefines() method
1230 #
1231 # Get Defines section contents and store its data into AllMacrosList
1232 #
1233 # @param self The object pointer
1234 # @retval True Successfully find a Defines
1235 # @retval False Not able to find a Defines
1236 #
1237 def __GetDefines(self):
1238
1239 if not self.__GetNextToken():
1240 return False
1241
1242 S = self.__Token.upper()
1243 if S.startswith("[") and not S.startswith("[DEFINES"):
1244 if not S.startswith("[FD.") and not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \
1245 and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):
1246 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [DEFINES], [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
1247 self.__UndoToken()
1248 return False
1249
1250 self.__UndoToken()
1251 if not self.__IsToken("[DEFINES", True):
1252 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
1253 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
1254 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
1255 raise Warning("expected [DEFINES", self.FileName, self.CurrentLineNumber)
1256
1257 if not self.__IsToken( "]"):
1258 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
1259
1260 while self.__GetNextWord():
1261 Macro = self.__Token
1262
1263 if not self.__IsToken("="):
1264 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1265 if not self.__GetNextToken() or self.__Token.startswith('['):
1266 raise Warning("expected MACRO value", self.FileName, self.CurrentLineNumber)
1267 Value = self.__Token
1268 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
1269 MacProfile = MacroProfile(FileLineTuple[0], FileLineTuple[1])
1270 MacProfile.MacroName = Macro
1271 MacProfile.MacroValue = Value
1272 AllMacroList.append(MacProfile)
1273
1274 return False
1275
1276 ## __GetFd() method
1277 #
1278 # Get FD section contents and store its data into FD dictionary of self.Profile
1279 #
1280 # @param self The object pointer
1281 # @retval True Successfully find a FD
1282 # @retval False Not able to find a FD
1283 #
1284 def __GetFd(self):
1285
1286 if not self.__GetNextToken():
1287 return False
1288
1289 S = self.__Token.upper()
1290 if S.startswith("[") and not S.startswith("[FD."):
1291 if not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \
1292 and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):
1293 raise Warning("Unknown section", self.FileName, self.CurrentLineNumber)
1294 self.__UndoToken()
1295 return False
1296
1297 self.__UndoToken()
1298 if not self.__IsToken("[FD.", True):
1299 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
1300 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
1301 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
1302 raise Warning("expected [FD.]", self.FileName, self.CurrentLineNumber)
1303
1304 FdName = self.__GetUiName()
1305 if FdName == "":
1306 if len (self.Profile.FdDict) == 0:
1307 FdName = GenFdsGlobalVariable.PlatformName
1308 self.Profile.FdNameNotSet = True
1309 else:
1310 raise Warning("expected FdName in [FD.] section", self.FileName, self.CurrentLineNumber)
1311 self.CurrentFdName = FdName.upper()
1312
1313 if self.CurrentFdName in self.Profile.FdDict:
1314 raise Warning("Unexpected the same FD name", self.FileName, self.CurrentLineNumber)
1315
1316 if not self.__IsToken( "]"):
1317 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
1318
1319 FdObj = Fd.FD()
1320 FdObj.FdUiName = self.CurrentFdName
1321 self.Profile.FdDict[self.CurrentFdName] = FdObj
1322
1323 if len (self.Profile.FdDict) > 1 and self.Profile.FdNameNotSet:
1324 raise Warning("expected all FDs have their name", self.FileName, self.CurrentLineNumber)
1325
1326 Status = self.__GetCreateFile(FdObj)
1327 if not Status:
1328 raise Warning("FD name error", self.FileName, self.CurrentLineNumber)
1329
1330 self.__GetTokenStatements(FdObj)
1331
1332 self.__GetDefineStatements(FdObj)
1333
1334 self.__GetSetStatements(FdObj)
1335
1336 if not self.__GetRegionLayout(FdObj):
1337 raise Warning("expected region layout", self.FileName, self.CurrentLineNumber)
1338
1339 while self.__GetRegionLayout(FdObj):
1340 pass
1341 return True
1342
1343 ## __GetUiName() method
1344 #
1345 # Return the UI name of a section
1346 #
1347 # @param self The object pointer
1348 # @retval FdName UI name
1349 #
1350 def __GetUiName(self):
1351 Name = ""
1352 if self.__GetNextWord():
1353 Name = self.__Token
1354
1355 return Name
1356
1357 ## __GetCreateFile() method
1358 #
1359 # Return the output file name of object
1360 #
1361 # @param self The object pointer
1362 # @param Obj object whose data will be stored in file
1363 # @retval FdName UI name
1364 #
1365 def __GetCreateFile(self, Obj):
1366
1367 if self.__IsKeyword( "CREATE_FILE"):
1368 if not self.__IsToken( "="):
1369 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1370
1371 if not self.__GetNextToken():
1372 raise Warning("expected file name", self.FileName, self.CurrentLineNumber)
1373
1374 FileName = self.__Token
1375 Obj.CreateFileName = FileName
1376
1377 return True
1378
1379 ## __GetTokenStatements() method
1380 #
1381 # Get token statements
1382 #
1383 # @param self The object pointer
1384 # @param Obj for whom token statement is got
1385 #
1386 def __GetTokenStatements(self, Obj):
1387 if not self.__IsKeyword( "BaseAddress"):
1388 raise Warning("BaseAddress missing", self.FileName, self.CurrentLineNumber)
1389
1390 if not self.__IsToken( "="):
1391 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1392
1393 if not self.__GetNextHexNumber():
1394 raise Warning("expected Hex base address", self.FileName, self.CurrentLineNumber)
1395
1396 Obj.BaseAddress = self.__Token
1397
1398 if self.__IsToken( "|"):
1399 pcdPair = self.__GetNextPcdName()
1400 Obj.BaseAddressPcd = pcdPair
1401 self.Profile.PcdDict[pcdPair] = Obj.BaseAddress
1402
1403 if not self.__IsKeyword( "Size"):
1404 raise Warning("Size missing", self.FileName, self.CurrentLineNumber)
1405
1406 if not self.__IsToken( "="):
1407 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1408
1409 if not self.__GetNextHexNumber():
1410 raise Warning("expected Hex size", self.FileName, self.CurrentLineNumber)
1411
1412
1413 Size = self.__Token
1414 if self.__IsToken( "|"):
1415 pcdPair = self.__GetNextPcdName()
1416 Obj.SizePcd = pcdPair
1417 self.Profile.PcdDict[pcdPair] = Size
1418 Obj.Size = long(Size, 0)
1419
1420 if not self.__IsKeyword( "ErasePolarity"):
1421 raise Warning("ErasePolarity missing", self.FileName, self.CurrentLineNumber)
1422
1423 if not self.__IsToken( "="):
1424 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1425
1426 if not self.__GetNextToken():
1427 raise Warning("expected Erase Polarity", self.FileName, self.CurrentLineNumber)
1428
1429 if self.__Token != "1" and self.__Token != "0":
1430 raise Warning("expected 1 or 0 Erase Polarity", self.FileName, self.CurrentLineNumber)
1431
1432 Obj.ErasePolarity = self.__Token
1433
1434 self.__GetBlockStatements(Obj)
1435
1436 ## __GetAddressStatements() method
1437 #
1438 # Get address statements
1439 #
1440 # @param self The object pointer
1441 # @param Obj for whom address statement is got
1442 # @retval True Successfully find
1443 # @retval False Not able to find
1444 #
1445 def __GetAddressStatements(self, Obj):
1446
1447 if self.__IsKeyword("BsBaseAddress"):
1448 if not self.__IsToken( "="):
1449 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1450
1451 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():
1452 raise Warning("expected address", self.FileName, self.CurrentLineNumber)
1453
1454 BsAddress = long(self.__Token, 0)
1455 Obj.BsBaseAddress = BsAddress
1456
1457 if self.__IsKeyword("RtBaseAddress"):
1458 if not self.__IsToken( "="):
1459 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1460
1461 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():
1462 raise Warning("expected address", self.FileName, self.CurrentLineNumber)
1463
1464 RtAddress = long(self.__Token, 0)
1465 Obj.RtBaseAddress = RtAddress
1466
1467 ## __GetBlockStatements() method
1468 #
1469 # Get block statements
1470 #
1471 # @param self The object pointer
1472 # @param Obj for whom block statement is got
1473 #
1474 def __GetBlockStatements(self, Obj):
1475
1476 if not self.__GetBlockStatement(Obj):
1477 #set default block size is 1
1478 Obj.BlockSizeList.append((1, Obj.Size, None))
1479 return
1480
1481 while self.__GetBlockStatement(Obj):
1482 pass
1483
1484 for Item in Obj.BlockSizeList:
1485 if Item[0] == None or Item[1] == None:
1486 raise Warning("expected block statement for Fd Section", self.FileName, self.CurrentLineNumber)
1487
1488 ## __GetBlockStatement() method
1489 #
1490 # Get block statement
1491 #
1492 # @param self The object pointer
1493 # @param Obj for whom block statement is got
1494 # @retval True Successfully find
1495 # @retval False Not able to find
1496 #
1497 def __GetBlockStatement(self, Obj):
1498 if not self.__IsKeyword( "BlockSize"):
1499 return False
1500
1501 if not self.__IsToken( "="):
1502 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1503
1504 if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():
1505 raise Warning("expected Hex block size", self.FileName, self.CurrentLineNumber)
1506
1507 BlockSize = self.__Token
1508 BlockSizePcd = None
1509 if self.__IsToken( "|"):
1510 PcdPair = self.__GetNextPcdName()
1511 BlockSizePcd = PcdPair
1512 self.Profile.PcdDict[PcdPair] = BlockSize
1513 BlockSize = long(BlockSize, 0)
1514
1515 BlockNumber = None
1516 if self.__IsKeyword( "NumBlocks"):
1517 if not self.__IsToken( "="):
1518 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1519
1520 if not self.__GetNextDecimalNumber() and not self.__GetNextHexNumber():
1521 raise Warning("expected block numbers", self.FileName, self.CurrentLineNumber)
1522
1523 BlockNumber = long(self.__Token, 0)
1524
1525 Obj.BlockSizeList.append((BlockSize, BlockNumber, BlockSizePcd))
1526 return True
1527
1528 ## __GetDefineStatements() method
1529 #
1530 # Get define statements
1531 #
1532 # @param self The object pointer
1533 # @param Obj for whom define statement is got
1534 # @retval True Successfully find
1535 # @retval False Not able to find
1536 #
1537 def __GetDefineStatements(self, Obj):
1538 while self.__GetDefineStatement( Obj):
1539 pass
1540
1541 ## __GetDefineStatement() method
1542 #
1543 # Get define statement
1544 #
1545 # @param self The object pointer
1546 # @param Obj for whom define statement is got
1547 # @retval True Successfully find
1548 # @retval False Not able to find
1549 #
1550 def __GetDefineStatement(self, Obj):
1551 if self.__IsKeyword("DEFINE"):
1552 self.__GetNextToken()
1553 Macro = self.__Token
1554 if not self.__IsToken( "="):
1555 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1556
1557 if not self.__GetNextToken():
1558 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
1559
1560 Value = self.__Token
1561 Macro = '$(' + Macro + ')'
1562 Obj.DefineVarDict[Macro] = Value
1563 return True
1564
1565 return False
1566
1567 ## __GetSetStatements() method
1568 #
1569 # Get set statements
1570 #
1571 # @param self The object pointer
1572 # @param Obj for whom set statement is got
1573 # @retval True Successfully find
1574 # @retval False Not able to find
1575 #
1576 def __GetSetStatements(self, Obj):
1577 while self.__GetSetStatement(Obj):
1578 pass
1579
1580 ## __GetSetStatement() method
1581 #
1582 # Get set statement
1583 #
1584 # @param self The object pointer
1585 # @param Obj for whom set statement is got
1586 # @retval True Successfully find
1587 # @retval False Not able to find
1588 #
1589 def __GetSetStatement(self, Obj):
1590 if self.__IsKeyword("SET"):
1591 PcdPair = self.__GetNextPcdName()
1592
1593 if not self.__IsToken( "="):
1594 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1595
1596 if not self.__GetNextToken():
1597 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
1598
1599 Value = self.__Token
1600 if Value.startswith("{"):
1601 # deal with value with {}
1602 if not self.__SkipToToken( "}"):
1603 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
1604 Value += self.__SkippedChars
1605
1606 Obj.SetVarDict[PcdPair] = Value
1607 self.Profile.PcdDict[PcdPair] = Value
1608 return True
1609
1610 return False
1611
1612 ## __GetRegionLayout() method
1613 #
1614 # Get region layout for FD
1615 #
1616 # @param self The object pointer
1617 # @param Fd for whom region is got
1618 # @retval True Successfully find
1619 # @retval False Not able to find
1620 #
1621 def __GetRegionLayout(self, Fd):
1622 if not self.__GetNextHexNumber():
1623 return False
1624
1625 RegionObj = Region.Region()
1626 RegionObj.Offset = long(self.__Token, 0)
1627 Fd.RegionList.append(RegionObj)
1628
1629 if not self.__IsToken( "|"):
1630 raise Warning("expected '|'", self.FileName, self.CurrentLineNumber)
1631
1632 if not self.__GetNextHexNumber():
1633 raise Warning("expected Region Size", self.FileName, self.CurrentLineNumber)
1634 RegionObj.Size = long(self.__Token, 0)
1635
1636 if not self.__GetNextWord():
1637 return True
1638
1639 if not self.__Token in ("SET", "FV", "FILE", "DATA", "CAPSULE"):
1640 self.__UndoToken()
1641 RegionObj.PcdOffset = self.__GetNextPcdName()
1642 self.Profile.PcdDict[RegionObj.PcdOffset] = "0x%08X" % (RegionObj.Offset + long(Fd.BaseAddress, 0))
1643 if self.__IsToken( "|"):
1644 RegionObj.PcdSize = self.__GetNextPcdName()
1645 self.Profile.PcdDict[RegionObj.PcdSize] = "0x%08X" % RegionObj.Size
1646
1647 if not self.__GetNextWord():
1648 return True
1649
1650 if self.__Token == "SET":
1651 self.__UndoToken()
1652 self.__GetSetStatements( RegionObj)
1653 if not self.__GetNextWord():
1654 return True
1655
1656 elif self.__Token == "FV":
1657 self.__UndoToken()
1658 self.__GetRegionFvType( RegionObj)
1659
1660 elif self.__Token == "CAPSULE":
1661 self.__UndoToken()
1662 self.__GetRegionCapType( RegionObj)
1663
1664 elif self.__Token == "FILE":
1665 self.__UndoToken()
1666 self.__GetRegionFileType( RegionObj)
1667
1668 else:
1669 self.__UndoToken()
1670 self.__GetRegionDataType( RegionObj)
1671
1672 return True
1673
1674 ## __GetRegionFvType() method
1675 #
1676 # Get region fv data for region
1677 #
1678 # @param self The object pointer
1679 # @param RegionObj for whom region data is got
1680 #
1681 def __GetRegionFvType(self, RegionObj):
1682
1683 if not self.__IsKeyword( "FV"):
1684 raise Warning("expected Keyword 'FV'", self.FileName, self.CurrentLineNumber)
1685
1686 if not self.__IsToken( "="):
1687 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1688
1689 if not self.__GetNextToken():
1690 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)
1691
1692 RegionObj.RegionType = "FV"
1693 RegionObj.RegionDataList.append(self.__Token)
1694
1695 while self.__IsKeyword( "FV"):
1696
1697 if not self.__IsToken( "="):
1698 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1699
1700 if not self.__GetNextToken():
1701 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)
1702
1703 RegionObj.RegionDataList.append(self.__Token)
1704
1705 ## __GetRegionCapType() method
1706 #
1707 # Get region capsule data for region
1708 #
1709 # @param self The object pointer
1710 # @param RegionObj for whom region data is got
1711 #
1712 def __GetRegionCapType(self, RegionObj):
1713
1714 if not self.__IsKeyword("CAPSULE"):
1715 raise Warning("expected Keyword 'CAPSULE'", self.FileName, self.CurrentLineNumber)
1716
1717 if not self.__IsToken("="):
1718 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1719
1720 if not self.__GetNextToken():
1721 raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)
1722
1723 RegionObj.RegionType = "CAPSULE"
1724 RegionObj.RegionDataList.append(self.__Token)
1725
1726 while self.__IsKeyword("CAPSULE"):
1727
1728 if not self.__IsToken("="):
1729 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1730
1731 if not self.__GetNextToken():
1732 raise Warning("expected CAPSULE name", self.FileName, self.CurrentLineNumber)
1733
1734 RegionObj.RegionDataList.append(self.__Token)
1735
1736 ## __GetRegionFileType() method
1737 #
1738 # Get region file data for region
1739 #
1740 # @param self The object pointer
1741 # @param RegionObj for whom region data is got
1742 #
1743 def __GetRegionFileType(self, RegionObj):
1744
1745 if not self.__IsKeyword( "FILE"):
1746 raise Warning("expected Keyword 'FILE'", self.FileName, self.CurrentLineNumber)
1747
1748 if not self.__IsToken( "="):
1749 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1750
1751 if not self.__GetNextToken():
1752 raise Warning("expected File name", self.FileName, self.CurrentLineNumber)
1753
1754 RegionObj.RegionType = "FILE"
1755 RegionObj.RegionDataList.append( self.__Token)
1756
1757 while self.__IsKeyword( "FILE"):
1758
1759 if not self.__IsToken( "="):
1760 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1761
1762 if not self.__GetNextToken():
1763 raise Warning("expected FILE name", self.FileName, self.CurrentLineNumber)
1764
1765 RegionObj.RegionDataList.append(self.__Token)
1766
1767 ## __GetRegionDataType() method
1768 #
1769 # Get region array data for region
1770 #
1771 # @param self The object pointer
1772 # @param RegionObj for whom region data is got
1773 #
1774 def __GetRegionDataType(self, RegionObj):
1775
1776 if not self.__IsKeyword( "DATA"):
1777 raise Warning("expected Region Data type", self.FileName, self.CurrentLineNumber)
1778
1779 if not self.__IsToken( "="):
1780 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1781
1782 if not self.__IsToken( "{"):
1783 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
1784
1785 if not self.__GetNextHexNumber():
1786 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)
1787
1788 if len(self.__Token) > 4:
1789 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
1790
1791 DataString = self.__Token
1792 DataString += ","
1793
1794 while self.__IsToken(","):
1795 if not self.__GetNextHexNumber():
1796 raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)
1797 if len(self.__Token) > 4:
1798 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
1799 DataString += self.__Token
1800 DataString += ","
1801
1802 if not self.__IsToken( "}"):
1803 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
1804
1805 DataString = DataString.rstrip(",")
1806 RegionObj.RegionType = "DATA"
1807 RegionObj.RegionDataList.append( DataString)
1808
1809 while self.__IsKeyword( "DATA"):
1810
1811 if not self.__IsToken( "="):
1812 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1813
1814 if not self.__IsToken( "{"):
1815 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
1816
1817 if not self.__GetNextHexNumber():
1818 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)
1819
1820 if len(self.__Token) > 4:
1821 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
1822
1823 DataString = self.__Token
1824 DataString += ","
1825
1826 while self.__IsToken(","):
1827 self.__GetNextHexNumber()
1828 if len(self.__Token) > 4:
1829 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
1830 DataString += self.__Token
1831 DataString += ","
1832
1833 if not self.__IsToken( "}"):
1834 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
1835
1836 DataString = DataString.rstrip(",")
1837 RegionObj.RegionDataList.append( DataString)
1838
1839 ## __GetFv() method
1840 #
1841 # Get FV section contents and store its data into FV dictionary of self.Profile
1842 #
1843 # @param self The object pointer
1844 # @retval True Successfully find a FV
1845 # @retval False Not able to find a FV
1846 #
1847 def __GetFv(self):
1848 if not self.__GetNextToken():
1849 return False
1850
1851 S = self.__Token.upper()
1852 if S.startswith("[") and not S.startswith("[FV."):
1853 if not S.startswith("[CAPSULE.") \
1854 and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):
1855 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
1856 self.__UndoToken()
1857 return False
1858
1859 self.__UndoToken()
1860 if not self.__IsToken("[FV.", True):
1861 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
1862 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
1863 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
1864 raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
1865
1866 FvName = self.__GetUiName()
1867 self.CurrentFvName = FvName.upper()
1868
1869 if not self.__IsToken( "]"):
1870 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
1871
1872 FvObj = Fv.FV()
1873 FvObj.UiFvName = self.CurrentFvName
1874 self.Profile.FvDict[self.CurrentFvName] = FvObj
1875
1876 Status = self.__GetCreateFile(FvObj)
1877 if not Status:
1878 raise Warning("FV name error", self.FileName, self.CurrentLineNumber)
1879
1880 self.__GetDefineStatements(FvObj)
1881
1882 self.__GetAddressStatements(FvObj)
1883
1884 self.__GetBlockStatement(FvObj)
1885
1886 self.__GetSetStatements(FvObj)
1887
1888 self.__GetFvAlignment(FvObj)
1889
1890 self.__GetFvAttributes(FvObj)
1891
1892 self.__GetFvNameGuid(FvObj)
1893
1894 FvObj.FvExtEntryTypeValue = []
1895 FvObj.FvExtEntryType = []
1896 FvObj.FvExtEntryData = []
1897 while True:
1898 isFvExtEntry = self.__GetFvExtEntryStatement(FvObj)
1899 if not isFvExtEntry:
1900 break
1901
1902 self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())
1903 self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())
1904
1905 while True:
1906 isInf = self.__GetInfStatement(FvObj, MacroDict = FvObj.DefineVarDict.copy())
1907 isFile = self.__GetFileStatement(FvObj, MacroDict = FvObj.DefineVarDict.copy())
1908 if not isInf and not isFile:
1909 break
1910
1911 return True
1912
1913 ## __GetFvAlignment() method
1914 #
1915 # Get alignment for FV
1916 #
1917 # @param self The object pointer
1918 # @param Obj for whom alignment is got
1919 # @retval True Successfully find a alignment statement
1920 # @retval False Not able to find a alignment statement
1921 #
1922 def __GetFvAlignment(self, Obj):
1923
1924 if not self.__IsKeyword( "FvAlignment"):
1925 return False
1926
1927 if not self.__IsToken( "="):
1928 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1929
1930 if not self.__GetNextToken():
1931 raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)
1932
1933 if self.__Token.upper() not in ("1", "2", "4", "8", "16", "32", "64", "128", "256", "512", \
1934 "1K", "2K", "4K", "8K", "16K", "32K", "64K", "128K", "256K", "512K", \
1935 "1M", "2M", "4M", "8M", "16M", "32M", "64M", "128M", "256M", "512M", \
1936 "1G", "2G"):
1937 raise Warning("Unknown alignment value '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
1938 Obj.FvAlignment = self.__Token
1939 return True
1940
1941 ## __GetFvAttributes() method
1942 #
1943 # Get attributes for FV
1944 #
1945 # @param self The object pointer
1946 # @param Obj for whom attribute is got
1947 # @retval None
1948 #
1949 def __GetFvAttributes(self, FvObj):
1950
1951 while self.__GetNextWord():
1952 name = self.__Token
1953 if name not in ("ERASE_POLARITY", "MEMORY_MAPPED", \
1954 "STICKY_WRITE", "LOCK_CAP", "LOCK_STATUS", "WRITE_ENABLED_CAP", \
1955 "WRITE_DISABLED_CAP", "WRITE_STATUS", "READ_ENABLED_CAP", \
1956 "READ_DISABLED_CAP", "READ_STATUS", "READ_LOCK_CAP", \
1957 "READ_LOCK_STATUS", "WRITE_LOCK_CAP", "WRITE_LOCK_STATUS", \
1958 "WRITE_POLICY_RELIABLE"):
1959 self.__UndoToken()
1960 return
1961
1962 if not self.__IsToken( "="):
1963 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1964
1965 if not self.__GetNextToken() or self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):
1966 raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)
1967
1968 FvObj.FvAttributeDict[name] = self.__Token
1969
1970 return
1971
1972 ## __GetFvNameGuid() method
1973 #
1974 # Get FV GUID for FV
1975 #
1976 # @param self The object pointer
1977 # @param Obj for whom GUID is got
1978 # @retval None
1979 #
1980 def __GetFvNameGuid(self, FvObj):
1981
1982 if not self.__IsKeyword( "FvNameGuid"):
1983 return
1984
1985 if not self.__IsToken( "="):
1986 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
1987
1988 if not self.__GetNextGuid():
1989 raise Warning("expected FV GUID value", self.FileName, self.CurrentLineNumber)
1990
1991 FvObj.FvNameGuid = self.__Token
1992
1993 return
1994
1995 def __GetFvExtEntryStatement(self, FvObj):
1996
1997 if not self.__IsKeyword( "FV_EXT_ENTRY"):
1998 return False
1999
2000 if not self.__IsKeyword ("TYPE"):
2001 raise Warning("expected 'TYPE'", self.FileName, self.CurrentLineNumber)
2002
2003 if not self.__IsToken( "="):
2004 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2005
2006 if not self.__GetNextHexNumber() and not self.__GetNextDecimalNumber():
2007 raise Warning("expected Hex FV extension entry type value At Line ", self.FileName, self.CurrentLineNumber)
2008
2009 FvObj.FvExtEntryTypeValue += [self.__Token]
2010
2011 if not self.__IsToken( "{"):
2012 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2013
2014 if not self.__IsKeyword ("FILE") and not self.__IsKeyword ("DATA"):
2015 raise Warning("expected 'FILE' or 'DATA'", self.FileName, self.CurrentLineNumber)
2016
2017 FvObj.FvExtEntryType += [self.__Token]
2018
2019 if self.__Token == 'DATA':
2020
2021 if not self.__IsToken( "="):
2022 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2023
2024 if not self.__IsToken( "{"):
2025 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2026
2027 if not self.__GetNextHexNumber():
2028 raise Warning("expected Hex byte", self.FileName, self.CurrentLineNumber)
2029
2030 if len(self.__Token) > 4:
2031 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
2032
2033 DataString = self.__Token
2034 DataString += ","
2035
2036 while self.__IsToken(","):
2037 if not self.__GetNextHexNumber():
2038 raise Warning("Invalid Hex number", self.FileName, self.CurrentLineNumber)
2039 if len(self.__Token) > 4:
2040 raise Warning("Hex byte(must be 2 digits) too long", self.FileName, self.CurrentLineNumber)
2041 DataString += self.__Token
2042 DataString += ","
2043
2044 if not self.__IsToken( "}"):
2045 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2046
2047 if not self.__IsToken( "}"):
2048 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2049
2050 DataString = DataString.rstrip(",")
2051 FvObj.FvExtEntryData += [DataString]
2052
2053 if self.__Token == 'FILE':
2054
2055 if not self.__IsToken( "="):
2056 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2057
2058 if not self.__GetNextToken():
2059 raise Warning("expected FV Extension Entry file path At Line ", self.FileName, self.CurrentLineNumber)
2060
2061 FvObj.FvExtEntryData += [self.__Token]
2062
2063 if not self.__IsToken( "}"):
2064 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2065
2066 return True
2067
2068 ## __GetAprioriSection() method
2069 #
2070 # Get token statements
2071 #
2072 # @param self The object pointer
2073 # @param FvObj for whom apriori is got
2074 # @param MacroDict dictionary used to replace macro
2075 # @retval True Successfully find apriori statement
2076 # @retval False Not able to find apriori statement
2077 #
2078 def __GetAprioriSection(self, FvObj, MacroDict = {}):
2079
2080 if not self.__IsKeyword( "APRIORI"):
2081 return False
2082
2083 if not self.__IsKeyword("PEI") and not self.__IsKeyword("DXE"):
2084 raise Warning("expected Apriori file type", self.FileName, self.CurrentLineNumber)
2085 AprType = self.__Token
2086
2087 if not self.__IsToken( "{"):
2088 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2089
2090 AprSectionObj = AprioriSection.AprioriSection()
2091 AprSectionObj.AprioriType = AprType
2092
2093 self.__GetDefineStatements(AprSectionObj)
2094 MacroDict.update(AprSectionObj.DefineVarDict)
2095
2096 while True:
2097 IsInf = self.__GetInfStatement( AprSectionObj, MacroDict = MacroDict)
2098 IsFile = self.__GetFileStatement( AprSectionObj)
2099 if not IsInf and not IsFile:
2100 break
2101
2102 if not self.__IsToken( "}"):
2103 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2104
2105 FvObj.AprioriSectionList.append(AprSectionObj)
2106 return True
2107
2108 ## __GetInfStatement() method
2109 #
2110 # Get INF statements
2111 #
2112 # @param self The object pointer
2113 # @param Obj for whom inf statement is got
2114 # @param MacroDict dictionary used to replace macro
2115 # @retval True Successfully find inf statement
2116 # @retval False Not able to find inf statement
2117 #
2118 def __GetInfStatement(self, Obj, ForCapsule = False, MacroDict = {}):
2119
2120 if not self.__IsKeyword( "INF"):
2121 return False
2122
2123 ffsInf = FfsInfStatement.FfsInfStatement()
2124 self.__GetInfOptions( ffsInf)
2125
2126 if not self.__GetNextToken():
2127 raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)
2128 ffsInf.InfFileName = self.__Token
2129
2130 if not ffsInf.InfFileName in self.Profile.InfList:
2131 self.Profile.InfList.append(ffsInf.InfFileName)
2132
2133 if self.__IsToken('|'):
2134 if self.__IsKeyword('RELOCS_STRIPPED'):
2135 ffsInf.KeepReloc = False
2136 elif self.__IsKeyword('RELOCS_RETAINED'):
2137 ffsInf.KeepReloc = True
2138 else:
2139 raise Warning("Unknown reloc strip flag '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2140
2141 if ForCapsule:
2142 capsuleFfs = CapsuleData.CapsuleFfs()
2143 capsuleFfs.Ffs = ffsInf
2144 Obj.CapsuleDataList.append(capsuleFfs)
2145 else:
2146 Obj.FfsList.append(ffsInf)
2147 return True
2148
2149 ## __GetInfOptions() method
2150 #
2151 # Get options for INF
2152 #
2153 # @param self The object pointer
2154 # @param FfsInfObj for whom option is got
2155 #
2156 def __GetInfOptions(self, FfsInfObj):
2157
2158 if self.__IsKeyword( "RuleOverride"):
2159 if not self.__IsToken( "="):
2160 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2161 if not self.__GetNextToken():
2162 raise Warning("expected Rule name", self.FileName, self.CurrentLineNumber)
2163 FfsInfObj.Rule = self.__Token
2164
2165 if self.__IsKeyword( "VERSION"):
2166 if not self.__IsToken( "="):
2167 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2168 if not self.__GetNextToken():
2169 raise Warning("expected Version", self.FileName, self.CurrentLineNumber)
2170
2171 if self.__GetStringData():
2172 FfsInfObj.Version = self.__Token
2173
2174 if self.__IsKeyword( "UI"):
2175 if not self.__IsToken( "="):
2176 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2177 if not self.__GetNextToken():
2178 raise Warning("expected UI name", self.FileName, self.CurrentLineNumber)
2179
2180 if self.__GetStringData():
2181 FfsInfObj.Ui = self.__Token
2182
2183 if self.__IsKeyword( "USE"):
2184 if not self.__IsToken( "="):
2185 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2186 if not self.__GetNextToken():
2187 raise Warning("expected ARCH name", self.FileName, self.CurrentLineNumber)
2188 FfsInfObj.UseArch = self.__Token
2189
2190
2191 if self.__GetNextToken():
2192 p = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')
2193 if p.match(self.__Token):
2194 FfsInfObj.KeyStringList.append(self.__Token)
2195 if not self.__IsToken(","):
2196 return
2197 else:
2198 self.__UndoToken()
2199 return
2200
2201 while self.__GetNextToken():
2202 if not p.match(self.__Token):
2203 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)
2204 FfsInfObj.KeyStringList.append(self.__Token)
2205
2206 if not self.__IsToken(","):
2207 break
2208
2209 ## __GetFileStatement() method
2210 #
2211 # Get FILE statements
2212 #
2213 # @param self The object pointer
2214 # @param Obj for whom FILE statement is got
2215 # @param MacroDict dictionary used to replace macro
2216 # @retval True Successfully find FILE statement
2217 # @retval False Not able to find FILE statement
2218 #
2219 def __GetFileStatement(self, Obj, ForCapsule = False, MacroDict = {}):
2220
2221 if not self.__IsKeyword( "FILE"):
2222 return False
2223
2224 FfsFileObj = FfsFileStatement.FileStatement()
2225
2226 if not self.__GetNextWord():
2227 raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)
2228 FfsFileObj.FvFileType = self.__Token
2229
2230 if not self.__IsToken( "="):
2231 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2232
2233 if not self.__GetNextGuid():
2234 if not self.__GetNextWord():
2235 raise Warning("expected File GUID", self.FileName, self.CurrentLineNumber)
2236 if self.__Token == 'PCD':
2237 if not self.__IsToken( "("):
2238 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)
2239 PcdPair = self.__GetNextPcdName()
2240 if not self.__IsToken( ")"):
2241 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)
2242 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'
2243
2244 FfsFileObj.NameGuid = self.__Token
2245
2246 self.__GetFilePart( FfsFileObj, MacroDict.copy())
2247
2248 if ForCapsule:
2249 capsuleFfs = CapsuleData.CapsuleFfs()
2250 capsuleFfs.Ffs = FfsFileObj
2251 Obj.CapsuleDataList.append(capsuleFfs)
2252 else:
2253 Obj.FfsList.append(FfsFileObj)
2254
2255 return True
2256
2257 ## __FileCouldHaveRelocFlag() method
2258 #
2259 # Check whether reloc strip flag can be set for a file type.
2260 #
2261 # @param self The object pointer
2262 # @param FileType The file type to check with
2263 # @retval True This type could have relocation strip flag
2264 # @retval False No way to have it
2265 #
2266
2267 def __FileCouldHaveRelocFlag (self, FileType):
2268 if FileType in ('SEC', 'PEI_CORE', 'PEIM', 'PEI_DXE_COMBO'):
2269 return True
2270 else:
2271 return False
2272
2273 ## __SectionCouldHaveRelocFlag() method
2274 #
2275 # Check whether reloc strip flag can be set for a section type.
2276 #
2277 # @param self The object pointer
2278 # @param SectionType The section type to check with
2279 # @retval True This type could have relocation strip flag
2280 # @retval False No way to have it
2281 #
2282
2283 def __SectionCouldHaveRelocFlag (self, SectionType):
2284 if SectionType in ('TE', 'PE32'):
2285 return True
2286 else:
2287 return False
2288
2289 ## __GetFilePart() method
2290 #
2291 # Get components for FILE statement
2292 #
2293 # @param self The object pointer
2294 # @param FfsFileObj for whom component is got
2295 # @param MacroDict dictionary used to replace macro
2296 #
2297 def __GetFilePart(self, FfsFileObj, MacroDict = {}):
2298
2299 self.__GetFileOpts( FfsFileObj)
2300
2301 if not self.__IsToken("{"):
2302 # if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):
2303 # if self.__FileCouldHaveRelocFlag(FfsFileObj.FvFileType):
2304 # if self.__Token == 'RELOCS_STRIPPED':
2305 # FfsFileObj.KeepReloc = False
2306 # else:
2307 # FfsFileObj.KeepReloc = True
2308 # else:
2309 # raise Warning("File type %s could not have reloc strip flag%d" % (FfsFileObj.FvFileType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
2310 #
2311 # if not self.__IsToken("{"):
2312 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2313
2314 if not self.__GetNextToken():
2315 raise Warning("expected File name or section data", self.FileName, self.CurrentLineNumber)
2316
2317 if self.__Token == "FV":
2318 if not self.__IsToken( "="):
2319 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2320 if not self.__GetNextToken():
2321 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)
2322 FfsFileObj.FvName = self.__Token
2323
2324 elif self.__Token == "FD":
2325 if not self.__IsToken( "="):
2326 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2327 if not self.__GetNextToken():
2328 raise Warning("expected FD name", self.FileName, self.CurrentLineNumber)
2329 FfsFileObj.FdName = self.__Token
2330
2331 elif self.__Token in ("DEFINE", "APRIORI", "SECTION"):
2332 self.__UndoToken()
2333 self.__GetSectionData( FfsFileObj, MacroDict)
2334 else:
2335 FfsFileObj.FileName = self.__Token
2336
2337 if not self.__IsToken( "}"):
2338 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2339
2340 ## __GetFileOpts() method
2341 #
2342 # Get options for FILE statement
2343 #
2344 # @param self The object pointer
2345 # @param FfsFileObj for whom options is got
2346 #
2347 def __GetFileOpts(self, FfsFileObj):
2348
2349 if self.__GetNextToken():
2350 Pattern = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')
2351 if Pattern.match(self.__Token):
2352 FfsFileObj.KeyStringList.append(self.__Token)
2353 if self.__IsToken(","):
2354 while self.__GetNextToken():
2355 if not Pattern.match(self.__Token):
2356 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)
2357 FfsFileObj.KeyStringList.append(self.__Token)
2358
2359 if not self.__IsToken(","):
2360 break
2361
2362 else:
2363 self.__UndoToken()
2364
2365 if self.__IsKeyword( "FIXED", True):
2366 FfsFileObj.Fixed = True
2367
2368 if self.__IsKeyword( "CHECKSUM", True):
2369 FfsFileObj.CheckSum = True
2370
2371 if self.__GetAlignment():
2372 FfsFileObj.Alignment = self.__Token
2373
2374
2375
2376 ## __GetAlignment() method
2377 #
2378 # Return the alignment value
2379 #
2380 # @param self The object pointer
2381 # @retval True Successfully find alignment
2382 # @retval False Not able to find alignment
2383 #
2384 def __GetAlignment(self):
2385 if self.__IsKeyword( "Align", True):
2386 if not self.__IsToken( "="):
2387 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2388
2389 if not self.__GetNextToken():
2390 raise Warning("expected alignment value", self.FileName, self.CurrentLineNumber)
2391 return True
2392
2393 return False
2394
2395 ## __GetFilePart() method
2396 #
2397 # Get section data for FILE statement
2398 #
2399 # @param self The object pointer
2400 # @param FfsFileObj for whom section is got
2401 # @param MacroDict dictionary used to replace macro
2402 #
2403 def __GetSectionData(self, FfsFileObj, MacroDict = {}):
2404 Dict = {}
2405 Dict.update(MacroDict)
2406
2407 self.__GetDefineStatements(FfsFileObj)
2408
2409 Dict.update(FfsFileObj.DefineVarDict)
2410 self.__GetAprioriSection(FfsFileObj, Dict.copy())
2411 self.__GetAprioriSection(FfsFileObj, Dict.copy())
2412
2413 while True:
2414 IsLeafSection = self.__GetLeafSection(FfsFileObj, Dict)
2415 IsEncapSection = self.__GetEncapsulationSec(FfsFileObj)
2416 if not IsLeafSection and not IsEncapSection:
2417 break
2418
2419 ## __GetLeafSection() method
2420 #
2421 # Get leaf section for Obj
2422 #
2423 # @param self The object pointer
2424 # @param Obj for whom leaf section is got
2425 # @param MacroDict dictionary used to replace macro
2426 # @retval True Successfully find section statement
2427 # @retval False Not able to find section statement
2428 #
2429 def __GetLeafSection(self, Obj, MacroDict = {}):
2430
2431 OldPos = self.GetFileBufferPos()
2432
2433 if not self.__IsKeyword( "SECTION"):
2434 if len(Obj.SectionList) == 0:
2435 raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)
2436 else:
2437 return False
2438
2439 AlignValue = None
2440 if self.__GetAlignment():
2441 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
2442 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2443 AlignValue = self.__Token
2444
2445 BuildNum = None
2446 if self.__IsKeyword( "BUILD_NUM"):
2447 if not self.__IsToken( "="):
2448 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2449
2450 if not self.__GetNextToken():
2451 raise Warning("expected Build number value", self.FileName, self.CurrentLineNumber)
2452
2453 BuildNum = self.__Token
2454
2455 if self.__IsKeyword( "VERSION"):
2456 if AlignValue == 'Auto':
2457 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
2458 if not self.__IsToken( "="):
2459 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2460 if not self.__GetNextToken():
2461 raise Warning("expected version", self.FileName, self.CurrentLineNumber)
2462 VerSectionObj = VerSection.VerSection()
2463 VerSectionObj.Alignment = AlignValue
2464 VerSectionObj.BuildNum = BuildNum
2465 if self.__GetStringData():
2466 VerSectionObj.StringData = self.__Token
2467 else:
2468 VerSectionObj.FileName = self.__Token
2469 Obj.SectionList.append(VerSectionObj)
2470
2471 elif self.__IsKeyword( "UI"):
2472 if AlignValue == 'Auto':
2473 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
2474 if not self.__IsToken( "="):
2475 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2476 if not self.__GetNextToken():
2477 raise Warning("expected UI", self.FileName, self.CurrentLineNumber)
2478 UiSectionObj = UiSection.UiSection()
2479 UiSectionObj.Alignment = AlignValue
2480 if self.__GetStringData():
2481 UiSectionObj.StringData = self.__Token
2482 else:
2483 UiSectionObj.FileName = self.__Token
2484 Obj.SectionList.append(UiSectionObj)
2485
2486 elif self.__IsKeyword( "FV_IMAGE"):
2487 if AlignValue == 'Auto':
2488 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
2489 if not self.__IsToken( "="):
2490 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2491 if not self.__GetNextToken():
2492 raise Warning("expected FV name or FV file path", self.FileName, self.CurrentLineNumber)
2493
2494 FvName = self.__Token
2495 FvObj = None
2496
2497 if self.__IsToken( "{"):
2498 FvObj = Fv.FV()
2499 FvObj.UiFvName = FvName.upper()
2500 self.__GetDefineStatements(FvObj)
2501 MacroDict.update(FvObj.DefineVarDict)
2502 self.__GetBlockStatement(FvObj)
2503 self.__GetSetStatements(FvObj)
2504 self.__GetFvAlignment(FvObj)
2505 self.__GetFvAttributes(FvObj)
2506 self.__GetAprioriSection(FvObj, MacroDict.copy())
2507 self.__GetAprioriSection(FvObj, MacroDict.copy())
2508
2509 while True:
2510 IsInf = self.__GetInfStatement(FvObj, MacroDict.copy())
2511 IsFile = self.__GetFileStatement(FvObj, MacroDict.copy())
2512 if not IsInf and not IsFile:
2513 break
2514
2515 if not self.__IsToken( "}"):
2516 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2517
2518 FvImageSectionObj = FvImageSection.FvImageSection()
2519 FvImageSectionObj.Alignment = AlignValue
2520 if FvObj != None:
2521 FvImageSectionObj.Fv = FvObj
2522 FvImageSectionObj.FvName = None
2523 else:
2524 FvImageSectionObj.FvName = FvName.upper()
2525 FvImageSectionObj.FvFileName = FvName
2526
2527 Obj.SectionList.append(FvImageSectionObj)
2528
2529 elif self.__IsKeyword("PEI_DEPEX_EXP") or self.__IsKeyword("DXE_DEPEX_EXP") or self.__IsKeyword("SMM_DEPEX_EXP"):
2530 if AlignValue == 'Auto':
2531 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
2532 DepexSectionObj = DepexSection.DepexSection()
2533 DepexSectionObj.Alignment = AlignValue
2534 DepexSectionObj.DepexType = self.__Token
2535
2536 if not self.__IsToken( "="):
2537 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2538 if not self.__IsToken( "{"):
2539 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2540 if not self.__SkipToToken( "}"):
2541 raise Warning("expected Depex expression ending '}'", self.FileName, self.CurrentLineNumber)
2542
2543 DepexSectionObj.Expression = self.__SkippedChars.rstrip('}')
2544 Obj.SectionList.append(DepexSectionObj)
2545
2546 else:
2547 if not self.__GetNextWord():
2548 raise Warning("expected section type", self.FileName, self.CurrentLineNumber)
2549
2550 # Encapsulation section appear, UndoToken and return
2551 if self.__Token == "COMPRESS" or self.__Token == "GUIDED":
2552 self.SetFileBufferPos(OldPos)
2553 return False
2554
2555 if self.__Token not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\
2556 "UI", "VERSION", "PEI_DEPEX", "SUBTYPE_GUID", "SMM_DEPEX"):
2557 raise Warning("Unknown section type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2558 if AlignValue == 'Auto'and (not self.__Token == 'PE32') and (not self.__Token == 'TE'):
2559 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
2560
2561 # DataSection
2562 DataSectionObj = DataSection.DataSection()
2563 DataSectionObj.Alignment = AlignValue
2564 DataSectionObj.SecType = self.__Token
2565
2566 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):
2567 if self.__FileCouldHaveRelocFlag(Obj.FvFileType) and self.__SectionCouldHaveRelocFlag(DataSectionObj.SecType):
2568 if self.__Token == 'RELOCS_STRIPPED':
2569 DataSectionObj.KeepReloc = False
2570 else:
2571 DataSectionObj.KeepReloc = True
2572 else:
2573 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)
2574
2575 if self.__IsToken("="):
2576 if not self.__GetNextToken():
2577 raise Warning("expected section file path", self.FileName, self.CurrentLineNumber)
2578 DataSectionObj.SectFileName = self.__Token
2579 else:
2580 if not self.__GetCglSection(DataSectionObj):
2581 return False
2582
2583 Obj.SectionList.append(DataSectionObj)
2584
2585 return True
2586
2587 ## __GetCglSection() method
2588 #
2589 # Get compressed or GUIDed section for Obj
2590 #
2591 # @param self The object pointer
2592 # @param Obj for whom leaf section is got
2593 # @param AlignValue alignment value for complex section
2594 # @retval True Successfully find section statement
2595 # @retval False Not able to find section statement
2596 #
2597 def __GetCglSection(self, Obj, AlignValue = None):
2598
2599 if self.__IsKeyword( "COMPRESS"):
2600 type = "PI_STD"
2601 if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):
2602 type = self.__Token
2603
2604 if not self.__IsToken("{"):
2605 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2606
2607 CompressSectionObj = CompressSection.CompressSection()
2608 CompressSectionObj.Alignment = AlignValue
2609 CompressSectionObj.CompType = type
2610 # Recursive sections...
2611 while True:
2612 IsLeafSection = self.__GetLeafSection(CompressSectionObj)
2613 IsEncapSection = self.__GetEncapsulationSec(CompressSectionObj)
2614 if not IsLeafSection and not IsEncapSection:
2615 break
2616
2617
2618 if not self.__IsToken( "}"):
2619 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2620 Obj.SectionList.append(CompressSectionObj)
2621
2622 # else:
2623 # raise Warning("Compress type not known")
2624
2625 return True
2626
2627 elif self.__IsKeyword( "GUIDED"):
2628 GuidValue = None
2629 if self.__GetNextGuid():
2630 GuidValue = self.__Token
2631
2632 AttribDict = self.__GetGuidAttrib()
2633 if not self.__IsToken("{"):
2634 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
2635 GuidSectionObj = GuidSection.GuidSection()
2636 GuidSectionObj.Alignment = AlignValue
2637 GuidSectionObj.NameGuid = GuidValue
2638 GuidSectionObj.SectionType = "GUIDED"
2639 GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]
2640 GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]
2641 # Recursive sections...
2642 while True:
2643 IsLeafSection = self.__GetLeafSection(GuidSectionObj)
2644 IsEncapSection = self.__GetEncapsulationSec(GuidSectionObj)
2645 if not IsLeafSection and not IsEncapSection:
2646 break
2647
2648 if not self.__IsToken( "}"):
2649 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
2650 Obj.SectionList.append(GuidSectionObj)
2651
2652 return True
2653
2654 return False
2655
2656 ## __GetGuidAttri() method
2657 #
2658 # Get attributes for GUID section
2659 #
2660 # @param self The object pointer
2661 # @retval AttribDict Dictionary of key-value pair of section attributes
2662 #
2663 def __GetGuidAttrib(self):
2664
2665 AttribDict = {}
2666 AttribDict["PROCESSING_REQUIRED"] = False
2667 AttribDict["AUTH_STATUS_VALID"] = False
2668 if self.__IsKeyword("PROCESSING_REQUIRED") or self.__IsKeyword("AUTH_STATUS_VALID"):
2669 AttribKey = self.__Token
2670
2671 if not self.__IsToken("="):
2672 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2673
2674 if not self.__GetNextToken() or self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):
2675 raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)
2676 AttribDict[AttribKey] = self.__Token
2677
2678 if self.__IsKeyword("PROCESSING_REQUIRED") or self.__IsKeyword("AUTH_STATUS_VALID"):
2679 AttribKey = self.__Token
2680
2681 if not self.__IsToken("="):
2682 raise Warning("expected '='")
2683
2684 if not self.__GetNextToken() or self.__Token.upper() not in ("TRUE", "FALSE", "1", "0"):
2685 raise Warning("expected TRUE/FALSE (1/0)", self.FileName, self.CurrentLineNumber)
2686 AttribDict[AttribKey] = self.__Token
2687
2688 return AttribDict
2689
2690 ## __GetEncapsulationSec() method
2691 #
2692 # Get encapsulation section for FILE
2693 #
2694 # @param self The object pointer
2695 # @param FfsFile for whom section is got
2696 # @retval True Successfully find section statement
2697 # @retval False Not able to find section statement
2698 #
2699 def __GetEncapsulationSec(self, FfsFileObj):
2700
2701 OldPos = self.GetFileBufferPos()
2702 if not self.__IsKeyword( "SECTION"):
2703 if len(FfsFileObj.SectionList) == 0:
2704 raise Warning("expected SECTION", self.FileName, self.CurrentLineNumber)
2705 else:
2706 return False
2707
2708 AlignValue = None
2709 if self.__GetAlignment():
2710 if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
2711 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2712 AlignValue = self.__Token
2713
2714 if not self.__GetCglSection(FfsFileObj, AlignValue):
2715 self.SetFileBufferPos(OldPos)
2716 return False
2717 else:
2718 return True
2719
2720 ## __GetCapsule() method
2721 #
2722 # Get capsule section contents and store its data into capsule list of self.Profile
2723 #
2724 # @param self The object pointer
2725 # @retval True Successfully find a capsule
2726 # @retval False Not able to find a capsule
2727 #
2728 def __GetCapsule(self):
2729
2730 if not self.__GetNextToken():
2731 return False
2732
2733 S = self.__Token.upper()
2734 if S.startswith("[") and not S.startswith("[CAPSULE."):
2735 if not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):
2736 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
2737 self.__UndoToken()
2738 return False
2739
2740 self.__UndoToken()
2741 if not self.__IsToken("[CAPSULE.", True):
2742 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
2743 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
2744 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
2745 raise Warning("expected [Capsule.]", self.FileName, self.CurrentLineNumber)
2746
2747 CapsuleObj = Capsule.Capsule()
2748
2749 CapsuleName = self.__GetUiName()
2750 if not CapsuleName:
2751 raise Warning("expected capsule name", self.FileName, self.CurrentLineNumber)
2752
2753 CapsuleObj.UiCapsuleName = CapsuleName.upper()
2754
2755 if not self.__IsToken( "]"):
2756 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
2757
2758 if self.__IsKeyword("CREATE_FILE"):
2759 if not self.__IsToken( "="):
2760 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2761
2762 if not self.__GetNextToken():
2763 raise Warning("expected file name", self.FileName, self.CurrentLineNumber)
2764
2765 CapsuleObj.CreateFile = self.__Token
2766
2767 self.__GetCapsuleStatements(CapsuleObj)
2768 self.Profile.CapsuleDict[CapsuleObj.UiCapsuleName] = CapsuleObj
2769 return True
2770
2771 ## __GetCapsuleStatements() method
2772 #
2773 # Get statements for capsule
2774 #
2775 # @param self The object pointer
2776 # @param Obj for whom statements are got
2777 #
2778 def __GetCapsuleStatements(self, Obj):
2779 self.__GetCapsuleTokens(Obj)
2780 self.__GetDefineStatements(Obj)
2781 self.__GetSetStatements(Obj)
2782 self.__GetCapsuleData(Obj)
2783
2784 ## __GetCapsuleTokens() method
2785 #
2786 # Get token statements for capsule
2787 #
2788 # @param self The object pointer
2789 # @param Obj for whom token statements are got
2790 #
2791 def __GetCapsuleTokens(self, Obj):
2792 if not self.__GetNextToken():
2793 return False
2794 while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS"):
2795 Name = self.__Token.strip()
2796 if not self.__IsToken("="):
2797 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2798 if not self.__GetNextToken():
2799 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
2800 if Name == 'CAPSULE_FLAGS':
2801 if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):
2802 raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)
2803 Value = self.__Token.strip()
2804 while self.__IsToken(","):
2805 Value += ','
2806 if not self.__GetNextToken():
2807 raise Warning("expected value", self.FileName, self.CurrentLineNumber)
2808 if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):
2809 raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)
2810 Value += self.__Token.strip()
2811 else:
2812 Value = self.__Token.strip()
2813 Obj.TokensDict[Name] = Value
2814 if not self.__GetNextToken():
2815 return False
2816 self.__UndoToken()
2817
2818 ## __GetCapsuleData() method
2819 #
2820 # Get capsule data for capsule
2821 #
2822 # @param self The object pointer
2823 # @param Obj for whom capsule data are got
2824 #
2825 def __GetCapsuleData(self, Obj):
2826
2827 while True:
2828 IsInf = self.__GetInfStatement(Obj, True)
2829 IsFile = self.__GetFileStatement(Obj, True)
2830 IsFv = self.__GetFvStatement(Obj)
2831 if not IsInf and not IsFile and not IsFv:
2832 break
2833
2834 ## __GetFvStatement() method
2835 #
2836 # Get FV for capsule
2837 #
2838 # @param self The object pointer
2839 # @param CapsuleObj for whom FV is got
2840 # @retval True Successfully find a FV statement
2841 # @retval False Not able to find a FV statement
2842 #
2843 def __GetFvStatement(self, CapsuleObj):
2844
2845 if not self.__IsKeyword("FV"):
2846 return False
2847
2848 if not self.__IsToken("="):
2849 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2850
2851 if not self.__GetNextToken():
2852 raise Warning("expected FV name", self.FileName, self.CurrentLineNumber)
2853
2854 CapsuleFv = CapsuleData.CapsuleFv()
2855 CapsuleFv.FvName = self.__Token
2856 CapsuleObj.CapsuleDataList.append(CapsuleFv)
2857 return True
2858
2859 ## __GetRule() method
2860 #
2861 # Get Rule section contents and store its data into rule list of self.Profile
2862 #
2863 # @param self The object pointer
2864 # @retval True Successfully find a Rule
2865 # @retval False Not able to find a Rule
2866 #
2867 def __GetRule(self):
2868
2869 if not self.__GetNextToken():
2870 return False
2871
2872 S = self.__Token.upper()
2873 if S.startswith("[") and not S.startswith("[RULE."):
2874 if not S.startswith("[OPTIONROM."):
2875 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
2876 self.__UndoToken()
2877 return False
2878 self.__UndoToken()
2879 if not self.__IsToken("[Rule.", True):
2880 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
2881 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
2882 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
2883 raise Warning("expected [Rule.]", self.FileName, self.CurrentLineNumber)
2884
2885 if not self.__SkipToToken("."):
2886 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)
2887
2888 Arch = self.__SkippedChars.rstrip(".")
2889 if Arch.upper() not in ("IA32", "X64", "IPF", "EBC", "ARM", "COMMON"):
2890 raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)
2891
2892 ModuleType = self.__GetModuleType()
2893
2894 TemplateName = ""
2895 if self.__IsToken("."):
2896 if not self.__GetNextWord():
2897 raise Warning("expected template name", self.FileName, self.CurrentLineNumber)
2898 TemplateName = self.__Token
2899
2900 if not self.__IsToken( "]"):
2901 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
2902
2903 RuleObj = self.__GetRuleFileStatements()
2904 RuleObj.Arch = Arch.upper()
2905 RuleObj.ModuleType = ModuleType
2906 RuleObj.TemplateName = TemplateName
2907 if TemplateName == '' :
2908 self.Profile.RuleDict['RULE' + \
2909 '.' + \
2910 Arch.upper() + \
2911 '.' + \
2912 ModuleType.upper() ] = RuleObj
2913 else :
2914 self.Profile.RuleDict['RULE' + \
2915 '.' + \
2916 Arch.upper() + \
2917 '.' + \
2918 ModuleType.upper() + \
2919 '.' + \
2920 TemplateName.upper() ] = RuleObj
2921 # self.Profile.RuleList.append(rule)
2922 return True
2923
2924 ## __GetModuleType() method
2925 #
2926 # Return the module type
2927 #
2928 # @param self The object pointer
2929 # @retval string module type
2930 #
2931 def __GetModuleType(self):
2932
2933 if not self.__GetNextWord():
2934 raise Warning("expected Module type", self.FileName, self.CurrentLineNumber)
2935 if self.__Token.upper() not in ("SEC", "PEI_CORE", "PEIM", "DXE_CORE", \
2936 "DXE_DRIVER", "DXE_SAL_DRIVER", \
2937 "DXE_SMM_DRIVER", "DXE_RUNTIME_DRIVER", \
2938 "UEFI_DRIVER", "UEFI_APPLICATION", "USER_DEFINED", "DEFAULT", "BASE", \
2939 "SECURITY_CORE", "COMBINED_PEIM_DRIVER", "PIC_PEIM", "RELOCATABLE_PEIM", \
2940 "PE32_PEIM", "BS_DRIVER", "RT_DRIVER", "SAL_RT_DRIVER", "APPLICATION", "ACPITABLE", "SMM_CORE"):
2941 raise Warning("Unknown Module type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2942 return self.__Token
2943
2944 ## __GetFileExtension() method
2945 #
2946 # Return the file extension
2947 #
2948 # @param self The object pointer
2949 # @retval string file name extension
2950 #
2951 def __GetFileExtension(self):
2952 if not self.__IsToken("."):
2953 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)
2954
2955 Ext = ""
2956 if self.__GetNextToken():
2957 Pattern = re.compile(r'([a-zA-Z][a-zA-Z0-9]*)')
2958 if Pattern.match(self.__Token):
2959 Ext = self.__Token
2960 return '.' + Ext
2961 else:
2962 raise Warning("Unknown file extension '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2963
2964 else:
2965 raise Warning("expected file extension", self.FileName, self.CurrentLineNumber)
2966
2967 ## __GetRuleFileStatement() method
2968 #
2969 # Get rule contents
2970 #
2971 # @param self The object pointer
2972 # @retval Rule Rule object
2973 #
2974 def __GetRuleFileStatements(self):
2975
2976 if not self.__IsKeyword("FILE"):
2977 raise Warning("expected FILE", self.FileName, self.CurrentLineNumber)
2978
2979 if not self.__GetNextWord():
2980 raise Warning("expected FFS type", self.FileName, self.CurrentLineNumber)
2981
2982 Type = self.__Token.strip().upper()
2983 if Type not in ("RAW", "FREEFORM", "SEC", "PEI_CORE", "PEIM",\
2984 "PEI_DXE_COMBO", "DRIVER", "DXE_CORE", "APPLICATION", "FV_IMAGE", "SMM", "SMM_CORE"):
2985 raise Warning("Unknown FV type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
2986
2987 if not self.__IsToken("="):
2988 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
2989
2990 if not self.__IsKeyword("$(NAMED_GUID)"):
2991 if not self.__GetNextWord():
2992 raise Warning("expected $(NAMED_GUID)", self.FileName, self.CurrentLineNumber)
2993 if self.__Token == 'PCD':
2994 if not self.__IsToken( "("):
2995 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)
2996 PcdPair = self.__GetNextPcdName()
2997 if not self.__IsToken( ")"):
2998 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)
2999 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'
3000
3001 NameGuid = self.__Token
3002
3003 KeepReloc = None
3004 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):
3005 if self.__FileCouldHaveRelocFlag(Type):
3006 if self.__Token == 'RELOCS_STRIPPED':
3007 KeepReloc = False
3008 else:
3009 KeepReloc = True
3010 else:
3011 raise Warning("File type %s could not have reloc strip flag%d" % (Type, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
3012
3013 KeyStringList = []
3014 if self.__GetNextToken():
3015 Pattern = re.compile(r'([a-zA-Z0-9\-]+|\$\(TARGET\)|\*)_([a-zA-Z0-9\-]+|\$\(TOOL_CHAIN_TAG\)|\*)_([a-zA-Z0-9\-]+|\$\(ARCH\)|\*)')
3016 if Pattern.match(self.__Token):
3017 KeyStringList.append(self.__Token)
3018 if self.__IsToken(","):
3019 while self.__GetNextToken():
3020 if not Pattern.match(self.__Token):
3021 raise Warning("expected KeyString \"Target_Tag_Arch\"", self.FileName, self.CurrentLineNumber)
3022 KeyStringList.append(self.__Token)
3023
3024 if not self.__IsToken(","):
3025 break
3026
3027 else:
3028 self.__UndoToken()
3029
3030
3031 Fixed = False
3032 if self.__IsKeyword("Fixed", True):
3033 Fixed = True
3034
3035 CheckSum = False
3036 if self.__IsKeyword("CheckSum", True):
3037 CheckSum = True
3038
3039 AlignValue = ""
3040 if self.__GetAlignment():
3041 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
3042 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3043 #For FFS, Auto is default option same to ""
3044 if not self.__Token == "Auto":
3045 AlignValue = self.__Token
3046
3047 if self.__IsToken("{"):
3048 # Complex file rule expected
3049 Rule = RuleComplexFile.RuleComplexFile()
3050 Rule.FvFileType = Type
3051 Rule.NameGuid = NameGuid
3052 Rule.Alignment = AlignValue
3053 Rule.CheckSum = CheckSum
3054 Rule.Fixed = Fixed
3055 Rule.KeyStringList = KeyStringList
3056 if KeepReloc != None:
3057 Rule.KeepReloc = KeepReloc
3058
3059 while True:
3060 IsEncapsulate = self.__GetRuleEncapsulationSection(Rule)
3061 IsLeaf = self.__GetEfiSection(Rule)
3062 if not IsEncapsulate and not IsLeaf:
3063 break
3064
3065 if not self.__IsToken("}"):
3066 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
3067
3068 return Rule
3069
3070 else:
3071 # Simple file rule expected
3072 if not self.__GetNextWord():
3073 raise Warning("expected leaf section type", self.FileName, self.CurrentLineNumber)
3074
3075 SectionName = self.__Token
3076
3077 if SectionName not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\
3078 "UI", "PEI_DEPEX", "VERSION", "SUBTYPE_GUID", "SMM_DEPEX"):
3079 raise Warning("Unknown leaf section name '%s'" % SectionName, self.FileName, self.CurrentLineNumber)
3080
3081
3082 if self.__IsKeyword("Fixed", True):
3083 Fixed = True
3084
3085 if self.__IsKeyword("CheckSum", True):
3086 CheckSum = True
3087
3088 SectAlignment = ""
3089 if self.__GetAlignment():
3090 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
3091 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3092 if self.__Token == 'Auto' and (not SectionName == 'PE32') and (not SectionName == 'TE'):
3093 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
3094 SectAlignment = self.__Token
3095
3096 Ext = None
3097 if self.__IsToken('|'):
3098 Ext = self.__GetFileExtension()
3099 elif not self.__GetNextToken():
3100 raise Warning("expected File name", self.FileName, self.CurrentLineNumber)
3101
3102 Rule = RuleSimpleFile.RuleSimpleFile()
3103 Rule.SectionType = SectionName
3104 Rule.FvFileType = Type
3105 Rule.NameGuid = NameGuid
3106 Rule.Alignment = AlignValue
3107 Rule.SectAlignment = SectAlignment
3108 Rule.CheckSum = CheckSum
3109 Rule.Fixed = Fixed
3110 Rule.KeyStringList = KeyStringList
3111 if KeepReloc != None:
3112 Rule.KeepReloc = KeepReloc
3113 Rule.FileExtension = Ext
3114 Rule.FileName = self.__Token
3115 return Rule
3116
3117 ## __GetEfiSection() method
3118 #
3119 # Get section list for Rule
3120 #
3121 # @param self The object pointer
3122 # @param Obj for whom section is got
3123 # @retval True Successfully find section statement
3124 # @retval False Not able to find section statement
3125 #
3126 def __GetEfiSection(self, Obj):
3127
3128 OldPos = self.GetFileBufferPos()
3129 if not self.__GetNextWord():
3130 return False
3131 SectionName = self.__Token
3132
3133 if SectionName not in ("COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\
3134 "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):
3135 self.__UndoToken()
3136 return False
3137
3138 if SectionName == "FV_IMAGE":
3139 FvImageSectionObj = FvImageSection.FvImageSection()
3140 if self.__IsKeyword("FV_IMAGE"):
3141 pass
3142 if self.__IsToken( "{"):
3143 FvObj = Fv.FV()
3144 self.__GetDefineStatements(FvObj)
3145 self.__GetBlockStatement(FvObj)
3146 self.__GetSetStatements(FvObj)
3147 self.__GetFvAlignment(FvObj)
3148 self.__GetFvAttributes(FvObj)
3149 self.__GetAprioriSection(FvObj)
3150 self.__GetAprioriSection(FvObj)
3151
3152 while True:
3153 IsInf = self.__GetInfStatement(FvObj)
3154 IsFile = self.__GetFileStatement(FvObj)
3155 if not IsInf and not IsFile:
3156 break
3157
3158 if not self.__IsToken( "}"):
3159 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
3160 FvImageSectionObj.Fv = FvObj
3161 FvImageSectionObj.FvName = None
3162
3163 else:
3164 if not self.__IsKeyword("FV"):
3165 raise Warning("expected 'FV'", self.FileName, self.CurrentLineNumber)
3166 FvImageSectionObj.FvFileType = self.__Token
3167
3168 if self.__GetAlignment():
3169 if self.__Token not in ("8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
3170 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3171 FvImageSectionObj.Alignment = self.__Token
3172
3173 if self.__IsToken('|'):
3174 FvImageSectionObj.FvFileExtension = self.__GetFileExtension()
3175 elif self.__GetNextToken():
3176 if self.__Token not in ("}", "COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\
3177 "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):
3178 FvImageSectionObj.FvFileName = self.__Token
3179 else:
3180 self.__UndoToken()
3181 else:
3182 raise Warning("expected FV file name", self.FileName, self.CurrentLineNumber)
3183
3184 Obj.SectionList.append(FvImageSectionObj)
3185 return True
3186
3187 EfiSectionObj = EfiSection.EfiSection()
3188 EfiSectionObj.SectionType = SectionName
3189
3190 if not self.__GetNextToken():
3191 raise Warning("expected file type", self.FileName, self.CurrentLineNumber)
3192
3193 if self.__Token == "STRING":
3194 if not self.__RuleSectionCouldHaveString(EfiSectionObj.SectionType):
3195 raise Warning("%s section could NOT have string data%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
3196
3197 if not self.__IsToken('='):
3198 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3199
3200 if not self.__GetNextToken():
3201 raise Warning("expected Quoted String", self.FileName, self.CurrentLineNumber)
3202
3203 if self.__GetStringData():
3204 EfiSectionObj.StringData = self.__Token
3205
3206 if self.__IsKeyword("BUILD_NUM"):
3207 if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):
3208 raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
3209
3210 if not self.__IsToken("="):
3211 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3212 if not self.__GetNextToken():
3213 raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)
3214 EfiSectionObj.BuildNum = self.__Token
3215
3216 else:
3217 EfiSectionObj.FileType = self.__Token
3218 self.__CheckRuleSectionFileType(EfiSectionObj.SectionType, EfiSectionObj.FileType)
3219
3220 if self.__IsKeyword("Optional"):
3221 if not self.__RuleSectionCouldBeOptional(EfiSectionObj.SectionType):
3222 raise Warning("%s section could NOT be optional%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
3223 EfiSectionObj.Optional = True
3224
3225 if self.__IsKeyword("BUILD_NUM"):
3226 if not self.__RuleSectionCouldHaveBuildNum(EfiSectionObj.SectionType):
3227 raise Warning("%s section could NOT have BUILD_NUM%d" % (EfiSectionObj.SectionType, self.CurrentLineNumber), self.FileName, self.CurrentLineNumber)
3228
3229 if not self.__IsToken("="):
3230 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3231 if not self.__GetNextToken():
3232 raise Warning("expected Build number", self.FileName, self.CurrentLineNumber)
3233 EfiSectionObj.BuildNum = self.__Token
3234
3235 if self.__GetAlignment():
3236 if self.__Token not in ("Auto", "8", "16", "32", "64", "128", "512", "1K", "4K", "32K" ,"64K"):
3237 raise Warning("Incorrect alignment '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3238 if self.__Token == 'Auto' and (not SectionName == 'PE32') and (not SectionName == 'TE'):
3239 raise Warning("Auto alignment can only be used in PE32 or TE section ", self.FileName, self.CurrentLineNumber)
3240 EfiSectionObj.Alignment = self.__Token
3241
3242 if self.__IsKeyword('RELOCS_STRIPPED') or self.__IsKeyword('RELOCS_RETAINED'):
3243 if self.__SectionCouldHaveRelocFlag(EfiSectionObj.SectionType):
3244 if self.__Token == 'RELOCS_STRIPPED':
3245 EfiSectionObj.KeepReloc = False
3246 else:
3247 EfiSectionObj.KeepReloc = True
3248 if Obj.KeepReloc != None and Obj.KeepReloc != EfiSectionObj.KeepReloc:
3249 raise Warning("Section type %s has reloc strip flag conflict with Rule" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)
3250 else:
3251 raise Warning("Section type %s could not have reloc strip flag" % EfiSectionObj.SectionType, self.FileName, self.CurrentLineNumber)
3252
3253
3254 if self.__IsToken('|'):
3255 EfiSectionObj.FileExtension = self.__GetFileExtension()
3256 elif self.__GetNextToken():
3257 if self.__Token not in ("}", "COMPAT16", "PE32", "PIC", "TE", "FV_IMAGE", "RAW", "DXE_DEPEX",\
3258 "UI", "VERSION", "PEI_DEPEX", "GUID", "SMM_DEPEX"):
3259
3260 if self.__Token.startswith('PCD'):
3261 self.__UndoToken()
3262 self.__GetNextWord()
3263
3264 if self.__Token == 'PCD':
3265 if not self.__IsToken( "("):
3266 raise Warning("expected '('", self.FileName, self.CurrentLineNumber)
3267 PcdPair = self.__GetNextPcdName()
3268 if not self.__IsToken( ")"):
3269 raise Warning("expected ')'", self.FileName, self.CurrentLineNumber)
3270 self.__Token = 'PCD('+PcdPair[1]+'.'+PcdPair[0]+')'
3271
3272 EfiSectionObj.FileName = self.__Token
3273
3274 else:
3275 self.__UndoToken()
3276 else:
3277 raise Warning("expected section file name", self.FileName, self.CurrentLineNumber)
3278
3279 Obj.SectionList.append(EfiSectionObj)
3280 return True
3281
3282 ## __RuleSectionCouldBeOptional() method
3283 #
3284 # Get whether a section could be optional
3285 #
3286 # @param self The object pointer
3287 # @param SectionType The section type to check
3288 # @retval True section could be optional
3289 # @retval False section never optional
3290 #
3291 def __RuleSectionCouldBeOptional(self, SectionType):
3292 if SectionType in ("DXE_DEPEX", "UI", "VERSION", "PEI_DEPEX", "RAW", "SMM_DEPEX"):
3293 return True
3294 else:
3295 return False
3296
3297 ## __RuleSectionCouldHaveBuildNum() method
3298 #
3299 # Get whether a section could have build number information
3300 #
3301 # @param self The object pointer
3302 # @param SectionType The section type to check
3303 # @retval True section could have build number information
3304 # @retval False section never have build number information
3305 #
3306 def __RuleSectionCouldHaveBuildNum(self, SectionType):
3307 if SectionType in ("VERSION"):
3308 return True
3309 else:
3310 return False
3311
3312 ## __RuleSectionCouldHaveString() method
3313 #
3314 # Get whether a section could have string
3315 #
3316 # @param self The object pointer
3317 # @param SectionType The section type to check
3318 # @retval True section could have string
3319 # @retval False section never have string
3320 #
3321 def __RuleSectionCouldHaveString(self, SectionType):
3322 if SectionType in ("UI", "VERSION"):
3323 return True
3324 else:
3325 return False
3326
3327 ## __CheckRuleSectionFileType() method
3328 #
3329 # Get whether a section matches a file type
3330 #
3331 # @param self The object pointer
3332 # @param SectionType The section type to check
3333 # @param FileType The file type to check
3334 #
3335 def __CheckRuleSectionFileType(self, SectionType, FileType):
3336 if SectionType == "COMPAT16":
3337 if FileType not in ("COMPAT16", "SEC_COMPAT16"):
3338 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3339 elif SectionType == "PE32":
3340 if FileType not in ("PE32", "SEC_PE32"):
3341 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3342 elif SectionType == "PIC":
3343 if FileType not in ("PIC", "PIC"):
3344 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3345 elif SectionType == "TE":
3346 if FileType not in ("TE", "SEC_TE"):
3347 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3348 elif SectionType == "RAW":
3349 if FileType not in ("BIN", "SEC_BIN", "RAW", "ASL", "ACPI"):
3350 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3351 elif SectionType == "DXE_DEPEX" or SectionType == "SMM_DEPEX":
3352 if FileType not in ("DXE_DEPEX", "SEC_DXE_DEPEX", "SMM_DEPEX"):
3353 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3354 elif SectionType == "UI":
3355 if FileType not in ("UI", "SEC_UI"):
3356 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3357 elif SectionType == "VERSION":
3358 if FileType not in ("VERSION", "SEC_VERSION"):
3359 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3360 elif SectionType == "PEI_DEPEX":
3361 if FileType not in ("PEI_DEPEX", "SEC_PEI_DEPEX"):
3362 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3363 elif SectionType == "GUID":
3364 if FileType not in ("PE32", "SEC_GUID"):
3365 raise Warning("Incorrect section file type '%s'" % FileType, self.FileName, self.CurrentLineNumber)
3366
3367 ## __GetRuleEncapsulationSection() method
3368 #
3369 # Get encapsulation section for Rule
3370 #
3371 # @param self The object pointer
3372 # @param Rule for whom section is got
3373 # @retval True Successfully find section statement
3374 # @retval False Not able to find section statement
3375 #
3376 def __GetRuleEncapsulationSection(self, Rule):
3377
3378 if self.__IsKeyword( "COMPRESS"):
3379 Type = "PI_STD"
3380 if self.__IsKeyword("PI_STD") or self.__IsKeyword("PI_NONE"):
3381 Type = self.__Token
3382
3383 if not self.__IsToken("{"):
3384 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
3385
3386 CompressSectionObj = CompressSection.CompressSection()
3387
3388 CompressSectionObj.CompType = Type
3389 # Recursive sections...
3390 while True:
3391 IsEncapsulate = self.__GetRuleEncapsulationSection(CompressSectionObj)
3392 IsLeaf = self.__GetEfiSection(CompressSectionObj)
3393 if not IsEncapsulate and not IsLeaf:
3394 break
3395
3396 if not self.__IsToken( "}"):
3397 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
3398 Rule.SectionList.append(CompressSectionObj)
3399
3400 return True
3401
3402 elif self.__IsKeyword( "GUIDED"):
3403 GuidValue = None
3404 if self.__GetNextGuid():
3405 GuidValue = self.__Token
3406
3407 if self.__IsKeyword( "$(NAMED_GUID)"):
3408 GuidValue = self.__Token
3409
3410 AttribDict = self.__GetGuidAttrib()
3411
3412 if not self.__IsToken("{"):
3413 raise Warning("expected '{'", self.FileName, self.CurrentLineNumber)
3414 GuidSectionObj = GuidSection.GuidSection()
3415 GuidSectionObj.NameGuid = GuidValue
3416 GuidSectionObj.SectionType = "GUIDED"
3417 GuidSectionObj.ProcessRequired = AttribDict["PROCESSING_REQUIRED"]
3418 GuidSectionObj.AuthStatusValid = AttribDict["AUTH_STATUS_VALID"]
3419
3420 # Efi sections...
3421 while True:
3422 IsEncapsulate = self.__GetRuleEncapsulationSection(GuidSectionObj)
3423 IsLeaf = self.__GetEfiSection(GuidSectionObj)
3424 if not IsEncapsulate and not IsLeaf:
3425 break
3426
3427 if not self.__IsToken( "}"):
3428 raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)
3429 Rule.SectionList.append(GuidSectionObj)
3430
3431 return True
3432
3433 return False
3434
3435 ## __GetVtf() method
3436 #
3437 # Get VTF section contents and store its data into VTF list of self.Profile
3438 #
3439 # @param self The object pointer
3440 # @retval True Successfully find a VTF
3441 # @retval False Not able to find a VTF
3442 #
3443 def __GetVtf(self):
3444
3445 if not self.__GetNextToken():
3446 return False
3447
3448 S = self.__Token.upper()
3449 if S.startswith("[") and not S.startswith("[VTF."):
3450 if not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):
3451 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
3452 self.__UndoToken()
3453 return False
3454
3455 self.__UndoToken()
3456 if not self.__IsToken("[VTF.", True):
3457 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)
3458 #print 'Parsing String: %s in File %s, At line: %d, Offset Within Line: %d' \
3459 # % (self.Profile.FileLinesList[self.CurrentLineNumber - 1][self.CurrentOffsetWithinLine :], FileLineTuple[0], FileLineTuple[1], self.CurrentOffsetWithinLine)
3460 raise Warning("expected [VTF.]", self.FileName, self.CurrentLineNumber)
3461
3462 if not self.__SkipToToken("."):
3463 raise Warning("expected '.'", self.FileName, self.CurrentLineNumber)
3464
3465 Arch = self.__SkippedChars.rstrip(".").upper()
3466 if Arch not in ("IA32", "X64", "IPF", "ARM"):
3467 raise Warning("Unknown Arch '%s'" % Arch, self.FileName, self.CurrentLineNumber)
3468
3469 if not self.__GetNextWord():
3470 raise Warning("expected VTF name", self.FileName, self.CurrentLineNumber)
3471 Name = self.__Token.upper()
3472
3473 VtfObj = Vtf.Vtf()
3474 VtfObj.UiName = Name
3475 VtfObj.KeyArch = Arch
3476
3477 if self.__IsToken(","):
3478 if not self.__GetNextWord():
3479 raise Warning("expected Arch list", self.FileName, self.CurrentLineNumber)
3480 if self.__Token.upper() not in ("IA32", "X64", "IPF", "ARM"):
3481 raise Warning("Unknown Arch '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3482 VtfObj.ArchList = self.__Token.upper()
3483
3484 if not self.__IsToken( "]"):
3485 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
3486
3487 if self.__IsKeyword("IA32_RST_BIN"):
3488 if not self.__IsToken("="):
3489 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3490
3491 if not self.__GetNextToken():
3492 raise Warning("expected Reset file", self.FileName, self.CurrentLineNumber)
3493
3494 VtfObj.ResetBin = self.__Token
3495
3496 while self.__GetComponentStatement(VtfObj):
3497 pass
3498
3499 self.Profile.VtfList.append(VtfObj)
3500 return True
3501
3502 ## __GetComponentStatement() method
3503 #
3504 # Get components in VTF
3505 #
3506 # @param self The object pointer
3507 # @param VtfObj for whom component is got
3508 # @retval True Successfully find a component
3509 # @retval False Not able to find a component
3510 #
3511 def __GetComponentStatement(self, VtfObj):
3512
3513 if not self.__IsKeyword("COMP_NAME"):
3514 return False
3515
3516 if not self.__IsToken("="):
3517 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3518
3519 if not self.__GetNextWord():
3520 raise Warning("expected Component Name", self.FileName, self.CurrentLineNumber)
3521
3522 CompStatementObj = ComponentStatement.ComponentStatement()
3523 CompStatementObj.CompName = self.__Token
3524
3525 if not self.__IsKeyword("COMP_LOC"):
3526 raise Warning("expected COMP_LOC", self.FileName, self.CurrentLineNumber)
3527
3528 if not self.__IsToken("="):
3529 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3530
3531 CompStatementObj.CompLoc = ""
3532 if self.__GetNextWord():
3533 CompStatementObj.CompLoc = self.__Token
3534 if self.__IsToken('|'):
3535 if not self.__GetNextWord():
3536 raise Warning("Expected Region Name", self.FileName, self.CurrentLineNumber)
3537
3538 if self.__Token not in ("F", "N", "S"): #, "H", "L", "PH", "PL"): not support
3539 raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3540
3541 CompStatementObj.FilePos = self.__Token
3542 else:
3543 self.CurrentLineNumber += 1
3544 self.CurrentOffsetWithinLine = 0
3545
3546 if not self.__IsKeyword("COMP_TYPE"):
3547 raise Warning("expected COMP_TYPE", self.FileName, self.CurrentLineNumber)
3548
3549 if not self.__IsToken("="):
3550 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3551
3552 if not self.__GetNextToken():
3553 raise Warning("expected Component type", self.FileName, self.CurrentLineNumber)
3554 if self.__Token not in ("FIT", "PAL_B", "PAL_A", "OEM"):
3555 if not self.__Token.startswith("0x") or len(self.__Token) < 3 or len(self.__Token) > 4 or \
3556 not self.__HexDigit(self.__Token[2]) or not self.__HexDigit(self.__Token[-1]):
3557 raise Warning("Unknown location type '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3558 CompStatementObj.CompType = self.__Token
3559
3560 if not self.__IsKeyword("COMP_VER"):
3561 raise Warning("expected COMP_VER", self.FileName, self.CurrentLineNumber)
3562
3563 if not self.__IsToken("="):
3564 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3565
3566 if not self.__GetNextToken():
3567 raise Warning("expected Component version", self.FileName, self.CurrentLineNumber)
3568
3569 Pattern = re.compile('-$|[0-9]{0,1}[0-9]{1}\.[0-9]{0,1}[0-9]{1}')
3570 if Pattern.match(self.__Token) == None:
3571 raise Warning("Unknown version format '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3572 CompStatementObj.CompVer = self.__Token
3573
3574 if not self.__IsKeyword("COMP_CS"):
3575 raise Warning("expected COMP_CS", self.FileName, self.CurrentLineNumber)
3576
3577 if not self.__IsToken("="):
3578 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3579
3580 if not self.__GetNextToken():
3581 raise Warning("expected Component CS", self.FileName, self.CurrentLineNumber)
3582 if self.__Token not in ("1", "0"):
3583 raise Warning("Unknown Component CS '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3584 CompStatementObj.CompCs = self.__Token
3585
3586
3587 if not self.__IsKeyword("COMP_BIN"):
3588 raise Warning("expected COMP_BIN", self.FileName, self.CurrentLineNumber)
3589
3590 if not self.__IsToken("="):
3591 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3592
3593 if not self.__GetNextToken():
3594 raise Warning("expected Component file", self.FileName, self.CurrentLineNumber)
3595
3596 CompStatementObj.CompBin = self.__Token
3597
3598 if not self.__IsKeyword("COMP_SYM"):
3599 raise Warning("expected COMP_SYM", self.FileName, self.CurrentLineNumber)
3600
3601 if not self.__IsToken("="):
3602 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3603
3604 if not self.__GetNextToken():
3605 raise Warning("expected Component symbol file", self.FileName, self.CurrentLineNumber)
3606
3607 CompStatementObj.CompSym = self.__Token
3608
3609 if not self.__IsKeyword("COMP_SIZE"):
3610 raise Warning("expected COMP_SIZE", self.FileName, self.CurrentLineNumber)
3611
3612 if not self.__IsToken("="):
3613 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3614
3615 if self.__IsToken("-"):
3616 CompStatementObj.CompSize = self.__Token
3617 elif self.__GetNextDecimalNumber():
3618 CompStatementObj.CompSize = self.__Token
3619 elif self.__GetNextHexNumber():
3620 CompStatementObj.CompSize = self.__Token
3621 else:
3622 raise Warning("Unknown size '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3623
3624 VtfObj.ComponentStatementList.append(CompStatementObj)
3625 return True
3626
3627 ## __GetOptionRom() method
3628 #
3629 # Get OptionROM section contents and store its data into OptionROM list of self.Profile
3630 #
3631 # @param self The object pointer
3632 # @retval True Successfully find a OptionROM
3633 # @retval False Not able to find a OptionROM
3634 #
3635 def __GetOptionRom(self):
3636
3637 if not self.__GetNextToken():
3638 return False
3639
3640 S = self.__Token.upper()
3641 if S.startswith("[") and not S.startswith("[OPTIONROM."):
3642 raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)
3643
3644 self.__UndoToken()
3645 if not self.__IsToken("[OptionRom.", True):
3646 raise Warning("Unknown Keyword '%s'" % self.__Token, self.FileName, self.CurrentLineNumber)
3647
3648 OptRomName = self.__GetUiName()
3649
3650 if not self.__IsToken( "]"):
3651 raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)
3652
3653 OptRomObj = OptionRom.OPTIONROM()
3654 OptRomObj.DriverName = OptRomName
3655 self.Profile.OptRomDict[OptRomName] = OptRomObj
3656
3657 while True:
3658 isInf = self.__GetOptRomInfStatement(OptRomObj)
3659 isFile = self.__GetOptRomFileStatement(OptRomObj)
3660 if not isInf and not isFile:
3661 break
3662
3663 return True
3664
3665 ## __GetOptRomInfStatement() method
3666 #
3667 # Get INF statements
3668 #
3669 # @param self The object pointer
3670 # @param Obj for whom inf statement is got
3671 # @retval True Successfully find inf statement
3672 # @retval False Not able to find inf statement
3673 #
3674 def __GetOptRomInfStatement(self, Obj):
3675
3676 if not self.__IsKeyword( "INF"):
3677 return False
3678
3679 ffsInf = OptRomInfStatement.OptRomInfStatement()
3680 self.__GetInfOptions( ffsInf)
3681
3682 if not self.__GetNextToken():
3683 raise Warning("expected INF file path", self.FileName, self.CurrentLineNumber)
3684 ffsInf.InfFileName = self.__Token
3685
3686 if not ffsInf.InfFileName in self.Profile.InfList:
3687 self.Profile.InfList.append(ffsInf.InfFileName)
3688
3689
3690 self.__GetOptRomOverrides (ffsInf)
3691
3692 Obj.FfsList.append(ffsInf)
3693 return True
3694
3695 ## __GetOptRomOverrides() method
3696 #
3697 # Get overrides for OptROM INF & FILE
3698 #
3699 # @param self The object pointer
3700 # @param FfsInfObj for whom overrides is got
3701 #
3702 def __GetOptRomOverrides(self, Obj):
3703 if self.__IsToken('{'):
3704 Overrides = OptionRom.OverrideAttribs()
3705 while True:
3706 if self.__IsKeyword( "PCI_VENDOR_ID"):
3707 if not self.__IsToken( "="):
3708 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3709 if not self.__GetNextHexNumber():
3710 raise Warning("expected Hex vendor id", self.FileName, self.CurrentLineNumber)
3711 Overrides.PciVendorId = self.__Token
3712 continue
3713
3714 if self.__IsKeyword( "PCI_CLASS_CODE"):
3715 if not self.__IsToken( "="):
3716 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3717 if not self.__GetNextHexNumber():
3718 raise Warning("expected Hex class code", self.FileName, self.CurrentLineNumber)
3719 Overrides.PciClassCode = self.__Token
3720 continue
3721
3722 if self.__IsKeyword( "PCI_DEVICE_ID"):
3723 if not self.__IsToken( "="):
3724 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3725 if not self.__GetNextHexNumber():
3726 raise Warning("expected Hex device id", self.FileName, self.CurrentLineNumber)
3727
3728 Overrides.PciDeviceId = self.__Token
3729 continue
3730
3731 if self.__IsKeyword( "PCI_REVISION"):
3732 if not self.__IsToken( "="):
3733 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3734 if not self.__GetNextHexNumber():
3735 raise Warning("expected Hex revision", self.FileName, self.CurrentLineNumber)
3736 Overrides.PciRevision = self.__Token
3737 continue
3738
3739 if self.__IsKeyword( "COMPRESS"):
3740 if not self.__IsToken( "="):
3741 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
3742 if not self.__GetNextToken():
3743 raise Warning("expected TRUE/FALSE for compress", self.FileName, self.CurrentLineNumber)
3744 Overrides.NeedCompress = self.__Token.upper() == 'TRUE'
3745 continue
3746
3747 if self.__IsToken( "}"):
3748 break
3749 else:
3750 EdkLogger.error("FdfParser", FORMAT_INVALID, File=self.FileName, Line=self.CurrentLineNumber)
3751
3752 Obj.OverrideAttribs = Overrides
3753
3754 ## __GetOptRomFileStatement() method
3755 #
3756 # Get FILE statements
3757 #
3758 # @param self The object pointer
3759 # @param Obj for whom FILE statement is got
3760 # @retval True Successfully find FILE statement
3761 # @retval False Not able to find FILE statement
3762 #
3763 def __GetOptRomFileStatement(self, Obj):
3764
3765 if not self.__IsKeyword( "FILE"):
3766 return False
3767
3768 FfsFileObj = OptRomFileStatement.OptRomFileStatement()
3769
3770 if not self.__IsKeyword("EFI") and not self.__IsKeyword("BIN"):
3771 raise Warning("expected Binary type (EFI/BIN)", self.FileName, self.CurrentLineNumber)
3772 FfsFileObj.FileType = self.__Token
3773
3774 if not self.__GetNextToken():
3775 raise Warning("expected File path", self.FileName, self.CurrentLineNumber)
3776 FfsFileObj.FileName = self.__Token
3777
3778 if FfsFileObj.FileType == 'EFI':
3779 self.__GetOptRomOverrides(FfsFileObj)
3780
3781 Obj.FfsList.append(FfsFileObj)
3782
3783 return True
3784
3785 ## __GetCapInFd() method
3786 #
3787 # Get Cap list contained in FD
3788 #
3789 # @param self The object pointer
3790 # @param FdName FD name
3791 # @retval CapList List of Capsule in FD
3792 #
3793 def __GetCapInFd (self, FdName):
3794
3795 CapList = []
3796 if FdName.upper() in self.Profile.FdDict.keys():
3797 FdObj = self.Profile.FdDict[FdName.upper()]
3798 for elementRegion in FdObj.RegionList:
3799 if elementRegion.RegionType == 'CAPSULE':
3800 for elementRegionData in elementRegion.RegionDataList:
3801 if elementRegionData.endswith(".cap"):
3802 continue
3803 if elementRegionData != None and elementRegionData.upper() not in CapList:
3804 CapList.append(elementRegionData.upper())
3805 return CapList
3806
3807 ## __GetReferencedFdCapTuple() method
3808 #
3809 # Get FV and FD list referenced by a capsule image
3810 #
3811 # @param self The object pointer
3812 # @param CapObj Capsule section to be searched
3813 # @param RefFdList referenced FD by section
3814 # @param RefFvList referenced FV by section
3815 #
3816 def __GetReferencedFdCapTuple(self, CapObj, RefFdList = [], RefFvList = []):
3817
3818 for CapsuleDataObj in CapObj.CapsuleDataList :
3819 if CapsuleDataObj.FvName != None and CapsuleDataObj.FvName.upper() not in RefFvList:
3820 RefFvList.append (CapsuleDataObj.FvName.upper())
3821 elif CapsuleDataObj.Ffs != None:
3822 if isinstance(CapsuleDataObj.Ffs, FfsFileStatement.FileStatement):
3823 if CapsuleDataObj.Ffs.FvName != None and CapsuleDataObj.Ffs.FvName.upper() not in RefFvList:
3824 RefFvList.append(CapsuleDataObj.Ffs.FvName.upper())
3825 elif CapsuleDataObj.Ffs.FdName != None and CapsuleDataObj.Ffs.FdName.upper() not in RefFdList:
3826 RefFdList.append(CapsuleDataObj.Ffs.FdName.upper())
3827 else:
3828 self.__GetReferencedFdFvTupleFromSection(CapsuleDataObj.Ffs, RefFdList, RefFvList)
3829
3830 ## __GetFvInFd() method
3831 #
3832 # Get FV list contained in FD
3833 #
3834 # @param self The object pointer
3835 # @param FdName FD name
3836 # @retval FvList list of FV in FD
3837 #
3838 def __GetFvInFd (self, FdName):
3839
3840 FvList = []
3841 if FdName.upper() in self.Profile.FdDict.keys():
3842 FdObj = self.Profile.FdDict[FdName.upper()]
3843 for elementRegion in FdObj.RegionList:
3844 if elementRegion.RegionType == 'FV':
3845 for elementRegionData in elementRegion.RegionDataList:
3846 if elementRegionData.endswith(".fv"):
3847 continue
3848 if elementRegionData != None and elementRegionData.upper() not in FvList:
3849 FvList.append(elementRegionData.upper())
3850 return FvList
3851
3852 ## __GetReferencedFdFvTuple() method
3853 #
3854 # Get FD and FV list referenced by a FFS file
3855 #
3856 # @param self The object pointer
3857 # @param FfsFile contains sections to be searched
3858 # @param RefFdList referenced FD by section
3859 # @param RefFvList referenced FV by section
3860 #
3861 def __GetReferencedFdFvTuple(self, FvObj, RefFdList = [], RefFvList = []):
3862
3863 for FfsObj in FvObj.FfsList:
3864 if isinstance(FfsObj, FfsFileStatement.FileStatement):
3865 if FfsObj.FvName != None and FfsObj.FvName.upper() not in RefFvList:
3866 RefFvList.append(FfsObj.FvName.upper())
3867 elif FfsObj.FdName != None and FfsObj.FdName.upper() not in RefFdList:
3868 RefFdList.append(FfsObj.FdName.upper())
3869 else:
3870 self.__GetReferencedFdFvTupleFromSection(FfsObj, RefFdList, RefFvList)
3871
3872 ## __GetReferencedFdFvTupleFromSection() method
3873 #
3874 # Get FD and FV list referenced by a FFS section
3875 #
3876 # @param self The object pointer
3877 # @param FfsFile contains sections to be searched
3878 # @param FdList referenced FD by section
3879 # @param FvList referenced FV by section
3880 #
3881 def __GetReferencedFdFvTupleFromSection(self, FfsFile, FdList = [], FvList = []):
3882
3883 SectionStack = []
3884 SectionStack.extend(FfsFile.SectionList)
3885 while SectionStack != []:
3886 SectionObj = SectionStack.pop()
3887 if isinstance(SectionObj, FvImageSection.FvImageSection):
3888 if SectionObj.FvName != None and SectionObj.FvName.upper() not in FvList:
3889 FvList.append(SectionObj.FvName.upper())
3890 if SectionObj.Fv != None and SectionObj.Fv.UiFvName != None and SectionObj.Fv.UiFvName.upper() not in FvList:
3891 FvList.append(SectionObj.Fv.UiFvName.upper())
3892 self.__GetReferencedFdFvTuple(SectionObj.Fv, FdList, FvList)
3893
3894 if isinstance(SectionObj, CompressSection.CompressSection) or isinstance(SectionObj, GuidSection.GuidSection):
3895 SectionStack.extend(SectionObj.SectionList)
3896
3897 ## CycleReferenceCheck() method
3898 #
3899 # Check whether cycle reference exists in FDF
3900 #
3901 # @param self The object pointer
3902 # @retval True cycle reference exists
3903 # @retval False Not exists cycle reference
3904 #
3905 def CycleReferenceCheck(self):
3906 #
3907 # Check the cycle between FV and FD image
3908 #
3909 MaxLength = len (self.Profile.FvDict)
3910 for FvName in self.Profile.FvDict.keys():
3911 LogStr = "\nCycle Reference Checking for FV: %s\n" % FvName
3912 RefFvStack = []
3913 RefFvStack.append(FvName)
3914 FdAnalyzedList = []
3915
3916 Index = 0
3917 while RefFvStack != [] and Index < MaxLength:
3918 Index = Index + 1
3919 FvNameFromStack = RefFvStack.pop()
3920 if FvNameFromStack.upper() in self.Profile.FvDict.keys():
3921 FvObj = self.Profile.FvDict[FvNameFromStack.upper()]
3922 else:
3923 continue
3924
3925 RefFdList = []
3926 RefFvList = []
3927 self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)
3928
3929 for RefFdName in RefFdList:
3930 if RefFdName in FdAnalyzedList:
3931 continue
3932
3933 LogStr += "FV %s contains FD %s\n" % (FvNameFromStack, RefFdName)
3934 FvInFdList = self.__GetFvInFd(RefFdName)
3935 if FvInFdList != []:
3936 for FvNameInFd in FvInFdList:
3937 LogStr += "FD %s contains FV %s\n" % (RefFdName,FvNameInFd)
3938 if FvNameInFd not in RefFvStack:
3939 RefFvStack.append(FvNameInFd)
3940
3941 if FvName in RefFvStack or FvNameFromStack in RefFvStack:
3942 EdkLogger.info(LogStr)
3943 return True
3944 FdAnalyzedList.append(RefFdName)
3945
3946 for RefFvName in RefFvList:
3947 LogStr += "FV %s contains FV %s\n" % (FvNameFromStack, RefFvName)
3948 if RefFvName not in RefFvStack:
3949 RefFvStack.append(RefFvName)
3950
3951 if FvName in RefFvStack or FvNameFromStack in RefFvStack:
3952 EdkLogger.info(LogStr)
3953 return True
3954
3955 #
3956 # Check the cycle between Capsule and FD image
3957 #
3958 MaxLength = len (self.Profile.CapsuleDict)
3959 for CapName in self.Profile.CapsuleDict.keys():
3960 #
3961 # Capsule image to be checked.
3962 #
3963 LogStr = "\n\n\nCycle Reference Checking for Capsule: %s\n" % CapName
3964 RefCapStack = []
3965 RefCapStack.append(CapName)
3966 FdAnalyzedList = []
3967 FvAnalyzedList = []
3968
3969 Index = 0
3970 while RefCapStack != [] and Index < MaxLength:
3971 Index = Index + 1
3972 CapNameFromStack = RefCapStack.pop()
3973 if CapNameFromStack.upper() in self.Profile.CapsuleDict.keys():
3974 CapObj = self.Profile.CapsuleDict[CapNameFromStack.upper()]
3975 else:
3976 continue
3977
3978 RefFvList = []
3979 RefFdList = []
3980 self.__GetReferencedFdCapTuple(CapObj, RefFdList, RefFvList)
3981
3982 FvListLength = 0
3983 FdListLength = 0
3984 while FvListLength < len (RefFvList) or FdListLength < len (RefFdList):
3985 for RefFdName in RefFdList:
3986 if RefFdName in FdAnalyzedList:
3987 continue
3988
3989 LogStr += "Capsule %s contains FD %s\n" % (CapNameFromStack, RefFdName)
3990 CapInFdList = self.__GetCapInFd(RefFdName)
3991 if CapInFdList != []:
3992 for CapNameInFd in CapInFdList:
3993 LogStr += "FD %s contains Capsule %s\n" % (RefFdName,CapNameInFd)
3994 if CapNameInFd not in RefCapStack:
3995 RefCapStack.append(CapNameInFd)
3996
3997 if CapName in RefCapStack or CapNameFromStack in RefCapStack:
3998 EdkLogger.info(LogStr)
3999 return True
4000
4001 FvInFdList = self.__GetFvInFd(RefFdName)
4002 if FvInFdList != []:
4003 for FvNameInFd in FvInFdList:
4004 LogStr += "FD %s contains FV %s\n" % (RefFdName,FvNameInFd)
4005 if FvNameInFd not in RefFvList:
4006 RefFvList.append(FvNameInFd)
4007
4008 FdAnalyzedList.append(RefFdName)
4009 #
4010 # the number of the parsed FV and FD image
4011 #
4012 FvListLength = len (RefFvList)
4013 FdListLength = len (RefFdList)
4014 for RefFvName in RefFvList:
4015 if RefFvName in FvAnalyzedList:
4016 continue
4017 LogStr += "Capsule %s contains FV %s\n" % (CapNameFromStack, RefFvName)
4018 if RefFvName.upper() in self.Profile.FvDict.keys():
4019 FvObj = self.Profile.FvDict[RefFvName.upper()]
4020 else:
4021 continue
4022 self.__GetReferencedFdFvTuple(FvObj, RefFdList, RefFvList)
4023 FvAnalyzedList.append(RefFvName)
4024
4025 return False
4026
4027 if __name__ == "__main__":
4028 parser = FdfParser("..\LakeportX64Pkg.fdf")
4029 try:
4030 parser.ParseFile()
4031 parser.CycleReferenceCheck()
4032 except Warning, X:
4033 print str(X)
4034 else:
4035 print "Success!"
4036
EFI Development Kit II mirror for PVE