]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
projects / mirror_edk2.git / blob
? search:


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