BaseTools: dont use enumerate when un-needed
[mirror_edk2.git] / BaseTools / Source / Python / Common / Misc.py
1 ## @file
2 # Common routines used by all tools
3 #
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 ##
15 # Import Modules
16 #
17 import Common.LongFilePathOs as os
18 import sys
19 import string
20 import thread
21 import threading
22 import time
23 import re
24 import cPickle
25 import array
26 import shutil
27 from struct import pack
28 from UserDict import IterableUserDict
29 from UserList import UserList
30
31 from Common import EdkLogger as EdkLogger
32 from Common import GlobalData as GlobalData
33 from DataType import *
34 from BuildToolError import *
35 from CommonDataClass.DataClass import *
36 from Parsing import GetSplitValueList
37 from Common.LongFilePathSupport import OpenLongFilePath as open
38 from Common.MultipleWorkspace import MultipleWorkspace as mws
39 import uuid
40 from CommonDataClass.Exceptions import BadExpression
41 import subprocess
42 ## Regular expression used to find out place holders in string template
43 gPlaceholderPattern = re.compile("\$\{([^$()\s]+)\}", re.MULTILINE | re.UNICODE)
44
45 ## Dictionary used to store file time stamp for quick re-access
46 gFileTimeStampCache = {} # {file path : file time stamp}
47
48 ## Dictionary used to store dependencies of files
49 gDependencyDatabase = {} # arch : {file path : [dependent files list]}
50
51 def GetVariableOffset(mapfilepath, efifilepath, varnames):
52 """ Parse map file to get variable offset in current EFI file
53 @param mapfilepath Map file absolution path
54 @param efifilepath: EFI binary file full path
55 @param varnames iteratable container whose elements are variable names to be searched
56
57 @return List whos elements are tuple with variable name and raw offset
58 """
59 lines = []
60 try:
61 f = open(mapfilepath, 'r')
62 lines = f.readlines()
63 f.close()
64 except:
65 return None
66
67 if len(lines) == 0: return None
68 firstline = lines[0].strip()
69 if (firstline.startswith("Archive member included ") and
70 firstline.endswith(" file (symbol)")):
71 return _parseForGCC(lines, efifilepath, varnames)
72 if firstline.startswith("# Path:"):
73 return _parseForXcode(lines, efifilepath, varnames)
74 return _parseGeneral(lines, efifilepath, varnames)
75
76 def _parseForXcode(lines, efifilepath, varnames):
77 status = 0
78 ret = []
79 for line in lines:
80 line = line.strip()
81 if status == 0 and line == "# Symbols:":
82 status = 1
83 continue
84 if status == 1 and len(line) != 0:
85 for varname in varnames:
86 if varname in line:
87 m = re.match('^([\da-fA-FxX]+)([\s\S]*)([_]*%s)$' % varname, line)
88 if m != None:
89 ret.append((varname, m.group(1)))
90 return ret
91
92 def _parseForGCC(lines, efifilepath, varnames):
93 """ Parse map file generated by GCC linker """
94 status = 0
95 sections = []
96 varoffset = []
97 for index, line in enumerate(lines):
98 line = line.strip()
99 # status machine transection
100 if status == 0 and line == "Memory Configuration":
101 status = 1
102 continue
103 elif status == 1 and line == 'Linker script and memory map':
104 status = 2
105 continue
106 elif status ==2 and line == 'START GROUP':
107 status = 3
108 continue
109
110 # status handler
111 if status == 3:
112 m = re.match('^([\w_\.]+) +([\da-fA-Fx]+) +([\da-fA-Fx]+)$', line)
113 if m != None:
114 sections.append(m.groups(0))
115 for varname in varnames:
116 Str = ''
117 m = re.match("^.data.(%s)" % varname, line)
118 if m != None:
119 m = re.match(".data.(%s)$" % varname, line)
120 if m != None:
121 Str = lines[index + 1]
122 else:
123 Str = line[len(".data.%s" % varname):]
124 if Str:
125 m = re.match('^([\da-fA-Fx]+) +([\da-fA-Fx]+)', Str.strip())
126 if m != None:
127 varoffset.append((varname, int(m.groups(0)[0], 16) , int(sections[-1][1], 16), sections[-1][0]))
128
129 if not varoffset:
130 return []
131 # get section information from efi file
132 efisecs = PeImageClass(efifilepath).SectionHeaderList
133 if efisecs == None or len(efisecs) == 0:
134 return []
135 #redirection
136 redirection = 0
137 for efisec in efisecs:
138 for section in sections:
139 if section[0].strip() == efisec[0].strip() and section[0].strip() == '.text':
140 redirection = int(section[1], 16) - efisec[1]
141
142 ret = []
143 for var in varoffset:
144 for efisec in efisecs:
145 if var[1] >= efisec[1] and var[1] < efisec[1]+efisec[3]:
146 ret.append((var[0], hex(efisec[2] + var[1] - efisec[1] - redirection)))
147 return ret
148
149 def _parseGeneral(lines, efifilepath, varnames):
150 status = 0 #0 - beginning of file; 1 - PE section definition; 2 - symbol table
151 secs = [] # key = section name
152 varoffset = []
153 secRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\da-fA-F]+)[Hh]? +([.\w\$]+) +(\w+)', re.UNICODE)
154 symRe = re.compile('^([\da-fA-F]+):([\da-fA-F]+) +([\.:\\\\\w\?@\$]+) +([\da-fA-F]+)', re.UNICODE)
155
156 for line in lines:
157 line = line.strip()
158 if re.match("^Start[' ']+Length[' ']+Name[' ']+Class", line):
159 status = 1
160 continue
161 if re.match("^Address[' ']+Publics by Value[' ']+Rva\+Base", line):
162 status = 2
163 continue
164 if re.match("^entry point at", line):
165 status = 3
166 continue
167 if status == 1 and len(line) != 0:
168 m = secRe.match(line)
169 assert m != None, "Fail to parse the section in map file , line is %s" % line
170 sec_no, sec_start, sec_length, sec_name, sec_class = m.groups(0)
171 secs.append([int(sec_no, 16), int(sec_start, 16), int(sec_length, 16), sec_name, sec_class])
172 if status == 2 and len(line) != 0:
173 for varname in varnames:
174 m = symRe.match(line)
175 assert m != None, "Fail to parse the symbol in map file, line is %s" % line
176 sec_no, sym_offset, sym_name, vir_addr = m.groups(0)
177 sec_no = int(sec_no, 16)
178 sym_offset = int(sym_offset, 16)
179 vir_addr = int(vir_addr, 16)
180 m2 = re.match('^[_]*(%s)' % varname, sym_name)
181 if m2 != None:
182 # fond a binary pcd entry in map file
183 for sec in secs:
184 if sec[0] == sec_no and (sym_offset >= sec[1] and sym_offset < sec[1] + sec[2]):
185 varoffset.append([varname, sec[3], sym_offset, vir_addr, sec_no])
186
187 if not varoffset: return []
188
189 # get section information from efi file
190 efisecs = PeImageClass(efifilepath).SectionHeaderList
191 if efisecs == None or len(efisecs) == 0:
192 return []
193
194 ret = []
195 for var in varoffset:
196 index = 0
197 for efisec in efisecs:
198 index = index + 1
199 if var[1].strip() == efisec[0].strip():
200 ret.append((var[0], hex(efisec[2] + var[2])))
201 elif var[4] == index:
202 ret.append((var[0], hex(efisec[2] + var[2])))
203
204 return ret
205
206 ## Routine to process duplicated INF
207 #
208 # This function is called by following two cases:
209 # Case 1 in DSC:
210 # [components.arch]
211 # Pkg/module/module.inf
212 # Pkg/module/module.inf {
213 # <Defines>
214 # FILE_GUID = 0D1B936F-68F3-4589-AFCC-FB8B7AEBC836
215 # }
216 # Case 2 in FDF:
217 # INF Pkg/module/module.inf
218 # INF FILE_GUID = 0D1B936F-68F3-4589-AFCC-FB8B7AEBC836 Pkg/module/module.inf
219 #
220 # This function copies Pkg/module/module.inf to
221 # Conf/.cache/0D1B936F-68F3-4589-AFCC-FB8B7AEBC836module.inf
222 #
223 # @param Path Original PathClass object
224 # @param BaseName New file base name
225 #
226 # @retval return the new PathClass object
227 #
228 def ProcessDuplicatedInf(Path, BaseName, Workspace):
229 Filename = os.path.split(Path.File)[1]
230 if '.' in Filename:
231 Filename = BaseName + Path.BaseName + Filename[Filename.rfind('.'):]
232 else:
233 Filename = BaseName + Path.BaseName
234
235 #
236 # If -N is specified on command line, cache is disabled
237 # The directory has to be created
238 #
239 DbDir = os.path.split(GlobalData.gDatabasePath)[0]
240 if not os.path.exists(DbDir):
241 os.makedirs(DbDir)
242 #
243 # A temporary INF is copied to database path which must have write permission
244 # The temporary will be removed at the end of build
245 # In case of name conflict, the file name is
246 # FILE_GUIDBaseName (0D1B936F-68F3-4589-AFCC-FB8B7AEBC836module.inf)
247 #
248 TempFullPath = os.path.join(DbDir,
249 Filename)
250 RtPath = PathClass(Path.File, Workspace)
251 #
252 # Modify the full path to temporary path, keep other unchanged
253 #
254 # To build same module more than once, the module path with FILE_GUID overridden has
255 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the real path
256 # in DSC which is used as relative path by C files and other files in INF.
257 # A trick was used: all module paths are PathClass instances, after the initialization
258 # of PathClass, the PathClass.Path is overridden by the temporary INF path.
259 #
260 # The reason for creating a temporary INF is:
261 # Platform.Modules which is the base to create ModuleAutoGen objects is a dictionary,
262 # the key is the full path of INF, the value is an object to save overridden library instances, PCDs.
263 # A different key for the same module is needed to create different output directory,
264 # retrieve overridden PCDs, library instances.
265 #
266 # The BaseName is the FILE_GUID which is also the output directory name.
267 #
268 #
269 RtPath.Path = TempFullPath
270 RtPath.BaseName = BaseName
271 #
272 # If file exists, compare contents
273 #
274 if os.path.exists(TempFullPath):
275 with open(str(Path), 'rb') as f1: Src = f1.read()
276 with open(TempFullPath, 'rb') as f2: Dst = f2.read()
277 if Src == Dst:
278 return RtPath
279 GlobalData.gTempInfs.append(TempFullPath)
280 shutil.copy2(str(Path), TempFullPath)
281 return RtPath
282
283 ## Remove temporary created INFs whose paths were saved in gTempInfs
284 #
285 def ClearDuplicatedInf():
286 for File in GlobalData.gTempInfs:
287 if os.path.exists(File):
288 os.remove(File)
289
290 ## callback routine for processing variable option
291 #
292 # This function can be used to process variable number of option values. The
293 # typical usage of it is specify architecure list on command line.
294 # (e.g. <tool> -a IA32 X64 IPF)
295 #
296 # @param Option Standard callback function parameter
297 # @param OptionString Standard callback function parameter
298 # @param Value Standard callback function parameter
299 # @param Parser Standard callback function parameter
300 #
301 # @retval
302 #
303 def ProcessVariableArgument(Option, OptionString, Value, Parser):
304 assert Value is None
305 Value = []
306 RawArgs = Parser.rargs
307 while RawArgs:
308 Arg = RawArgs[0]
309 if (Arg[:2] == "--" and len(Arg) > 2) or \
310 (Arg[:1] == "-" and len(Arg) > 1 and Arg[1] != "-"):
311 break
312 Value.append(Arg)
313 del RawArgs[0]
314 setattr(Parser.values, Option.dest, Value)
315
316 ## Convert GUID string in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx style to C structure style
317 #
318 # @param Guid The GUID string
319 #
320 # @retval string The GUID string in C structure style
321 #
322 def GuidStringToGuidStructureString(Guid):
323 GuidList = Guid.split('-')
324 Result = '{'
325 for Index in range(0, 3, 1):
326 Result = Result + '0x' + GuidList[Index] + ', '
327 Result = Result + '{0x' + GuidList[3][0:2] + ', 0x' + GuidList[3][2:4]
328 for Index in range(0, 12, 2):
329 Result = Result + ', 0x' + GuidList[4][Index:Index + 2]
330 Result += '}}'
331 return Result
332
333 ## Convert GUID structure in byte array to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
334 #
335 # @param GuidValue The GUID value in byte array
336 #
337 # @retval string The GUID value in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format
338 #
339 def GuidStructureByteArrayToGuidString(GuidValue):
340 guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "").replace(";", "")
341 guidValueList = guidValueString.split(",")
342 if len(guidValueList) != 16:
343 return ''
344 #EdkLogger.error(None, None, "Invalid GUID value string %s" % GuidValue)
345 try:
346 return "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x" % (
347 int(guidValueList[3], 16),
348 int(guidValueList[2], 16),
349 int(guidValueList[1], 16),
350 int(guidValueList[0], 16),
351 int(guidValueList[5], 16),
352 int(guidValueList[4], 16),
353 int(guidValueList[7], 16),
354 int(guidValueList[6], 16),
355 int(guidValueList[8], 16),
356 int(guidValueList[9], 16),
357 int(guidValueList[10], 16),
358 int(guidValueList[11], 16),
359 int(guidValueList[12], 16),
360 int(guidValueList[13], 16),
361 int(guidValueList[14], 16),
362 int(guidValueList[15], 16)
363 )
364 except:
365 return ''
366
367 ## Convert GUID string in C structure style to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
368 #
369 # @param GuidValue The GUID value in C structure format
370 #
371 # @retval string The GUID value in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format
372 #
373 def GuidStructureStringToGuidString(GuidValue):
374 guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "").replace(";", "")
375 guidValueList = guidValueString.split(",")
376 if len(guidValueList) != 11:
377 return ''
378 #EdkLogger.error(None, None, "Invalid GUID value string %s" % GuidValue)
379 try:
380 return "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" % (
381 int(guidValueList[0], 16),
382 int(guidValueList[1], 16),
383 int(guidValueList[2], 16),
384 int(guidValueList[3], 16),
385 int(guidValueList[4], 16),
386 int(guidValueList[5], 16),
387 int(guidValueList[6], 16),
388 int(guidValueList[7], 16),
389 int(guidValueList[8], 16),
390 int(guidValueList[9], 16),
391 int(guidValueList[10], 16)
392 )
393 except:
394 return ''
395
396 ## Convert GUID string in C structure style to xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx
397 #
398 # @param GuidValue The GUID value in C structure format
399 #
400 # @retval string The GUID value in xxxxxxxx_xxxx_xxxx_xxxx_xxxxxxxxxxxx format
401 #
402 def GuidStructureStringToGuidValueName(GuidValue):
403 guidValueString = GuidValue.lower().replace("{", "").replace("}", "").replace(" ", "")
404 guidValueList = guidValueString.split(",")
405 if len(guidValueList) != 11:
406 EdkLogger.error(None, FORMAT_INVALID, "Invalid GUID value string [%s]" % GuidValue)
407 return "%08x_%04x_%04x_%02x%02x_%02x%02x%02x%02x%02x%02x" % (
408 int(guidValueList[0], 16),
409 int(guidValueList[1], 16),
410 int(guidValueList[2], 16),
411 int(guidValueList[3], 16),
412 int(guidValueList[4], 16),
413 int(guidValueList[5], 16),
414 int(guidValueList[6], 16),
415 int(guidValueList[7], 16),
416 int(guidValueList[8], 16),
417 int(guidValueList[9], 16),
418 int(guidValueList[10], 16)
419 )
420
421 ## Create directories
422 #
423 # @param Directory The directory name
424 #
425 def CreateDirectory(Directory):
426 if Directory == None or Directory.strip() == "":
427 return True
428 try:
429 if not os.access(Directory, os.F_OK):
430 os.makedirs(Directory)
431 except:
432 return False
433 return True
434
435 ## Remove directories, including files and sub-directories in it
436 #
437 # @param Directory The directory name
438 #
439 def RemoveDirectory(Directory, Recursively=False):
440 if Directory == None or Directory.strip() == "" or not os.path.exists(Directory):
441 return
442 if Recursively:
443 CurrentDirectory = os.getcwd()
444 os.chdir(Directory)
445 for File in os.listdir("."):
446 if os.path.isdir(File):
447 RemoveDirectory(File, Recursively)
448 else:
449 os.remove(File)
450 os.chdir(CurrentDirectory)
451 os.rmdir(Directory)
452
453 ## Check if given file is changed or not
454 #
455 # This method is used to check if a file is changed or not between two build
456 # actions. It makes use a cache to store files timestamp.
457 #
458 # @param File The path of file
459 #
460 # @retval True If the given file is changed, doesn't exist, or can't be
461 # found in timestamp cache
462 # @retval False If the given file is changed
463 #
464 def IsChanged(File):
465 if not os.path.exists(File):
466 return True
467
468 FileState = os.stat(File)
469 TimeStamp = FileState[-2]
470
471 if File in gFileTimeStampCache and TimeStamp == gFileTimeStampCache[File]:
472 FileChanged = False
473 else:
474 FileChanged = True
475 gFileTimeStampCache[File] = TimeStamp
476
477 return FileChanged
478
479 ## Store content in file
480 #
481 # This method is used to save file only when its content is changed. This is
482 # quite useful for "make" system to decide what will be re-built and what won't.
483 #
484 # @param File The path of file
485 # @param Content The new content of the file
486 # @param IsBinaryFile The flag indicating if the file is binary file or not
487 #
488 # @retval True If the file content is changed and the file is renewed
489 # @retval False If the file content is the same
490 #
491 def SaveFileOnChange(File, Content, IsBinaryFile=True):
492 if not IsBinaryFile:
493 Content = Content.replace("\n", os.linesep)
494
495 if os.path.exists(File):
496 try:
497 if Content == open(File, "rb").read():
498 return False
499 except:
500 EdkLogger.error(None, FILE_OPEN_FAILURE, ExtraData=File)
501
502 DirName = os.path.dirname(File)
503 if not CreateDirectory(DirName):
504 EdkLogger.error(None, FILE_CREATE_FAILURE, "Could not create directory %s" % DirName)
505 else:
506 if DirName == '':
507 DirName = os.getcwd()
508 if not os.access(DirName, os.W_OK):
509 EdkLogger.error(None, PERMISSION_FAILURE, "Do not have write permission on directory %s" % DirName)
510
511 try:
512 if GlobalData.gIsWindows:
513 try:
514 from PyUtility import SaveFileToDisk
515 if not SaveFileToDisk(File, Content):
516 EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData=File)
517 except:
518 Fd = open(File, "wb")
519 Fd.write(Content)
520 Fd.close()
521 else:
522 Fd = open(File, "wb")
523 Fd.write(Content)
524 Fd.close()
525 except IOError, X:
526 EdkLogger.error(None, FILE_CREATE_FAILURE, ExtraData='IOError %s' % X)
527
528 return True
529
530 ## Make a Python object persistent on file system
531 #
532 # @param Data The object to be stored in file
533 # @param File The path of file to store the object
534 #
535 def DataDump(Data, File):
536 Fd = None
537 try:
538 Fd = open(File, 'wb')
539 cPickle.dump(Data, Fd, cPickle.HIGHEST_PROTOCOL)
540 except:
541 EdkLogger.error("", FILE_OPEN_FAILURE, ExtraData=File, RaiseError=False)
542 finally:
543 if Fd != None:
544 Fd.close()
545
546 ## Restore a Python object from a file
547 #
548 # @param File The path of file stored the object
549 #
550 # @retval object A python object
551 # @retval None If failure in file operation
552 #
553 def DataRestore(File):
554 Data = None
555 Fd = None
556 try:
557 Fd = open(File, 'rb')
558 Data = cPickle.load(Fd)
559 except Exception, e:
560 EdkLogger.verbose("Failed to load [%s]\n\t%s" % (File, str(e)))
561 Data = None
562 finally:
563 if Fd != None:
564 Fd.close()
565 return Data
566
567 ## Retrieve and cache the real path name in file system
568 #
569 # @param Root The root directory of path relative to
570 #
571 # @retval str The path string if the path exists
572 # @retval None If path doesn't exist
573 #
574 class DirCache:
575 _CACHE_ = set()
576 _UPPER_CACHE_ = {}
577
578 def __init__(self, Root):
579 self._Root = Root
580 for F in os.listdir(Root):
581 self._CACHE_.add(F)
582 self._UPPER_CACHE_[F.upper()] = F
583
584 # =[] operator
585 def __getitem__(self, Path):
586 Path = Path[len(os.path.commonprefix([Path, self._Root])):]
587 if not Path:
588 return self._Root
589 if Path and Path[0] == os.path.sep:
590 Path = Path[1:]
591 if Path in self._CACHE_:
592 return os.path.join(self._Root, Path)
593 UpperPath = Path.upper()
594 if UpperPath in self._UPPER_CACHE_:
595 return os.path.join(self._Root, self._UPPER_CACHE_[UpperPath])
596
597 IndexList = []
598 LastSepIndex = -1
599 SepIndex = Path.find(os.path.sep)
600 while SepIndex > -1:
601 Parent = UpperPath[:SepIndex]
602 if Parent not in self._UPPER_CACHE_:
603 break
604 LastSepIndex = SepIndex
605 SepIndex = Path.find(os.path.sep, LastSepIndex + 1)
606
607 if LastSepIndex == -1:
608 return None
609
610 Cwd = os.getcwd()
611 os.chdir(self._Root)
612 SepIndex = LastSepIndex
613 while SepIndex > -1:
614 Parent = Path[:SepIndex]
615 ParentKey = UpperPath[:SepIndex]
616 if ParentKey not in self._UPPER_CACHE_:
617 os.chdir(Cwd)
618 return None
619
620 if Parent in self._CACHE_:
621 ParentDir = Parent
622 else:
623 ParentDir = self._UPPER_CACHE_[ParentKey]
624 for F in os.listdir(ParentDir):
625 Dir = os.path.join(ParentDir, F)
626 self._CACHE_.add(Dir)
627 self._UPPER_CACHE_[Dir.upper()] = Dir
628
629 SepIndex = Path.find(os.path.sep, SepIndex + 1)
630
631 os.chdir(Cwd)
632 if Path in self._CACHE_:
633 return os.path.join(self._Root, Path)
634 elif UpperPath in self._UPPER_CACHE_:
635 return os.path.join(self._Root, self._UPPER_CACHE_[UpperPath])
636 return None
637
638 ## Get all files of a directory
639 #
640 # @param Root: Root dir
641 # @param SkipList : The files need be skipped
642 #
643 # @retval A list of all files
644 #
645 def GetFiles(Root, SkipList=None, FullPath=True):
646 OriPath = Root
647 FileList = []
648 for Root, Dirs, Files in os.walk(Root):
649 if SkipList:
650 for Item in SkipList:
651 if Item in Dirs:
652 Dirs.remove(Item)
653
654 for File in Files:
655 File = os.path.normpath(os.path.join(Root, File))
656 if not FullPath:
657 File = File[len(OriPath) + 1:]
658 FileList.append(File)
659
660 return FileList
661
662 ## Check if gvien file exists or not
663 #
664 # @param File File name or path to be checked
665 # @param Dir The directory the file is relative to
666 #
667 # @retval True if file exists
668 # @retval False if file doesn't exists
669 #
670 def ValidFile(File, Ext=None):
671 if Ext != None:
672 Dummy, FileExt = os.path.splitext(File)
673 if FileExt.lower() != Ext.lower():
674 return False
675 if not os.path.exists(File):
676 return False
677 return True
678
679 def RealPath(File, Dir='', OverrideDir=''):
680 NewFile = os.path.normpath(os.path.join(Dir, File))
681 NewFile = GlobalData.gAllFiles[NewFile]
682 if not NewFile and OverrideDir:
683 NewFile = os.path.normpath(os.path.join(OverrideDir, File))
684 NewFile = GlobalData.gAllFiles[NewFile]
685 return NewFile
686
687 def RealPath2(File, Dir='', OverrideDir=''):
688 NewFile = None
689 if OverrideDir:
690 NewFile = GlobalData.gAllFiles[os.path.normpath(os.path.join(OverrideDir, File))]
691 if NewFile:
692 if OverrideDir[-1] == os.path.sep:
693 return NewFile[len(OverrideDir):], NewFile[0:len(OverrideDir)]
694 else:
695 return NewFile[len(OverrideDir) + 1:], NewFile[0:len(OverrideDir)]
696 if GlobalData.gAllFiles:
697 NewFile = GlobalData.gAllFiles[os.path.normpath(os.path.join(Dir, File))]
698 if not NewFile:
699 NewFile = os.path.normpath(os.path.join(Dir, File))
700 if not os.path.exists(NewFile):
701 return None, None
702 if NewFile:
703 if Dir:
704 if Dir[-1] == os.path.sep:
705 return NewFile[len(Dir):], NewFile[0:len(Dir)]
706 else:
707 return NewFile[len(Dir) + 1:], NewFile[0:len(Dir)]
708 else:
709 return NewFile, ''
710
711 return None, None
712
713 ## Check if gvien file exists or not
714 #
715 #
716 def ValidFile2(AllFiles, File, Ext=None, Workspace='', EfiSource='', EdkSource='', Dir='.', OverrideDir=''):
717 NewFile = File
718 if Ext != None:
719 Dummy, FileExt = os.path.splitext(File)
720 if FileExt.lower() != Ext.lower():
721 return False, File
722
723 # Replace the Edk macros
724 if OverrideDir != '' and OverrideDir != None:
725 if OverrideDir.find('$(EFI_SOURCE)') > -1:
726 OverrideDir = OverrideDir.replace('$(EFI_SOURCE)', EfiSource)
727 if OverrideDir.find('$(EDK_SOURCE)') > -1:
728 OverrideDir = OverrideDir.replace('$(EDK_SOURCE)', EdkSource)
729
730 # Replace the default dir to current dir
731 if Dir == '.':
732 Dir = os.getcwd()
733 Dir = Dir[len(Workspace) + 1:]
734
735 # First check if File has Edk definition itself
736 if File.find('$(EFI_SOURCE)') > -1 or File.find('$(EDK_SOURCE)') > -1:
737 NewFile = File.replace('$(EFI_SOURCE)', EfiSource)
738 NewFile = NewFile.replace('$(EDK_SOURCE)', EdkSource)
739 NewFile = AllFiles[os.path.normpath(NewFile)]
740 if NewFile != None:
741 return True, NewFile
742
743 # Second check the path with override value
744 if OverrideDir != '' and OverrideDir != None:
745 NewFile = AllFiles[os.path.normpath(os.path.join(OverrideDir, File))]
746 if NewFile != None:
747 return True, NewFile
748
749 # Last check the path with normal definitions
750 File = os.path.join(Dir, File)
751 NewFile = AllFiles[os.path.normpath(File)]
752 if NewFile != None:
753 return True, NewFile
754
755 return False, File
756
757 ## Check if gvien file exists or not
758 #
759 #
760 def ValidFile3(AllFiles, File, Workspace='', EfiSource='', EdkSource='', Dir='.', OverrideDir=''):
761 # Replace the Edk macros
762 if OverrideDir != '' and OverrideDir != None:
763 if OverrideDir.find('$(EFI_SOURCE)') > -1:
764 OverrideDir = OverrideDir.replace('$(EFI_SOURCE)', EfiSource)
765 if OverrideDir.find('$(EDK_SOURCE)') > -1:
766 OverrideDir = OverrideDir.replace('$(EDK_SOURCE)', EdkSource)
767
768 # Replace the default dir to current dir
769 # Dir is current module dir related to workspace
770 if Dir == '.':
771 Dir = os.getcwd()
772 Dir = Dir[len(Workspace) + 1:]
773
774 NewFile = File
775 RelaPath = AllFiles[os.path.normpath(Dir)]
776 NewRelaPath = RelaPath
777
778 while(True):
779 # First check if File has Edk definition itself
780 if File.find('$(EFI_SOURCE)') > -1 or File.find('$(EDK_SOURCE)') > -1:
781 File = File.replace('$(EFI_SOURCE)', EfiSource)
782 File = File.replace('$(EDK_SOURCE)', EdkSource)
783 NewFile = AllFiles[os.path.normpath(File)]
784 if NewFile != None:
785 NewRelaPath = os.path.dirname(NewFile)
786 File = os.path.basename(NewFile)
787 #NewRelaPath = NewFile[:len(NewFile) - len(File.replace("..\\", '').replace("../", '')) - 1]
788 break
789
790 # Second check the path with override value
791 if OverrideDir != '' and OverrideDir != None:
792 NewFile = AllFiles[os.path.normpath(os.path.join(OverrideDir, File))]
793 if NewFile != None:
794 #NewRelaPath = os.path.dirname(NewFile)
795 NewRelaPath = NewFile[:len(NewFile) - len(File.replace("..\\", '').replace("../", '')) - 1]
796 break
797
798 # Last check the path with normal definitions
799 NewFile = AllFiles[os.path.normpath(os.path.join(Dir, File))]
800 if NewFile != None:
801 break
802
803 # No file found
804 break
805
806 return NewRelaPath, RelaPath, File
807
808
809 def GetRelPath(Path1, Path2):
810 FileName = os.path.basename(Path2)
811 L1 = os.path.normpath(Path1).split(os.path.normpath('/'))
812 L2 = os.path.normpath(Path2).split(os.path.normpath('/'))
813 for Index in range(0, len(L1)):
814 if L1[Index] != L2[Index]:
815 FileName = '../' * (len(L1) - Index)
816 for Index2 in range(Index, len(L2)):
817 FileName = os.path.join(FileName, L2[Index2])
818 break
819 return os.path.normpath(FileName)
820
821
822 ## Get GUID value from given packages
823 #
824 # @param CName The CName of the GUID
825 # @param PackageList List of packages looking-up in
826 # @param Inffile The driver file
827 #
828 # @retval GuidValue if the CName is found in any given package
829 # @retval None if the CName is not found in all given packages
830 #
831 def GuidValue(CName, PackageList, Inffile = None):
832 for P in PackageList:
833 GuidKeys = P.Guids.keys()
834 if Inffile and P._PrivateGuids:
835 if not Inffile.startswith(P.MetaFile.Dir):
836 GuidKeys = (dict.fromkeys(x for x in P.Guids if x not in P._PrivateGuids)).keys()
837 if CName in GuidKeys:
838 return P.Guids[CName]
839 return None
840
841 ## Get Protocol value from given packages
842 #
843 # @param CName The CName of the GUID
844 # @param PackageList List of packages looking-up in
845 # @param Inffile The driver file
846 #
847 # @retval GuidValue if the CName is found in any given package
848 # @retval None if the CName is not found in all given packages
849 #
850 def ProtocolValue(CName, PackageList, Inffile = None):
851 for P in PackageList:
852 ProtocolKeys = P.Protocols.keys()
853 if Inffile and P._PrivateProtocols:
854 if not Inffile.startswith(P.MetaFile.Dir):
855 ProtocolKeys = (dict.fromkeys(x for x in P.Protocols if x not in P._PrivateProtocols)).keys()
856 if CName in ProtocolKeys:
857 return P.Protocols[CName]
858 return None
859
860 ## Get PPI value from given packages
861 #
862 # @param CName The CName of the GUID
863 # @param PackageList List of packages looking-up in
864 # @param Inffile The driver file
865 #
866 # @retval GuidValue if the CName is found in any given package
867 # @retval None if the CName is not found in all given packages
868 #
869 def PpiValue(CName, PackageList, Inffile = None):
870 for P in PackageList:
871 PpiKeys = P.Ppis.keys()
872 if Inffile and P._PrivatePpis:
873 if not Inffile.startswith(P.MetaFile.Dir):
874 PpiKeys = (dict.fromkeys(x for x in P.Ppis if x not in P._PrivatePpis)).keys()
875 if CName in PpiKeys:
876 return P.Ppis[CName]
877 return None
878
879 ## A string template class
880 #
881 # This class implements a template for string replacement. A string template
882 # looks like following
883 #
884 # ${BEGIN} other_string ${placeholder_name} other_string ${END}
885 #
886 # The string between ${BEGIN} and ${END} will be repeated as many times as the
887 # length of "placeholder_name", which is a list passed through a dict. The
888 # "placeholder_name" is the key name of the dict. The ${BEGIN} and ${END} can
889 # be not used and, in this case, the "placeholder_name" must not a list and it
890 # will just be replaced once.
891 #
892 class TemplateString(object):
893 _REPEAT_START_FLAG = "BEGIN"
894 _REPEAT_END_FLAG = "END"
895
896 class Section(object):
897 _LIST_TYPES = [type([]), type(set()), type((0,))]
898
899 def __init__(self, TemplateSection, PlaceHolderList):
900 self._Template = TemplateSection
901 self._PlaceHolderList = []
902
903 # Split the section into sub-sections according to the position of placeholders
904 if PlaceHolderList:
905 self._SubSectionList = []
906 SubSectionStart = 0
907 #
908 # The placeholders passed in must be in the format of
909 #
910 # PlaceHolderName, PlaceHolderStartPoint, PlaceHolderEndPoint
911 #
912 for PlaceHolder, Start, End in PlaceHolderList:
913 self._SubSectionList.append(TemplateSection[SubSectionStart:Start])
914 self._SubSectionList.append(TemplateSection[Start:End])
915 self._PlaceHolderList.append(PlaceHolder)
916 SubSectionStart = End
917 if SubSectionStart < len(TemplateSection):
918 self._SubSectionList.append(TemplateSection[SubSectionStart:])
919 else:
920 self._SubSectionList = [TemplateSection]
921
922 def __str__(self):
923 return self._Template + " : " + str(self._PlaceHolderList)
924
925 def Instantiate(self, PlaceHolderValues):
926 RepeatTime = -1
927 RepeatPlaceHolders = {}
928 NonRepeatPlaceHolders = {}
929
930 for PlaceHolder in self._PlaceHolderList:
931 if PlaceHolder not in PlaceHolderValues:
932 continue
933 Value = PlaceHolderValues[PlaceHolder]
934 if type(Value) in self._LIST_TYPES:
935 if RepeatTime < 0:
936 RepeatTime = len(Value)
937 elif RepeatTime != len(Value):
938 EdkLogger.error(
939 "TemplateString",
940 PARAMETER_INVALID,
941 "${%s} has different repeat time from others!" % PlaceHolder,
942 ExtraData=str(self._Template)
943 )
944 RepeatPlaceHolders["${%s}" % PlaceHolder] = Value
945 else:
946 NonRepeatPlaceHolders["${%s}" % PlaceHolder] = Value
947
948 if NonRepeatPlaceHolders:
949 StringList = []
950 for S in self._SubSectionList:
951 if S not in NonRepeatPlaceHolders:
952 StringList.append(S)
953 else:
954 StringList.append(str(NonRepeatPlaceHolders[S]))
955 else:
956 StringList = self._SubSectionList
957
958 if RepeatPlaceHolders:
959 TempStringList = []
960 for Index in range(RepeatTime):
961 for S in StringList:
962 if S not in RepeatPlaceHolders:
963 TempStringList.append(S)
964 else:
965 TempStringList.append(str(RepeatPlaceHolders[S][Index]))
966 StringList = TempStringList
967
968 return "".join(StringList)
969
970 ## Constructor
971 def __init__(self, Template=None):
972 self.String = ''
973 self.IsBinary = False
974 self._Template = Template
975 self._TemplateSectionList = self._Parse(Template)
976
977 ## str() operator
978 #
979 # @retval string The string replaced
980 #
981 def __str__(self):
982 return self.String
983
984 ## Split the template string into fragments per the ${BEGIN} and ${END} flags
985 #
986 # @retval list A list of TemplateString.Section objects
987 #
988 def _Parse(self, Template):
989 SectionStart = 0
990 SearchFrom = 0
991 MatchEnd = 0
992 PlaceHolderList = []
993 TemplateSectionList = []
994 while Template:
995 MatchObj = gPlaceholderPattern.search(Template, SearchFrom)
996 if not MatchObj:
997 if MatchEnd <= len(Template):
998 TemplateSection = TemplateString.Section(Template[SectionStart:], PlaceHolderList)
999 TemplateSectionList.append(TemplateSection)
1000 break
1001
1002 MatchString = MatchObj.group(1)
1003 MatchStart = MatchObj.start()
1004 MatchEnd = MatchObj.end()
1005
1006 if MatchString == self._REPEAT_START_FLAG:
1007 if MatchStart > SectionStart:
1008 TemplateSection = TemplateString.Section(Template[SectionStart:MatchStart], PlaceHolderList)
1009 TemplateSectionList.append(TemplateSection)
1010 SectionStart = MatchEnd
1011 PlaceHolderList = []
1012 elif MatchString == self._REPEAT_END_FLAG:
1013 TemplateSection = TemplateString.Section(Template[SectionStart:MatchStart], PlaceHolderList)
1014 TemplateSectionList.append(TemplateSection)
1015 SectionStart = MatchEnd
1016 PlaceHolderList = []
1017 else:
1018 PlaceHolderList.append((MatchString, MatchStart - SectionStart, MatchEnd - SectionStart))
1019 SearchFrom = MatchEnd
1020 return TemplateSectionList
1021
1022 ## Replace the string template with dictionary of placeholders and append it to previous one
1023 #
1024 # @param AppendString The string template to append
1025 # @param Dictionary The placeholder dictionaries
1026 #
1027 def Append(self, AppendString, Dictionary=None):
1028 if Dictionary:
1029 SectionList = self._Parse(AppendString)
1030 self.String += "".join([S.Instantiate(Dictionary) for S in SectionList])
1031 else:
1032 self.String += AppendString
1033
1034 ## Replace the string template with dictionary of placeholders
1035 #
1036 # @param Dictionary The placeholder dictionaries
1037 #
1038 # @retval str The string replaced with placeholder values
1039 #
1040 def Replace(self, Dictionary=None):
1041 return "".join([S.Instantiate(Dictionary) for S in self._TemplateSectionList])
1042
1043 ## Progress indicator class
1044 #
1045 # This class makes use of thread to print progress on console.
1046 #
1047 class Progressor:
1048 # for avoiding deadloop
1049 _StopFlag = None
1050 _ProgressThread = None
1051 _CheckInterval = 0.25
1052
1053 ## Constructor
1054 #
1055 # @param OpenMessage The string printed before progress charaters
1056 # @param CloseMessage The string printed after progress charaters
1057 # @param ProgressChar The charater used to indicate the progress
1058 # @param Interval The interval in seconds between two progress charaters
1059 #
1060 def __init__(self, OpenMessage="", CloseMessage="", ProgressChar='.', Interval=1.0):
1061 self.PromptMessage = OpenMessage
1062 self.CodaMessage = CloseMessage
1063 self.ProgressChar = ProgressChar
1064 self.Interval = Interval
1065 if Progressor._StopFlag == None:
1066 Progressor._StopFlag = threading.Event()
1067
1068 ## Start to print progress charater
1069 #
1070 # @param OpenMessage The string printed before progress charaters
1071 #
1072 def Start(self, OpenMessage=None):
1073 if OpenMessage != None:
1074 self.PromptMessage = OpenMessage
1075 Progressor._StopFlag.clear()
1076 if Progressor._ProgressThread == None:
1077 Progressor._ProgressThread = threading.Thread(target=self._ProgressThreadEntry)
1078 Progressor._ProgressThread.setDaemon(False)
1079 Progressor._ProgressThread.start()
1080
1081 ## Stop printing progress charater
1082 #
1083 # @param CloseMessage The string printed after progress charaters
1084 #
1085 def Stop(self, CloseMessage=None):
1086 OriginalCodaMessage = self.CodaMessage
1087 if CloseMessage != None:
1088 self.CodaMessage = CloseMessage
1089 self.Abort()
1090 self.CodaMessage = OriginalCodaMessage
1091
1092 ## Thread entry method
1093 def _ProgressThreadEntry(self):
1094 sys.stdout.write(self.PromptMessage + " ")
1095 sys.stdout.flush()
1096 TimeUp = 0.0
1097 while not Progressor._StopFlag.isSet():
1098 if TimeUp <= 0.0:
1099 sys.stdout.write(self.ProgressChar)
1100 sys.stdout.flush()
1101 TimeUp = self.Interval
1102 time.sleep(self._CheckInterval)
1103 TimeUp -= self._CheckInterval
1104 sys.stdout.write(" " + self.CodaMessage + "\n")
1105 sys.stdout.flush()
1106
1107 ## Abort the progress display
1108 @staticmethod
1109 def Abort():
1110 if Progressor._StopFlag != None:
1111 Progressor._StopFlag.set()
1112 if Progressor._ProgressThread != None:
1113 Progressor._ProgressThread.join()
1114 Progressor._ProgressThread = None
1115
1116 ## A dict which can access its keys and/or values orderly
1117 #
1118 # The class implements a new kind of dict which its keys or values can be
1119 # accessed in the order they are added into the dict. It guarantees the order
1120 # by making use of an internal list to keep a copy of keys.
1121 #
1122 class sdict(IterableUserDict):
1123 ## Constructor
1124 def __init__(self):
1125 IterableUserDict.__init__(self)
1126 self._key_list = []
1127
1128 ## [] operator
1129 def __setitem__(self, key, value):
1130 if key not in self._key_list:
1131 self._key_list.append(key)
1132 IterableUserDict.__setitem__(self, key, value)
1133
1134 ## del operator
1135 def __delitem__(self, key):
1136 self._key_list.remove(key)
1137 IterableUserDict.__delitem__(self, key)
1138
1139 ## used in "for k in dict" loop to ensure the correct order
1140 def __iter__(self):
1141 return self.iterkeys()
1142
1143 ## len() support
1144 def __len__(self):
1145 return len(self._key_list)
1146
1147 ## "in" test support
1148 def __contains__(self, key):
1149 return key in self._key_list
1150
1151 ## indexof support
1152 def index(self, key):
1153 return self._key_list.index(key)
1154
1155 ## insert support
1156 def insert(self, key, newkey, newvalue, order):
1157 index = self._key_list.index(key)
1158 if order == 'BEFORE':
1159 self._key_list.insert(index, newkey)
1160 IterableUserDict.__setitem__(self, newkey, newvalue)
1161 elif order == 'AFTER':
1162 self._key_list.insert(index + 1, newkey)
1163 IterableUserDict.__setitem__(self, newkey, newvalue)
1164
1165 ## append support
1166 def append(self, sdict):
1167 for key in sdict:
1168 if key not in self._key_list:
1169 self._key_list.append(key)
1170 IterableUserDict.__setitem__(self, key, sdict[key])
1171
1172 def has_key(self, key):
1173 return key in self._key_list
1174
1175 ## Empty the dict
1176 def clear(self):
1177 self._key_list = []
1178 IterableUserDict.clear(self)
1179
1180 ## Return a copy of keys
1181 def keys(self):
1182 keys = []
1183 for key in self._key_list:
1184 keys.append(key)
1185 return keys
1186
1187 ## Return a copy of values
1188 def values(self):
1189 values = []
1190 for key in self._key_list:
1191 values.append(self[key])
1192 return values
1193
1194 ## Return a copy of (key, value) list
1195 def items(self):
1196 items = []
1197 for key in self._key_list:
1198 items.append((key, self[key]))
1199 return items
1200
1201 ## Iteration support
1202 def iteritems(self):
1203 return iter(self.items())
1204
1205 ## Keys interation support
1206 def iterkeys(self):
1207 return iter(self.keys())
1208
1209 ## Values interation support
1210 def itervalues(self):
1211 return iter(self.values())
1212
1213 ## Return value related to a key, and remove the (key, value) from the dict
1214 def pop(self, key, *dv):
1215 value = None
1216 if key in self._key_list:
1217 value = self[key]
1218 self.__delitem__(key)
1219 elif len(dv) != 0 :
1220 value = kv[0]
1221 return value
1222
1223 ## Return (key, value) pair, and remove the (key, value) from the dict
1224 def popitem(self):
1225 key = self._key_list[-1]
1226 value = self[key]
1227 self.__delitem__(key)
1228 return key, value
1229
1230 def update(self, dict=None, **kwargs):
1231 if dict != None:
1232 for k, v in dict.items():
1233 self[k] = v
1234 if len(kwargs):
1235 for k, v in kwargs.items():
1236 self[k] = v
1237
1238 ## Dictionary with restricted keys
1239 #
1240 class rdict(dict):
1241 ## Constructor
1242 def __init__(self, KeyList):
1243 for Key in KeyList:
1244 dict.__setitem__(self, Key, "")
1245
1246 ## []= operator
1247 def __setitem__(self, key, value):
1248 if key not in self:
1249 EdkLogger.error("RestrictedDict", ATTRIBUTE_SET_FAILURE, "Key [%s] is not allowed" % key,
1250 ExtraData=", ".join(dict.keys(self)))
1251 dict.__setitem__(self, key, value)
1252
1253 ## =[] operator
1254 def __getitem__(self, key):
1255 if key not in self:
1256 return ""
1257 return dict.__getitem__(self, key)
1258
1259 ## del operator
1260 def __delitem__(self, key):
1261 EdkLogger.error("RestrictedDict", ATTRIBUTE_ACCESS_DENIED, ExtraData="del")
1262
1263 ## Empty the dict
1264 def clear(self):
1265 for Key in self:
1266 self.__setitem__(Key, "")
1267
1268 ## Return value related to a key, and remove the (key, value) from the dict
1269 def pop(self, key, *dv):
1270 EdkLogger.error("RestrictedDict", ATTRIBUTE_ACCESS_DENIED, ExtraData="pop")
1271
1272 ## Return (key, value) pair, and remove the (key, value) from the dict
1273 def popitem(self):
1274 EdkLogger.error("RestrictedDict", ATTRIBUTE_ACCESS_DENIED, ExtraData="popitem")
1275
1276 ## Dictionary using prioritized list as key
1277 #
1278 class tdict:
1279 _ListType = type([])
1280 _TupleType = type(())
1281 _Wildcard = 'COMMON'
1282 _ValidWildcardList = ['COMMON', 'DEFAULT', 'ALL', '*', 'PLATFORM']
1283
1284 def __init__(self, _Single_=False, _Level_=2):
1285 self._Level_ = _Level_
1286 self.data = {}
1287 self._Single_ = _Single_
1288
1289 # =[] operator
1290 def __getitem__(self, key):
1291 KeyType = type(key)
1292 RestKeys = None
1293 if KeyType == self._ListType or KeyType == self._TupleType:
1294 FirstKey = key[0]
1295 if len(key) > 1:
1296 RestKeys = key[1:]
1297 elif self._Level_ > 1:
1298 RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]
1299 else:
1300 FirstKey = key
1301 if self._Level_ > 1:
1302 RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]
1303
1304 if FirstKey == None or str(FirstKey).upper() in self._ValidWildcardList:
1305 FirstKey = self._Wildcard
1306
1307 if self._Single_:
1308 return self._GetSingleValue(FirstKey, RestKeys)
1309 else:
1310 return self._GetAllValues(FirstKey, RestKeys)
1311
1312 def _GetSingleValue(self, FirstKey, RestKeys):
1313 Value = None
1314 #print "%s-%s" % (FirstKey, self._Level_) ,
1315 if self._Level_ > 1:
1316 if FirstKey == self._Wildcard:
1317 if FirstKey in self.data:
1318 Value = self.data[FirstKey][RestKeys]
1319 if Value == None:
1320 for Key in self.data:
1321 Value = self.data[Key][RestKeys]
1322 if Value != None: break
1323 else:
1324 if FirstKey in self.data:
1325 Value = self.data[FirstKey][RestKeys]
1326 if Value == None and self._Wildcard in self.data:
1327 #print "Value=None"
1328 Value = self.data[self._Wildcard][RestKeys]
1329 else:
1330 if FirstKey == self._Wildcard:
1331 if FirstKey in self.data:
1332 Value = self.data[FirstKey]
1333 if Value == None:
1334 for Key in self.data:
1335 Value = self.data[Key]
1336 if Value != None: break
1337 else:
1338 if FirstKey in self.data:
1339 Value = self.data[FirstKey]
1340 elif self._Wildcard in self.data:
1341 Value = self.data[self._Wildcard]
1342 return Value
1343
1344 def _GetAllValues(self, FirstKey, RestKeys):
1345 Value = []
1346 if self._Level_ > 1:
1347 if FirstKey == self._Wildcard:
1348 for Key in self.data:
1349 Value += self.data[Key][RestKeys]
1350 else:
1351 if FirstKey in self.data:
1352 Value += self.data[FirstKey][RestKeys]
1353 if self._Wildcard in self.data:
1354 Value += self.data[self._Wildcard][RestKeys]
1355 else:
1356 if FirstKey == self._Wildcard:
1357 for Key in self.data:
1358 Value.append(self.data[Key])
1359 else:
1360 if FirstKey in self.data:
1361 Value.append(self.data[FirstKey])
1362 if self._Wildcard in self.data:
1363 Value.append(self.data[self._Wildcard])
1364 return Value
1365
1366 ## []= operator
1367 def __setitem__(self, key, value):
1368 KeyType = type(key)
1369 RestKeys = None
1370 if KeyType == self._ListType or KeyType == self._TupleType:
1371 FirstKey = key[0]
1372 if len(key) > 1:
1373 RestKeys = key[1:]
1374 else:
1375 RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]
1376 else:
1377 FirstKey = key
1378 if self._Level_ > 1:
1379 RestKeys = [self._Wildcard for i in range(0, self._Level_ - 1)]
1380
1381 if FirstKey in self._ValidWildcardList:
1382 FirstKey = self._Wildcard
1383
1384 if FirstKey not in self.data and self._Level_ > 0:
1385 self.data[FirstKey] = tdict(self._Single_, self._Level_ - 1)
1386
1387 if self._Level_ > 1:
1388 self.data[FirstKey][RestKeys] = value
1389 else:
1390 self.data[FirstKey] = value
1391
1392 def SetGreedyMode(self):
1393 self._Single_ = False
1394 if self._Level_ > 1:
1395 for Key in self.data:
1396 self.data[Key].SetGreedyMode()
1397
1398 def SetSingleMode(self):
1399 self._Single_ = True
1400 if self._Level_ > 1:
1401 for Key in self.data:
1402 self.data[Key].SetSingleMode()
1403
1404 def GetKeys(self, KeyIndex=0):
1405 assert KeyIndex >= 0
1406 if KeyIndex == 0:
1407 return set(self.data.keys())
1408 else:
1409 keys = set()
1410 for Key in self.data:
1411 keys |= self.data[Key].GetKeys(KeyIndex - 1)
1412 return keys
1413
1414 ## Boolean chain list
1415 #
1416 class Blist(UserList):
1417 def __init__(self, initlist=None):
1418 UserList.__init__(self, initlist)
1419 def __setitem__(self, i, item):
1420 if item not in [True, False]:
1421 if item == 0:
1422 item = False
1423 else:
1424 item = True
1425 self.data[i] = item
1426 def _GetResult(self):
1427 Value = True
1428 for item in self.data:
1429 Value &= item
1430 return Value
1431 Result = property(_GetResult)
1432
1433 def ParseConsoleLog(Filename):
1434 Opr = open(os.path.normpath(Filename), 'r')
1435 Opw = open(os.path.normpath(Filename + '.New'), 'w+')
1436 for Line in Opr.readlines():
1437 if Line.find('.efi') > -1:
1438 Line = Line[Line.rfind(' ') : Line.rfind('.efi')].strip()
1439 Opw.write('%s\n' % Line)
1440
1441 Opr.close()
1442 Opw.close()
1443
1444 def IsFieldValueAnArray (Value):
1445 Value = Value.strip()
1446 if Value.startswith('GUID') and Value.endswith(')'):
1447 return True
1448 if Value.startswith('L"') and Value.endswith('"') and len(list(Value[2:-1])) > 1:
1449 return True
1450 if Value[0] == '"' and Value[-1] == '"' and len(list(Value[1:-1])) > 1:
1451 return True
1452 if Value[0] == '{' and Value[-1] == '}':
1453 return True
1454 if Value.startswith("L'") and Value.endswith("'") and len(list(Value[2:-1])) > 1:
1455 return True
1456 if Value[0] == "'" and Value[-1] == "'" and len(list(Value[1:-1])) > 1:
1457 return True
1458 return False
1459
1460 def AnalyzePcdExpression(Setting):
1461 Setting = Setting.strip()
1462 # There might be escaped quote in a string: \", \\\" , \', \\\'
1463 Data = Setting
1464 # There might be '|' in string and in ( ... | ... ), replace it with '-'
1465 NewStr = ''
1466 InSingleQuoteStr = False
1467 InDoubleQuoteStr = False
1468 Pair = 0
1469 for Index, ch in enumerate(Data):
1470 if ch == '"' and not InSingleQuoteStr:
1471 if Data[Index - 1] != '\\':
1472 InDoubleQuoteStr = not InDoubleQuoteStr
1473 elif ch == "'" and not InDoubleQuoteStr:
1474 if Data[Index - 1] != '\\':
1475 InSingleQuoteStr = not InSingleQuoteStr
1476 elif ch == '(' and not (InSingleQuoteStr or InDoubleQuoteStr):
1477 Pair += 1
1478 elif ch == ')' and not (InSingleQuoteStr or InDoubleQuoteStr):
1479 Pair -= 1
1480
1481 if (Pair > 0 or InSingleQuoteStr or InDoubleQuoteStr) and ch == TAB_VALUE_SPLIT:
1482 NewStr += '-'
1483 else:
1484 NewStr += ch
1485 FieldList = []
1486 StartPos = 0
1487 while True:
1488 Pos = NewStr.find(TAB_VALUE_SPLIT, StartPos)
1489 if Pos < 0:
1490 FieldList.append(Setting[StartPos:].strip())
1491 break
1492 FieldList.append(Setting[StartPos:Pos].strip())
1493 StartPos = Pos + 1
1494
1495 return FieldList
1496
1497 def ParseDevPathValue (Value):
1498 DevPathList = [ "Path","HardwarePath","Pci","PcCard","MemoryMapped","VenHw","Ctrl","BMC","AcpiPath","Acpi","PciRoot",
1499 "PcieRoot","Floppy","Keyboard","Serial","ParallelPort","AcpiEx","AcpiExp","AcpiAdr","Msg","Ata","Scsi",
1500 "Fibre","FibreEx","I1394","USB","I2O","Infiniband","VenMsg","VenPcAnsi","VenVt100","VenVt100Plus",
1501 "VenUtf8","UartFlowCtrl","SAS","SasEx","NVMe","UFS","SD","eMMC","DebugPort","MAC","IPv4","IPv6","Uart",
1502 "UsbClass","UsbAudio","UsbCDCControl","UsbHID","UsbImage","UsbPrinter","UsbMassStorage","UsbHub",
1503 "UsbCDCData","UsbSmartCard","UsbVideo","UsbDiagnostic","UsbWireless","UsbDeviceFirmwareUpdate",
1504 "UsbIrdaBridge","UsbTestAndMeasurement","UsbWwid","Unit","iSCSI","Vlan","Uri","Bluetooth","Wi-Fi",
1505 "MediaPath","HD","CDROM","VenMedia","Media","Fv","FvFile","Offset","RamDisk","VirtualDisk","VirtualCD",
1506 "PersistentVirtualDisk","PersistentVirtualCD","BbsPath","BBS","Sata" ]
1507 if '\\' in Value:
1508 Value.replace('\\', '/').replace(' ', '')
1509 for Item in Value.split('/'):
1510 Key = Item.strip().split('(')[0]
1511 if Key not in DevPathList:
1512 pass
1513
1514 Cmd = 'DevicePath ' + '"' + Value + '"'
1515 try:
1516 p = subprocess.Popen(Cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
1517 out, err = p.communicate()
1518 except Exception, X:
1519 raise BadExpression("DevicePath: %s" % (str(X)) )
1520 finally:
1521 subprocess._cleanup()
1522 p.stdout.close()
1523 p.stderr.close()
1524 if err:
1525 raise BadExpression("DevicePath: %s" % str(err))
1526 Size = len(out.split())
1527 out = ','.join(out.split())
1528 return '{' + out + '}', Size
1529
1530 def ParseFieldValue (Value):
1531 if type(Value) == type(0):
1532 return Value, (Value.bit_length() + 7) / 8
1533 if type(Value) <> type(''):
1534 raise BadExpression('Type %s is %s' %(Value, type(Value)))
1535 Value = Value.strip()
1536 if Value.startswith('UINT8') and Value.endswith(')'):
1537 Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])
1538 if Size > 1:
1539 raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))
1540 return Value, 1
1541 if Value.startswith('UINT16') and Value.endswith(')'):
1542 Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])
1543 if Size > 2:
1544 raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))
1545 return Value, 2
1546 if Value.startswith('UINT32') and Value.endswith(')'):
1547 Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])
1548 if Size > 4:
1549 raise BadExpression('Value (%s) Size larger than %d' %(Value, Size))
1550 return Value, 4
1551 if Value.startswith('UINT64') and Value.endswith(')'):
1552 Value, Size = ParseFieldValue(Value.split('(', 1)[1][:-1])
1553 if Size > 8:
1554 raise BadExpression('Value (%s) Size larger than %d' % (Value, Size))
1555 return Value, 8
1556 if Value.startswith('GUID') and Value.endswith(')'):
1557 Value = Value.split('(', 1)[1][:-1].strip()
1558 if Value[0] == '{' and Value[-1] == '}':
1559 TmpValue = GuidStructureStringToGuidString(Value)
1560 if len(TmpValue) == 0:
1561 raise BadExpression("Invalid GUID value string %s" % Value)
1562 Value = TmpValue
1563 if Value[0] == '"' and Value[-1] == '"':
1564 Value = Value[1:-1]
1565 try:
1566 Value = "'" + uuid.UUID(Value).get_bytes_le() + "'"
1567 except ValueError, Message:
1568 raise BadExpression('%s' % Message)
1569 Value, Size = ParseFieldValue(Value)
1570 return Value, 16
1571 if Value.startswith('L"') and Value.endswith('"'):
1572 # Unicode String
1573 # translate escape character
1574 Value = Value[1:]
1575 try:
1576 Value = eval(Value)
1577 except:
1578 Value = Value[1:-1]
1579 List = list(Value)
1580 List.reverse()
1581 Value = 0
1582 for Char in List:
1583 Value = (Value << 16) | ord(Char)
1584 return Value, (len(List) + 1) * 2
1585 if Value.startswith('"') and Value.endswith('"'):
1586 # ASCII String
1587 # translate escape character
1588 try:
1589 Value = eval(Value)
1590 except:
1591 Value = Value[1:-1]
1592 List = list(Value)
1593 List.reverse()
1594 Value = 0
1595 for Char in List:
1596 Value = (Value << 8) | ord(Char)
1597 return Value, len(List) + 1
1598 if Value.startswith("L'") and Value.endswith("'"):
1599 # Unicode Character Constant
1600 # translate escape character
1601 Value = Value[1:]
1602 try:
1603 Value = eval(Value)
1604 except:
1605 Value = Value[1:-1]
1606 List = list(Value)
1607 if len(List) == 0:
1608 raise BadExpression('Length %s is %s' % (Value, len(List)))
1609 List.reverse()
1610 Value = 0
1611 for Char in List:
1612 Value = (Value << 16) | ord(Char)
1613 return Value, len(List) * 2
1614 if Value.startswith("'") and Value.endswith("'"):
1615 # Character constant
1616 # translate escape character
1617 try:
1618 Value = eval(Value)
1619 except:
1620 Value = Value[1:-1]
1621 List = list(Value)
1622 if len(List) == 0:
1623 raise BadExpression('Length %s is %s' % (Value, len(List)))
1624 List.reverse()
1625 Value = 0
1626 for Char in List:
1627 Value = (Value << 8) | ord(Char)
1628 return Value, len(List)
1629 if Value.startswith('{') and Value.endswith('}'):
1630 # Byte array
1631 Value = Value[1:-1]
1632 List = [Item.strip() for Item in Value.split(',')]
1633 List.reverse()
1634 Value = 0
1635 RetSize = 0
1636 for Item in List:
1637 ItemValue, Size = ParseFieldValue(Item)
1638 RetSize += Size
1639 for I in range(Size):
1640 Value = (Value << 8) | ((ItemValue >> 8 * I) & 0xff)
1641 return Value, RetSize
1642 if Value.startswith('DEVICE_PATH(') and Value.endswith(')'):
1643 Value = Value.replace("DEVICE_PATH(", '').rstrip(')')
1644 Value = Value.strip().strip('"')
1645 return ParseDevPathValue(Value)
1646 if Value.lower().startswith('0x'):
1647 Value = int(Value, 16)
1648 if Value == 0:
1649 return 0, 1
1650 return Value, (Value.bit_length() + 7) / 8
1651 if Value[0].isdigit():
1652 Value = int(Value, 10)
1653 if Value == 0:
1654 return 0, 1
1655 return Value, (Value.bit_length() + 7) / 8
1656 if Value.lower() == 'true':
1657 return 1, 1
1658 if Value.lower() == 'false':
1659 return 0, 1
1660 return Value, 1
1661
1662 ## AnalyzeDscPcd
1663 #
1664 # Analyze DSC PCD value, since there is no data type info in DSC
1665 # This fuction is used to match functions (AnalyzePcdData, AnalyzeHiiPcdData, AnalyzeVpdPcdData) used for retrieving PCD value from database
1666 # 1. Feature flag: TokenSpace.PcdCName|PcdValue
1667 # 2. Fix and Patch:TokenSpace.PcdCName|PcdValue[|MaxSize]
1668 # 3. Dynamic default:
1669 # TokenSpace.PcdCName|PcdValue[|VOID*[|MaxSize]]
1670 # TokenSpace.PcdCName|PcdValue
1671 # 4. Dynamic VPD:
1672 # TokenSpace.PcdCName|VpdOffset[|VpdValue]
1673 # TokenSpace.PcdCName|VpdOffset[|MaxSize[|VpdValue]]
1674 # 5. Dynamic HII:
1675 # TokenSpace.PcdCName|HiiString|VaiableGuid|VariableOffset[|HiiValue]
1676 # PCD value needs to be located in such kind of string, and the PCD value might be an expression in which
1677 # there might have "|" operator, also in string value.
1678 #
1679 # @param Setting: String contain information described above with "TokenSpace.PcdCName|" stripped
1680 # @param PcdType: PCD type: feature, fixed, dynamic default VPD HII
1681 # @param DataType: The datum type of PCD: VOID*, UNIT, BOOL
1682 # @retval:
1683 # ValueList: A List contain fields described above
1684 # IsValid: True if conforming EBNF, otherwise False
1685 # Index: The index where PcdValue is in ValueList
1686 #
1687 def AnalyzeDscPcd(Setting, PcdType, DataType=''):
1688 FieldList = AnalyzePcdExpression(Setting)
1689
1690 IsValid = True
1691 if PcdType in (MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, MODEL_PCD_FEATURE_FLAG):
1692 Value = FieldList[0]
1693 Size = ''
1694 if len(FieldList) > 1:
1695 if FieldList[1].upper().startswith("0X") or FieldList[1].isdigit():
1696 Size = FieldList[1]
1697 else:
1698 DataType = FieldList[1]
1699
1700 if len(FieldList) > 2:
1701 Size = FieldList[2]
1702 if DataType == "":
1703 IsValid = (len(FieldList) <= 1)
1704 else:
1705 IsValid = (len(FieldList) <= 3)
1706 # Value, Size = ParseFieldValue(Value)
1707 if Size:
1708 try:
1709 int(Size,16) if Size.upper().startswith("0X") else int(Size)
1710 except:
1711 IsValid = False
1712 Size = -1
1713 return [str(Value), '', str(Size)], IsValid, 0
1714 elif PcdType in (MODEL_PCD_DYNAMIC_DEFAULT, MODEL_PCD_DYNAMIC_EX_DEFAULT):
1715 Value = FieldList[0]
1716 Size = Type = ''
1717 if len(FieldList) > 1:
1718 Type = FieldList[1]
1719 else:
1720 Type = DataType
1721 if len(FieldList) > 2:
1722 Size = FieldList[2]
1723 if DataType == "":
1724 IsValid = (len(FieldList) <= 1)
1725 else:
1726 IsValid = (len(FieldList) <= 3)
1727
1728 if Size:
1729 try:
1730 int(Size,16) if Size.upper().startswith("0X") else int(Size)
1731 except:
1732 IsValid = False
1733 Size = -1
1734 return [Value, Type, str(Size)], IsValid, 0
1735 elif PcdType in (MODEL_PCD_DYNAMIC_VPD, MODEL_PCD_DYNAMIC_EX_VPD):
1736 VpdOffset = FieldList[0]
1737 Value = Size = ''
1738 if not DataType == 'VOID*':
1739 if len(FieldList) > 1:
1740 Value = FieldList[1]
1741 else:
1742 if len(FieldList) > 1:
1743 Size = FieldList[1]
1744 if len(FieldList) > 2:
1745 Value = FieldList[2]
1746 if DataType == "":
1747 IsValid = (len(FieldList) <= 1)
1748 else:
1749 IsValid = (len(FieldList) <= 3)
1750 if Size:
1751 try:
1752 int(Size,16) if Size.upper().startswith("0X") else int(Size)
1753 except:
1754 IsValid = False
1755 Size = -1
1756 return [VpdOffset, str(Size), Value], IsValid, 2
1757 elif PcdType in (MODEL_PCD_DYNAMIC_HII, MODEL_PCD_DYNAMIC_EX_HII):
1758 HiiString = FieldList[0]
1759 Guid = Offset = Value = Attribute = ''
1760 if len(FieldList) > 1:
1761 Guid = FieldList[1]
1762 if len(FieldList) > 2:
1763 Offset = FieldList[2]
1764 if len(FieldList) > 3:
1765 Value = FieldList[3]
1766 if len(FieldList) > 4:
1767 Attribute = FieldList[4]
1768 IsValid = (3 <= len(FieldList) <= 5)
1769 return [HiiString, Guid, Offset, Value, Attribute], IsValid, 3
1770 return [], False, 0
1771
1772 ## AnalyzePcdData
1773 #
1774 # Analyze the pcd Value, Datum type and TokenNumber.
1775 # Used to avoid split issue while the value string contain "|" character
1776 #
1777 # @param[in] Setting: A String contain value/datum type/token number information;
1778 #
1779 # @retval ValueList: A List contain value, datum type and toke number.
1780 #
1781 def AnalyzePcdData(Setting):
1782 ValueList = ['', '', '']
1783
1784 ValueRe = re.compile(r'^\s*L?\".*\|.*\"')
1785 PtrValue = ValueRe.findall(Setting)
1786
1787 ValueUpdateFlag = False
1788
1789 if len(PtrValue) >= 1:
1790 Setting = re.sub(ValueRe, '', Setting)
1791 ValueUpdateFlag = True
1792
1793 TokenList = Setting.split(TAB_VALUE_SPLIT)
1794 ValueList[0:len(TokenList)] = TokenList
1795
1796 if ValueUpdateFlag:
1797 ValueList[0] = PtrValue[0]
1798
1799 return ValueList
1800
1801 ## AnalyzeHiiPcdData
1802 #
1803 # Analyze the pcd Value, variable name, variable Guid and variable offset.
1804 # Used to avoid split issue while the value string contain "|" character
1805 #
1806 # @param[in] Setting: A String contain VariableName, VariableGuid, VariableOffset, DefaultValue information;
1807 #
1808 # @retval ValueList: A List contaian VariableName, VariableGuid, VariableOffset, DefaultValue.
1809 #
1810 def AnalyzeHiiPcdData(Setting):
1811 ValueList = ['', '', '', '']
1812
1813 TokenList = GetSplitValueList(Setting)
1814 ValueList[0:len(TokenList)] = TokenList
1815
1816 return ValueList
1817
1818 ## AnalyzeVpdPcdData
1819 #
1820 # Analyze the vpd pcd VpdOffset, MaxDatumSize and InitialValue.
1821 # Used to avoid split issue while the value string contain "|" character
1822 #
1823 # @param[in] Setting: A String contain VpdOffset/MaxDatumSize/InitialValue information;
1824 #
1825 # @retval ValueList: A List contain VpdOffset, MaxDatumSize and InitialValue.
1826 #
1827 def AnalyzeVpdPcdData(Setting):
1828 ValueList = ['', '', '']
1829
1830 ValueRe = re.compile(r'\s*L?\".*\|.*\"\s*$')
1831 PtrValue = ValueRe.findall(Setting)
1832
1833 ValueUpdateFlag = False
1834
1835 if len(PtrValue) >= 1:
1836 Setting = re.sub(ValueRe, '', Setting)
1837 ValueUpdateFlag = True
1838
1839 TokenList = Setting.split(TAB_VALUE_SPLIT)
1840 ValueList[0:len(TokenList)] = TokenList
1841
1842 if ValueUpdateFlag:
1843 ValueList[2] = PtrValue[0]
1844
1845 return ValueList
1846
1847 ## check format of PCD value against its the datum type
1848 #
1849 # For PCD value setting
1850 #
1851 def CheckPcdDatum(Type, Value):
1852 if Type == "VOID*":
1853 ValueRe = re.compile(r'\s*L?\".*\"\s*$')
1854 if not (((Value.startswith('L"') or Value.startswith('"')) and Value.endswith('"'))
1855 or (Value.startswith('{') and Value.endswith('}')) or (Value.startswith("L'") or Value.startswith("'") and Value.endswith("'"))
1856 ):
1857 return False, "Invalid value [%s] of type [%s]; must be in the form of {...} for array"\
1858 ", \"...\" or \'...\' for string, L\"...\" or L\'...\' for unicode string" % (Value, Type)
1859 elif ValueRe.match(Value):
1860 # Check the chars in UnicodeString or CString is printable
1861 if Value.startswith("L"):
1862 Value = Value[2:-1]
1863 else:
1864 Value = Value[1:-1]
1865 Printset = set(string.printable)
1866 Printset.remove(TAB_PRINTCHAR_VT)
1867 Printset.add(TAB_PRINTCHAR_BS)
1868 Printset.add(TAB_PRINTCHAR_NUL)
1869 if not set(Value).issubset(Printset):
1870 PrintList = list(Printset)
1871 PrintList.sort()
1872 return False, "Invalid PCD string value of type [%s]; must be printable chars %s." % (Type, PrintList)
1873 elif Type == 'BOOLEAN':
1874 if Value not in ['TRUE', 'True', 'true', '0x1', '0x01', '1', 'FALSE', 'False', 'false', '0x0', '0x00', '0']:
1875 return False, "Invalid value [%s] of type [%s]; must be one of TRUE, True, true, 0x1, 0x01, 1"\
1876 ", FALSE, False, false, 0x0, 0x00, 0" % (Value, Type)
1877 elif Type in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64]:
1878 try:
1879 Value = long(Value, 0)
1880 except:
1881 return False, "Invalid value [%s] of type [%s];"\
1882 " must be a hexadecimal, decimal or octal in C language format." % (Value, Type)
1883 else:
1884 return True, "StructurePcd"
1885
1886 return True, ""
1887
1888 ## Split command line option string to list
1889 #
1890 # subprocess.Popen needs the args to be a sequence. Otherwise there's problem
1891 # in non-windows platform to launch command
1892 #
1893 def SplitOption(OptionString):
1894 OptionList = []
1895 LastChar = " "
1896 OptionStart = 0
1897 QuotationMark = ""
1898 for Index in range(0, len(OptionString)):
1899 CurrentChar = OptionString[Index]
1900 if CurrentChar in ['"', "'"]:
1901 if QuotationMark == CurrentChar:
1902 QuotationMark = ""
1903 elif QuotationMark == "":
1904 QuotationMark = CurrentChar
1905 continue
1906 elif QuotationMark:
1907 continue
1908
1909 if CurrentChar in ["/", "-"] and LastChar in [" ", "\t", "\r", "\n"]:
1910 if Index > OptionStart:
1911 OptionList.append(OptionString[OptionStart:Index - 1])
1912 OptionStart = Index
1913 LastChar = CurrentChar
1914 OptionList.append(OptionString[OptionStart:])
1915 return OptionList
1916
1917 def CommonPath(PathList):
1918 P1 = min(PathList).split(os.path.sep)
1919 P2 = max(PathList).split(os.path.sep)
1920 for Index in xrange(min(len(P1), len(P2))):
1921 if P1[Index] != P2[Index]:
1922 return os.path.sep.join(P1[:Index])
1923 return os.path.sep.join(P1)
1924
1925 #
1926 # Convert string to C format array
1927 #
1928 def ConvertStringToByteArray(Value):
1929 Value = Value.strip()
1930 if not Value:
1931 return None
1932 if Value[0] == '{':
1933 if not Value.endswith('}'):
1934 return None
1935 Value = Value.replace(' ', '').replace('{', '').replace('}', '')
1936 ValFields = Value.split(',')
1937 try:
1938 for Index in range(len(ValFields)):
1939 ValFields[Index] = str(int(ValFields[Index], 0))
1940 except ValueError:
1941 return None
1942 Value = '{' + ','.join(ValFields) + '}'
1943 return Value
1944
1945 Unicode = False
1946 if Value.startswith('L"'):
1947 if not Value.endswith('"'):
1948 return None
1949 Value = Value[1:]
1950 Unicode = True
1951 elif not Value.startswith('"') or not Value.endswith('"'):
1952 return None
1953
1954 Value = eval(Value) # translate escape character
1955 NewValue = '{'
1956 for Index in range(0,len(Value)):
1957 if Unicode:
1958 NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ','
1959 else:
1960 NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ','
1961 Value = NewValue + '0}'
1962 return Value
1963
1964 class PathClass(object):
1965 def __init__(self, File='', Root='', AlterRoot='', Type='', IsBinary=False,
1966 Arch='COMMON', ToolChainFamily='', Target='', TagName='', ToolCode=''):
1967 self.Arch = Arch
1968 self.File = str(File)
1969 if os.path.isabs(self.File):
1970 self.Root = ''
1971 self.AlterRoot = ''
1972 else:
1973 self.Root = str(Root)
1974 self.AlterRoot = str(AlterRoot)
1975
1976 # Remove any '.' and '..' in path
1977 if self.Root:
1978 self.Root = mws.getWs(self.Root, self.File)
1979 self.Path = os.path.normpath(os.path.join(self.Root, self.File))
1980 self.Root = os.path.normpath(CommonPath([self.Root, self.Path]))
1981 # eliminate the side-effect of 'C:'
1982 if self.Root[-1] == ':':
1983 self.Root += os.path.sep
1984 # file path should not start with path separator
1985 if self.Root[-1] == os.path.sep:
1986 self.File = self.Path[len(self.Root):]
1987 else:
1988 self.File = self.Path[len(self.Root) + 1:]
1989 else:
1990 self.Path = os.path.normpath(self.File)
1991
1992 self.SubDir, self.Name = os.path.split(self.File)
1993 self.BaseName, self.Ext = os.path.splitext(self.Name)
1994
1995 if self.Root:
1996 if self.SubDir:
1997 self.Dir = os.path.join(self.Root, self.SubDir)
1998 else:
1999 self.Dir = self.Root
2000 else:
2001 self.Dir = self.SubDir
2002
2003 if IsBinary:
2004 self.Type = Type
2005 else:
2006 self.Type = self.Ext.lower()
2007
2008 self.IsBinary = IsBinary
2009 self.Target = Target
2010 self.TagName = TagName
2011 self.ToolCode = ToolCode
2012 self.ToolChainFamily = ToolChainFamily
2013
2014 self._Key = None
2015
2016 ## Convert the object of this class to a string
2017 #
2018 # Convert member Path of the class to a string
2019 #
2020 # @retval string Formatted String
2021 #
2022 def __str__(self):
2023 return self.Path
2024
2025 ## Override __eq__ function
2026 #
2027 # Check whether PathClass are the same
2028 #
2029 # @retval False The two PathClass are different
2030 # @retval True The two PathClass are the same
2031 #
2032 def __eq__(self, Other):
2033 if type(Other) == type(self):
2034 return self.Path == Other.Path
2035 else:
2036 return self.Path == str(Other)
2037
2038 ## Override __cmp__ function
2039 #
2040 # Customize the comparsion operation of two PathClass
2041 #
2042 # @retval 0 The two PathClass are different
2043 # @retval -1 The first PathClass is less than the second PathClass
2044 # @retval 1 The first PathClass is Bigger than the second PathClass
2045 def __cmp__(self, Other):
2046 if type(Other) == type(self):
2047 OtherKey = Other.Path
2048 else:
2049 OtherKey = str(Other)
2050
2051 SelfKey = self.Path
2052 if SelfKey == OtherKey:
2053 return 0
2054 elif SelfKey > OtherKey:
2055 return 1
2056 else:
2057 return -1
2058
2059 ## Override __hash__ function
2060 #
2061 # Use Path as key in hash table
2062 #
2063 # @retval string Key for hash table
2064 #
2065 def __hash__(self):
2066 return hash(self.Path)
2067
2068 def _GetFileKey(self):
2069 if self._Key == None:
2070 self._Key = self.Path.upper() # + self.ToolChainFamily + self.TagName + self.ToolCode + self.Target
2071 return self._Key
2072
2073 def _GetTimeStamp(self):
2074 return os.stat(self.Path)[8]
2075
2076 def Validate(self, Type='', CaseSensitive=True):
2077 if GlobalData.gCaseInsensitive:
2078 CaseSensitive = False
2079 if Type and Type.lower() != self.Type:
2080 return FILE_TYPE_MISMATCH, '%s (expect %s but got %s)' % (self.File, Type, self.Type)
2081
2082 RealFile, RealRoot = RealPath2(self.File, self.Root, self.AlterRoot)
2083 if not RealRoot and not RealFile:
2084 RealFile = self.File
2085 if self.AlterRoot:
2086 RealFile = os.path.join(self.AlterRoot, self.File)
2087 elif self.Root:
2088 RealFile = os.path.join(self.Root, self.File)
2089 if len (mws.getPkgPath()) == 0:
2090 return FILE_NOT_FOUND, os.path.join(self.AlterRoot, RealFile)
2091 else:
2092 return FILE_NOT_FOUND, "%s is not found in packages path:\n\t%s" % (self.File, '\n\t'.join(mws.getPkgPath()))
2093
2094 ErrorCode = 0
2095 ErrorInfo = ''
2096 if RealRoot != self.Root or RealFile != self.File:
2097 if CaseSensitive and (RealFile != self.File or (RealRoot != self.Root and RealRoot != self.AlterRoot)):
2098 ErrorCode = FILE_CASE_MISMATCH
2099 ErrorInfo = self.File + '\n\t' + RealFile + " [in file system]"
2100
2101 self.SubDir, self.Name = os.path.split(RealFile)
2102 self.BaseName, self.Ext = os.path.splitext(self.Name)
2103 if self.SubDir:
2104 self.Dir = os.path.join(RealRoot, self.SubDir)
2105 else:
2106 self.Dir = RealRoot
2107 self.File = RealFile
2108 self.Root = RealRoot
2109 self.Path = os.path.join(RealRoot, RealFile)
2110 return ErrorCode, ErrorInfo
2111
2112 Key = property(_GetFileKey)
2113 TimeStamp = property(_GetTimeStamp)
2114
2115 ## Parse PE image to get the required PE informaion.
2116 #
2117 class PeImageClass():
2118 ## Constructor
2119 #
2120 # @param File FilePath of PeImage
2121 #
2122 def __init__(self, PeFile):
2123 self.FileName = PeFile
2124 self.IsValid = False
2125 self.Size = 0
2126 self.EntryPoint = 0
2127 self.SectionAlignment = 0
2128 self.SectionHeaderList = []
2129 self.ErrorInfo = ''
2130 try:
2131 PeObject = open(PeFile, 'rb')
2132 except:
2133 self.ErrorInfo = self.FileName + ' can not be found\n'
2134 return
2135 # Read DOS header
2136 ByteArray = array.array('B')
2137 ByteArray.fromfile(PeObject, 0x3E)
2138 ByteList = ByteArray.tolist()
2139 # DOS signature should be 'MZ'
2140 if self._ByteListToStr (ByteList[0x0:0x2]) != 'MZ':
2141 self.ErrorInfo = self.FileName + ' has no valid DOS signature MZ'
2142 return
2143
2144 # Read 4 byte PE Signature
2145 PeOffset = self._ByteListToInt(ByteList[0x3C:0x3E])
2146 PeObject.seek(PeOffset)
2147 ByteArray = array.array('B')
2148 ByteArray.fromfile(PeObject, 4)
2149 # PE signature should be 'PE\0\0'
2150 if ByteArray.tostring() != 'PE\0\0':
2151 self.ErrorInfo = self.FileName + ' has no valid PE signature PE00'
2152 return
2153
2154 # Read PE file header
2155 ByteArray = array.array('B')
2156 ByteArray.fromfile(PeObject, 0x14)
2157 ByteList = ByteArray.tolist()
2158 SecNumber = self._ByteListToInt(ByteList[0x2:0x4])
2159 if SecNumber == 0:
2160 self.ErrorInfo = self.FileName + ' has no section header'
2161 return
2162
2163 # Read PE optional header
2164 OptionalHeaderSize = self._ByteListToInt(ByteArray[0x10:0x12])
2165 ByteArray = array.array('B')
2166 ByteArray.fromfile(PeObject, OptionalHeaderSize)
2167 ByteList = ByteArray.tolist()
2168 self.EntryPoint = self._ByteListToInt(ByteList[0x10:0x14])
2169 self.SectionAlignment = self._ByteListToInt(ByteList[0x20:0x24])
2170 self.Size = self._ByteListToInt(ByteList[0x38:0x3C])
2171
2172 # Read each Section Header
2173 for Index in range(SecNumber):
2174 ByteArray = array.array('B')
2175 ByteArray.fromfile(PeObject, 0x28)
2176 ByteList = ByteArray.tolist()
2177 SecName = self._ByteListToStr(ByteList[0:8])
2178 SecVirtualSize = self._ByteListToInt(ByteList[8:12])
2179 SecRawAddress = self._ByteListToInt(ByteList[20:24])
2180 SecVirtualAddress = self._ByteListToInt(ByteList[12:16])
2181 self.SectionHeaderList.append((SecName, SecVirtualAddress, SecRawAddress, SecVirtualSize))
2182 self.IsValid = True
2183 PeObject.close()
2184
2185 def _ByteListToStr(self, ByteList):
2186 String = ''
2187 for index in range(len(ByteList)):
2188 if ByteList[index] == 0:
2189 break
2190 String += chr(ByteList[index])
2191 return String
2192
2193 def _ByteListToInt(self, ByteList):
2194 Value = 0
2195 for index in range(len(ByteList) - 1, -1, -1):
2196 Value = (Value << 8) | int(ByteList[index])
2197 return Value
2198
2199 class DefaultStore():
2200 def __init__(self,DefaultStores ):
2201
2202 self.DefaultStores = DefaultStores
2203 def DefaultStoreID(self,DefaultStoreName):
2204 for key,value in self.DefaultStores.items():
2205 if value == DefaultStoreName:
2206 return key
2207 return None
2208 def GetDefaultDefault(self):
2209 if not self.DefaultStores or "0" in self.DefaultStores:
2210 return "0",TAB_DEFAULT_STORES_DEFAULT
2211 else:
2212 minvalue = min([int(value_str) for value_str in self.DefaultStores.keys()])
2213 return (str(minvalue), self.DefaultStores[str(minvalue)])
2214 def GetMin(self,DefaultSIdList):
2215 if not DefaultSIdList:
2216 return "STANDARD"
2217 storeidset = {storeid for storeid, storename in self.DefaultStores.values() if storename in DefaultSIdList}
2218 if not storeidset:
2219 return ""
2220 minid = min(storeidset )
2221 for sid,name in self.DefaultStores.values():
2222 if sid == minid:
2223 return name
2224 class SkuClass():
2225
2226 DEFAULT = 0
2227 SINGLE = 1
2228 MULTIPLE =2
2229
2230 def __init__(self,SkuIdentifier='', SkuIds=None):
2231 if SkuIds is None:
2232 SkuIds = {}
2233
2234 for SkuName in SkuIds:
2235 SkuId = SkuIds[SkuName][0]
2236 skuid_num = int(SkuId,16) if SkuId.upper().startswith("0X") else int(SkuId)
2237 if skuid_num > 0xFFFFFFFFFFFFFFFF:
2238 EdkLogger.error("build", PARAMETER_INVALID,
2239 ExtraData = "SKU-ID [%s] value %s exceeds the max value of UINT64"
2240 % (SkuName, SkuId))
2241
2242 self.AvailableSkuIds = sdict()
2243 self.SkuIdSet = []
2244 self.SkuIdNumberSet = []
2245 self.SkuData = SkuIds
2246 self.__SkuInherit = {}
2247 self.__SkuIdentifier = SkuIdentifier
2248 if SkuIdentifier == '' or SkuIdentifier is None:
2249 self.SkuIdSet = ['DEFAULT']
2250 self.SkuIdNumberSet = ['0U']
2251 elif SkuIdentifier == 'ALL':
2252 self.SkuIdSet = SkuIds.keys()
2253 self.SkuIdNumberSet = [num[0].strip() + 'U' for num in SkuIds.values()]
2254 else:
2255 r = SkuIdentifier.split('|')
2256 self.SkuIdSet=[(r[k].strip()).upper() for k in range(len(r))]
2257 k = None
2258 try:
2259 self.SkuIdNumberSet = [SkuIds[k][0].strip() + 'U' for k in self.SkuIdSet]
2260 except Exception:
2261 EdkLogger.error("build", PARAMETER_INVALID,
2262 ExtraData = "SKU-ID [%s] is not supported by the platform. [Valid SKU-ID: %s]"
2263 % (k, " | ".join(SkuIds.keys())))
2264 for each in self.SkuIdSet:
2265 if each in SkuIds:
2266 self.AvailableSkuIds[each] = SkuIds[each][0]
2267 else:
2268 EdkLogger.error("build", PARAMETER_INVALID,
2269 ExtraData="SKU-ID [%s] is not supported by the platform. [Valid SKU-ID: %s]"
2270 % (each, " | ".join(SkuIds.keys())))
2271 if self.SkuUsageType != self.SINGLE:
2272 self.AvailableSkuIds.update({'DEFAULT':0, 'COMMON':0})
2273 if self.SkuIdSet:
2274 GlobalData.gSkuids = (self.SkuIdSet)
2275 if 'COMMON' in GlobalData.gSkuids:
2276 GlobalData.gSkuids.remove('COMMON')
2277 if self.SkuUsageType == self.SINGLE:
2278 if len(GlobalData.gSkuids) != 1:
2279 if 'DEFAULT' in GlobalData.gSkuids:
2280 GlobalData.gSkuids.remove('DEFAULT')
2281 if GlobalData.gSkuids:
2282 GlobalData.gSkuids.sort()
2283
2284 def GetNextSkuId(self, skuname):
2285 if not self.__SkuInherit:
2286 self.__SkuInherit = {}
2287 for item in self.SkuData.values():
2288 self.__SkuInherit[item[1]]=item[2] if item[2] else "DEFAULT"
2289 return self.__SkuInherit.get(skuname,"DEFAULT")
2290
2291 def GetSkuChain(self,sku):
2292 if sku == "DEFAULT":
2293 return ["DEFAULT"]
2294 skulist = [sku]
2295 nextsku = sku
2296 while 1:
2297 nextsku = self.GetNextSkuId(nextsku)
2298 skulist.append(nextsku)
2299 if nextsku == "DEFAULT":
2300 break
2301 skulist.reverse()
2302 return skulist
2303 def SkuOverrideOrder(self):
2304 skuorderset = []
2305 for skuname in self.SkuIdSet:
2306 skuorderset.append(self.GetSkuChain(skuname))
2307
2308 skuorder = []
2309 for index in range(max([len(item) for item in skuorderset])):
2310 for subset in skuorderset:
2311 if index > len(subset)-1:
2312 continue
2313 if subset[index] in skuorder:
2314 continue
2315 skuorder.append(subset[index])
2316
2317 return skuorder
2318
2319 def __SkuUsageType(self):
2320
2321 if self.__SkuIdentifier.upper() == "ALL":
2322 return SkuClass.MULTIPLE
2323
2324 if len(self.SkuIdSet) == 1:
2325 if self.SkuIdSet[0] == 'DEFAULT':
2326 return SkuClass.DEFAULT
2327 else:
2328 return SkuClass.SINGLE
2329 elif len(self.SkuIdSet) == 2:
2330 if 'DEFAULT' in self.SkuIdSet:
2331 return SkuClass.SINGLE
2332 else:
2333 return SkuClass.MULTIPLE
2334 else:
2335 return SkuClass.MULTIPLE
2336 def DumpSkuIdArrary(self):
2337
2338 ArrayStrList = []
2339 if self.SkuUsageType == SkuClass.SINGLE:
2340 ArrayStr = "{0x0}"
2341 else:
2342 for skuname in self.AvailableSkuIds:
2343 if skuname == "COMMON":
2344 continue
2345 while skuname != "DEFAULT":
2346 ArrayStrList.append(hex(int(self.AvailableSkuIds[skuname])))
2347 skuname = self.GetNextSkuId(skuname)
2348 ArrayStrList.append("0x0")
2349 ArrayStr = "{" + ",".join(ArrayStrList) + "}"
2350 return ArrayStr
2351 def __GetAvailableSkuIds(self):
2352 return self.AvailableSkuIds
2353
2354 def __GetSystemSkuID(self):
2355 if self.__SkuUsageType() == SkuClass.SINGLE:
2356 if len(self.SkuIdSet) == 1:
2357 return self.SkuIdSet[0]
2358 else:
2359 return self.SkuIdSet[0] if self.SkuIdSet[0] != 'DEFAULT' else self.SkuIdSet[1]
2360 else:
2361 return 'DEFAULT'
2362 def __GetAvailableSkuIdNumber(self):
2363 return self.SkuIdNumberSet
2364 SystemSkuId = property(__GetSystemSkuID)
2365 AvailableSkuIdSet = property(__GetAvailableSkuIds)
2366 SkuUsageType = property(__SkuUsageType)
2367 AvailableSkuIdNumSet = property(__GetAvailableSkuIdNumber)
2368
2369 #
2370 # Pack a registry format GUID
2371 #
2372 def PackRegistryFormatGuid(Guid):
2373 Guid = Guid.split('-')
2374 return pack('=LHHBBBBBBBB',
2375 int(Guid[0], 16),
2376 int(Guid[1], 16),
2377 int(Guid[2], 16),
2378 int(Guid[3][-4:-2], 16),
2379 int(Guid[3][-2:], 16),
2380 int(Guid[4][-12:-10], 16),
2381 int(Guid[4][-10:-8], 16),
2382 int(Guid[4][-8:-6], 16),
2383 int(Guid[4][-6:-4], 16),
2384 int(Guid[4][-4:-2], 16),
2385 int(Guid[4][-2:], 16)
2386 )
2387
2388 ## Get the integer value from string like "14U" or integer like 2
2389 #
2390 # @param Input The object that may be either a integer value or a string
2391 #
2392 # @retval Value The integer value that the input represents
2393 #
2394 def GetIntegerValue(Input):
2395 if type(Input) in (int, long):
2396 return Input
2397 String = Input
2398 if String.endswith("U"):
2399 String = String[:-1]
2400 if String.endswith("ULL"):
2401 String = String[:-3]
2402 if String.endswith("LL"):
2403 String = String[:-2]
2404
2405 if String.startswith("0x") or String.startswith("0X"):
2406 return int(String, 16)
2407 elif String == '':
2408 return 0
2409 else:
2410 return int(String)
2411
2412 ##
2413 #
2414 # This acts like the main() function for the script, unless it is 'import'ed into another
2415 # script.
2416 #
2417 if __name__ == '__main__':
2418 pass
2419