]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools: Fix VPD data optimization issue
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
1 ## @file
2 # Generate AutoGen.h, AutoGen.c and *.depex files
3 #
4 # Copyright (c) 2007 - 2017, 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 ## Import Modules
15 #
16 import Common.LongFilePathOs as os
17 import re
18 import os.path as path
19 import copy
20 import uuid
21
22 import GenC
23 import GenMake
24 import GenDepex
25 from StringIO import StringIO
26
27 from StrGather import *
28 from BuildEngine import BuildRule
29
30 from Common.LongFilePathSupport import CopyLongFilePath
31 from Common.BuildToolError import *
32 from Common.DataType import *
33 from Common.Misc import *
34 from Common.String import *
35 import Common.GlobalData as GlobalData
36 from GenFds.FdfParser import *
37 from CommonDataClass.CommonClass import SkuInfoClass
38 from Workspace.BuildClassObject import *
39 from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile
40 import Common.VpdInfoFile as VpdInfoFile
41 from GenPcdDb import CreatePcdDatabaseCode
42 from Workspace.MetaFileCommentParser import UsageList
43 from Common.MultipleWorkspace import MultipleWorkspace as mws
44 import InfSectionParser
45 import datetime
46 import hashlib
47 from GenVar import VariableMgr,var_info
48
49 ## Regular expression for splitting Dependency Expression string into tokens
50 gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")
51
52 #
53 # Match name = variable
54 #
55 gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")
56 #
57 # The format of guid in efivarstore statement likes following and must be correct:
58 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
59 #
60 gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
61
62 ## Mapping Makefile type
63 gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}
64
65
66 ## Build rule configuration file
67 gDefaultBuildRuleFile = 'build_rule.txt'
68
69 ## Tools definition configuration file
70 gDefaultToolsDefFile = 'tools_def.txt'
71
72 ## Build rule default version
73 AutoGenReqBuildRuleVerNum = "0.1"
74
75 ## default file name for AutoGen
76 gAutoGenCodeFileName = "AutoGen.c"
77 gAutoGenHeaderFileName = "AutoGen.h"
78 gAutoGenStringFileName = "%(module_name)sStrDefs.h"
79 gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"
80 gAutoGenDepexFileName = "%(module_name)s.depex"
81 gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"
82 gAutoGenIdfFileName = "%(module_name)sIdf.hpk"
83 gInfSpecVersion = "0x00010017"
84
85 #
86 # Template string to generic AsBuilt INF
87 #
88 gAsBuiltInfHeaderString = TemplateString("""${header_comments}
89
90 # DO NOT EDIT
91 # FILE auto-generated
92
93 [Defines]
94 INF_VERSION = ${module_inf_version}
95 BASE_NAME = ${module_name}
96 FILE_GUID = ${module_guid}
97 MODULE_TYPE = ${module_module_type}${BEGIN}
98 VERSION_STRING = ${module_version_string}${END}${BEGIN}
99 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
100 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
101 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
102 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
103 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
104 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
105 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
106 SHADOW = ${module_shadow}${END}${BEGIN}
107 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
108 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
109 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
110 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
111 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
112 SPEC = ${module_spec}${END}${BEGIN}
113 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
114 MODULE_UNI_FILE = ${module_uni_file}${END}
115
116 [Packages.${module_arch}]${BEGIN}
117 ${package_item}${END}
118
119 [Binaries.${module_arch}]${BEGIN}
120 ${binary_item}${END}
121
122 [PatchPcd.${module_arch}]${BEGIN}
123 ${patchablepcd_item}
124 ${END}
125
126 [Protocols.${module_arch}]${BEGIN}
127 ${protocol_item}
128 ${END}
129
130 [Ppis.${module_arch}]${BEGIN}
131 ${ppi_item}
132 ${END}
133
134 [Guids.${module_arch}]${BEGIN}
135 ${guid_item}
136 ${END}
137
138 [PcdEx.${module_arch}]${BEGIN}
139 ${pcd_item}
140 ${END}
141
142 [LibraryClasses.${module_arch}]
143 ## @LIB_INSTANCES${BEGIN}
144 # ${libraryclasses_item}${END}
145
146 ${depexsection_item}
147
148 ${userextension_tianocore_item}
149
150 ${tail_comments}
151
152 [BuildOptions.${module_arch}]
153 ## @AsBuilt${BEGIN}
154 ## ${flags_item}${END}
155 """)
156
157 ## Base class for AutoGen
158 #
159 # This class just implements the cache mechanism of AutoGen objects.
160 #
161 class AutoGen(object):
162 # database to maintain the objects of xxxAutoGen
163 _CACHE_ = {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}
164
165 ## Factory method
166 #
167 # @param Class class object of real AutoGen class
168 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
169 # @param Workspace Workspace directory or WorkspaceAutoGen object
170 # @param MetaFile The path of meta file
171 # @param Target Build target
172 # @param Toolchain Tool chain name
173 # @param Arch Target arch
174 # @param *args The specific class related parameters
175 # @param **kwargs The specific class related dict parameters
176 #
177 def __new__(Class, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
178 # check if the object has been created
179 Key = (Target, Toolchain)
180 if Key not in Class._CACHE_ or Arch not in Class._CACHE_[Key] \
181 or MetaFile not in Class._CACHE_[Key][Arch]:
182 AutoGenObject = super(AutoGen, Class).__new__(Class)
183 # call real constructor
184 if not AutoGenObject._Init(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
185 return None
186 if Key not in Class._CACHE_:
187 Class._CACHE_[Key] = {}
188 if Arch not in Class._CACHE_[Key]:
189 Class._CACHE_[Key][Arch] = {}
190 Class._CACHE_[Key][Arch][MetaFile] = AutoGenObject
191 else:
192 AutoGenObject = Class._CACHE_[Key][Arch][MetaFile]
193
194 return AutoGenObject
195
196 ## hash() operator
197 #
198 # The file path of platform file will be used to represent hash value of this object
199 #
200 # @retval int Hash value of the file path of platform file
201 #
202 def __hash__(self):
203 return hash(self.MetaFile)
204
205 ## str() operator
206 #
207 # The file path of platform file will be used to represent this object
208 #
209 # @retval string String of platform file path
210 #
211 def __str__(self):
212 return str(self.MetaFile)
213
214 ## "==" operator
215 def __eq__(self, Other):
216 return Other and self.MetaFile == Other
217
218 ## Workspace AutoGen class
219 #
220 # This class is used mainly to control the whole platform build for different
221 # architecture. This class will generate top level makefile.
222 #
223 class WorkspaceAutoGen(AutoGen):
224 ## Real constructor of WorkspaceAutoGen
225 #
226 # This method behaves the same as __init__ except that it needs explicit invoke
227 # (in super class's __new__ method)
228 #
229 # @param WorkspaceDir Root directory of workspace
230 # @param ActivePlatform Meta-file of active platform
231 # @param Target Build target
232 # @param Toolchain Tool chain name
233 # @param ArchList List of architecture of current build
234 # @param MetaFileDb Database containing meta-files
235 # @param BuildConfig Configuration of build
236 # @param ToolDefinition Tool chain definitions
237 # @param FlashDefinitionFile File of flash definition
238 # @param Fds FD list to be generated
239 # @param Fvs FV list to be generated
240 # @param Caps Capsule list to be generated
241 # @param SkuId SKU id from command line
242 #
243 def _Init(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,
244 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,
245 Progress=None, BuildModule=None):
246 if Fds is None:
247 Fds = []
248 if Fvs is None:
249 Fvs = []
250 if Caps is None:
251 Caps = []
252 self.BuildDatabase = MetaFileDb
253 self.MetaFile = ActivePlatform
254 self.WorkspaceDir = WorkspaceDir
255 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]
256 GlobalData.gActivePlatform = self.Platform
257 self.BuildTarget = Target
258 self.ToolChain = Toolchain
259 self.ArchList = ArchList
260 self.SkuId = SkuId
261 self.UniFlag = UniFlag
262
263 self.TargetTxt = BuildConfig
264 self.ToolDef = ToolDefinition
265 self.FdfFile = FlashDefinitionFile
266 self.FdTargetList = Fds
267 self.FvTargetList = Fvs
268 self.CapTargetList = Caps
269 self.AutoGenObjectList = []
270 self._BuildDir = None
271 self._FvDir = None
272 self._MakeFileDir = None
273 self._BuildCommand = None
274
275 # there's many relative directory operations, so ...
276 os.chdir(self.WorkspaceDir)
277
278 #
279 # Merge Arch
280 #
281 if not self.ArchList:
282 ArchList = set(self.Platform.SupArchList)
283 else:
284 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)
285 if not ArchList:
286 EdkLogger.error("build", PARAMETER_INVALID,
287 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))
288 elif self.ArchList and len(ArchList) != len(self.ArchList):
289 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))
290 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
291 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))
292 self.ArchList = tuple(ArchList)
293
294 # Validate build target
295 if self.BuildTarget not in self.Platform.BuildTargets:
296 EdkLogger.error("build", PARAMETER_INVALID,
297 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"
298 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))
299
300
301 # parse FDF file to get PCDs in it, if any
302 if not self.FdfFile:
303 self.FdfFile = self.Platform.FlashDefinition
304
305 EdkLogger.info("")
306 if self.ArchList:
307 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))
308 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))
309 EdkLogger.info('%-16s = %s' % ("Toolchain", self.ToolChain))
310
311 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))
312 if BuildModule:
313 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))
314
315 if self.FdfFile:
316 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))
317
318 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)
319
320 # if Progress:
321 # Progress.Start("\nProcessing meta-data")
322
323 if self.FdfFile:
324 #
325 # Mark now build in AutoGen Phase
326 #
327 GlobalData.gAutoGenPhase = True
328 Fdf = FdfParser(self.FdfFile.Path)
329 Fdf.ParseFile()
330 GlobalData.gFdfParser = Fdf
331 GlobalData.gAutoGenPhase = False
332 PcdSet = Fdf.Profile.PcdDict
333 if Fdf.CurrentFdName and Fdf.CurrentFdName in Fdf.Profile.FdDict:
334 FdDict = Fdf.Profile.FdDict[Fdf.CurrentFdName]
335 for FdRegion in FdDict.RegionList:
336 if str(FdRegion.RegionType) is 'FILE' and self.Platform.VpdToolGuid in str(FdRegion.RegionDataList):
337 if int(FdRegion.Offset) % 8 != 0:
338 EdkLogger.error("build", FORMAT_INVALID, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion.Offset))
339 ModuleList = Fdf.Profile.InfList
340 self.FdfProfile = Fdf.Profile
341 for fvname in self.FvTargetList:
342 if fvname.upper() not in self.FdfProfile.FvDict:
343 EdkLogger.error("build", OPTION_VALUE_INVALID,
344 "No such an FV in FDF file: %s" % fvname)
345
346 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
347 # but the path (self.MetaFile.Path) is the real path
348 for key in self.FdfProfile.InfDict:
349 if key == 'ArchTBD':
350 Platform_cache = {}
351 MetaFile_cache = {}
352 for Arch in self.ArchList:
353 Platform_cache[Arch] = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
354 MetaFile_cache[Arch] = []
355 for Pkey in Platform_cache[Arch].Modules.keys():
356 MetaFile_cache[Arch].append(Platform_cache[Arch].Modules[Pkey].MetaFile)
357 for Inf in self.FdfProfile.InfDict[key]:
358 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
359 for Arch in self.ArchList:
360 if ModuleFile in MetaFile_cache[Arch]:
361 break
362 else:
363 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
364 if not ModuleData.IsBinaryModule:
365 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
366
367 else:
368 for Arch in self.ArchList:
369 if Arch == key:
370 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
371 MetaFileList = []
372 for Pkey in Platform.Modules.keys():
373 MetaFileList.append(Platform.Modules[Pkey].MetaFile)
374 for Inf in self.FdfProfile.InfDict[key]:
375 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
376 if ModuleFile in MetaFileList:
377 continue
378 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
379 if not ModuleData.IsBinaryModule:
380 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
381
382 else:
383 PcdSet = {}
384 ModuleList = []
385 self.FdfProfile = None
386 if self.FdTargetList:
387 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))
388 self.FdTargetList = []
389 if self.FvTargetList:
390 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))
391 self.FvTargetList = []
392 if self.CapTargetList:
393 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))
394 self.CapTargetList = []
395
396 # apply SKU and inject PCDs from Flash Definition file
397 for Arch in self.ArchList:
398 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
399
400 DecPcds = {}
401 DecPcdsKey = set()
402 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
403 if GlobalData.BuildOptionPcd:
404 for i, pcd in enumerate(GlobalData.BuildOptionPcd):
405 if type(pcd) is tuple:
406 continue
407 (pcdname, pcdvalue) = pcd.split('=')
408 if not pcdvalue:
409 EdkLogger.error('build', AUTOGEN_ERROR, "No Value specified for the PCD %s." % (pcdname))
410 if '.' in pcdname:
411 (TokenSpaceGuidCName, TokenCName) = pcdname.split('.')
412 HasTokenSpace = True
413 else:
414 TokenCName = pcdname
415 TokenSpaceGuidCName = ''
416 HasTokenSpace = False
417 TokenSpaceGuidCNameList = []
418 FoundFlag = False
419 PcdDatumType = ''
420 NewValue = ''
421 for package in PGen.PackageList:
422 for key in package.Pcds:
423 PcdItem = package.Pcds[key]
424 if HasTokenSpace:
425 if (PcdItem.TokenCName, PcdItem.TokenSpaceGuidCName) == (TokenCName, TokenSpaceGuidCName):
426 PcdDatumType = PcdItem.DatumType
427 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)
428 FoundFlag = True
429 else:
430 if PcdItem.TokenCName == TokenCName:
431 if not PcdItem.TokenSpaceGuidCName in TokenSpaceGuidCNameList:
432 if len (TokenSpaceGuidCNameList) < 1:
433 TokenSpaceGuidCNameList.append(PcdItem.TokenSpaceGuidCName)
434 PcdDatumType = PcdItem.DatumType
435 TokenSpaceGuidCName = PcdItem.TokenSpaceGuidCName
436 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)
437 FoundFlag = True
438 else:
439 EdkLogger.error(
440 'build',
441 AUTOGEN_ERROR,
442 "The Pcd %s is found under multiple different TokenSpaceGuid: %s and %s." % (TokenCName, PcdItem.TokenSpaceGuidCName, TokenSpaceGuidCNameList[0])
443 )
444
445 GlobalData.BuildOptionPcd[i] = (TokenSpaceGuidCName, TokenCName, NewValue)
446
447 if not FoundFlag:
448 if HasTokenSpace:
449 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s.%s is not found in the DEC file." % (TokenSpaceGuidCName, TokenCName))
450 else:
451 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s is not found in the DEC file." % (TokenCName))
452
453 for BuildData in PGen.BuildDatabase._CACHE_.values():
454 if BuildData.Arch != Arch:
455 continue
456 if BuildData.MetaFile.Ext == '.dec':
457 continue
458 for key in BuildData.Pcds:
459 PcdItem = BuildData.Pcds[key]
460 if (TokenSpaceGuidCName, TokenCName) == (PcdItem.TokenSpaceGuidCName, PcdItem.TokenCName):
461 PcdItem.DefaultValue = NewValue
462
463 if (TokenCName, TokenSpaceGuidCName) in PcdSet:
464 PcdSet[(TokenCName, TokenSpaceGuidCName)] = NewValue
465
466 SourcePcdDict = {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}
467 BinaryPcdDict = {'DynamicEx':[], 'PatchableInModule':[]}
468 SourcePcdDict_Keys = SourcePcdDict.keys()
469 BinaryPcdDict_Keys = BinaryPcdDict.keys()
470
471 # generate the SourcePcdDict and BinaryPcdDict
472 for BuildData in PGen.BuildDatabase._CACHE_.values():
473 if BuildData.Arch != Arch:
474 continue
475 if BuildData.MetaFile.Ext == '.inf':
476 for key in BuildData.Pcds:
477 if BuildData.Pcds[key].Pending:
478 if key in Platform.Pcds:
479 PcdInPlatform = Platform.Pcds[key]
480 if PcdInPlatform.Type not in [None, '']:
481 BuildData.Pcds[key].Type = PcdInPlatform.Type
482
483 if BuildData.MetaFile in Platform.Modules:
484 PlatformModule = Platform.Modules[str(BuildData.MetaFile)]
485 if key in PlatformModule.Pcds:
486 PcdInPlatform = PlatformModule.Pcds[key]
487 if PcdInPlatform.Type not in [None, '']:
488 BuildData.Pcds[key].Type = PcdInPlatform.Type
489
490 if 'DynamicEx' in BuildData.Pcds[key].Type:
491 if BuildData.IsBinaryModule:
492 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['DynamicEx']:
493 BinaryPcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
494 else:
495 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['DynamicEx']:
496 SourcePcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
497
498 elif 'PatchableInModule' in BuildData.Pcds[key].Type:
499 if BuildData.MetaFile.Ext == '.inf':
500 if BuildData.IsBinaryModule:
501 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['PatchableInModule']:
502 BinaryPcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
503 else:
504 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['PatchableInModule']:
505 SourcePcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
506
507 elif 'Dynamic' in BuildData.Pcds[key].Type:
508 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['Dynamic']:
509 SourcePcdDict['Dynamic'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
510 elif 'FixedAtBuild' in BuildData.Pcds[key].Type:
511 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['FixedAtBuild']:
512 SourcePcdDict['FixedAtBuild'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
513 else:
514 pass
515 #
516 # A PCD can only use one type for all source modules
517 #
518 for i in SourcePcdDict_Keys:
519 for j in SourcePcdDict_Keys:
520 if i != j:
521 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(SourcePcdDict[j])))
522 if len(IntersectionList) > 0:
523 EdkLogger.error(
524 'build',
525 FORMAT_INVALID,
526 "Building modules from source INFs, following PCD use %s and %s access method. It must be corrected to use only one access method." % (i, j),
527 ExtraData="%s" % '\n\t'.join([str(P[1]+'.'+P[0]) for P in IntersectionList])
528 )
529 else:
530 pass
531
532 #
533 # intersection the BinaryPCD for Mixed PCD
534 #
535 for i in BinaryPcdDict_Keys:
536 for j in BinaryPcdDict_Keys:
537 if i != j:
538 IntersectionList = list(set(BinaryPcdDict[i]).intersection(set(BinaryPcdDict[j])))
539 for item in IntersectionList:
540 NewPcd1 = (item[0] + '_' + i, item[1])
541 NewPcd2 = (item[0] + '_' + j, item[1])
542 if item not in GlobalData.MixedPcd:
543 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
544 else:
545 if NewPcd1 not in GlobalData.MixedPcd[item]:
546 GlobalData.MixedPcd[item].append(NewPcd1)
547 if NewPcd2 not in GlobalData.MixedPcd[item]:
548 GlobalData.MixedPcd[item].append(NewPcd2)
549 else:
550 pass
551
552 #
553 # intersection the SourcePCD and BinaryPCD for Mixed PCD
554 #
555 for i in SourcePcdDict_Keys:
556 for j in BinaryPcdDict_Keys:
557 if i != j:
558 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(BinaryPcdDict[j])))
559 for item in IntersectionList:
560 NewPcd1 = (item[0] + '_' + i, item[1])
561 NewPcd2 = (item[0] + '_' + j, item[1])
562 if item not in GlobalData.MixedPcd:
563 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
564 else:
565 if NewPcd1 not in GlobalData.MixedPcd[item]:
566 GlobalData.MixedPcd[item].append(NewPcd1)
567 if NewPcd2 not in GlobalData.MixedPcd[item]:
568 GlobalData.MixedPcd[item].append(NewPcd2)
569 else:
570 pass
571
572 for BuildData in PGen.BuildDatabase._CACHE_.values():
573 if BuildData.Arch != Arch:
574 continue
575 for key in BuildData.Pcds:
576 for SinglePcd in GlobalData.MixedPcd:
577 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
578 for item in GlobalData.MixedPcd[SinglePcd]:
579 Pcd_Type = item[0].split('_')[-1]
580 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in GenC.gDynamicExPcd) or \
581 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in GenC.gDynamicPcd):
582 Value = BuildData.Pcds[key]
583 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type
584 if len(key) == 2:
585 newkey = (Value.TokenCName, key[1])
586 elif len(key) == 3:
587 newkey = (Value.TokenCName, key[1], key[2])
588 del BuildData.Pcds[key]
589 BuildData.Pcds[newkey] = Value
590 break
591 else:
592 pass
593 break
594 else:
595 pass
596
597 # handle the mixed pcd in FDF file
598 for key in PcdSet:
599 if key in GlobalData.MixedPcd:
600 Value = PcdSet[key]
601 del PcdSet[key]
602 for item in GlobalData.MixedPcd[key]:
603 PcdSet[item] = Value
604
605 #Collect package set information from INF of FDF
606 PkgSet = set()
607 for Inf in ModuleList:
608 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
609 if ModuleFile in Platform.Modules:
610 continue
611 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
612 PkgSet.update(ModuleData.Packages)
613 Pkgs = list(PkgSet) + list(PGen.PackageList)
614 for Pkg in Pkgs:
615 for Pcd in Pkg.Pcds:
616 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]
617 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))
618
619 Platform.SkuName = self.SkuId
620 for Name, Guid in PcdSet:
621 if (Name, Guid) not in DecPcds:
622 EdkLogger.error(
623 'build',
624 PARSER_ERROR,
625 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),
626 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
627 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
628 )
629 else:
630 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
631 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \
632 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \
633 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:
634 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])
635 continue
636 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:
637 EdkLogger.error(
638 'build',
639 PARSER_ERROR,
640 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),
641 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
642 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
643 )
644
645 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
646 #
647 # Explicitly collect platform's dynamic PCDs
648 #
649 Pa.CollectPlatformDynamicPcds()
650 Pa.CollectFixedAtBuildPcds()
651 self.AutoGenObjectList.append(Pa)
652
653 #
654 # Generate Package level hash value
655 #
656 GlobalData.gPackageHash[Arch] = {}
657 if GlobalData.gUseHashCache:
658 for Pkg in Pkgs:
659 self._GenPkgLevelHash(Pkg)
660
661 #
662 # Check PCDs token value conflict in each DEC file.
663 #
664 self._CheckAllPcdsTokenValueConflict()
665
666 #
667 # Check PCD type and definition between DSC and DEC
668 #
669 self._CheckPcdDefineAndType()
670
671 # if self.FdfFile:
672 # self._CheckDuplicateInFV(Fdf)
673
674 #
675 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
676 #
677 content = 'gCommandLineDefines: '
678 content += str(GlobalData.gCommandLineDefines)
679 content += os.linesep
680 content += 'BuildOptionPcd: '
681 content += str(GlobalData.BuildOptionPcd)
682 content += os.linesep
683 content += 'Active Platform: '
684 content += str(self.Platform)
685 content += os.linesep
686 if self.FdfFile:
687 content += 'Flash Image Definition: '
688 content += str(self.FdfFile)
689 content += os.linesep
690 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)
691
692 #
693 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
694 #
695 PcdTokenNumber = 'PcdTokenNumber: '
696 if Pa.PcdTokenNumber:
697 if Pa.DynamicPcdList:
698 for Pcd in Pa.DynamicPcdList:
699 PcdTokenNumber += os.linesep
700 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))
701 PcdTokenNumber += ' : '
702 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])
703 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)
704
705 #
706 # Get set of workspace metafiles
707 #
708 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)
709
710 #
711 # Retrieve latest modified time of all metafiles
712 #
713 SrcTimeStamp = 0
714 for f in AllWorkSpaceMetaFiles:
715 if os.stat(f)[8] > SrcTimeStamp:
716 SrcTimeStamp = os.stat(f)[8]
717 self._SrcTimeStamp = SrcTimeStamp
718
719 if GlobalData.gUseHashCache:
720 m = hashlib.md5()
721 for files in AllWorkSpaceMetaFiles:
722 if files.endswith('.dec'):
723 continue
724 f = open(files, 'r')
725 Content = f.read()
726 f.close()
727 m.update(Content)
728 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)
729 GlobalData.gPlatformHash = m.hexdigest()
730
731 #
732 # Write metafile list to build directory
733 #
734 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')
735 if os.path.exists (AutoGenFilePath):
736 os.remove(AutoGenFilePath)
737 if not os.path.exists(self.BuildDir):
738 os.makedirs(self.BuildDir)
739 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:
740 for f in AllWorkSpaceMetaFiles:
741 print >> file, f
742 return True
743
744 def _GenPkgLevelHash(self, Pkg):
745 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)
746 CreateDirectory(PkgDir)
747 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')
748 m = hashlib.md5()
749 # Get .dec file's hash value
750 f = open(Pkg.MetaFile.Path, 'r')
751 Content = f.read()
752 f.close()
753 m.update(Content)
754 # Get include files hash value
755 if Pkg.Includes:
756 for inc in Pkg.Includes:
757 for Root, Dirs, Files in os.walk(str(inc)):
758 for File in Files:
759 File_Path = os.path.join(Root, File)
760 f = open(File_Path, 'r')
761 Content = f.read()
762 f.close()
763 m.update(Content)
764 SaveFileOnChange(HashFile, m.hexdigest(), True)
765 if Pkg.PackageName not in GlobalData.gPackageHash[Pkg.Arch]:
766 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()
767
768 def _GetMetaFiles(self, Target, Toolchain, Arch):
769 AllWorkSpaceMetaFiles = set()
770 #
771 # add fdf
772 #
773 if self.FdfFile:
774 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)
775 if self.FdfFile:
776 FdfFiles = GlobalData.gFdfParser.GetAllIncludedFile()
777 for f in FdfFiles:
778 AllWorkSpaceMetaFiles.add (f.FileName)
779 #
780 # add dsc
781 #
782 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)
783
784 #
785 # add build_rule.txt & tools_def.txt
786 #
787 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))
788 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))
789
790 # add BuildOption metafile
791 #
792 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))
793
794 # add PcdToken Number file for Dynamic/DynamicEx Pcd
795 #
796 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))
797
798 for Arch in self.ArchList:
799 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
800 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
801
802 #
803 # add dec
804 #
805 for Package in PGen.PackageList:
806 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)
807
808 #
809 # add included dsc
810 #
811 for filePath in Platform._RawData.IncludedFiles:
812 AllWorkSpaceMetaFiles.add(filePath.Path)
813
814 return AllWorkSpaceMetaFiles
815
816 ## _CheckDuplicateInFV() method
817 #
818 # Check whether there is duplicate modules/files exist in FV section.
819 # The check base on the file GUID;
820 #
821 def _CheckDuplicateInFV(self, Fdf):
822 for Fv in Fdf.Profile.FvDict:
823 _GuidDict = {}
824 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:
825 if FfsFile.InfFileName and FfsFile.NameGuid == None:
826 #
827 # Get INF file GUID
828 #
829 InfFoundFlag = False
830 for Pa in self.AutoGenObjectList:
831 if InfFoundFlag:
832 break
833 for Module in Pa.ModuleAutoGenList:
834 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):
835 InfFoundFlag = True
836 if not Module.Guid.upper() in _GuidDict.keys():
837 _GuidDict[Module.Guid.upper()] = FfsFile
838 break
839 else:
840 EdkLogger.error("build",
841 FORMAT_INVALID,
842 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
843 FfsFile.CurrentLineContent,
844 _GuidDict[Module.Guid.upper()].CurrentLineNum,
845 _GuidDict[Module.Guid.upper()].CurrentLineContent,
846 Module.Guid.upper()),
847 ExtraData=self.FdfFile)
848 #
849 # Some INF files not have entity in DSC file.
850 #
851 if not InfFoundFlag:
852 if FfsFile.InfFileName.find('$') == -1:
853 InfPath = NormPath(FfsFile.InfFileName)
854 if not os.path.exists(InfPath):
855 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))
856
857 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)
858 #
859 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
860 # BuildObject from one of AutoGenObjectList is enough.
861 #
862 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]
863 if not InfObj.Guid.upper() in _GuidDict.keys():
864 _GuidDict[InfObj.Guid.upper()] = FfsFile
865 else:
866 EdkLogger.error("build",
867 FORMAT_INVALID,
868 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
869 FfsFile.CurrentLineContent,
870 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,
871 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,
872 InfObj.Guid.upper()),
873 ExtraData=self.FdfFile)
874 InfFoundFlag = False
875
876 if FfsFile.NameGuid != None:
877 _CheckPCDAsGuidPattern = re.compile("^PCD\(.+\..+\)$")
878
879 #
880 # If the NameGuid reference a PCD name.
881 # The style must match: PCD(xxxx.yyy)
882 #
883 if _CheckPCDAsGuidPattern.match(FfsFile.NameGuid):
884 #
885 # Replace the PCD value.
886 #
887 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")
888 PcdFoundFlag = False
889 for Pa in self.AutoGenObjectList:
890 if not PcdFoundFlag:
891 for PcdItem in Pa.AllPcdList:
892 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:
893 #
894 # First convert from CFormatGuid to GUID string
895 #
896 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)
897
898 if not _PcdGuidString:
899 #
900 # Then try Byte array.
901 #
902 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)
903
904 if not _PcdGuidString:
905 #
906 # Not Byte array or CFormat GUID, raise error.
907 #
908 EdkLogger.error("build",
909 FORMAT_INVALID,
910 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName, PcdItem.DefaultValue),
911 ExtraData=self.FdfFile)
912
913 if not _PcdGuidString.upper() in _GuidDict.keys():
914 _GuidDict[_PcdGuidString.upper()] = FfsFile
915 PcdFoundFlag = True
916 break
917 else:
918 EdkLogger.error("build",
919 FORMAT_INVALID,
920 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
921 FfsFile.CurrentLineContent,
922 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,
923 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,
924 FfsFile.NameGuid.upper()),
925 ExtraData=self.FdfFile)
926
927 if not FfsFile.NameGuid.upper() in _GuidDict.keys():
928 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile
929 else:
930 #
931 # Two raw file GUID conflict.
932 #
933 EdkLogger.error("build",
934 FORMAT_INVALID,
935 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
936 FfsFile.CurrentLineContent,
937 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,
938 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,
939 FfsFile.NameGuid.upper()),
940 ExtraData=self.FdfFile)
941
942
943 def _CheckPcdDefineAndType(self):
944 PcdTypeList = [
945 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
946 "Dynamic", #"DynamicHii", "DynamicVpd",
947 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
948 ]
949
950 # This dict store PCDs which are not used by any modules with specified arches
951 UnusedPcd = sdict()
952 for Pa in self.AutoGenObjectList:
953 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
954 for Pcd in Pa.Platform.Pcds:
955 PcdType = Pa.Platform.Pcds[Pcd].Type
956
957 # If no PCD type, this PCD comes from FDF
958 if not PcdType:
959 continue
960
961 # Try to remove Hii and Vpd suffix
962 if PcdType.startswith("DynamicEx"):
963 PcdType = "DynamicEx"
964 elif PcdType.startswith("Dynamic"):
965 PcdType = "Dynamic"
966
967 for Package in Pa.PackageList:
968 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
969 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:
970 break
971 for Type in PcdTypeList:
972 if (Pcd[0], Pcd[1], Type) in Package.Pcds:
973 EdkLogger.error(
974 'build',
975 FORMAT_INVALID,
976 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
977 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),
978 ExtraData=None
979 )
980 return
981 else:
982 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)
983
984 for Pcd in UnusedPcd:
985 EdkLogger.warn(
986 'build',
987 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
988 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
989 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),
990 ExtraData=None
991 )
992
993 def __repr__(self):
994 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))
995
996 ## Return the directory to store FV files
997 def _GetFvDir(self):
998 if self._FvDir == None:
999 self._FvDir = path.join(self.BuildDir, 'FV')
1000 return self._FvDir
1001
1002 ## Return the directory to store all intermediate and final files built
1003 def _GetBuildDir(self):
1004 if self._BuildDir == None:
1005 return self.AutoGenObjectList[0].BuildDir
1006
1007 ## Return the build output directory platform specifies
1008 def _GetOutputDir(self):
1009 return self.Platform.OutputDirectory
1010
1011 ## Return platform name
1012 def _GetName(self):
1013 return self.Platform.PlatformName
1014
1015 ## Return meta-file GUID
1016 def _GetGuid(self):
1017 return self.Platform.Guid
1018
1019 ## Return platform version
1020 def _GetVersion(self):
1021 return self.Platform.Version
1022
1023 ## Return paths of tools
1024 def _GetToolDefinition(self):
1025 return self.AutoGenObjectList[0].ToolDefinition
1026
1027 ## Return directory of platform makefile
1028 #
1029 # @retval string Makefile directory
1030 #
1031 def _GetMakeFileDir(self):
1032 if self._MakeFileDir == None:
1033 self._MakeFileDir = self.BuildDir
1034 return self._MakeFileDir
1035
1036 ## Return build command string
1037 #
1038 # @retval string Build command string
1039 #
1040 def _GetBuildCommand(self):
1041 if self._BuildCommand == None:
1042 # BuildCommand should be all the same. So just get one from platform AutoGen
1043 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand
1044 return self._BuildCommand
1045
1046 ## Check the PCDs token value conflict in each DEC file.
1047 #
1048 # Will cause build break and raise error message while two PCDs conflict.
1049 #
1050 # @return None
1051 #
1052 def _CheckAllPcdsTokenValueConflict(self):
1053 for Pa in self.AutoGenObjectList:
1054 for Package in Pa.PackageList:
1055 PcdList = Package.Pcds.values()
1056 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0)))
1057 Count = 0
1058 while (Count < len(PcdList) - 1) :
1059 Item = PcdList[Count]
1060 ItemNext = PcdList[Count + 1]
1061 #
1062 # Make sure in the same token space the TokenValue should be unique
1063 #
1064 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):
1065 SameTokenValuePcdList = []
1066 SameTokenValuePcdList.append(Item)
1067 SameTokenValuePcdList.append(ItemNext)
1068 RemainPcdListLength = len(PcdList) - Count - 2
1069 for ValueSameCount in range(RemainPcdListLength):
1070 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):
1071 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])
1072 else:
1073 break;
1074 #
1075 # Sort same token value PCD list with TokenGuid and TokenCName
1076 #
1077 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1078 SameTokenValuePcdListCount = 0
1079 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):
1080 Flag = False
1081 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]
1082 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]
1083
1084 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):
1085 for PcdItem in GlobalData.MixedPcd:
1086 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \
1087 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
1088 Flag = True
1089 if not Flag:
1090 EdkLogger.error(
1091 'build',
1092 FORMAT_INVALID,
1093 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1094 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),
1095 ExtraData=None
1096 )
1097 SameTokenValuePcdListCount += 1
1098 Count += SameTokenValuePcdListCount
1099 Count += 1
1100
1101 PcdList = Package.Pcds.values()
1102 PcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1103 Count = 0
1104 while (Count < len(PcdList) - 1) :
1105 Item = PcdList[Count]
1106 ItemNext = PcdList[Count + 1]
1107 #
1108 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1109 #
1110 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):
1111 EdkLogger.error(
1112 'build',
1113 FORMAT_INVALID,
1114 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1115 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),
1116 ExtraData=None
1117 )
1118 Count += 1
1119 ## Generate fds command
1120 def _GenFdsCommand(self):
1121 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()
1122
1123 ## Create makefile for the platform and modules in it
1124 #
1125 # @param CreateDepsMakeFile Flag indicating if the makefile for
1126 # modules will be created as well
1127 #
1128 def CreateMakeFile(self, CreateDepsMakeFile=False):
1129 if CreateDepsMakeFile:
1130 for Pa in self.AutoGenObjectList:
1131 Pa.CreateMakeFile(CreateDepsMakeFile)
1132
1133 ## Create autogen code for platform and modules
1134 #
1135 # Since there's no autogen code for platform, this method will do nothing
1136 # if CreateModuleCodeFile is set to False.
1137 #
1138 # @param CreateDepsCodeFile Flag indicating if creating module's
1139 # autogen code file or not
1140 #
1141 def CreateCodeFile(self, CreateDepsCodeFile=False):
1142 if not CreateDepsCodeFile:
1143 return
1144 for Pa in self.AutoGenObjectList:
1145 Pa.CreateCodeFile(CreateDepsCodeFile)
1146
1147 ## Create AsBuilt INF file the platform
1148 #
1149 def CreateAsBuiltInf(self):
1150 return
1151
1152 Name = property(_GetName)
1153 Guid = property(_GetGuid)
1154 Version = property(_GetVersion)
1155 OutputDir = property(_GetOutputDir)
1156
1157 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
1158
1159 BuildDir = property(_GetBuildDir)
1160 FvDir = property(_GetFvDir)
1161 MakeFileDir = property(_GetMakeFileDir)
1162 BuildCommand = property(_GetBuildCommand)
1163 GenFdsCommand = property(_GenFdsCommand)
1164
1165 ## AutoGen class for platform
1166 #
1167 # PlatformAutoGen class will process the original information in platform
1168 # file in order to generate makefile for platform.
1169 #
1170 class PlatformAutoGen(AutoGen):
1171 #
1172 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1173 # correct PCD database
1174 #
1175 _DynaPcdList_ = []
1176 _NonDynaPcdList_ = []
1177 _PlatformPcds = {}
1178
1179 #
1180 # The priority list while override build option
1181 #
1182 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1183 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1184 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1185 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1186 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1187 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1188 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1189 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1190 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1191 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1192 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1193 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1194 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1195 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1196 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1197 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1198
1199 ## The real constructor of PlatformAutoGen
1200 #
1201 # This method is not supposed to be called by users of PlatformAutoGen. It's
1202 # only used by factory method __new__() to do real initialization work for an
1203 # object of PlatformAutoGen
1204 #
1205 # @param Workspace WorkspaceAutoGen object
1206 # @param PlatformFile Platform file (DSC file)
1207 # @param Target Build target (DEBUG, RELEASE)
1208 # @param Toolchain Name of tool chain
1209 # @param Arch arch of the platform supports
1210 #
1211 def _Init(self, Workspace, PlatformFile, Target, Toolchain, Arch):
1212 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))
1213 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)
1214
1215 self.MetaFile = PlatformFile
1216 self.Workspace = Workspace
1217 self.WorkspaceDir = Workspace.WorkspaceDir
1218 self.ToolChain = Toolchain
1219 self.BuildTarget = Target
1220 self.Arch = Arch
1221 self.SourceDir = PlatformFile.SubDir
1222 self.SourceOverrideDir = None
1223 self.FdTargetList = self.Workspace.FdTargetList
1224 self.FvTargetList = self.Workspace.FvTargetList
1225 self.AllPcdList = []
1226 # get the original module/package/platform objects
1227 self.BuildDatabase = Workspace.BuildDatabase
1228 self.DscBuildDataObj = Workspace.Platform
1229
1230 # flag indicating if the makefile/C-code file has been created or not
1231 self.IsMakeFileCreated = False
1232 self.IsCodeFileCreated = False
1233
1234 self._Platform = None
1235 self._Name = None
1236 self._Guid = None
1237 self._Version = None
1238
1239 self._BuildRule = None
1240 self._SourceDir = None
1241 self._BuildDir = None
1242 self._OutputDir = None
1243 self._FvDir = None
1244 self._MakeFileDir = None
1245 self._FdfFile = None
1246
1247 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1248 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1249 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1250 self._NonDynamicPcdDict = {}
1251
1252 self._ToolDefinitions = None
1253 self._ToolDefFile = None # toolcode : tool path
1254 self._ToolChainFamily = None
1255 self._BuildRuleFamily = None
1256 self._BuildOption = None # toolcode : option
1257 self._EdkBuildOption = None # edktoolcode : option
1258 self._EdkIIBuildOption = None # edkiitoolcode : option
1259 self._PackageList = None
1260 self._ModuleAutoGenList = None
1261 self._LibraryAutoGenList = None
1262 self._BuildCommand = None
1263 self._AsBuildInfList = []
1264 self._AsBuildModuleList = []
1265
1266 self.VariableInfo = None
1267
1268 if GlobalData.gFdfParser != None:
1269 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList
1270 for Inf in self._AsBuildInfList:
1271 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)
1272 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1273 if not M.IsSupportedArch:
1274 continue
1275 self._AsBuildModuleList.append(InfClass)
1276 # get library/modules for build
1277 self.LibraryBuildDirectoryList = []
1278 self.ModuleBuildDirectoryList = []
1279
1280 return True
1281
1282 def __repr__(self):
1283 return "%s [%s]" % (self.MetaFile, self.Arch)
1284
1285 ## Create autogen code for platform and modules
1286 #
1287 # Since there's no autogen code for platform, this method will do nothing
1288 # if CreateModuleCodeFile is set to False.
1289 #
1290 # @param CreateModuleCodeFile Flag indicating if creating module's
1291 # autogen code file or not
1292 #
1293 def CreateCodeFile(self, CreateModuleCodeFile=False):
1294 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1295 if self.IsCodeFileCreated or not CreateModuleCodeFile:
1296 return
1297
1298 for Ma in self.ModuleAutoGenList:
1299 Ma.CreateCodeFile(True)
1300
1301 # don't do this twice
1302 self.IsCodeFileCreated = True
1303
1304 ## Generate Fds Command
1305 def _GenFdsCommand(self):
1306 return self.Workspace.GenFdsCommand
1307
1308 ## Create makefile for the platform and mdoules in it
1309 #
1310 # @param CreateModuleMakeFile Flag indicating if the makefile for
1311 # modules will be created as well
1312 #
1313 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):
1314 if CreateModuleMakeFile:
1315 for ModuleFile in self.Platform.Modules:
1316 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,
1317 self.ToolChain, self.Arch, self.MetaFile)
1318 if (ModuleFile.File, self.Arch) in FfsCommand:
1319 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])
1320 else:
1321 Ma.CreateMakeFile(True)
1322 #Ma.CreateAsBuiltInf()
1323
1324 # no need to create makefile for the platform more than once
1325 if self.IsMakeFileCreated:
1326 return
1327
1328 # create library/module build dirs for platform
1329 Makefile = GenMake.PlatformMakefile(self)
1330 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()
1331 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()
1332
1333 self.IsMakeFileCreated = True
1334
1335 ## Deal with Shared FixedAtBuild Pcds
1336 #
1337 def CollectFixedAtBuildPcds(self):
1338 for LibAuto in self.LibraryAutoGenList:
1339 FixedAtBuildPcds = {}
1340 ShareFixedAtBuildPcdsSameValue = {}
1341 for Module in LibAuto._ReferenceModules:
1342 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:
1343 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1344 if key not in FixedAtBuildPcds:
1345 ShareFixedAtBuildPcdsSameValue[key] = True
1346 FixedAtBuildPcds[key] = Pcd.DefaultValue
1347 else:
1348 if FixedAtBuildPcds[key] != Pcd.DefaultValue:
1349 ShareFixedAtBuildPcdsSameValue[key] = False
1350 for Pcd in LibAuto.FixedAtBuildPcds:
1351 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1352 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:
1353 continue
1354 else:
1355 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]
1356 if DscPcd.Type != "FixedAtBuild":
1357 continue
1358 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:
1359 LibAuto.ConstPcd[key] = Pcd.DefaultValue
1360
1361 def CollectVariables(self, DynamicPcdSet):
1362
1363 VpdRegionSize = 0
1364 VpdRegionBase = 0
1365 if self.Workspace.FdfFile:
1366 FdDict = self.Workspace.FdfProfile.FdDict[GlobalData.gFdfParser.CurrentFdName]
1367 for FdRegion in FdDict.RegionList:
1368 for item in FdRegion.RegionDataList:
1369 if self.Platform.VpdToolGuid.strip() and self.Platform.VpdToolGuid in item:
1370 VpdRegionSize = FdRegion.Size
1371 VpdRegionBase = FdRegion.Offset
1372 break
1373
1374
1375 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(),self.DscBuildDataObj._GetSkuIds())
1376 VariableInfo.SetVpdRegionMaxSize(VpdRegionSize)
1377 VariableInfo.SetVpdRegionOffset(VpdRegionBase)
1378 Index = 0
1379 for Pcd in DynamicPcdSet:
1380 pcdname = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1381 for SkuName in Pcd.SkuInfoList:
1382 Sku = Pcd.SkuInfoList[SkuName]
1383 SkuId = Sku.SkuId
1384 if SkuId == None or SkuId == '':
1385 continue
1386 if len(Sku.VariableName) > 0:
1387 VariableGuidStructure = Sku.VariableGuidValue
1388 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)
1389 if Pcd.Phase == "DXE":
1390 for StorageName in Sku.DefaultStoreDict:
1391 VariableInfo.append_variable(var_info(Index,pcdname,StorageName,SkuName, StringToArray(Sku.VariableName),VariableGuid, Sku.VariableAttribute , Sku.HiiDefaultValue,Sku.DefaultStoreDict[StorageName],Pcd.DatumType))
1392 Index += 1
1393 return VariableInfo
1394
1395 def UpdateNVStoreMaxSize(self,OrgVpdFile):
1396 if self.VariableInfo:
1397 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1398 PcdNvStoreDfBuffer = [item for item in self._DynamicPcdList if item.TokenCName == "PcdNvStoreDefaultValueBuffer" and item.TokenSpaceGuidCName == "gEfiMdeModulePkgTokenSpaceGuid"]
1399
1400 if PcdNvStoreDfBuffer:
1401 if os.path.exists(VpdMapFilePath):
1402 OrgVpdFile.Read(VpdMapFilePath)
1403 PcdItems = OrgVpdFile.GetOffset(PcdNvStoreDfBuffer[0])
1404 NvStoreOffset = PcdItems.values()[0].strip() if PcdItems else '0'
1405 else:
1406 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1407
1408 NvStoreOffset = int(NvStoreOffset,16) if NvStoreOffset.upper().startswith("0X") else int(NvStoreOffset)
1409 default_skuobj = PcdNvStoreDfBuffer[0].SkuInfoList.get("DEFAULT")
1410 maxsize = self.VariableInfo.VpdRegionSize - NvStoreOffset if self.VariableInfo.VpdRegionSize else len(default_skuobj.DefaultValue.split(","))
1411 var_data = self.VariableInfo.PatchNVStoreDefaultMaxSize(maxsize)
1412
1413 if var_data and default_skuobj:
1414 default_skuobj.DefaultValue = var_data
1415 PcdNvStoreDfBuffer[0].DefaultValue = var_data
1416 PcdNvStoreDfBuffer[0].SkuInfoList.clear()
1417 PcdNvStoreDfBuffer[0].SkuInfoList['DEFAULT'] = default_skuobj
1418 PcdNvStoreDfBuffer[0].MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))
1419
1420 return OrgVpdFile
1421
1422 ## Collect dynamic PCDs
1423 #
1424 # Gather dynamic PCDs list from each module and their settings from platform
1425 # This interface should be invoked explicitly when platform action is created.
1426 #
1427 def CollectPlatformDynamicPcds(self):
1428 # Override the platform Pcd's value by build option
1429 if GlobalData.BuildOptionPcd:
1430 for key in self.Platform.Pcds:
1431 PlatformPcd = self.Platform.Pcds[key]
1432 for PcdItem in GlobalData.BuildOptionPcd:
1433 if (PlatformPcd.TokenSpaceGuidCName, PlatformPcd.TokenCName) == (PcdItem[0], PcdItem[1]):
1434 PlatformPcd.DefaultValue = PcdItem[2]
1435 if PlatformPcd.SkuInfoList:
1436 Sku = PlatformPcd.SkuInfoList[PlatformPcd.SkuInfoList.keys()[0]]
1437 Sku.DefaultValue = PcdItem[2]
1438 break
1439
1440 for key in self.Platform.Pcds:
1441 for SinglePcd in GlobalData.MixedPcd:
1442 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
1443 for item in GlobalData.MixedPcd[SinglePcd]:
1444 Pcd_Type = item[0].split('_')[-1]
1445 if (Pcd_Type == self.Platform.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and self.Platform.Pcds[key].Type in GenC.gDynamicExPcd) or \
1446 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):
1447 Value = self.Platform.Pcds[key]
1448 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type
1449 if len(key) == 2:
1450 newkey = (Value.TokenCName, key[1])
1451 elif len(key) == 3:
1452 newkey = (Value.TokenCName, key[1], key[2])
1453 del self.Platform.Pcds[key]
1454 self.Platform.Pcds[newkey] = Value
1455 break
1456 else:
1457 pass
1458 break
1459 else:
1460 pass
1461
1462 # for gathering error information
1463 NoDatumTypePcdList = set()
1464 PcdNotInDb = []
1465 self._GuidValue = {}
1466 FdfModuleList = []
1467 for InfName in self._AsBuildInfList:
1468 InfName = mws.join(self.WorkspaceDir, InfName)
1469 FdfModuleList.append(os.path.normpath(InfName))
1470 for F in self.Platform.Modules.keys():
1471 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
1472 #GuidValue.update(M.Guids)
1473
1474 self.Platform.Modules[F].M = M
1475
1476 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:
1477 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1478 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1479 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
1480
1481 # Check the PCD from Binary INF or Source INF
1482 if M.IsBinaryModule == True:
1483 PcdFromModule.IsFromBinaryInf = True
1484
1485 # Check the PCD from DSC or not
1486 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
1487 PcdFromModule.IsFromDsc = True
1488 else:
1489 PcdFromModule.IsFromDsc = False
1490 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
1491 if F.Path not in FdfModuleList:
1492 # If one of the Source built modules listed in the DSC is not listed
1493 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1494 # access method (it is only listed in the DEC file that declares the
1495 # PCD as PcdsDynamic), then build tool will report warning message
1496 # notify the PI that they are attempting to build a module that must
1497 # be included in a flash image in order to be functional. These Dynamic
1498 # PCD will not be added into the Database unless it is used by other
1499 # modules that are included in the FDF file.
1500 if PcdFromModule.Type in GenC.gDynamicPcd and \
1501 PcdFromModule.IsFromBinaryInf == False:
1502 # Print warning message to let the developer make a determine.
1503 if PcdFromModule not in PcdNotInDb:
1504 PcdNotInDb.append(PcdFromModule)
1505 continue
1506 # If one of the Source built modules listed in the DSC is not listed in
1507 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1508 # access method (it is only listed in the DEC file that declares the
1509 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1510 # PCD to the Platform's PCD Database.
1511 if PcdFromModule.Type in GenC.gDynamicExPcd:
1512 if PcdFromModule not in PcdNotInDb:
1513 PcdNotInDb.append(PcdFromModule)
1514 continue
1515 #
1516 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1517 # it should be stored in Pcd PEI database, If a dynamic only
1518 # used by DXE module, it should be stored in DXE PCD database.
1519 # The default Phase is DXE
1520 #
1521 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1522 PcdFromModule.Phase = "PEI"
1523 if PcdFromModule not in self._DynaPcdList_:
1524 self._DynaPcdList_.append(PcdFromModule)
1525 elif PcdFromModule.Phase == 'PEI':
1526 # overwrite any the same PCD existing, if Phase is PEI
1527 Index = self._DynaPcdList_.index(PcdFromModule)
1528 self._DynaPcdList_[Index] = PcdFromModule
1529 elif PcdFromModule not in self._NonDynaPcdList_:
1530 self._NonDynaPcdList_.append(PcdFromModule)
1531 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1532 Index = self._NonDynaPcdList_.index(PcdFromModule)
1533 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1534 #The PCD from Binary INF will override the same one from source INF
1535 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1536 PcdFromModule.Pending = False
1537 self._NonDynaPcdList_.append (PcdFromModule)
1538 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1539 DscModuleList = []
1540 for ModuleInf in self.Platform.Modules.keys():
1541 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1542 # add the PCD from modules that listed in FDF but not in DSC to Database
1543 for InfName in FdfModuleList:
1544 if InfName not in DscModuleList:
1545 InfClass = PathClass(InfName)
1546 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1547 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1548 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1549 # For binary module, if in current arch, we need to list the PCDs into database.
1550 if not M.IsSupportedArch:
1551 continue
1552 # Override the module PCD setting by platform setting
1553 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1554 for PcdFromModule in ModulePcdList:
1555 PcdFromModule.IsFromBinaryInf = True
1556 PcdFromModule.IsFromDsc = False
1557 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1558 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1559 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1560 File=self.MetaFile,
1561 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1562 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1563 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1564 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1565 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1566 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1567 PcdFromModule.Phase = "PEI"
1568 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1569 self._DynaPcdList_.append(PcdFromModule)
1570 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1571 self._NonDynaPcdList_.append(PcdFromModule)
1572 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1573 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1574 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1575 # module & DXE module at a same time.
1576 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1577 # INF file as DynamicEx.
1578 Index = self._DynaPcdList_.index(PcdFromModule)
1579 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1580 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1581 for PcdFromModule in self._NonDynaPcdList_:
1582 # If a PCD is not listed in the DSC file, but binary INF files used by
1583 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1584 # section, AND all source INF files used by this platform the build
1585 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1586 # section, then the tools must NOT add the PCD to the Platform's PCD
1587 # Database; the build must assign the access method for this PCD as
1588 # PcdsPatchableInModule.
1589 if PcdFromModule not in self._DynaPcdList_:
1590 continue
1591 Index = self._DynaPcdList_.index(PcdFromModule)
1592 if PcdFromModule.IsFromDsc == False and \
1593 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1594 PcdFromModule.IsFromBinaryInf == True and \
1595 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1596 Index = self._DynaPcdList_.index(PcdFromModule)
1597 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1598
1599 # print out error information and break the build, if error found
1600 if len(NoDatumTypePcdList) > 0:
1601 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1602 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1603 File=self.MetaFile,
1604 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1605 % NoDatumTypePcdListString)
1606 self._NonDynamicPcdList = self._NonDynaPcdList_
1607 self._DynamicPcdList = self._DynaPcdList_
1608 #
1609 # Sort dynamic PCD list to:
1610 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1611 # try to be put header of dynamicd List
1612 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1613 #
1614 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1615 #
1616 UnicodePcdArray = set()
1617 HiiPcdArray = set()
1618 OtherPcdArray = set()
1619 VpdPcdDict = {}
1620 VpdFile = VpdInfoFile.VpdInfoFile()
1621 NeedProcessVpdMapFile = False
1622
1623 for pcd in self.Platform.Pcds.keys():
1624 if pcd not in self._PlatformPcds.keys():
1625 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]
1626
1627 for item in self._PlatformPcds:
1628 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1629 self._PlatformPcds[item].DatumType = "VOID*"
1630
1631 if (self.Workspace.ArchList[-1] == self.Arch):
1632 for Pcd in self._DynamicPcdList:
1633 # just pick the a value to determine whether is unicode string type
1634 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1635 Sku.VpdOffset = Sku.VpdOffset.strip()
1636
1637 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1638 Pcd.DatumType = "VOID*"
1639
1640 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1641 # if found HII type PCD then insert to right of UnicodeIndex
1642 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1643 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1644
1645 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1646 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1647 if PcdNvStoreDfBuffer:
1648 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)
1649 vardump = self.VariableInfo.dump()
1650 if vardump:
1651 PcdNvStoreDfBuffer.DefaultValue = vardump
1652 for skuname in PcdNvStoreDfBuffer.SkuInfoList:
1653 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump
1654 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))
1655
1656 PlatformPcds = self._PlatformPcds.keys()
1657 PlatformPcds.sort()
1658 #
1659 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1660 #
1661 VpdSkuMap = {}
1662 for PcdKey in PlatformPcds:
1663 Pcd = self._PlatformPcds[PcdKey]
1664 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1665 PcdKey in VpdPcdDict:
1666 Pcd = VpdPcdDict[PcdKey]
1667 SkuValueMap = {}
1668 DefaultSku = Pcd.SkuInfoList.get('DEFAULT')
1669 if DefaultSku:
1670 PcdValue = DefaultSku.DefaultValue
1671 if PcdValue not in SkuValueMap:
1672 SkuValueMap[PcdValue] = []
1673 VpdFile.Add(Pcd, 'DEFAULT',DefaultSku.VpdOffset)
1674 SkuValueMap[PcdValue].append(DefaultSku)
1675
1676 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1677 Sku.VpdOffset = Sku.VpdOffset.strip()
1678 PcdValue = Sku.DefaultValue
1679 if PcdValue == "":
1680 PcdValue = Pcd.DefaultValue
1681 if Sku.VpdOffset != '*':
1682 if PcdValue.startswith("{"):
1683 Alignment = 8
1684 elif PcdValue.startswith("L"):
1685 Alignment = 2
1686 else:
1687 Alignment = 1
1688 try:
1689 VpdOffset = int(Sku.VpdOffset)
1690 except:
1691 try:
1692 VpdOffset = int(Sku.VpdOffset, 16)
1693 except:
1694 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1695 if VpdOffset % Alignment != 0:
1696 if PcdValue.startswith("{"):
1697 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)
1698 else:
1699 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))
1700 if PcdValue not in SkuValueMap:
1701 SkuValueMap[PcdValue] = []
1702 VpdFile.Add(Pcd, SkuName,Sku.VpdOffset)
1703 SkuValueMap[PcdValue].append(Sku)
1704 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1705 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1706 NeedProcessVpdMapFile = True
1707 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':
1708 EdkLogger.error("Build", FILE_NOT_FOUND, \
1709 "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1710
1711 VpdSkuMap[PcdKey] = SkuValueMap
1712 #
1713 # Fix the PCDs define in VPD PCD section that never referenced by module.
1714 # An example is PCD for signature usage.
1715 #
1716 for DscPcd in PlatformPcds:
1717 DscPcdEntry = self._PlatformPcds[DscPcd]
1718 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1719 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):
1720 FoundFlag = False
1721 for VpdPcd in VpdFile._VpdArray.keys():
1722 # This PCD has been referenced by module
1723 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1724 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1725 FoundFlag = True
1726
1727 # Not found, it should be signature
1728 if not FoundFlag :
1729 # just pick the a value to determine whether is unicode string type
1730 SkuValueMap = {}
1731 DefaultSku = DscPcdEntry.SkuInfoList.get('DEFAULT')
1732 if DefaultSku:
1733 PcdValue = DefaultSku.DefaultValue
1734 if PcdValue not in SkuValueMap:
1735 SkuValueMap[PcdValue] = []
1736 VpdFile.Add(DscPcdEntry, 'DEFAULT',Sku.VpdOffset)
1737 SkuValueMap[PcdValue].append(Sku)
1738 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():
1739 Sku.VpdOffset = Sku.VpdOffset.strip()
1740
1741 # Need to iterate DEC pcd information to get the value & datumtype
1742 for eachDec in self.PackageList:
1743 for DecPcd in eachDec.Pcds:
1744 DecPcdEntry = eachDec.Pcds[DecPcd]
1745 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1746 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1747 # Print warning message to let the developer make a determine.
1748 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1749 File=self.MetaFile, \
1750 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1751 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1752
1753 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1754 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1755 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1756 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1757 # Only fix the value while no value provided in DSC file.
1758 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1759 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1760
1761 if DscPcdEntry not in self._DynamicPcdList:
1762 self._DynamicPcdList.append(DscPcdEntry)
1763 Sku.VpdOffset = Sku.VpdOffset.strip()
1764 PcdValue = Sku.DefaultValue
1765 if PcdValue == "":
1766 PcdValue = DscPcdEntry.DefaultValue
1767 if Sku.VpdOffset != '*':
1768 if PcdValue.startswith("{"):
1769 Alignment = 8
1770 elif PcdValue.startswith("L"):
1771 Alignment = 2
1772 else:
1773 Alignment = 1
1774 try:
1775 VpdOffset = int(Sku.VpdOffset)
1776 except:
1777 try:
1778 VpdOffset = int(Sku.VpdOffset, 16)
1779 except:
1780 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))
1781 if VpdOffset % Alignment != 0:
1782 if PcdValue.startswith("{"):
1783 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)
1784 else:
1785 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))
1786 if PcdValue not in SkuValueMap:
1787 SkuValueMap[PcdValue] = []
1788 VpdFile.Add(DscPcdEntry, SkuName,Sku.VpdOffset)
1789 SkuValueMap[PcdValue].append(Sku)
1790 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1791 NeedProcessVpdMapFile = True
1792 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1793 UnicodePcdArray.add(DscPcdEntry)
1794 elif len(Sku.VariableName) > 0:
1795 HiiPcdArray.add(DscPcdEntry)
1796 else:
1797 OtherPcdArray.add(DscPcdEntry)
1798
1799 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1800 VpdSkuMap[DscPcd] = SkuValueMap
1801 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \
1802 VpdFile.GetCount() != 0:
1803 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1804 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1805
1806 if VpdFile.GetCount() != 0:
1807
1808 self.FixVpdOffset(VpdFile)
1809
1810 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))
1811
1812 # Process VPD map file generated by third party BPDG tool
1813 if NeedProcessVpdMapFile:
1814 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1815 if os.path.exists(VpdMapFilePath):
1816 VpdFile.Read(VpdMapFilePath)
1817
1818 # Fixup "*" offset
1819 for pcd in VpdSkuMap:
1820 vpdinfo = VpdFile.GetVpdInfo(pcd)
1821 if vpdinfo is None:
1822 # just pick the a value to determine whether is unicode string type
1823 continue
1824 for pcdvalue in VpdSkuMap[pcd]:
1825 for sku in VpdSkuMap[pcd][pcdvalue]:
1826 for item in vpdinfo:
1827 if item[2] == pcdvalue:
1828 sku.VpdOffset = item[1]
1829 else:
1830 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1831
1832 # Delete the DynamicPcdList At the last time enter into this function
1833 for Pcd in self._DynamicPcdList:
1834 # just pick the a value to determine whether is unicode string type
1835 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1836 Sku.VpdOffset = Sku.VpdOffset.strip()
1837
1838 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1839 Pcd.DatumType = "VOID*"
1840
1841 PcdValue = Sku.DefaultValue
1842 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1843 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1844 UnicodePcdArray.add(Pcd)
1845 elif len(Sku.VariableName) > 0:
1846 # if found HII type PCD then insert to right of UnicodeIndex
1847 HiiPcdArray.add(Pcd)
1848 else:
1849 OtherPcdArray.add(Pcd)
1850 del self._DynamicPcdList[:]
1851 self._DynamicPcdList.extend(list(UnicodePcdArray))
1852 self._DynamicPcdList.extend(list(HiiPcdArray))
1853 self._DynamicPcdList.extend(list(OtherPcdArray))
1854 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]
1855 for pcd in self._DynamicPcdList:
1856 if len(pcd.SkuInfoList) == 1:
1857 for (SkuName,SkuId) in allskuset:
1858 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:
1859 continue
1860 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList['DEFAULT'])
1861 pcd.SkuInfoList[SkuName].SkuId = SkuId
1862 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1863
1864 def FixVpdOffset(self,VpdFile ):
1865 FvPath = os.path.join(self.BuildDir, "FV")
1866 if not os.path.exists(FvPath):
1867 try:
1868 os.makedirs(FvPath)
1869 except:
1870 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1871
1872 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1873
1874 if VpdFile.Write(VpdFilePath):
1875 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1876 BPDGToolName = None
1877 for ToolDef in self.ToolDefinition.values():
1878 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1879 if not ToolDef.has_key("PATH"):
1880 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1881 BPDGToolName = ToolDef["PATH"]
1882 break
1883 # Call third party GUID BPDG tool.
1884 if BPDGToolName != None:
1885 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1886 else:
1887 EdkLogger.error("Build", FILE_NOT_FOUND, "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1888
1889 ## Return the platform build data object
1890 def _GetPlatform(self):
1891 if self._Platform == None:
1892 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1893 return self._Platform
1894
1895 ## Return platform name
1896 def _GetName(self):
1897 return self.Platform.PlatformName
1898
1899 ## Return the meta file GUID
1900 def _GetGuid(self):
1901 return self.Platform.Guid
1902
1903 ## Return the platform version
1904 def _GetVersion(self):
1905 return self.Platform.Version
1906
1907 ## Return the FDF file name
1908 def _GetFdfFile(self):
1909 if self._FdfFile == None:
1910 if self.Workspace.FdfFile != "":
1911 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)
1912 else:
1913 self._FdfFile = ''
1914 return self._FdfFile
1915
1916 ## Return the build output directory platform specifies
1917 def _GetOutputDir(self):
1918 return self.Platform.OutputDirectory
1919
1920 ## Return the directory to store all intermediate and final files built
1921 def _GetBuildDir(self):
1922 if self._BuildDir == None:
1923 if os.path.isabs(self.OutputDir):
1924 self._BuildDir = path.join(
1925 path.abspath(self.OutputDir),
1926 self.BuildTarget + "_" + self.ToolChain,
1927 )
1928 else:
1929 self._BuildDir = path.join(
1930 self.WorkspaceDir,
1931 self.OutputDir,
1932 self.BuildTarget + "_" + self.ToolChain,
1933 )
1934 GlobalData.gBuildDirectory = self._BuildDir
1935 return self._BuildDir
1936
1937 ## Return directory of platform makefile
1938 #
1939 # @retval string Makefile directory
1940 #
1941 def _GetMakeFileDir(self):
1942 if self._MakeFileDir == None:
1943 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1944 return self._MakeFileDir
1945
1946 ## Return build command string
1947 #
1948 # @retval string Build command string
1949 #
1950 def _GetBuildCommand(self):
1951 if self._BuildCommand == None:
1952 self._BuildCommand = []
1953 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1954 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1955 if "FLAGS" in self.ToolDefinition["MAKE"]:
1956 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1957 if NewOption != '':
1958 self._BuildCommand += SplitOption(NewOption)
1959 return self._BuildCommand
1960
1961 ## Get tool chain definition
1962 #
1963 # Get each tool defition for given tool chain from tools_def.txt and platform
1964 #
1965 def _GetToolDefinition(self):
1966 if self._ToolDefinitions == None:
1967 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1968 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1969 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1970 ExtraData="[%s]" % self.MetaFile)
1971 self._ToolDefinitions = {}
1972 DllPathList = set()
1973 for Def in ToolDefinition:
1974 Target, Tag, Arch, Tool, Attr = Def.split("_")
1975 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1976 continue
1977
1978 Value = ToolDefinition[Def]
1979 # don't record the DLL
1980 if Attr == "DLL":
1981 DllPathList.add(Value)
1982 continue
1983
1984 if Tool not in self._ToolDefinitions:
1985 self._ToolDefinitions[Tool] = {}
1986 self._ToolDefinitions[Tool][Attr] = Value
1987
1988 ToolsDef = ''
1989 MakePath = ''
1990 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
1991 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
1992 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
1993 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
1994 MakeFlags = ''
1995 for Tool in self._ToolDefinitions:
1996 for Attr in self._ToolDefinitions[Tool]:
1997 Value = self._ToolDefinitions[Tool][Attr]
1998 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
1999 # check if override is indicated
2000 if self.BuildOption[Tool][Attr].startswith('='):
2001 Value = self.BuildOption[Tool][Attr][1:]
2002 else:
2003 if Attr != 'PATH':
2004 Value += " " + self.BuildOption[Tool][Attr]
2005 else:
2006 Value = self.BuildOption[Tool][Attr]
2007
2008 if Attr == "PATH":
2009 # Don't put MAKE definition in the file
2010 if Tool == "MAKE":
2011 MakePath = Value
2012 else:
2013 ToolsDef += "%s = %s\n" % (Tool, Value)
2014 elif Attr != "DLL":
2015 # Don't put MAKE definition in the file
2016 if Tool == "MAKE":
2017 if Attr == "FLAGS":
2018 MakeFlags = Value
2019 else:
2020 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
2021 ToolsDef += "\n"
2022
2023 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
2024 for DllPath in DllPathList:
2025 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
2026 os.environ["MAKE_FLAGS"] = MakeFlags
2027
2028 return self._ToolDefinitions
2029
2030 ## Return the paths of tools
2031 def _GetToolDefFile(self):
2032 if self._ToolDefFile == None:
2033 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
2034 return self._ToolDefFile
2035
2036 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
2037 def _GetToolChainFamily(self):
2038 if self._ToolChainFamily == None:
2039 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
2040 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
2041 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
2042 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
2043 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2044 % self.ToolChain)
2045 self._ToolChainFamily = "MSFT"
2046 else:
2047 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
2048 return self._ToolChainFamily
2049
2050 def _GetBuildRuleFamily(self):
2051 if self._BuildRuleFamily == None:
2052 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
2053 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
2054 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
2055 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
2056 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2057 % self.ToolChain)
2058 self._BuildRuleFamily = "MSFT"
2059 else:
2060 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
2061 return self._BuildRuleFamily
2062
2063 ## Return the build options specific for all modules in this platform
2064 def _GetBuildOptions(self):
2065 if self._BuildOption == None:
2066 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
2067 return self._BuildOption
2068
2069 ## Return the build options specific for EDK modules in this platform
2070 def _GetEdkBuildOptions(self):
2071 if self._EdkBuildOption == None:
2072 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
2073 return self._EdkBuildOption
2074
2075 ## Return the build options specific for EDKII modules in this platform
2076 def _GetEdkIIBuildOptions(self):
2077 if self._EdkIIBuildOption == None:
2078 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
2079 return self._EdkIIBuildOption
2080
2081 ## Parse build_rule.txt in Conf Directory.
2082 #
2083 # @retval BuildRule object
2084 #
2085 def _GetBuildRule(self):
2086 if self._BuildRule == None:
2087 BuildRuleFile = None
2088 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
2089 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
2090 if BuildRuleFile in [None, '']:
2091 BuildRuleFile = gDefaultBuildRuleFile
2092 self._BuildRule = BuildRule(BuildRuleFile)
2093 if self._BuildRule._FileVersion == "":
2094 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
2095 else:
2096 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
2097 # If Build Rule's version is less than the version number required by the tools, halting the build.
2098 EdkLogger.error("build", AUTOGEN_ERROR,
2099 ExtraData="The version number [%s] of build_rule.txt is less than the version number required by the AutoGen.(the minimum required version number is [%s])"\
2100 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
2101
2102 return self._BuildRule
2103
2104 ## Summarize the packages used by modules in this platform
2105 def _GetPackageList(self):
2106 if self._PackageList == None:
2107 self._PackageList = set()
2108 for La in self.LibraryAutoGenList:
2109 self._PackageList.update(La.DependentPackageList)
2110 for Ma in self.ModuleAutoGenList:
2111 self._PackageList.update(Ma.DependentPackageList)
2112 #Collect package set information from INF of FDF
2113 PkgSet = set()
2114 for ModuleFile in self._AsBuildModuleList:
2115 if ModuleFile in self.Platform.Modules:
2116 continue
2117 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
2118 PkgSet.update(ModuleData.Packages)
2119 self._PackageList = list(self._PackageList) + list (PkgSet)
2120 return self._PackageList
2121
2122 def _GetNonDynamicPcdDict(self):
2123 if self._NonDynamicPcdDict:
2124 return self._NonDynamicPcdDict
2125 for Pcd in self.NonDynamicPcdList:
2126 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
2127 return self._NonDynamicPcdDict
2128
2129 ## Get list of non-dynamic PCDs
2130 def _GetNonDynamicPcdList(self):
2131 if self._NonDynamicPcdList == None:
2132 self.CollectPlatformDynamicPcds()
2133 return self._NonDynamicPcdList
2134
2135 ## Get list of dynamic PCDs
2136 def _GetDynamicPcdList(self):
2137 if self._DynamicPcdList == None:
2138 self.CollectPlatformDynamicPcds()
2139 return self._DynamicPcdList
2140
2141 ## Generate Token Number for all PCD
2142 def _GetPcdTokenNumbers(self):
2143 if self._PcdTokenNumber == None:
2144 self._PcdTokenNumber = sdict()
2145 TokenNumber = 1
2146 #
2147 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2148 # Such as:
2149 #
2150 # Dynamic PCD:
2151 # TokenNumber 0 ~ 10
2152 # DynamicEx PCD:
2153 # TokeNumber 11 ~ 20
2154 #
2155 for Pcd in self.DynamicPcdList:
2156 if Pcd.Phase == "PEI":
2157 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2158 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2159 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2160 TokenNumber += 1
2161
2162 for Pcd in self.DynamicPcdList:
2163 if Pcd.Phase == "PEI":
2164 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2165 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2166 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2167 TokenNumber += 1
2168
2169 for Pcd in self.DynamicPcdList:
2170 if Pcd.Phase == "DXE":
2171 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2172 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2173 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2174 TokenNumber += 1
2175
2176 for Pcd in self.DynamicPcdList:
2177 if Pcd.Phase == "DXE":
2178 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2179 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2180 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2181 TokenNumber += 1
2182
2183 for Pcd in self.NonDynamicPcdList:
2184 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2185 TokenNumber += 1
2186 return self._PcdTokenNumber
2187
2188 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2189 def _GetAutoGenObjectList(self):
2190 self._ModuleAutoGenList = []
2191 self._LibraryAutoGenList = []
2192 for ModuleFile in self.Platform.Modules:
2193 Ma = ModuleAutoGen(
2194 self.Workspace,
2195 ModuleFile,
2196 self.BuildTarget,
2197 self.ToolChain,
2198 self.Arch,
2199 self.MetaFile
2200 )
2201 if Ma not in self._ModuleAutoGenList:
2202 self._ModuleAutoGenList.append(Ma)
2203 for La in Ma.LibraryAutoGenList:
2204 if La not in self._LibraryAutoGenList:
2205 self._LibraryAutoGenList.append(La)
2206 if Ma not in La._ReferenceModules:
2207 La._ReferenceModules.append(Ma)
2208
2209 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2210 def _GetModuleAutoGenList(self):
2211 if self._ModuleAutoGenList == None:
2212 self._GetAutoGenObjectList()
2213 return self._ModuleAutoGenList
2214
2215 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2216 def _GetLibraryAutoGenList(self):
2217 if self._LibraryAutoGenList == None:
2218 self._GetAutoGenObjectList()
2219 return self._LibraryAutoGenList
2220
2221 ## Test if a module is supported by the platform
2222 #
2223 # An error will be raised directly if the module or its arch is not supported
2224 # by the platform or current configuration
2225 #
2226 def ValidModule(self, Module):
2227 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
2228 or Module in self._AsBuildModuleList
2229
2230 ## Resolve the library classes in a module to library instances
2231 #
2232 # This method will not only resolve library classes but also sort the library
2233 # instances according to the dependency-ship.
2234 #
2235 # @param Module The module from which the library classes will be resolved
2236 #
2237 # @retval library_list List of library instances sorted
2238 #
2239 def ApplyLibraryInstance(self, Module):
2240 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2241 if str(Module) not in self.Platform.Modules:
2242 return []
2243
2244 ModuleType = Module.ModuleType
2245
2246 # for overridding library instances with module specific setting
2247 PlatformModule = self.Platform.Modules[str(Module)]
2248
2249 # add forced library instances (specified under LibraryClasses sections)
2250 #
2251 # If a module has a MODULE_TYPE of USER_DEFINED,
2252 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2253 #
2254 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
2255 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
2256 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
2257 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
2258
2259 # add forced library instances (specified in module overrides)
2260 for LibraryClass in PlatformModule.LibraryClasses:
2261 if LibraryClass.startswith("NULL"):
2262 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
2263
2264 # EdkII module
2265 LibraryConsumerList = [Module]
2266 Constructor = []
2267 ConsumedByList = sdict()
2268 LibraryInstance = sdict()
2269
2270 EdkLogger.verbose("")
2271 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2272 while len(LibraryConsumerList) > 0:
2273 M = LibraryConsumerList.pop()
2274 for LibraryClassName in M.LibraryClasses:
2275 if LibraryClassName not in LibraryInstance:
2276 # override library instance for this module
2277 if LibraryClassName in PlatformModule.LibraryClasses:
2278 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
2279 else:
2280 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
2281 if LibraryPath == None or LibraryPath == "":
2282 LibraryPath = M.LibraryClasses[LibraryClassName]
2283 if LibraryPath == None or LibraryPath == "":
2284 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
2285 "Instance of library class [%s] is not found" % LibraryClassName,
2286 File=self.MetaFile,
2287 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
2288
2289 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
2290 # for those forced library instance (NULL library), add a fake library class
2291 if LibraryClassName.startswith("NULL"):
2292 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
2293 elif LibraryModule.LibraryClass == None \
2294 or len(LibraryModule.LibraryClass) == 0 \
2295 or (ModuleType != 'USER_DEFINED'
2296 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
2297 # only USER_DEFINED can link against any library instance despite of its SupModList
2298 EdkLogger.error("build", OPTION_MISSING,
2299 "Module type [%s] is not supported by library instance [%s]" \
2300 % (ModuleType, LibraryPath), File=self.MetaFile,
2301 ExtraData="consumed by [%s]" % str(Module))
2302
2303 LibraryInstance[LibraryClassName] = LibraryModule
2304 LibraryConsumerList.append(LibraryModule)
2305 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
2306 else:
2307 LibraryModule = LibraryInstance[LibraryClassName]
2308
2309 if LibraryModule == None:
2310 continue
2311
2312 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
2313 Constructor.append(LibraryModule)
2314
2315 if LibraryModule not in ConsumedByList:
2316 ConsumedByList[LibraryModule] = []
2317 # don't add current module itself to consumer list
2318 if M != Module:
2319 if M in ConsumedByList[LibraryModule]:
2320 continue
2321 ConsumedByList[LibraryModule].append(M)
2322 #
2323 # Initialize the sorted output list to the empty set
2324 #
2325 SortedLibraryList = []
2326 #
2327 # Q <- Set of all nodes with no incoming edges
2328 #
2329 LibraryList = [] #LibraryInstance.values()
2330 Q = []
2331 for LibraryClassName in LibraryInstance:
2332 M = LibraryInstance[LibraryClassName]
2333 LibraryList.append(M)
2334 if ConsumedByList[M] == []:
2335 Q.append(M)
2336
2337 #
2338 # start the DAG algorithm
2339 #
2340 while True:
2341 EdgeRemoved = True
2342 while Q == [] and EdgeRemoved:
2343 EdgeRemoved = False
2344 # for each node Item with a Constructor
2345 for Item in LibraryList:
2346 if Item not in Constructor:
2347 continue
2348 # for each Node without a constructor with an edge e from Item to Node
2349 for Node in ConsumedByList[Item]:
2350 if Node in Constructor:
2351 continue
2352 # remove edge e from the graph if Node has no constructor
2353 ConsumedByList[Item].remove(Node)
2354 EdgeRemoved = True
2355 if ConsumedByList[Item] == []:
2356 # insert Item into Q
2357 Q.insert(0, Item)
2358 break
2359 if Q != []:
2360 break
2361 # DAG is done if there's no more incoming edge for all nodes
2362 if Q == []:
2363 break
2364
2365 # remove node from Q
2366 Node = Q.pop()
2367 # output Node
2368 SortedLibraryList.append(Node)
2369
2370 # for each node Item with an edge e from Node to Item do
2371 for Item in LibraryList:
2372 if Node not in ConsumedByList[Item]:
2373 continue
2374 # remove edge e from the graph
2375 ConsumedByList[Item].remove(Node)
2376
2377 if ConsumedByList[Item] != []:
2378 continue
2379 # insert Item into Q, if Item has no other incoming edges
2380 Q.insert(0, Item)
2381
2382 #
2383 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2384 #
2385 for Item in LibraryList:
2386 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
2387 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
2388 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
2389 ExtraData=ErrorMessage, File=self.MetaFile)
2390 if Item not in SortedLibraryList:
2391 SortedLibraryList.append(Item)
2392
2393 #
2394 # Build the list of constructor and destructir names
2395 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2396 #
2397 SortedLibraryList.reverse()
2398 return SortedLibraryList
2399
2400
2401 ## Override PCD setting (type, value, ...)
2402 #
2403 # @param ToPcd The PCD to be overrided
2404 # @param FromPcd The PCD overrideing from
2405 #
2406 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
2407 #
2408 # in case there's PCDs coming from FDF file, which have no type given.
2409 # at this point, ToPcd.Type has the type found from dependent
2410 # package
2411 #
2412 TokenCName = ToPcd.TokenCName
2413 for PcdItem in GlobalData.MixedPcd:
2414 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
2415 TokenCName = PcdItem[0]
2416 break
2417 if FromPcd != None:
2418 if GlobalData.BuildOptionPcd:
2419 for pcd in GlobalData.BuildOptionPcd:
2420 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):
2421 FromPcd.DefaultValue = pcd[2]
2422 break
2423 if ToPcd.Pending and FromPcd.Type not in [None, '']:
2424 ToPcd.Type = FromPcd.Type
2425 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
2426 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
2427 if ToPcd.Type.strip() == "DynamicEx":
2428 ToPcd.Type = FromPcd.Type
2429 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
2430 and ToPcd.Type != FromPcd.Type:
2431 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
2432 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2433 % (ToPcd.TokenSpaceGuidCName, TokenCName,
2434 ToPcd.Type, Module, FromPcd.Type),
2435 File=self.MetaFile)
2436
2437 if FromPcd.MaxDatumSize not in [None, '']:
2438 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2439 if FromPcd.DefaultValue not in [None, '']:
2440 ToPcd.DefaultValue = FromPcd.DefaultValue
2441 if FromPcd.TokenValue not in [None, '']:
2442 ToPcd.TokenValue = FromPcd.TokenValue
2443 if FromPcd.MaxDatumSize not in [None, '']:
2444 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2445 if FromPcd.DatumType not in [None, '']:
2446 ToPcd.DatumType = FromPcd.DatumType
2447 if FromPcd.SkuInfoList not in [None, '', []]:
2448 ToPcd.SkuInfoList = FromPcd.SkuInfoList
2449
2450 # check the validation of datum
2451 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
2452 if not IsValid:
2453 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
2454 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))
2455 ToPcd.validateranges = FromPcd.validateranges
2456 ToPcd.validlists = FromPcd.validlists
2457 ToPcd.expressions = FromPcd.expressions
2458
2459 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
2460 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
2461 % (ToPcd.TokenSpaceGuidCName, TokenCName))
2462 Value = ToPcd.DefaultValue
2463 if Value in [None, '']:
2464 ToPcd.MaxDatumSize = '1'
2465 elif Value[0] == 'L':
2466 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
2467 elif Value[0] == '{':
2468 ToPcd.MaxDatumSize = str(len(Value.split(',')))
2469 else:
2470 ToPcd.MaxDatumSize = str(len(Value) - 1)
2471
2472 # apply default SKU for dynamic PCDS if specified one is not available
2473 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
2474 and ToPcd.SkuInfoList in [None, {}, '']:
2475 if self.Platform.SkuName in self.Platform.SkuIds:
2476 SkuName = self.Platform.SkuName
2477 else:
2478 SkuName = 'DEFAULT'
2479 ToPcd.SkuInfoList = {
2480 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)
2481 }
2482
2483 ## Apply PCD setting defined platform to a module
2484 #
2485 # @param Module The module from which the PCD setting will be overrided
2486 #
2487 # @retval PCD_list The list PCDs with settings from platform
2488 #
2489 def ApplyPcdSetting(self, Module, Pcds):
2490 # for each PCD in module
2491 for Name, Guid in Pcds:
2492 PcdInModule = Pcds[Name, Guid]
2493 # find out the PCD setting in platform
2494 if (Name, Guid) in self.Platform.Pcds:
2495 PcdInPlatform = self.Platform.Pcds[Name, Guid]
2496 else:
2497 PcdInPlatform = None
2498 # then override the settings if any
2499 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
2500 # resolve the VariableGuid value
2501 for SkuId in PcdInModule.SkuInfoList:
2502 Sku = PcdInModule.SkuInfoList[SkuId]
2503 if Sku.VariableGuid == '': continue
2504 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)
2505 if Sku.VariableGuidValue == None:
2506 PackageList = "\n\t".join([str(P) for P in self.PackageList])
2507 EdkLogger.error(
2508 'build',
2509 RESOURCE_NOT_AVAILABLE,
2510 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
2511 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
2512 % (Guid, Name, str(Module)),
2513 File=self.MetaFile
2514 )
2515
2516 # override PCD settings with module specific setting
2517 if Module in self.Platform.Modules:
2518 PlatformModule = self.Platform.Modules[str(Module)]
2519 for Key in PlatformModule.Pcds:
2520 Flag = False
2521 if Key in Pcds:
2522 ToPcd = Pcds[Key]
2523 Flag = True
2524 elif Key in GlobalData.MixedPcd:
2525 for PcdItem in GlobalData.MixedPcd[Key]:
2526 if PcdItem in Pcds:
2527 ToPcd = Pcds[PcdItem]
2528 Flag = True
2529 break
2530 if Flag:
2531 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)
2532 return Pcds.values()
2533
2534 ## Resolve library names to library modules
2535 #
2536 # (for Edk.x modules)
2537 #
2538 # @param Module The module from which the library names will be resolved
2539 #
2540 # @retval library_list The list of library modules
2541 #
2542 def ResolveLibraryReference(self, Module):
2543 EdkLogger.verbose("")
2544 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2545 LibraryConsumerList = [Module]
2546
2547 # "CompilerStub" is a must for Edk modules
2548 if Module.Libraries:
2549 Module.Libraries.append("CompilerStub")
2550 LibraryList = []
2551 while len(LibraryConsumerList) > 0:
2552 M = LibraryConsumerList.pop()
2553 for LibraryName in M.Libraries:
2554 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2555 if Library == None:
2556 for Key in self.Platform.LibraryClasses.data.keys():
2557 if LibraryName.upper() == Key.upper():
2558 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2559 break
2560 if Library == None:
2561 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2562 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2563 continue
2564
2565 if Library not in LibraryList:
2566 LibraryList.append(Library)
2567 LibraryConsumerList.append(Library)
2568 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2569 return LibraryList
2570
2571 ## Calculate the priority value of the build option
2572 #
2573 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2574 #
2575 # @retval Value Priority value based on the priority list.
2576 #
2577 def CalculatePriorityValue(self, Key):
2578 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2579 PriorityValue = 0x11111
2580 if Target == "*":
2581 PriorityValue &= 0x01111
2582 if ToolChain == "*":
2583 PriorityValue &= 0x10111
2584 if Arch == "*":
2585 PriorityValue &= 0x11011
2586 if CommandType == "*":
2587 PriorityValue &= 0x11101
2588 if Attr == "*":
2589 PriorityValue &= 0x11110
2590
2591 return self.PrioList["0x%0.5x" % PriorityValue]
2592
2593
2594 ## Expand * in build option key
2595 #
2596 # @param Options Options to be expanded
2597 #
2598 # @retval options Options expanded
2599 #
2600 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2601 BuildOptions = {}
2602 FamilyMatch = False
2603 FamilyIsNull = True
2604
2605 OverrideList = {}
2606 #
2607 # Construct a list contain the build options which need override.
2608 #
2609 for Key in Options:
2610 #
2611 # Key[0] -- tool family
2612 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2613 #
2614 if (Key[0] == self.BuildRuleFamily and
2615 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2616 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2617 if Target == self.BuildTarget or Target == "*":
2618 if ToolChain == self.ToolChain or ToolChain == "*":
2619 if Arch == self.Arch or Arch == "*":
2620 if Options[Key].startswith("="):
2621 if OverrideList.get(Key[1]) != None:
2622 OverrideList.pop(Key[1])
2623 OverrideList[Key[1]] = Options[Key]
2624
2625 #
2626 # Use the highest priority value.
2627 #
2628 if (len(OverrideList) >= 2):
2629 KeyList = OverrideList.keys()
2630 for Index in range(len(KeyList)):
2631 NowKey = KeyList[Index]
2632 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2633 for Index1 in range(len(KeyList) - Index - 1):
2634 NextKey = KeyList[Index1 + Index + 1]
2635 #
2636 # Compare two Key, if one is included by another, choose the higher priority one
2637 #
2638 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2639 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2640 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2641 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2642 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2643 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2644 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2645 if Options.get((self.BuildRuleFamily, NextKey)) != None:
2646 Options.pop((self.BuildRuleFamily, NextKey))
2647 else:
2648 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2649 Options.pop((self.BuildRuleFamily, NowKey))
2650
2651 for Key in Options:
2652 if ModuleStyle != None and len (Key) > 2:
2653 # Check Module style is EDK or EDKII.
2654 # Only append build option for the matched style module.
2655 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2656 continue
2657 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2658 continue
2659 Family = Key[0]
2660 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2661 # if tool chain family doesn't match, skip it
2662 if Tool in self.ToolDefinition and Family != "":
2663 FamilyIsNull = False
2664 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2665 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2666 continue
2667 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2668 continue
2669 FamilyMatch = True
2670 # expand any wildcard
2671 if Target == "*" or Target == self.BuildTarget:
2672 if Tag == "*" or Tag == self.ToolChain:
2673 if Arch == "*" or Arch == self.Arch:
2674 if Tool not in BuildOptions:
2675 BuildOptions[Tool] = {}
2676 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2677 BuildOptions[Tool][Attr] = Options[Key]
2678 else:
2679 # append options for the same tool except PATH
2680 if Attr != 'PATH':
2681 BuildOptions[Tool][Attr] += " " + Options[Key]
2682 else:
2683 BuildOptions[Tool][Attr] = Options[Key]
2684 # Build Option Family has been checked, which need't to be checked again for family.
2685 if FamilyMatch or FamilyIsNull:
2686 return BuildOptions
2687
2688 for Key in Options:
2689 if ModuleStyle != None and len (Key) > 2:
2690 # Check Module style is EDK or EDKII.
2691 # Only append build option for the matched style module.
2692 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2693 continue
2694 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2695 continue
2696 Family = Key[0]
2697 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2698 # if tool chain family doesn't match, skip it
2699 if Tool not in self.ToolDefinition or Family == "":
2700 continue
2701 # option has been added before
2702 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2703 continue
2704
2705 # expand any wildcard
2706 if Target == "*" or Target == self.BuildTarget:
2707 if Tag == "*" or Tag == self.ToolChain:
2708 if Arch == "*" or Arch == self.Arch:
2709 if Tool not in BuildOptions:
2710 BuildOptions[Tool] = {}
2711 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2712 BuildOptions[Tool][Attr] = Options[Key]
2713 else:
2714 # append options for the same tool except PATH
2715 if Attr != 'PATH':
2716 BuildOptions[Tool][Attr] += " " + Options[Key]
2717 else:
2718 BuildOptions[Tool][Attr] = Options[Key]
2719 return BuildOptions
2720
2721 ## Append build options in platform to a module
2722 #
2723 # @param Module The module to which the build options will be appened
2724 #
2725 # @retval options The options appended with build options in platform
2726 #
2727 def ApplyBuildOption(self, Module):
2728 # Get the different options for the different style module
2729 if Module.AutoGenVersion < 0x00010005:
2730 PlatformOptions = self.EdkBuildOption
2731 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2732 else:
2733 PlatformOptions = self.EdkIIBuildOption
2734 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2735 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2736 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2737 if Module in self.Platform.Modules:
2738 PlatformModule = self.Platform.Modules[str(Module)]
2739 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2740 else:
2741 PlatformModuleOptions = {}
2742
2743 BuildRuleOrder = None
2744 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2745 for Tool in Options:
2746 for Attr in Options[Tool]:
2747 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2748 BuildRuleOrder = Options[Tool][Attr]
2749
2750 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2751 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2752 self.ToolDefinition.keys())
2753 BuildOptions = {}
2754 for Tool in AllTools:
2755 if Tool not in BuildOptions:
2756 BuildOptions[Tool] = {}
2757
2758 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2759 if Tool not in Options:
2760 continue
2761 for Attr in Options[Tool]:
2762 Value = Options[Tool][Attr]
2763 #
2764 # Do not generate it in Makefile
2765 #
2766 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2767 continue
2768 if Attr not in BuildOptions[Tool]:
2769 BuildOptions[Tool][Attr] = ""
2770 # check if override is indicated
2771 if Value.startswith('='):
2772 ToolPath = Value[1:]
2773 ToolPath = mws.handleWsMacro(ToolPath)
2774 BuildOptions[Tool][Attr] = ToolPath
2775 else:
2776 Value = mws.handleWsMacro(Value)
2777 if Attr != 'PATH':
2778 BuildOptions[Tool][Attr] += " " + Value
2779 else:
2780 BuildOptions[Tool][Attr] = Value
2781 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2782 #
2783 # Override UNI flag only for EDK module.
2784 #
2785 if 'BUILD' not in BuildOptions:
2786 BuildOptions['BUILD'] = {}
2787 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2788 return BuildOptions, BuildRuleOrder
2789
2790 Platform = property(_GetPlatform)
2791 Name = property(_GetName)
2792 Guid = property(_GetGuid)
2793 Version = property(_GetVersion)
2794
2795 OutputDir = property(_GetOutputDir)
2796 BuildDir = property(_GetBuildDir)
2797 MakeFileDir = property(_GetMakeFileDir)
2798 FdfFile = property(_GetFdfFile)
2799
2800 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2801 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2802 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2803 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2804 PackageList = property(_GetPackageList)
2805
2806 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2807 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2808 ToolChainFamily = property(_GetToolChainFamily)
2809 BuildRuleFamily = property(_GetBuildRuleFamily)
2810 BuildOption = property(_GetBuildOptions) # toolcode : option
2811 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2812 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2813
2814 BuildCommand = property(_GetBuildCommand)
2815 BuildRule = property(_GetBuildRule)
2816 ModuleAutoGenList = property(_GetModuleAutoGenList)
2817 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2818 GenFdsCommand = property(_GenFdsCommand)
2819
2820 ## ModuleAutoGen class
2821 #
2822 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2823 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2824 # to the [depex] section in module's inf file.
2825 #
2826 class ModuleAutoGen(AutoGen):
2827 ## Cache the timestamps of metafiles of every module in a class variable
2828 #
2829 TimeDict = {}
2830
2831 ## The real constructor of ModuleAutoGen
2832 #
2833 # This method is not supposed to be called by users of ModuleAutoGen. It's
2834 # only used by factory method __new__() to do real initialization work for an
2835 # object of ModuleAutoGen
2836 #
2837 # @param Workspace EdkIIWorkspaceBuild object
2838 # @param ModuleFile The path of module file
2839 # @param Target Build target (DEBUG, RELEASE)
2840 # @param Toolchain Name of tool chain
2841 # @param Arch The arch the module supports
2842 # @param PlatformFile Platform meta-file
2843 #
2844 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2845 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2846 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2847
2848 self.Workspace = Workspace
2849 self.WorkspaceDir = Workspace.WorkspaceDir
2850
2851 self.MetaFile = ModuleFile
2852 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2853 # check if this module is employed by active platform
2854 if not self.PlatformInfo.ValidModule(self.MetaFile):
2855 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2856 % (self.MetaFile, Arch))
2857 return False
2858
2859 self.SourceDir = self.MetaFile.SubDir
2860 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2861
2862 self.SourceOverrideDir = None
2863 # use overrided path defined in DSC file
2864 if self.MetaFile.Key in GlobalData.gOverrideDir:
2865 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2866
2867 self.ToolChain = Toolchain
2868 self.BuildTarget = Target
2869 self.Arch = Arch
2870 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2871 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2872
2873 self.IsMakeFileCreated = False
2874 self.IsCodeFileCreated = False
2875 self.IsAsBuiltInfCreated = False
2876 self.DepexGenerated = False
2877
2878 self.BuildDatabase = self.Workspace.BuildDatabase
2879 self.BuildRuleOrder = None
2880 self.BuildTime = 0
2881
2882 self._Module = None
2883 self._Name = None
2884 self._Guid = None
2885 self._Version = None
2886 self._ModuleType = None
2887 self._ComponentType = None
2888 self._PcdIsDriver = None
2889 self._AutoGenVersion = None
2890 self._LibraryFlag = None
2891 self._CustomMakefile = None
2892 self._Macro = None
2893
2894 self._BuildDir = None
2895 self._OutputDir = None
2896 self._FfsOutputDir = None
2897 self._DebugDir = None
2898 self._MakeFileDir = None
2899
2900 self._IncludePathList = None
2901 self._IncludePathLength = 0
2902 self._AutoGenFileList = None
2903 self._UnicodeFileList = None
2904 self._VfrFileList = None
2905 self._IdfFileList = None
2906 self._SourceFileList = None
2907 self._ObjectFileList = None
2908 self._BinaryFileList = None
2909
2910 self._DependentPackageList = None
2911 self._DependentLibraryList = None
2912 self._LibraryAutoGenList = None
2913 self._DerivedPackageList = None
2914 self._ModulePcdList = None
2915 self._LibraryPcdList = None
2916 self._PcdComments = sdict()
2917 self._GuidList = None
2918 self._GuidsUsedByPcd = None
2919 self._GuidComments = sdict()
2920 self._ProtocolList = None
2921 self._ProtocolComments = sdict()
2922 self._PpiList = None
2923 self._PpiComments = sdict()
2924 self._DepexList = None
2925 self._DepexExpressionList = None
2926 self._BuildOption = None
2927 self._BuildOptionIncPathList = None
2928 self._BuildTargets = None
2929 self._IntroBuildTargetList = None
2930 self._FinalBuildTargetList = None
2931 self._FileTypes = None
2932 self._BuildRules = None
2933
2934 self._TimeStampPath = None
2935
2936 self.AutoGenDepSet = set()
2937
2938
2939 ## The Modules referenced to this Library
2940 # Only Library has this attribute
2941 self._ReferenceModules = []
2942
2943 ## Store the FixedAtBuild Pcds
2944 #
2945 self._FixedAtBuildPcds = []
2946 self.ConstPcd = {}
2947 return True
2948
2949 def __repr__(self):
2950 return "%s [%s]" % (self.MetaFile, self.Arch)
2951
2952 # Get FixedAtBuild Pcds of this Module
2953 def _GetFixedAtBuildPcds(self):
2954 if self._FixedAtBuildPcds:
2955 return self._FixedAtBuildPcds
2956 for Pcd in self.ModulePcdList:
2957 if Pcd.Type != "FixedAtBuild":
2958 continue
2959 if Pcd not in self._FixedAtBuildPcds:
2960 self._FixedAtBuildPcds.append(Pcd)
2961
2962 return self._FixedAtBuildPcds
2963
2964 def _GetUniqueBaseName(self):
2965 BaseName = self.Name
2966 for Module in self.PlatformInfo.ModuleAutoGenList:
2967 if Module.MetaFile == self.MetaFile:
2968 continue
2969 if Module.Name == self.Name:
2970 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2971 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2972 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2973 BaseName = '%s_%s' % (self.Name, self.Guid)
2974 return BaseName
2975
2976 # Macros could be used in build_rule.txt (also Makefile)
2977 def _GetMacros(self):
2978 if self._Macro == None:
2979 self._Macro = sdict()
2980 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2981 self._Macro["MODULE_NAME" ] = self.Name
2982 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2983 self._Macro["MODULE_GUID" ] = self.Guid
2984 self._Macro["MODULE_VERSION" ] = self.Version
2985 self._Macro["MODULE_TYPE" ] = self.ModuleType
2986 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2987 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2988 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2989 self._Macro["MODULE_DIR" ] = self.SourceDir
2990
2991 self._Macro["BASE_NAME" ] = self.Name
2992
2993 self._Macro["ARCH" ] = self.Arch
2994 self._Macro["TOOLCHAIN" ] = self.ToolChain
2995 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2996 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2997 self._Macro["TARGET" ] = self.BuildTarget
2998
2999 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
3000 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
3001 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
3002 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
3003 self._Macro["OUTPUT_DIR" ] = self.OutputDir
3004 self._Macro["DEBUG_DIR" ] = self.DebugDir
3005 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
3006 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
3007 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
3008 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
3009 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
3010 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
3011 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
3012 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
3013 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
3014 return self._Macro
3015
3016 ## Return the module build data object
3017 def _GetModule(self):
3018 if self._Module == None:
3019 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
3020 return self._Module
3021
3022 ## Return the module name
3023 def _GetBaseName(self):
3024 return self.Module.BaseName
3025
3026 ## Return the module DxsFile if exist
3027 def _GetDxsFile(self):
3028 return self.Module.DxsFile
3029
3030 ## Return the module SourceOverridePath
3031 def _GetSourceOverridePath(self):
3032 return self.Module.SourceOverridePath
3033
3034 ## Return the module meta-file GUID
3035 def _GetGuid(self):
3036 #
3037 # To build same module more than once, the module path with FILE_GUID overridden has
3038 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3039 # in DSC. The overridden GUID can be retrieved from file name
3040 #
3041 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
3042 #
3043 # Length of GUID is 36
3044 #
3045 return os.path.basename(self.MetaFile.Path)[:36]
3046 return self.Module.Guid
3047
3048 ## Return the module version
3049 def _GetVersion(self):
3050 return self.Module.Version
3051
3052 ## Return the module type
3053 def _GetModuleType(self):
3054 return self.Module.ModuleType
3055
3056 ## Return the component type (for Edk.x style of module)
3057 def _GetComponentType(self):
3058 return self.Module.ComponentType
3059
3060 ## Return the build type
3061 def _GetBuildType(self):
3062 return self.Module.BuildType
3063
3064 ## Return the PCD_IS_DRIVER setting
3065 def _GetPcdIsDriver(self):
3066 return self.Module.PcdIsDriver
3067
3068 ## Return the autogen version, i.e. module meta-file version
3069 def _GetAutoGenVersion(self):
3070 return self.Module.AutoGenVersion
3071
3072 ## Check if the module is library or not
3073 def _IsLibrary(self):
3074 if self._LibraryFlag == None:
3075 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
3076 self._LibraryFlag = True
3077 else:
3078 self._LibraryFlag = False
3079 return self._LibraryFlag
3080
3081 ## Check if the module is binary module or not
3082 def _IsBinaryModule(self):
3083 return self.Module.IsBinaryModule
3084
3085 ## Return the directory to store intermediate files of the module
3086 def _GetBuildDir(self):
3087 if self._BuildDir == None:
3088 self._BuildDir = path.join(
3089 self.PlatformInfo.BuildDir,
3090 self.Arch,
3091 self.SourceDir,
3092 self.MetaFile.BaseName
3093 )
3094 CreateDirectory(self._BuildDir)
3095 return self._BuildDir
3096
3097 ## Return the directory to store the intermediate object files of the mdoule
3098 def _GetOutputDir(self):
3099 if self._OutputDir == None:
3100 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3101 CreateDirectory(self._OutputDir)
3102 return self._OutputDir
3103
3104 ## Return the directory to store ffs file
3105 def _GetFfsOutputDir(self):
3106 if self._FfsOutputDir == None:
3107 if GlobalData.gFdfParser != None:
3108 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)
3109 else:
3110 self._FfsOutputDir = ''
3111 return self._FfsOutputDir
3112
3113 ## Return the directory to store auto-gened source files of the mdoule
3114 def _GetDebugDir(self):
3115 if self._DebugDir == None:
3116 self._DebugDir = path.join(self.BuildDir, "DEBUG")
3117 CreateDirectory(self._DebugDir)
3118 return self._DebugDir
3119
3120 ## Return the path of custom file
3121 def _GetCustomMakefile(self):
3122 if self._CustomMakefile == None:
3123 self._CustomMakefile = {}
3124 for Type in self.Module.CustomMakefile:
3125 if Type in gMakeTypeMap:
3126 MakeType = gMakeTypeMap[Type]
3127 else:
3128 MakeType = 'nmake'
3129 if self.SourceOverrideDir != None:
3130 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
3131 if not os.path.exists(File):
3132 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3133 else:
3134 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3135 self._CustomMakefile[MakeType] = File
3136 return self._CustomMakefile
3137
3138 ## Return the directory of the makefile
3139 #
3140 # @retval string The directory string of module's makefile
3141 #
3142 def _GetMakeFileDir(self):
3143 return self.BuildDir
3144
3145 ## Return build command string
3146 #
3147 # @retval string Build command string
3148 #
3149 def _GetBuildCommand(self):
3150 return self.PlatformInfo.BuildCommand
3151
3152 ## Get object list of all packages the module and its dependent libraries belong to
3153 #
3154 # @retval list The list of package object
3155 #
3156 def _GetDerivedPackageList(self):
3157 PackageList = []
3158 for M in [self.Module] + self.DependentLibraryList:
3159 for Package in M.Packages:
3160 if Package in PackageList:
3161 continue
3162 PackageList.append(Package)
3163 return PackageList
3164
3165 ## Get the depex string
3166 #
3167 # @return : a string contain all depex expresion.
3168 def _GetDepexExpresionString(self):
3169 DepexStr = ''
3170 DepexList = []
3171 ## DPX_SOURCE IN Define section.
3172 if self.Module.DxsFile:
3173 return DepexStr
3174 for M in [self.Module] + self.DependentLibraryList:
3175 Filename = M.MetaFile.Path
3176 InfObj = InfSectionParser.InfSectionParser(Filename)
3177 DepexExpresionList = InfObj.GetDepexExpresionList()
3178 for DepexExpresion in DepexExpresionList:
3179 for key in DepexExpresion.keys():
3180 Arch, ModuleType = key
3181 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]
3182 # the type of build module is USER_DEFINED.
3183 # All different DEPEX section tags would be copied into the As Built INF file
3184 # and there would be separate DEPEX section tags
3185 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3186 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
3187 DepexList.append({(Arch, ModuleType): DepexExpr})
3188 else:
3189 if Arch.upper() == TAB_ARCH_COMMON or \
3190 (Arch.upper() == self.Arch.upper() and \
3191 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
3192 DepexList.append({(Arch, ModuleType): DepexExpr})
3193
3194 #the type of build module is USER_DEFINED.
3195 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3196 for Depex in DepexList:
3197 for key in Depex.keys():
3198 DepexStr += '[Depex.%s.%s]\n' % key
3199 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
3200 DepexStr += '\n\n'
3201 if not DepexStr:
3202 return '[Depex.%s]\n' % self.Arch
3203 return DepexStr
3204
3205 #the type of build module not is USER_DEFINED.
3206 Count = 0
3207 for Depex in DepexList:
3208 Count += 1
3209 if DepexStr != '':
3210 DepexStr += ' AND '
3211 DepexStr += '('
3212 for D in Depex.values():
3213 DepexStr += ' '.join([val for val in D])
3214 Index = DepexStr.find('END')
3215 if Index > -1 and Index == len(DepexStr) - 3:
3216 DepexStr = DepexStr[:-3]
3217 DepexStr = DepexStr.strip()
3218 DepexStr += ')'
3219 if Count == 1:
3220 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
3221 if not DepexStr:
3222 return '[Depex.%s]\n' % self.Arch
3223 return '[Depex.%s]\n# ' % self.Arch + DepexStr
3224
3225 ## Merge dependency expression
3226 #
3227 # @retval list The token list of the dependency expression after parsed
3228 #
3229 def _GetDepexTokenList(self):
3230 if self._DepexList == None:
3231 self._DepexList = {}
3232 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3233 return self._DepexList
3234
3235 self._DepexList[self.ModuleType] = []
3236
3237 for ModuleType in self._DepexList:
3238 DepexList = self._DepexList[ModuleType]
3239 #
3240 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3241 #
3242 for M in [self.Module] + self.DependentLibraryList:
3243 Inherited = False
3244 for D in M.Depex[self.Arch, ModuleType]:
3245 if DepexList != []:
3246 DepexList.append('AND')
3247 DepexList.append('(')
3248 DepexList.extend(D)
3249 if DepexList[-1] == 'END': # no need of a END at this time
3250 DepexList.pop()
3251 DepexList.append(')')
3252 Inherited = True
3253 if Inherited:
3254 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
3255 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
3256 break
3257 if len(DepexList) > 0:
3258 EdkLogger.verbose('')
3259 return self._DepexList
3260
3261 ## Merge dependency expression
3262 #
3263 # @retval list The token list of the dependency expression after parsed
3264 #
3265 def _GetDepexExpressionTokenList(self):
3266 if self._DepexExpressionList == None:
3267 self._DepexExpressionList = {}
3268 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3269 return self._DepexExpressionList
3270
3271 self._DepexExpressionList[self.ModuleType] = ''
3272
3273 for ModuleType in self._DepexExpressionList:
3274 DepexExpressionList = self._DepexExpressionList[ModuleType]
3275 #
3276 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3277 #
3278 for M in [self.Module] + self.DependentLibraryList:
3279 Inherited = False
3280 for D in M.DepexExpression[self.Arch, ModuleType]:
3281 if DepexExpressionList != '':
3282 DepexExpressionList += ' AND '
3283 DepexExpressionList += '('
3284 DepexExpressionList += D
3285 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
3286 DepexExpressionList += ')'
3287 Inherited = True
3288 if Inherited:
3289 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
3290 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
3291 break
3292 if len(DepexExpressionList) > 0:
3293 EdkLogger.verbose('')
3294 self._DepexExpressionList[ModuleType] = DepexExpressionList
3295 return self._DepexExpressionList
3296
3297 # Get the tiano core user extension, it is contain dependent library.
3298 # @retval: a list contain tiano core userextension.
3299 #
3300 def _GetTianoCoreUserExtensionList(self):
3301 TianoCoreUserExtentionList = []
3302 for M in [self.Module] + self.DependentLibraryList:
3303 Filename = M.MetaFile.Path
3304 InfObj = InfSectionParser.InfSectionParser(Filename)
3305 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()
3306 for TianoCoreUserExtent in TianoCoreUserExtenList:
3307 for Section in TianoCoreUserExtent.keys():
3308 ItemList = Section.split(TAB_SPLIT)
3309 Arch = self.Arch
3310 if len(ItemList) == 4:
3311 Arch = ItemList[3]
3312 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():
3313 TianoCoreList = []
3314 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])
3315 TianoCoreList.extend(TianoCoreUserExtent[Section][:])
3316 TianoCoreList.append('\n')
3317 TianoCoreUserExtentionList.append(TianoCoreList)
3318
3319 return TianoCoreUserExtentionList
3320
3321 ## Return the list of specification version required for the module
3322 #
3323 # @retval list The list of specification defined in module file
3324 #
3325 def _GetSpecification(self):
3326 return self.Module.Specification
3327
3328 ## Tool option for the module build
3329 #
3330 # @param PlatformInfo The object of PlatformBuildInfo
3331 # @retval dict The dict containing valid options
3332 #
3333 def _GetModuleBuildOption(self):
3334 if self._BuildOption == None:
3335 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
3336 if self.BuildRuleOrder:
3337 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
3338 return self._BuildOption
3339
3340 ## Get include path list from tool option for the module build
3341 #
3342 # @retval list The include path list
3343 #
3344 def _GetBuildOptionIncPathList(self):
3345 if self._BuildOptionIncPathList == None:
3346 #
3347 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3348 # is the former use /I , the Latter used -I to specify include directories
3349 #
3350 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
3351 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3352 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
3353 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3354 else:
3355 #
3356 # New ToolChainFamily, don't known whether there is option to specify include directories
3357 #
3358 self._BuildOptionIncPathList = []
3359 return self._BuildOptionIncPathList
3360
3361 BuildOptionIncPathList = []
3362 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3363 Attr = 'FLAGS'
3364 try:
3365 FlagOption = self.BuildOption[Tool][Attr]
3366 except KeyError:
3367 FlagOption = ''
3368
3369 if self.PlatformInfo.ToolChainFamily != 'RVCT':
3370 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
3371 else:
3372 #
3373 # RVCT may specify a list of directory seperated by commas
3374 #
3375 IncPathList = []
3376 for Path in gBuildOptIncludePattern.findall(FlagOption):
3377 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
3378 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
3379
3380 #
3381 # EDK II modules must not reference header files outside of the packages they depend on or
3382 # within the module's directory tree. Report error if violation.
3383 #
3384 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
3385 for Path in IncPathList:
3386 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
3387 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
3388 EdkLogger.error("build",
3389 PARAMETER_INVALID,
3390 ExtraData=ErrMsg,
3391 File=str(self.MetaFile))
3392
3393
3394 BuildOptionIncPathList += IncPathList
3395
3396 self._BuildOptionIncPathList = BuildOptionIncPathList
3397
3398 return self._BuildOptionIncPathList
3399
3400 ## Return a list of files which can be built from source
3401 #
3402 # What kind of files can be built is determined by build rules in
3403 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3404 #
3405 def _GetSourceFileList(self):
3406 if self._SourceFileList == None:
3407 self._SourceFileList = []
3408 for F in self.Module.Sources:
3409 # match tool chain
3410 if F.TagName not in ("", "*", self.ToolChain):
3411 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
3412 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
3413 continue
3414 # match tool chain family or build rule family
3415 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):
3416 EdkLogger.debug(
3417 EdkLogger.DEBUG_0,
3418 "The file [%s] must be built by tools of [%s], " \
3419 "but current toolchain family is [%s], buildrule family is [%s]" \
3420 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))
3421 continue
3422
3423 # add the file path into search path list for file including
3424 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
3425 self.IncludePathList.insert(0, F.Dir)
3426 self._SourceFileList.append(F)
3427
3428 self._MatchBuildRuleOrder(self._SourceFileList)
3429
3430 for F in self._SourceFileList:
3431 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
3432 return self._SourceFileList
3433
3434 def _MatchBuildRuleOrder(self, FileList):
3435 Order_Dict = {}
3436 self._GetModuleBuildOption()
3437 for SingleFile in FileList:
3438 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:
3439 key = SingleFile.Path.split(SingleFile.Ext)[0]
3440 if key in Order_Dict:
3441 Order_Dict[key].append(SingleFile.Ext)
3442 else:
3443 Order_Dict[key] = [SingleFile.Ext]
3444
3445 RemoveList = []
3446 for F in Order_Dict:
3447 if len(Order_Dict[F]) > 1:
3448 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))
3449 for Ext in Order_Dict[F][1:]:
3450 RemoveList.append(F + Ext)
3451
3452 for item in RemoveList:
3453 FileList.remove(item)
3454
3455 return FileList
3456
3457 ## Return the list of unicode files
3458 def _GetUnicodeFileList(self):
3459 if self._UnicodeFileList == None:
3460 if TAB_UNICODE_FILE in self.FileTypes:
3461 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
3462 else:
3463 self._UnicodeFileList = []
3464 return self._UnicodeFileList
3465
3466 ## Return the list of vfr files
3467 def _GetVfrFileList(self):
3468 if self._VfrFileList == None:
3469 if TAB_VFR_FILE in self.FileTypes:
3470 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]
3471 else:
3472 self._VfrFileList = []
3473 return self._VfrFileList
3474
3475 ## Return the list of Image Definition files
3476 def _GetIdfFileList(self):
3477 if self._IdfFileList == None:
3478 if TAB_IMAGE_FILE in self.FileTypes:
3479 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]
3480 else:
3481 self._IdfFileList = []
3482 return self._IdfFileList
3483
3484 ## Return a list of files which can be built from binary
3485 #
3486 # "Build" binary files are just to copy them to build directory.
3487 #
3488 # @retval list The list of files which can be built later
3489 #
3490 def _GetBinaryFiles(self):
3491 if self._BinaryFileList == None:
3492 self._BinaryFileList = []
3493 for F in self.Module.Binaries:
3494 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
3495 continue
3496 self._BinaryFileList.append(F)
3497 self._ApplyBuildRule(F, F.Type)
3498 return self._BinaryFileList
3499
3500 def _GetBuildRules(self):
3501 if self._BuildRules == None:
3502 BuildRules = {}
3503 BuildRuleDatabase = self.PlatformInfo.BuildRule
3504 for Type in BuildRuleDatabase.FileTypeList:
3505 #first try getting build rule by BuildRuleFamily
3506 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
3507 if not RuleObject:
3508 # build type is always module type, but ...
3509 if self.ModuleType != self.BuildType:
3510 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
3511 #second try getting build rule by ToolChainFamily
3512 if not RuleObject:
3513 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
3514 if not RuleObject:
3515 # build type is always module type, but ...
3516 if self.ModuleType != self.BuildType:
3517 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
3518 if not RuleObject:
3519 continue
3520 RuleObject = RuleObject.Instantiate(self.Macros)
3521 BuildRules[Type] = RuleObject
3522 for Ext in RuleObject.SourceFileExtList:
3523 BuildRules[Ext] = RuleObject
3524 self._BuildRules = BuildRules
3525 return self._BuildRules
3526
3527 def _ApplyBuildRule(self, File, FileType):
3528 if self._BuildTargets == None:
3529 self._IntroBuildTargetList = set()
3530 self._FinalBuildTargetList = set()
3531 self._BuildTargets = {}
3532 self._FileTypes = {}
3533
3534 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
3535 if not os.path.exists(SubDirectory):
3536 CreateDirectory(SubDirectory)
3537 LastTarget = None
3538 RuleChain = []
3539 SourceList = [File]
3540 Index = 0
3541 #
3542 # Make sure to get build rule order value
3543 #
3544 self._GetModuleBuildOption()
3545
3546 while Index < len(SourceList):
3547 Source = SourceList[Index]
3548 Index = Index + 1
3549
3550 if Source != File:
3551 CreateDirectory(Source.Dir)
3552
3553 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
3554 # Skip all files that are not binary libraries
3555 if not self.IsLibrary:
3556 continue
3557 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
3558 elif FileType in self.BuildRules:
3559 RuleObject = self.BuildRules[FileType]
3560 elif Source.Ext in self.BuildRules:
3561 RuleObject = self.BuildRules[Source.Ext]
3562 else:
3563 # stop at no more rules
3564 if LastTarget:
3565 self._FinalBuildTargetList.add(LastTarget)
3566 break
3567
3568 FileType = RuleObject.SourceFileType
3569 if FileType not in self._FileTypes:
3570 self._FileTypes[FileType] = set()
3571 self._FileTypes[FileType].add(Source)
3572
3573 # stop at STATIC_LIBRARY for library
3574 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
3575 if LastTarget:
3576 self._FinalBuildTargetList.add(LastTarget)
3577 break
3578
3579 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
3580 if not Target:
3581 if LastTarget:
3582 self._FinalBuildTargetList.add(LastTarget)
3583 break
3584 elif not Target.Outputs:
3585 # Only do build for target with outputs
3586 self._FinalBuildTargetList.add(Target)
3587
3588 if FileType not in self._BuildTargets:
3589 self._BuildTargets[FileType] = set()
3590 self._BuildTargets[FileType].add(Target)
3591
3592 if not Source.IsBinary and Source == File:
3593 self._IntroBuildTargetList.add(Target)
3594
3595 # to avoid cyclic rule
3596 if FileType in RuleChain:
3597 break
3598
3599 RuleChain.append(FileType)
3600 SourceList.extend(Target.Outputs)
3601 LastTarget = Target
3602 FileType = TAB_UNKNOWN_FILE
3603
3604 def _GetTargets(self):
3605 if self._BuildTargets == None:
3606 self._IntroBuildTargetList = set()
3607 self._FinalBuildTargetList = set()
3608 self._BuildTargets = {}
3609 self._FileTypes = {}
3610
3611 #TRICK: call _GetSourceFileList to apply build rule for source files
3612 if self.SourceFileList:
3613 pass
3614
3615 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3616 if self.BinaryFileList:
3617 pass
3618
3619 return self._BuildTargets
3620
3621 def _GetIntroTargetList(self):
3622 self._GetTargets()
3623 return self._IntroBuildTargetList
3624
3625 def _GetFinalTargetList(self):
3626 self._GetTargets()
3627 return self._FinalBuildTargetList
3628
3629 def _GetFileTypes(self):
3630 self._GetTargets()
3631 return self._FileTypes
3632
3633 ## Get the list of package object the module depends on
3634 #
3635 # @retval list The package object list
3636 #
3637 def _GetDependentPackageList(self):
3638 return self.Module.Packages
3639
3640 ## Return the list of auto-generated code file
3641 #
3642 # @retval list The list of auto-generated file
3643 #
3644 def _GetAutoGenFileList(self):
3645 UniStringAutoGenC = True
3646 IdfStringAutoGenC = True
3647 UniStringBinBuffer = StringIO()
3648 IdfGenBinBuffer = StringIO()
3649 if self.BuildType == 'UEFI_HII':
3650 UniStringAutoGenC = False
3651 IdfStringAutoGenC = False
3652 if self._AutoGenFileList == None:
3653 self._AutoGenFileList = {}
3654 AutoGenC = TemplateString()
3655 AutoGenH = TemplateString()
3656 StringH = TemplateString()
3657 StringIdf = TemplateString()
3658 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)
3659 #
3660 # AutoGen.c is generated if there are library classes in inf, or there are object files
3661 #
3662 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
3663 or TAB_OBJECT_FILE in self.FileTypes):
3664 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
3665 self._AutoGenFileList[AutoFile] = str(AutoGenC)
3666 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3667 if str(AutoGenH) != "":
3668 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
3669 self._AutoGenFileList[AutoFile] = str(AutoGenH)
3670 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3671 if str(StringH) != "":
3672 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
3673 self._AutoGenFileList[AutoFile] = str(StringH)
3674 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3675 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
3676 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
3677 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
3678 AutoFile.IsBinary = True
3679 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3680 if UniStringBinBuffer != None:
3681 UniStringBinBuffer.close()
3682 if str(StringIdf) != "":
3683 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)
3684 self._AutoGenFileList[AutoFile] = str(StringIdf)
3685 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3686 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":
3687 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)
3688 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()
3689 AutoFile.IsBinary = True
3690 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3691 if IdfGenBinBuffer != None:
3692 IdfGenBinBuffer.close()
3693 return self._AutoGenFileList
3694
3695 ## Return the list of library modules explicitly or implicityly used by this module
3696 def _GetLibraryList(self):
3697 if self._DependentLibraryList == None:
3698 # only merge library classes and PCD for non-library module
3699 if self.IsLibrary:
3700 self._DependentLibraryList = []
3701 else:
3702 if self.AutoGenVersion < 0x00010005:
3703 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
3704 else:
3705 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
3706 return self._DependentLibraryList
3707
3708 @staticmethod
3709 def UpdateComments(Recver, Src):
3710 for Key in Src:
3711 if Key not in Recver:
3712 Recver[Key] = []
3713 Recver[Key].extend(Src[Key])
3714 ## Get the list of PCDs from current module
3715 #
3716 # @retval list The list of PCD
3717 #
3718 def _GetModulePcdList(self):
3719 if self._ModulePcdList == None:
3720 # apply PCD settings from platform
3721 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
3722 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
3723 return self._ModulePcdList
3724
3725 ## Get the list of PCDs from dependent libraries
3726 #
3727 # @retval list The list of PCD
3728 #
3729 def _GetLibraryPcdList(self):
3730 if self._LibraryPcdList == None:
3731 Pcds = sdict()
3732 if not self.IsLibrary:
3733 # get PCDs from dependent libraries
3734 for Library in self.DependentLibraryList:
3735 self.UpdateComments(self._PcdComments, Library.PcdComments)
3736 for Key in Library.Pcds:
3737 # skip duplicated PCDs
3738 if Key in self.Module.Pcds or Key in Pcds:
3739 continue
3740 Pcds[Key] = copy.copy(Library.Pcds[Key])
3741 # apply PCD settings from platform
3742 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
3743 else:
3744 self._LibraryPcdList = []
3745 return self._LibraryPcdList
3746
3747 ## Get the GUID value mapping
3748 #
3749 # @retval dict The mapping between GUID cname and its value
3750 #
3751 def _GetGuidList(self):
3752 if self._GuidList == None:
3753 self._GuidList = sdict()
3754 self._GuidList.update(self.Module.Guids)
3755 for Library in self.DependentLibraryList:
3756 self._GuidList.update(Library.Guids)
3757 self.UpdateComments(self._GuidComments, Library.GuidComments)
3758 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
3759 return self._GuidList
3760
3761 def GetGuidsUsedByPcd(self):
3762 if self._GuidsUsedByPcd == None:
3763 self._GuidsUsedByPcd = sdict()
3764 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3765 for Library in self.DependentLibraryList:
3766 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3767 return self._GuidsUsedByPcd
3768 ## Get the protocol value mapping
3769 #
3770 # @retval dict The mapping between protocol cname and its value
3771 #
3772 def _GetProtocolList(self):
3773 if self._ProtocolList == None:
3774 self._ProtocolList = sdict()
3775 self._ProtocolList.update(self.Module.Protocols)
3776 for Library in self.DependentLibraryList:
3777 self._ProtocolList.update(Library.Protocols)
3778 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3779 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3780 return self._ProtocolList
3781
3782 ## Get the PPI value mapping
3783 #
3784 # @retval dict The mapping between PPI cname and its value
3785 #
3786 def _GetPpiList(self):
3787 if self._PpiList == None:
3788 self._PpiList = sdict()
3789 self._PpiList.update(self.Module.Ppis)
3790 for Library in self.DependentLibraryList:
3791 self._PpiList.update(Library.Ppis)
3792 self.UpdateComments(self._PpiComments, Library.PpiComments)
3793 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3794 return self._PpiList
3795
3796 ## Get the list of include search path
3797 #
3798 # @retval list The list path
3799 #
3800 def _GetIncludePathList(self):
3801 if self._IncludePathList == None:
3802 self._IncludePathList = []
3803 if self.AutoGenVersion < 0x00010005:
3804 for Inc in self.Module.Includes:
3805 if Inc not in self._IncludePathList:
3806 self._IncludePathList.append(Inc)
3807 # for Edk modules
3808 Inc = path.join(Inc, self.Arch.capitalize())
3809 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3810 self._IncludePathList.append(Inc)
3811 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3812 self._IncludePathList.append(self.DebugDir)
3813 else:
3814 self._IncludePathList.append(self.MetaFile.Dir)
3815 self._IncludePathList.append(self.DebugDir)
3816
3817 for Package in self.Module.Packages:
3818 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)
3819 if PackageDir not in self._IncludePathList:
3820 self._IncludePathList.append(PackageDir)
3821 IncludesList = Package.Includes
3822 if Package._PrivateIncludes:
3823 if not self.MetaFile.Path.startswith(PackageDir):
3824 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))
3825 for Inc in IncludesList:
3826 if Inc not in self._IncludePathList:
3827 self._IncludePathList.append(str(Inc))
3828 return self._IncludePathList
3829
3830 def _GetIncludePathLength(self):
3831 self._IncludePathLength = 0
3832 if self._IncludePathList:
3833 for inc in self._IncludePathList:
3834 self._IncludePathLength += len(' ' + inc)
3835 return self._IncludePathLength
3836
3837 ## Get HII EX PCDs which maybe used by VFR
3838 #
3839 # efivarstore used by VFR may relate with HII EX PCDs
3840 # Get the variable name and GUID from efivarstore and HII EX PCD
3841 # List the HII EX PCDs in As Built INF if both name and GUID match.
3842 #
3843 # @retval list HII EX PCDs
3844 #
3845 def _GetPcdsMaybeUsedByVfr(self):
3846 if not self.SourceFileList:
3847 return []
3848
3849 NameGuids = []
3850 for SrcFile in self.SourceFileList:
3851 if SrcFile.Ext.lower() != '.vfr':
3852 continue
3853 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3854 if not os.path.exists(Vfri):
3855 continue
3856 VfriFile = open(Vfri, 'r')
3857 Content = VfriFile.read()
3858 VfriFile.close()
3859 Pos = Content.find('efivarstore')
3860 while Pos != -1:
3861 #
3862 # Make sure 'efivarstore' is the start of efivarstore statement
3863 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3864 #
3865 Index = Pos - 1
3866 while Index >= 0 and Content[Index] in ' \t\r\n':
3867 Index -= 1
3868 if Index >= 0 and Content[Index] != ';':
3869 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3870 continue
3871 #
3872 # 'efivarstore' must be followed by name and guid
3873 #
3874 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3875 if not Name:
3876 break
3877 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3878 if not Guid:
3879 break
3880 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3881 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3882 Pos = Content.find('efivarstore', Name.end())
3883 if not NameGuids:
3884 return []
3885 HiiExPcds = []
3886 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3887 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3888 continue
3889 for SkuName in Pcd.SkuInfoList:
3890 SkuInfo = Pcd.SkuInfoList[SkuName]
3891 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3892 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)
3893 if not Value:
3894 continue
3895 Guid = GuidStructureStringToGuidString(Value)
3896 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3897 HiiExPcds.append(Pcd)
3898 break
3899
3900 return HiiExPcds
3901
3902 def _GenOffsetBin(self):
3903 VfrUniBaseName = {}
3904 for SourceFile in self.Module.Sources:
3905 if SourceFile.Type.upper() == ".VFR" :
3906 #
3907 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3908 #
3909 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3910 if SourceFile.Type.upper() == ".UNI" :
3911 #
3912 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3913 #
3914 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3915
3916 if len(VfrUniBaseName) == 0:
3917 return None
3918 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3919 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3920 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3921 if not VfrUniOffsetList:
3922 return None
3923
3924 OutputName = '%sOffset.bin' % self.Name
3925 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3926
3927 try:
3928 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3929 except:
3930 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3931
3932 # Use a instance of StringIO to cache data
3933 fStringIO = StringIO('')
3934
3935 for Item in VfrUniOffsetList:
3936 if (Item[0].find("Strings") != -1):
3937 #
3938 # UNI offset in image.
3939 # GUID + Offset
3940 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3941 #
3942 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3943 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3944 fStringIO.write(''.join(UniGuid))
3945 UniValue = pack ('Q', int (Item[1], 16))
3946 fStringIO.write (UniValue)
3947 else:
3948 #
3949 # VFR binary offset in image.
3950 # GUID + Offset
3951 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3952 #
3953 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3954 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3955 fStringIO.write(''.join(VfrGuid))
3956 type (Item[1])
3957 VfrValue = pack ('Q', int (Item[1], 16))
3958 fStringIO.write (VfrValue)
3959 #
3960 # write data into file.
3961 #
3962 try :
3963 fInputfile.write (fStringIO.getvalue())
3964 except:
3965 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
3966 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
3967
3968 fStringIO.close ()
3969 fInputfile.close ()
3970 return OutputName
3971
3972 ## Create AsBuilt INF file the module
3973 #
3974 def CreateAsBuiltInf(self, IsOnlyCopy = False):
3975 self.OutputFile = []
3976 if IsOnlyCopy:
3977 if GlobalData.gBinCacheDest:
3978 self.CopyModuleToCache()
3979 return
3980
3981 if self.IsAsBuiltInfCreated:
3982 return
3983
3984 # Skip the following code for EDK I inf
3985 if self.AutoGenVersion < 0x00010005:
3986 return
3987
3988 # Skip the following code for libraries
3989 if self.IsLibrary:
3990 return
3991
3992 # Skip the following code for modules with no source files
3993 if self.SourceFileList == None or self.SourceFileList == []:
3994 return
3995
3996 # Skip the following code for modules without any binary files
3997 if self.BinaryFileList <> None and self.BinaryFileList <> []:
3998 return
3999
4000 ### TODO: How to handles mixed source and binary modules
4001
4002 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
4003 # Also find all packages that the DynamicEx PCDs depend on
4004 Pcds = []
4005 PatchablePcds = []
4006 Packages = []
4007 PcdCheckList = []
4008 PcdTokenSpaceList = []
4009 for Pcd in self.ModulePcdList + self.LibraryPcdList:
4010 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
4011 PatchablePcds += [Pcd]
4012 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
4013 elif Pcd.Type in GenC.gDynamicExPcd:
4014 if Pcd not in Pcds:
4015 Pcds += [Pcd]
4016 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
4017 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
4018 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
4019 GuidList = sdict()
4020 GuidList.update(self.GuidList)
4021 for TokenSpace in self.GetGuidsUsedByPcd():
4022 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
4023 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
4024 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
4025 GuidList.pop(TokenSpace)
4026 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
4027 for Package in self.DerivedPackageList:
4028 if Package in Packages:
4029 continue
4030 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
4031 Found = False
4032 for Index in range(len(BeChecked)):
4033 for Item in CheckList[Index]:
4034 if Item in BeChecked[Index]:
4035 Packages += [Package]
4036 Found = True
4037 break
4038 if Found: break
4039
4040 VfrPcds = self._GetPcdsMaybeUsedByVfr()
4041 for Pkg in self.PlatformInfo.PackageList:
4042 if Pkg in Packages:
4043 continue
4044 for VfrPcd in VfrPcds:
4045 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
4046 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
4047 Packages += [Pkg]
4048 break
4049
4050 ModuleType = self.ModuleType
4051 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
4052 ModuleType = 'DXE_DRIVER'
4053
4054 DriverType = ''
4055 if self.PcdIsDriver != '':
4056 DriverType = self.PcdIsDriver
4057
4058 Guid = self.Guid
4059 MDefs = self.Module.Defines
4060
4061 AsBuiltInfDict = {
4062 'module_name' : self.Name,
4063 'module_guid' : Guid,
4064 'module_module_type' : ModuleType,
4065 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
4066 'pcd_is_driver_string' : [],
4067 'module_uefi_specification_version' : [],
4068 'module_pi_specification_version' : [],
4069 'module_entry_point' : self.Module.ModuleEntryPointList,
4070 'module_unload_image' : self.Module.ModuleUnloadImageList,
4071 'module_constructor' : self.Module.ConstructorList,
4072 'module_destructor' : self.Module.DestructorList,
4073 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
4074 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
4075 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
4076 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
4077 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
4078 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
4079 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
4080 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
4081 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
4082 'module_arch' : self.Arch,
4083 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],
4084 'binary_item' : [],
4085 'patchablepcd_item' : [],
4086 'pcd_item' : [],
4087 'protocol_item' : [],
4088 'ppi_item' : [],
4089 'guid_item' : [],
4090 'flags_item' : [],
4091 'libraryclasses_item' : []
4092 }
4093
4094 if 'MODULE_UNI_FILE' in MDefs:
4095 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])
4096 if os.path.isfile(UNIFile):
4097 shutil.copy2(UNIFile, self.OutputDir)
4098
4099 if self.AutoGenVersion > int(gInfSpecVersion, 0):
4100 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
4101 else:
4102 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
4103
4104 if DriverType:
4105 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
4106
4107 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
4108 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
4109 if 'PI_SPECIFICATION_VERSION' in self.Specification:
4110 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
4111
4112 OutputDir = self.OutputDir.replace('\\', '/').strip('/')
4113 for Item in self.CodaTargetList:
4114 File = Item.Target.Path.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')
4115 if File not in self.OutputFile:
4116 self.OutputFile.append(File)
4117 if Item.Target.Ext.lower() == '.aml':
4118 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
4119 elif Item.Target.Ext.lower() == '.acpi':
4120 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
4121 elif Item.Target.Ext.lower() == '.efi':
4122 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
4123 else:
4124 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
4125 if self.DepexGenerated:
4126 if self.Name + '.depex' not in self.OutputFile:
4127 self.OutputFile.append(self.Name + '.depex')
4128 if self.ModuleType in ['PEIM']:
4129 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
4130 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4131 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
4132 if self.ModuleType in ['DXE_SMM_DRIVER']:
4133 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
4134
4135 Bin = self._GenOffsetBin()
4136 if Bin:
4137 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
4138 if Bin not in self.OutputFile:
4139 self.OutputFile.append(Bin)
4140
4141 for Root, Dirs, Files in os.walk(OutputDir):
4142 for File in Files:
4143 if File.lower().endswith('.pdb'):
4144 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
4145 if File not in self.OutputFile:
4146 self.OutputFile.append(File)
4147 HeaderComments = self.Module.HeaderComments
4148 StartPos = 0
4149 for Index in range(len(HeaderComments)):
4150 if HeaderComments[Index].find('@BinaryHeader') != -1:
4151 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
4152 StartPos = Index
4153 break
4154 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
4155 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
4156
4157 GenList = [
4158 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
4159 (self.PpiList, self._PpiComments, 'ppi_item'),
4160 (GuidList, self._GuidComments, 'guid_item')
4161 ]
4162 for Item in GenList:
4163 for CName in Item[0]:
4164 Comments = ''
4165 if CName in Item[1]:
4166 Comments = '\n '.join(Item[1][CName])
4167 Entry = CName
4168 if Comments:
4169 Entry = Comments + '\n ' + CName
4170 AsBuiltInfDict[Item[2]].append(Entry)
4171 PatchList = parsePcdInfoFromMapFile(
4172 os.path.join(self.OutputDir, self.Name + '.map'),
4173 os.path.join(self.OutputDir, self.Name + '.efi')
4174 )
4175 if PatchList:
4176 for Pcd in PatchablePcds:
4177 TokenCName = Pcd.TokenCName
4178 for PcdItem in GlobalData.MixedPcd:
4179 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4180 TokenCName = PcdItem[0]
4181 break
4182 for PatchPcd in PatchList:
4183 if TokenCName == PatchPcd[0]:
4184 break
4185 else:
4186 continue
4187 PcdValue = ''
4188 if Pcd.DatumType == 'BOOLEAN':
4189 BoolValue = Pcd.DefaultValue.upper()
4190 if BoolValue == 'TRUE':
4191 Pcd.DefaultValue = '1'
4192 elif BoolValue == 'FALSE':
4193 Pcd.DefaultValue = '0'
4194
4195 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4196 HexFormat = '0x%02x'
4197 if Pcd.DatumType == 'UINT16':
4198 HexFormat = '0x%04x'
4199 elif Pcd.DatumType == 'UINT32':
4200 HexFormat = '0x%08x'
4201 elif Pcd.DatumType == 'UINT64':
4202 HexFormat = '0x%016x'
4203 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
4204 else:
4205 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
4206 EdkLogger.error("build", AUTOGEN_ERROR,
4207 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)
4208 )
4209 ArraySize = int(Pcd.MaxDatumSize, 0)
4210 PcdValue = Pcd.DefaultValue
4211 if PcdValue[0] != '{':
4212 Unicode = False
4213 if PcdValue[0] == 'L':
4214 Unicode = True
4215 PcdValue = PcdValue.lstrip('L')
4216 PcdValue = eval(PcdValue)
4217 NewValue = '{'
4218 for Index in range(0, len(PcdValue)):
4219 if Unicode:
4220 CharVal = ord(PcdValue[Index])
4221 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
4222 + '0x%02x' % (CharVal >> 8) + ', '
4223 else:
4224 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
4225 Padding = '0x00, '
4226 if Unicode:
4227 Padding = Padding * 2
4228 ArraySize = ArraySize / 2
4229 if ArraySize < (len(PcdValue) + 1):
4230 EdkLogger.error("build", AUTOGEN_ERROR,
4231 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4232 )
4233 if ArraySize > len(PcdValue) + 1:
4234 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
4235 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
4236 elif len(PcdValue.split(',')) <= ArraySize:
4237 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
4238 PcdValue += '}'
4239 else:
4240 EdkLogger.error("build", AUTOGEN_ERROR,
4241 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4242 )
4243 PcdItem = '%s.%s|%s|0x%X' % \
4244 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])
4245 PcdComments = ''
4246 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4247 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
4248 if PcdComments:
4249 PcdItem = PcdComments + '\n ' + PcdItem
4250 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
4251
4252 HiiPcds = []
4253 for Pcd in Pcds + VfrPcds:
4254 PcdComments = ''
4255 PcdCommentList = []
4256 HiiInfo = ''
4257 SkuId = ''
4258 TokenCName = Pcd.TokenCName
4259 for PcdItem in GlobalData.MixedPcd:
4260 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4261 TokenCName = PcdItem[0]
4262 break
4263 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
4264 for SkuName in Pcd.SkuInfoList:
4265 SkuInfo = Pcd.SkuInfoList[SkuName]
4266 SkuId = SkuInfo.SkuId
4267 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
4268 break
4269 if SkuId:
4270 #
4271 # Don't generate duplicated HII PCD
4272 #
4273 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
4274 continue
4275 else:
4276 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
4277 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4278 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
4279 if HiiInfo:
4280 UsageIndex = -1
4281 UsageStr = ''
4282 for Index, Comment in enumerate(PcdCommentList):
4283 for Usage in UsageList:
4284 if Comment.find(Usage) != -1:
4285 UsageStr = Usage
4286 UsageIndex = Index
4287 break
4288 if UsageIndex != -1:
4289 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
4290 else:
4291 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
4292 PcdComments = '\n '.join(PcdCommentList)
4293 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName
4294 if PcdComments:
4295 PcdEntry = PcdComments + '\n ' + PcdEntry
4296 AsBuiltInfDict['pcd_item'] += [PcdEntry]
4297 for Item in self.BuildOption:
4298 if 'FLAGS' in self.BuildOption[Item]:
4299 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
4300
4301 # Generated LibraryClasses section in comments.
4302 for Library in self.LibraryAutoGenList:
4303 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
4304
4305 # Generated UserExtensions TianoCore section.
4306 # All tianocore user extensions are copied.
4307 UserExtStr = ''
4308 for TianoCore in self._GetTianoCoreUserExtensionList():
4309 UserExtStr += '\n'.join(TianoCore)
4310 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])
4311 if os.path.isfile(ExtensionFile):
4312 shutil.copy2(ExtensionFile, self.OutputDir)
4313 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr
4314
4315 # Generated depex expression section in comments.
4316 AsBuiltInfDict['depexsection_item'] = ''
4317 DepexExpresion = self._GetDepexExpresionString()
4318 if DepexExpresion:
4319 AsBuiltInfDict['depexsection_item'] = DepexExpresion
4320
4321 AsBuiltInf = TemplateString()
4322 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
4323
4324 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
4325
4326 self.IsAsBuiltInfCreated = True
4327 if GlobalData.gBinCacheDest:
4328 self.CopyModuleToCache()
4329
4330 def CopyModuleToCache(self):
4331 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4332 CreateDirectory (FileDir)
4333 HashFile = path.join(self.BuildDir, self.Name + '.hash')
4334 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')
4335 if os.path.exists(HashFile):
4336 shutil.copy2(HashFile, FileDir)
4337 if os.path.exists(ModuleFile):
4338 shutil.copy2(ModuleFile, FileDir)
4339 if not self.OutputFile:
4340 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]
4341 self.OutputFile = Ma.Binaries
4342 if self.OutputFile:
4343 for File in self.OutputFile:
4344 File = str(File)
4345 if not os.path.isabs(File):
4346 File = os.path.join(self.OutputDir, File)
4347 if os.path.exists(File):
4348 shutil.copy2(File, FileDir)
4349
4350 def AttemptModuleCacheCopy(self):
4351 if self.IsBinaryModule:
4352 return False
4353 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4354 HashFile = path.join(FileDir, self.Name + '.hash')
4355 if os.path.exists(HashFile):
4356 f = open(HashFile, 'r')
4357 CacheHash = f.read()
4358 f.close()
4359 if GlobalData.gModuleHash[self.Arch][self.Name]:
4360 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:
4361 for root, dir, files in os.walk(FileDir):
4362 for f in files:
4363 if self.Name + '.hash' in f:
4364 shutil.copy2(HashFile, self.BuildDir)
4365 else:
4366 File = path.join(root, f)
4367 shutil.copy2(File, self.OutputDir)
4368 if self.Name == "PcdPeim" or self.Name == "PcdDxe":
4369 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4370 return True
4371 return False
4372
4373 ## Create makefile for the module and its dependent libraries
4374 #
4375 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4376 # dependent libraries will be created
4377 #
4378 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):
4379 # Ignore generating makefile when it is a binary module
4380 if self.IsBinaryModule:
4381 return
4382
4383 if self.IsMakeFileCreated:
4384 return
4385 self.GenFfsList = GenFfsList
4386 if not self.IsLibrary and CreateLibraryMakeFile:
4387 for LibraryAutoGen in self.LibraryAutoGenList:
4388 LibraryAutoGen.CreateMakeFile()
4389
4390 if self.CanSkip():
4391 return
4392
4393 if len(self.CustomMakefile) == 0:
4394 Makefile = GenMake.ModuleMakefile(self)
4395 else:
4396 Makefile = GenMake.CustomMakefile(self)
4397 if Makefile.Generate():
4398 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
4399 (self.Name, self.Arch))
4400 else:
4401 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
4402 (self.Name, self.Arch))
4403
4404 self.CreateTimeStamp(Makefile)
4405 self.IsMakeFileCreated = True
4406
4407 def CopyBinaryFiles(self):
4408 for File in self.Module.Binaries:
4409 SrcPath = File.Path
4410 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
4411 CopyLongFilePath(SrcPath, DstPath)
4412 ## Create autogen code for the module and its dependent libraries
4413 #
4414 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4415 # dependent libraries will be created
4416 #
4417 def CreateCodeFile(self, CreateLibraryCodeFile=True):
4418 if self.IsCodeFileCreated:
4419 return
4420
4421 # Need to generate PcdDatabase even PcdDriver is binarymodule
4422 if self.IsBinaryModule and self.PcdIsDriver != '':
4423 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4424 return
4425 if self.IsBinaryModule:
4426 if self.IsLibrary:
4427 self.CopyBinaryFiles()
4428 return
4429
4430 if not self.IsLibrary and CreateLibraryCodeFile:
4431 for LibraryAutoGen in self.LibraryAutoGenList:
4432 LibraryAutoGen.CreateCodeFile()
4433
4434 if self.CanSkip():
4435 return
4436
4437 AutoGenList = []
4438 IgoredAutoGenList = []
4439
4440 for File in self.AutoGenFileList:
4441 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
4442 #Ignore Edk AutoGen.c
4443 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
4444 continue
4445
4446 AutoGenList.append(str(File))
4447 else:
4448 IgoredAutoGenList.append(str(File))
4449
4450 # Skip the following code for EDK I inf
4451 if self.AutoGenVersion < 0x00010005:
4452 return
4453
4454 for ModuleType in self.DepexList:
4455 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4456 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
4457 continue
4458
4459 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
4460 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
4461
4462 if len(Dpx.PostfixNotation) <> 0:
4463 self.DepexGenerated = True
4464
4465 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
4466 AutoGenList.append(str(DpxFile))
4467 else:
4468 IgoredAutoGenList.append(str(DpxFile))
4469
4470 if IgoredAutoGenList == []:
4471 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
4472 (" ".join(AutoGenList), self.Name, self.Arch))
4473 elif AutoGenList == []:
4474 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
4475 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
4476 else:
4477 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
4478 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
4479
4480 self.IsCodeFileCreated = True
4481 return AutoGenList
4482
4483 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4484 def _GetLibraryAutoGenList(self):
4485 if self._LibraryAutoGenList == None:
4486 self._LibraryAutoGenList = []
4487 for Library in self.DependentLibraryList:
4488 La = ModuleAutoGen(
4489 self.Workspace,
4490 Library.MetaFile,
4491 self.BuildTarget,
4492 self.ToolChain,
4493 self.Arch,
4494 self.PlatformInfo.MetaFile
4495 )
4496 if La not in self._LibraryAutoGenList:
4497 self._LibraryAutoGenList.append(La)
4498 for Lib in La.CodaTargetList:
4499 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
4500 return self._LibraryAutoGenList
4501
4502 def GenModuleHash(self):
4503 if self.Arch not in GlobalData.gModuleHash:
4504 GlobalData.gModuleHash[self.Arch] = {}
4505 m = hashlib.md5()
4506 # Add Platform level hash
4507 m.update(GlobalData.gPlatformHash)
4508 # Add Package level hash
4509 if self.DependentPackageList:
4510 for Pkg in self.DependentPackageList:
4511 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:
4512 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])
4513
4514 # Add Library hash
4515 if self.LibraryAutoGenList:
4516 for Lib in self.LibraryAutoGenList:
4517 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:
4518 Lib.GenModuleHash()
4519 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])
4520
4521 # Add Module self
4522 f = open(str(self.MetaFile), 'r')
4523 Content = f.read()
4524 f.close()
4525 m.update(Content)
4526 # Add Module's source files
4527 if self.SourceFileList:
4528 for File in self.SourceFileList:
4529 f = open(str(File), 'r')
4530 Content = f.read()
4531 f.close()
4532 m.update(Content)
4533
4534 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")
4535 if self.Name not in GlobalData.gModuleHash[self.Arch]:
4536 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()
4537 if GlobalData.gBinCacheSource:
4538 CacheValid = self.AttemptModuleCacheCopy()
4539 if CacheValid:
4540 return False
4541 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)
4542
4543 ## Decide whether we can skip the ModuleAutoGen process
4544 def CanSkipbyHash(self):
4545 if GlobalData.gUseHashCache:
4546 return not self.GenModuleHash()
4547
4548 ## Decide whether we can skip the ModuleAutoGen process
4549 # If any source file is newer than the module than we cannot skip
4550 #
4551 def CanSkip(self):
4552 if not os.path.exists(self.GetTimeStampPath()):
4553 return False
4554 #last creation time of the module
4555 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]
4556
4557 SrcTimeStamp = self.Workspace._SrcTimeStamp
4558 if SrcTimeStamp > DstTimeStamp:
4559 return False
4560
4561 with open(self.GetTimeStampPath(),'r') as f:
4562 for source in f:
4563 source = source.rstrip('\n')
4564 if not os.path.exists(source):
4565 return False
4566 if source not in ModuleAutoGen.TimeDict :
4567 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]
4568 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:
4569 return False
4570 return True
4571
4572 def GetTimeStampPath(self):
4573 if self._TimeStampPath == None:
4574 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')
4575 return self._TimeStampPath
4576 def CreateTimeStamp(self, Makefile):
4577
4578 FileSet = set()
4579
4580 FileSet.add (self.MetaFile.Path)
4581
4582 for SourceFile in self.Module.Sources:
4583 FileSet.add (SourceFile.Path)
4584
4585 for Lib in self.DependentLibraryList:
4586 FileSet.add (Lib.MetaFile.Path)
4587
4588 for f in self.AutoGenDepSet:
4589 FileSet.add (f.Path)
4590
4591 if os.path.exists (self.GetTimeStampPath()):
4592 os.remove (self.GetTimeStampPath())
4593 with open(self.GetTimeStampPath(), 'w+') as file:
4594 for f in FileSet:
4595 print >> file, f
4596
4597 Module = property(_GetModule)
4598 Name = property(_GetBaseName)
4599 Guid = property(_GetGuid)
4600 Version = property(_GetVersion)
4601 ModuleType = property(_GetModuleType)
4602 ComponentType = property(_GetComponentType)
4603 BuildType = property(_GetBuildType)
4604 PcdIsDriver = property(_GetPcdIsDriver)
4605 AutoGenVersion = property(_GetAutoGenVersion)
4606 Macros = property(_GetMacros)
4607 Specification = property(_GetSpecification)
4608
4609 IsLibrary = property(_IsLibrary)
4610 IsBinaryModule = property(_IsBinaryModule)
4611 BuildDir = property(_GetBuildDir)
4612 OutputDir = property(_GetOutputDir)
4613 FfsOutputDir = property(_GetFfsOutputDir)
4614 DebugDir = property(_GetDebugDir)
4615 MakeFileDir = property(_GetMakeFileDir)
4616 CustomMakefile = property(_GetCustomMakefile)
4617
4618 IncludePathList = property(_GetIncludePathList)
4619 IncludePathLength = property(_GetIncludePathLength)
4620 AutoGenFileList = property(_GetAutoGenFileList)
4621 UnicodeFileList = property(_GetUnicodeFileList)
4622 VfrFileList = property(_GetVfrFileList)
4623 SourceFileList = property(_GetSourceFileList)
4624 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
4625 Targets = property(_GetTargets)
4626 IntroTargetList = property(_GetIntroTargetList)
4627 CodaTargetList = property(_GetFinalTargetList)
4628 FileTypes = property(_GetFileTypes)
4629 BuildRules = property(_GetBuildRules)
4630 IdfFileList = property(_GetIdfFileList)
4631
4632 DependentPackageList = property(_GetDependentPackageList)
4633 DependentLibraryList = property(_GetLibraryList)
4634 LibraryAutoGenList = property(_GetLibraryAutoGenList)
4635 DerivedPackageList = property(_GetDerivedPackageList)
4636
4637 ModulePcdList = property(_GetModulePcdList)
4638 LibraryPcdList = property(_GetLibraryPcdList)
4639 GuidList = property(_GetGuidList)
4640 ProtocolList = property(_GetProtocolList)
4641 PpiList = property(_GetPpiList)
4642 DepexList = property(_GetDepexTokenList)
4643 DxsFile = property(_GetDxsFile)
4644 DepexExpressionList = property(_GetDepexExpressionTokenList)
4645 BuildOption = property(_GetModuleBuildOption)
4646 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
4647 BuildCommand = property(_GetBuildCommand)
4648
4649 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
4650
4651 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4652 if __name__ == '__main__':
4653 pass
4654
EFI Development Kit II mirror for PVE