]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools: Enhance binary file in [Binaries] section use relative path
[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 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 ## 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 for StorageName in Sku.DefaultStoreDict:
1409 VariableInfo.append_variable(var_info(Index,pcdname,StorageName,SkuName, StringToArray(Sku.VariableName),VariableGuid, Sku.VariableAttribute , Sku.HiiDefaultValue,Sku.DefaultStoreDict[StorageName],Pcd.DatumType))
1410 Index += 1
1411 return VariableInfo
1412
1413 def UpdateNVStoreMaxSize(self,OrgVpdFile):
1414 if self.VariableInfo:
1415 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1416 PcdNvStoreDfBuffer = [item for item in self._DynamicPcdList if item.TokenCName == "PcdNvStoreDefaultValueBuffer" and item.TokenSpaceGuidCName == "gEfiMdeModulePkgTokenSpaceGuid"]
1417
1418 if PcdNvStoreDfBuffer:
1419 if os.path.exists(VpdMapFilePath):
1420 OrgVpdFile.Read(VpdMapFilePath)
1421 PcdItems = OrgVpdFile.GetOffset(PcdNvStoreDfBuffer[0])
1422 NvStoreOffset = PcdItems.values()[0].strip() if PcdItems else '0'
1423 else:
1424 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1425
1426 NvStoreOffset = int(NvStoreOffset,16) if NvStoreOffset.upper().startswith("0X") else int(NvStoreOffset)
1427 default_skuobj = PcdNvStoreDfBuffer[0].SkuInfoList.get("DEFAULT")
1428 maxsize = self.VariableInfo.VpdRegionSize - NvStoreOffset if self.VariableInfo.VpdRegionSize else len(default_skuobj.DefaultValue.split(","))
1429 var_data = self.VariableInfo.PatchNVStoreDefaultMaxSize(maxsize)
1430
1431 if var_data and default_skuobj:
1432 default_skuobj.DefaultValue = var_data
1433 PcdNvStoreDfBuffer[0].DefaultValue = var_data
1434 PcdNvStoreDfBuffer[0].SkuInfoList.clear()
1435 PcdNvStoreDfBuffer[0].SkuInfoList['DEFAULT'] = default_skuobj
1436 PcdNvStoreDfBuffer[0].MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))
1437
1438 return OrgVpdFile
1439
1440 ## Collect dynamic PCDs
1441 #
1442 # Gather dynamic PCDs list from each module and their settings from platform
1443 # This interface should be invoked explicitly when platform action is created.
1444 #
1445 def CollectPlatformDynamicPcds(self):
1446 # Override the platform Pcd's value by build option
1447 if GlobalData.BuildOptionPcd:
1448 for key in self.Platform.Pcds:
1449 PlatformPcd = self.Platform.Pcds[key]
1450 for PcdItem in GlobalData.BuildOptionPcd:
1451 if (PlatformPcd.TokenSpaceGuidCName, PlatformPcd.TokenCName) == (PcdItem[0], PcdItem[1]):
1452 PlatformPcd.DefaultValue = PcdItem[2]
1453 if PlatformPcd.SkuInfoList:
1454 Sku = PlatformPcd.SkuInfoList[PlatformPcd.SkuInfoList.keys()[0]]
1455 Sku.DefaultValue = PcdItem[2]
1456 break
1457
1458 for key in self.Platform.Pcds:
1459 for SinglePcd in GlobalData.MixedPcd:
1460 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
1461 for item in GlobalData.MixedPcd[SinglePcd]:
1462 Pcd_Type = item[0].split('_')[-1]
1463 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 \
1464 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):
1465 Value = self.Platform.Pcds[key]
1466 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type
1467 if len(key) == 2:
1468 newkey = (Value.TokenCName, key[1])
1469 elif len(key) == 3:
1470 newkey = (Value.TokenCName, key[1], key[2])
1471 del self.Platform.Pcds[key]
1472 self.Platform.Pcds[newkey] = Value
1473 break
1474 else:
1475 pass
1476 break
1477 else:
1478 pass
1479
1480 # for gathering error information
1481 NoDatumTypePcdList = set()
1482 PcdNotInDb = []
1483 self._GuidValue = {}
1484 FdfModuleList = []
1485 for InfName in self._AsBuildInfList:
1486 InfName = mws.join(self.WorkspaceDir, InfName)
1487 FdfModuleList.append(os.path.normpath(InfName))
1488 for F in self.Platform.Modules.keys():
1489 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
1490 #GuidValue.update(M.Guids)
1491
1492 self.Platform.Modules[F].M = M
1493
1494 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:
1495 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1496 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1497 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
1498
1499 # Check the PCD from Binary INF or Source INF
1500 if M.IsBinaryModule == True:
1501 PcdFromModule.IsFromBinaryInf = True
1502
1503 # Check the PCD from DSC or not
1504 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
1505 PcdFromModule.IsFromDsc = True
1506 else:
1507 PcdFromModule.IsFromDsc = False
1508 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
1509 if F.Path not in FdfModuleList:
1510 # If one of the Source built modules listed in the DSC is not listed
1511 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1512 # access method (it is only listed in the DEC file that declares the
1513 # PCD as PcdsDynamic), then build tool will report warning message
1514 # notify the PI that they are attempting to build a module that must
1515 # be included in a flash image in order to be functional. These Dynamic
1516 # PCD will not be added into the Database unless it is used by other
1517 # modules that are included in the FDF file.
1518 if PcdFromModule.Type in GenC.gDynamicPcd and \
1519 PcdFromModule.IsFromBinaryInf == False:
1520 # Print warning message to let the developer make a determine.
1521 if PcdFromModule not in PcdNotInDb:
1522 PcdNotInDb.append(PcdFromModule)
1523 continue
1524 # If one of the Source built modules listed in the DSC is not listed in
1525 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1526 # access method (it is only listed in the DEC file that declares the
1527 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1528 # PCD to the Platform's PCD Database.
1529 if PcdFromModule.Type in GenC.gDynamicExPcd:
1530 if PcdFromModule not in PcdNotInDb:
1531 PcdNotInDb.append(PcdFromModule)
1532 continue
1533 #
1534 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1535 # it should be stored in Pcd PEI database, If a dynamic only
1536 # used by DXE module, it should be stored in DXE PCD database.
1537 # The default Phase is DXE
1538 #
1539 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1540 PcdFromModule.Phase = "PEI"
1541 if PcdFromModule not in self._DynaPcdList_:
1542 self._DynaPcdList_.append(PcdFromModule)
1543 elif PcdFromModule.Phase == 'PEI':
1544 # overwrite any the same PCD existing, if Phase is PEI
1545 Index = self._DynaPcdList_.index(PcdFromModule)
1546 self._DynaPcdList_[Index] = PcdFromModule
1547 elif PcdFromModule not in self._NonDynaPcdList_:
1548 self._NonDynaPcdList_.append(PcdFromModule)
1549 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1550 Index = self._NonDynaPcdList_.index(PcdFromModule)
1551 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1552 #The PCD from Binary INF will override the same one from source INF
1553 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1554 PcdFromModule.Pending = False
1555 self._NonDynaPcdList_.append (PcdFromModule)
1556 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1557 DscModuleList = []
1558 for ModuleInf in self.Platform.Modules.keys():
1559 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1560 # add the PCD from modules that listed in FDF but not in DSC to Database
1561 for InfName in FdfModuleList:
1562 if InfName not in DscModuleList:
1563 InfClass = PathClass(InfName)
1564 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1565 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1566 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1567 # For binary module, if in current arch, we need to list the PCDs into database.
1568 if not M.IsSupportedArch:
1569 continue
1570 # Override the module PCD setting by platform setting
1571 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1572 for PcdFromModule in ModulePcdList:
1573 PcdFromModule.IsFromBinaryInf = True
1574 PcdFromModule.IsFromDsc = False
1575 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1576 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1577 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1578 File=self.MetaFile,
1579 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1580 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1581 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1582 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1583 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1584 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1585 PcdFromModule.Phase = "PEI"
1586 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1587 self._DynaPcdList_.append(PcdFromModule)
1588 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1589 self._NonDynaPcdList_.append(PcdFromModule)
1590 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1591 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1592 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1593 # module & DXE module at a same time.
1594 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1595 # INF file as DynamicEx.
1596 Index = self._DynaPcdList_.index(PcdFromModule)
1597 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1598 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1599 for PcdFromModule in self._NonDynaPcdList_:
1600 # If a PCD is not listed in the DSC file, but binary INF files used by
1601 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1602 # section, AND all source INF files used by this platform the build
1603 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1604 # section, then the tools must NOT add the PCD to the Platform's PCD
1605 # Database; the build must assign the access method for this PCD as
1606 # PcdsPatchableInModule.
1607 if PcdFromModule not in self._DynaPcdList_:
1608 continue
1609 Index = self._DynaPcdList_.index(PcdFromModule)
1610 if PcdFromModule.IsFromDsc == False and \
1611 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1612 PcdFromModule.IsFromBinaryInf == True and \
1613 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1614 Index = self._DynaPcdList_.index(PcdFromModule)
1615 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1616
1617 # print out error information and break the build, if error found
1618 if len(NoDatumTypePcdList) > 0:
1619 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1620 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1621 File=self.MetaFile,
1622 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1623 % NoDatumTypePcdListString)
1624 self._NonDynamicPcdList = self._NonDynaPcdList_
1625 self._DynamicPcdList = self._DynaPcdList_
1626 #
1627 # Sort dynamic PCD list to:
1628 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1629 # try to be put header of dynamicd List
1630 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1631 #
1632 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1633 #
1634 UnicodePcdArray = set()
1635 HiiPcdArray = set()
1636 OtherPcdArray = set()
1637 VpdPcdDict = {}
1638 VpdFile = VpdInfoFile.VpdInfoFile()
1639 NeedProcessVpdMapFile = False
1640
1641 for pcd in self.Platform.Pcds.keys():
1642 if pcd not in self._PlatformPcds.keys():
1643 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]
1644
1645 for item in self._PlatformPcds:
1646 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1647 self._PlatformPcds[item].DatumType = "VOID*"
1648
1649 if (self.Workspace.ArchList[-1] == self.Arch):
1650 for Pcd in self._DynamicPcdList:
1651 # just pick the a value to determine whether is unicode string type
1652 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1653 Sku.VpdOffset = Sku.VpdOffset.strip()
1654
1655 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1656 Pcd.DatumType = "VOID*"
1657
1658 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1659 # if found HII type PCD then insert to right of UnicodeIndex
1660 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1661 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1662
1663 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1664 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1665 if PcdNvStoreDfBuffer:
1666 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)
1667 vardump = self.VariableInfo.dump()
1668 if vardump:
1669 PcdNvStoreDfBuffer.DefaultValue = vardump
1670 for skuname in PcdNvStoreDfBuffer.SkuInfoList:
1671 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump
1672 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))
1673
1674 PlatformPcds = self._PlatformPcds.keys()
1675 PlatformPcds.sort()
1676 #
1677 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1678 #
1679 VpdSkuMap = {}
1680 for PcdKey in PlatformPcds:
1681 Pcd = self._PlatformPcds[PcdKey]
1682 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1683 PcdKey in VpdPcdDict:
1684 Pcd = VpdPcdDict[PcdKey]
1685 SkuValueMap = {}
1686 DefaultSku = Pcd.SkuInfoList.get('DEFAULT')
1687 if DefaultSku:
1688 PcdValue = DefaultSku.DefaultValue
1689 if PcdValue not in SkuValueMap:
1690 SkuValueMap[PcdValue] = []
1691 VpdFile.Add(Pcd, 'DEFAULT',DefaultSku.VpdOffset)
1692 SkuValueMap[PcdValue].append(DefaultSku)
1693
1694 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1695 Sku.VpdOffset = Sku.VpdOffset.strip()
1696 PcdValue = Sku.DefaultValue
1697 if PcdValue == "":
1698 PcdValue = Pcd.DefaultValue
1699 if Sku.VpdOffset != '*':
1700 if PcdValue.startswith("{"):
1701 Alignment = 8
1702 elif PcdValue.startswith("L"):
1703 Alignment = 2
1704 else:
1705 Alignment = 1
1706 try:
1707 VpdOffset = int(Sku.VpdOffset)
1708 except:
1709 try:
1710 VpdOffset = int(Sku.VpdOffset, 16)
1711 except:
1712 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1713 if VpdOffset % Alignment != 0:
1714 if PcdValue.startswith("{"):
1715 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)
1716 else:
1717 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))
1718 if PcdValue not in SkuValueMap:
1719 SkuValueMap[PcdValue] = []
1720 VpdFile.Add(Pcd, SkuName,Sku.VpdOffset)
1721 SkuValueMap[PcdValue].append(Sku)
1722 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1723 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1724 NeedProcessVpdMapFile = True
1725 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':
1726 EdkLogger.error("Build", FILE_NOT_FOUND, \
1727 "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.")
1728
1729 VpdSkuMap[PcdKey] = SkuValueMap
1730 #
1731 # Fix the PCDs define in VPD PCD section that never referenced by module.
1732 # An example is PCD for signature usage.
1733 #
1734 for DscPcd in PlatformPcds:
1735 DscPcdEntry = self._PlatformPcds[DscPcd]
1736 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1737 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):
1738 FoundFlag = False
1739 for VpdPcd in VpdFile._VpdArray.keys():
1740 # This PCD has been referenced by module
1741 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1742 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1743 FoundFlag = True
1744
1745 # Not found, it should be signature
1746 if not FoundFlag :
1747 # just pick the a value to determine whether is unicode string type
1748 SkuValueMap = {}
1749 DefaultSku = DscPcdEntry.SkuInfoList.get('DEFAULT')
1750 if DefaultSku:
1751 PcdValue = DefaultSku.DefaultValue
1752 if PcdValue not in SkuValueMap:
1753 SkuValueMap[PcdValue] = []
1754 VpdFile.Add(DscPcdEntry, 'DEFAULT',Sku.VpdOffset)
1755 SkuValueMap[PcdValue].append(Sku)
1756 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():
1757 Sku.VpdOffset = Sku.VpdOffset.strip()
1758
1759 # Need to iterate DEC pcd information to get the value & datumtype
1760 for eachDec in self.PackageList:
1761 for DecPcd in eachDec.Pcds:
1762 DecPcdEntry = eachDec.Pcds[DecPcd]
1763 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1764 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1765 # Print warning message to let the developer make a determine.
1766 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1767 File=self.MetaFile, \
1768 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1769 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1770
1771 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1772 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1773 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1774 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1775 # Only fix the value while no value provided in DSC file.
1776 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1777 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1778
1779 if DscPcdEntry not in self._DynamicPcdList:
1780 self._DynamicPcdList.append(DscPcdEntry)
1781 Sku.VpdOffset = Sku.VpdOffset.strip()
1782 PcdValue = Sku.DefaultValue
1783 if PcdValue == "":
1784 PcdValue = DscPcdEntry.DefaultValue
1785 if Sku.VpdOffset != '*':
1786 if PcdValue.startswith("{"):
1787 Alignment = 8
1788 elif PcdValue.startswith("L"):
1789 Alignment = 2
1790 else:
1791 Alignment = 1
1792 try:
1793 VpdOffset = int(Sku.VpdOffset)
1794 except:
1795 try:
1796 VpdOffset = int(Sku.VpdOffset, 16)
1797 except:
1798 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))
1799 if VpdOffset % Alignment != 0:
1800 if PcdValue.startswith("{"):
1801 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)
1802 else:
1803 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))
1804 if PcdValue not in SkuValueMap:
1805 SkuValueMap[PcdValue] = []
1806 VpdFile.Add(DscPcdEntry, SkuName,Sku.VpdOffset)
1807 SkuValueMap[PcdValue].append(Sku)
1808 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1809 NeedProcessVpdMapFile = True
1810 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1811 UnicodePcdArray.add(DscPcdEntry)
1812 elif len(Sku.VariableName) > 0:
1813 HiiPcdArray.add(DscPcdEntry)
1814 else:
1815 OtherPcdArray.add(DscPcdEntry)
1816
1817 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1818 VpdSkuMap[DscPcd] = SkuValueMap
1819 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \
1820 VpdFile.GetCount() != 0:
1821 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1822 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1823
1824 if VpdFile.GetCount() != 0:
1825
1826 self.FixVpdOffset(VpdFile)
1827
1828 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))
1829
1830 # Process VPD map file generated by third party BPDG tool
1831 if NeedProcessVpdMapFile:
1832 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1833 if os.path.exists(VpdMapFilePath):
1834 VpdFile.Read(VpdMapFilePath)
1835
1836 # Fixup "*" offset
1837 for pcd in VpdSkuMap:
1838 vpdinfo = VpdFile.GetVpdInfo(pcd)
1839 if vpdinfo is None:
1840 # just pick the a value to determine whether is unicode string type
1841 continue
1842 for pcdvalue in VpdSkuMap[pcd]:
1843 for sku in VpdSkuMap[pcd][pcdvalue]:
1844 for item in vpdinfo:
1845 if item[2] == pcdvalue:
1846 sku.VpdOffset = item[1]
1847 else:
1848 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1849
1850 # Delete the DynamicPcdList At the last time enter into this function
1851 for Pcd in self._DynamicPcdList:
1852 # just pick the a value to determine whether is unicode string type
1853 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1854 Sku.VpdOffset = Sku.VpdOffset.strip()
1855
1856 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1857 Pcd.DatumType = "VOID*"
1858
1859 PcdValue = Sku.DefaultValue
1860 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1861 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1862 UnicodePcdArray.add(Pcd)
1863 elif len(Sku.VariableName) > 0:
1864 # if found HII type PCD then insert to right of UnicodeIndex
1865 HiiPcdArray.add(Pcd)
1866 else:
1867 OtherPcdArray.add(Pcd)
1868 del self._DynamicPcdList[:]
1869 self._DynamicPcdList.extend(list(UnicodePcdArray))
1870 self._DynamicPcdList.extend(list(HiiPcdArray))
1871 self._DynamicPcdList.extend(list(OtherPcdArray))
1872 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]
1873 for pcd in self._DynamicPcdList:
1874 if len(pcd.SkuInfoList) == 1:
1875 for (SkuName,SkuId) in allskuset:
1876 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:
1877 continue
1878 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList['DEFAULT'])
1879 pcd.SkuInfoList[SkuName].SkuId = SkuId
1880 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1881
1882 def FixVpdOffset(self,VpdFile ):
1883 FvPath = os.path.join(self.BuildDir, "FV")
1884 if not os.path.exists(FvPath):
1885 try:
1886 os.makedirs(FvPath)
1887 except:
1888 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1889
1890 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1891
1892 if VpdFile.Write(VpdFilePath):
1893 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1894 BPDGToolName = None
1895 for ToolDef in self.ToolDefinition.values():
1896 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1897 if not ToolDef.has_key("PATH"):
1898 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1899 BPDGToolName = ToolDef["PATH"]
1900 break
1901 # Call third party GUID BPDG tool.
1902 if BPDGToolName != None:
1903 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1904 else:
1905 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.")
1906
1907 ## Return the platform build data object
1908 def _GetPlatform(self):
1909 if self._Platform == None:
1910 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1911 return self._Platform
1912
1913 ## Return platform name
1914 def _GetName(self):
1915 return self.Platform.PlatformName
1916
1917 ## Return the meta file GUID
1918 def _GetGuid(self):
1919 return self.Platform.Guid
1920
1921 ## Return the platform version
1922 def _GetVersion(self):
1923 return self.Platform.Version
1924
1925 ## Return the FDF file name
1926 def _GetFdfFile(self):
1927 if self._FdfFile == None:
1928 if self.Workspace.FdfFile != "":
1929 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)
1930 else:
1931 self._FdfFile = ''
1932 return self._FdfFile
1933
1934 ## Return the build output directory platform specifies
1935 def _GetOutputDir(self):
1936 return self.Platform.OutputDirectory
1937
1938 ## Return the directory to store all intermediate and final files built
1939 def _GetBuildDir(self):
1940 if self._BuildDir == None:
1941 if os.path.isabs(self.OutputDir):
1942 self._BuildDir = path.join(
1943 path.abspath(self.OutputDir),
1944 self.BuildTarget + "_" + self.ToolChain,
1945 )
1946 else:
1947 self._BuildDir = path.join(
1948 self.WorkspaceDir,
1949 self.OutputDir,
1950 self.BuildTarget + "_" + self.ToolChain,
1951 )
1952 GlobalData.gBuildDirectory = self._BuildDir
1953 return self._BuildDir
1954
1955 ## Return directory of platform makefile
1956 #
1957 # @retval string Makefile directory
1958 #
1959 def _GetMakeFileDir(self):
1960 if self._MakeFileDir == None:
1961 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1962 return self._MakeFileDir
1963
1964 ## Return build command string
1965 #
1966 # @retval string Build command string
1967 #
1968 def _GetBuildCommand(self):
1969 if self._BuildCommand == None:
1970 self._BuildCommand = []
1971 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1972 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1973 if "FLAGS" in self.ToolDefinition["MAKE"]:
1974 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1975 if NewOption != '':
1976 self._BuildCommand += SplitOption(NewOption)
1977 return self._BuildCommand
1978
1979 ## Get tool chain definition
1980 #
1981 # Get each tool defition for given tool chain from tools_def.txt and platform
1982 #
1983 def _GetToolDefinition(self):
1984 if self._ToolDefinitions == None:
1985 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1986 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1987 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1988 ExtraData="[%s]" % self.MetaFile)
1989 self._ToolDefinitions = {}
1990 DllPathList = set()
1991 for Def in ToolDefinition:
1992 Target, Tag, Arch, Tool, Attr = Def.split("_")
1993 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1994 continue
1995
1996 Value = ToolDefinition[Def]
1997 # don't record the DLL
1998 if Attr == "DLL":
1999 DllPathList.add(Value)
2000 continue
2001
2002 if Tool not in self._ToolDefinitions:
2003 self._ToolDefinitions[Tool] = {}
2004 self._ToolDefinitions[Tool][Attr] = Value
2005
2006 ToolsDef = ''
2007 MakePath = ''
2008 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
2009 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
2010 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
2011 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
2012 MakeFlags = ''
2013 for Tool in self._ToolDefinitions:
2014 for Attr in self._ToolDefinitions[Tool]:
2015 Value = self._ToolDefinitions[Tool][Attr]
2016 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
2017 # check if override is indicated
2018 if self.BuildOption[Tool][Attr].startswith('='):
2019 Value = self.BuildOption[Tool][Attr][1:]
2020 else:
2021 if Attr != 'PATH':
2022 Value += " " + self.BuildOption[Tool][Attr]
2023 else:
2024 Value = self.BuildOption[Tool][Attr]
2025
2026 if Attr == "PATH":
2027 # Don't put MAKE definition in the file
2028 if Tool == "MAKE":
2029 MakePath = Value
2030 else:
2031 ToolsDef += "%s = %s\n" % (Tool, Value)
2032 elif Attr != "DLL":
2033 # Don't put MAKE definition in the file
2034 if Tool == "MAKE":
2035 if Attr == "FLAGS":
2036 MakeFlags = Value
2037 else:
2038 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
2039 ToolsDef += "\n"
2040
2041 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
2042 for DllPath in DllPathList:
2043 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
2044 os.environ["MAKE_FLAGS"] = MakeFlags
2045
2046 return self._ToolDefinitions
2047
2048 ## Return the paths of tools
2049 def _GetToolDefFile(self):
2050 if self._ToolDefFile == None:
2051 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
2052 return self._ToolDefFile
2053
2054 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
2055 def _GetToolChainFamily(self):
2056 if self._ToolChainFamily == None:
2057 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
2058 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
2059 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
2060 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
2061 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2062 % self.ToolChain)
2063 self._ToolChainFamily = "MSFT"
2064 else:
2065 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
2066 return self._ToolChainFamily
2067
2068 def _GetBuildRuleFamily(self):
2069 if self._BuildRuleFamily == None:
2070 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
2071 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
2072 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
2073 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
2074 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2075 % self.ToolChain)
2076 self._BuildRuleFamily = "MSFT"
2077 else:
2078 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
2079 return self._BuildRuleFamily
2080
2081 ## Return the build options specific for all modules in this platform
2082 def _GetBuildOptions(self):
2083 if self._BuildOption == None:
2084 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
2085 return self._BuildOption
2086
2087 ## Return the build options specific for EDK modules in this platform
2088 def _GetEdkBuildOptions(self):
2089 if self._EdkBuildOption == None:
2090 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
2091 return self._EdkBuildOption
2092
2093 ## Return the build options specific for EDKII modules in this platform
2094 def _GetEdkIIBuildOptions(self):
2095 if self._EdkIIBuildOption == None:
2096 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
2097 return self._EdkIIBuildOption
2098
2099 ## Parse build_rule.txt in Conf Directory.
2100 #
2101 # @retval BuildRule object
2102 #
2103 def _GetBuildRule(self):
2104 if self._BuildRule == None:
2105 BuildRuleFile = None
2106 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
2107 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
2108 if BuildRuleFile in [None, '']:
2109 BuildRuleFile = gDefaultBuildRuleFile
2110 self._BuildRule = BuildRule(BuildRuleFile)
2111 if self._BuildRule._FileVersion == "":
2112 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
2113 else:
2114 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
2115 # If Build Rule's version is less than the version number required by the tools, halting the build.
2116 EdkLogger.error("build", AUTOGEN_ERROR,
2117 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])"\
2118 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
2119
2120 return self._BuildRule
2121
2122 ## Summarize the packages used by modules in this platform
2123 def _GetPackageList(self):
2124 if self._PackageList == None:
2125 self._PackageList = set()
2126 for La in self.LibraryAutoGenList:
2127 self._PackageList.update(La.DependentPackageList)
2128 for Ma in self.ModuleAutoGenList:
2129 self._PackageList.update(Ma.DependentPackageList)
2130 #Collect package set information from INF of FDF
2131 PkgSet = set()
2132 for ModuleFile in self._AsBuildModuleList:
2133 if ModuleFile in self.Platform.Modules:
2134 continue
2135 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
2136 PkgSet.update(ModuleData.Packages)
2137 self._PackageList = list(self._PackageList) + list (PkgSet)
2138 return self._PackageList
2139
2140 def _GetNonDynamicPcdDict(self):
2141 if self._NonDynamicPcdDict:
2142 return self._NonDynamicPcdDict
2143 for Pcd in self.NonDynamicPcdList:
2144 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
2145 return self._NonDynamicPcdDict
2146
2147 ## Get list of non-dynamic PCDs
2148 def _GetNonDynamicPcdList(self):
2149 if self._NonDynamicPcdList == None:
2150 self.CollectPlatformDynamicPcds()
2151 return self._NonDynamicPcdList
2152
2153 ## Get list of dynamic PCDs
2154 def _GetDynamicPcdList(self):
2155 if self._DynamicPcdList == None:
2156 self.CollectPlatformDynamicPcds()
2157 return self._DynamicPcdList
2158
2159 ## Generate Token Number for all PCD
2160 def _GetPcdTokenNumbers(self):
2161 if self._PcdTokenNumber == None:
2162 self._PcdTokenNumber = sdict()
2163 TokenNumber = 1
2164 #
2165 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2166 # Such as:
2167 #
2168 # Dynamic PCD:
2169 # TokenNumber 0 ~ 10
2170 # DynamicEx PCD:
2171 # TokeNumber 11 ~ 20
2172 #
2173 for Pcd in self.DynamicPcdList:
2174 if Pcd.Phase == "PEI":
2175 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2176 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2177 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2178 TokenNumber += 1
2179
2180 for Pcd in self.DynamicPcdList:
2181 if Pcd.Phase == "PEI":
2182 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2183 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2184 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2185 TokenNumber += 1
2186
2187 for Pcd in self.DynamicPcdList:
2188 if Pcd.Phase == "DXE":
2189 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2190 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2191 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2192 TokenNumber += 1
2193
2194 for Pcd in self.DynamicPcdList:
2195 if Pcd.Phase == "DXE":
2196 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2197 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2198 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2199 TokenNumber += 1
2200
2201 for Pcd in self.NonDynamicPcdList:
2202 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2203 TokenNumber += 1
2204 return self._PcdTokenNumber
2205
2206 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2207 def _GetAutoGenObjectList(self):
2208 self._ModuleAutoGenList = []
2209 self._LibraryAutoGenList = []
2210 for ModuleFile in self.Platform.Modules:
2211 Ma = ModuleAutoGen(
2212 self.Workspace,
2213 ModuleFile,
2214 self.BuildTarget,
2215 self.ToolChain,
2216 self.Arch,
2217 self.MetaFile
2218 )
2219 if Ma not in self._ModuleAutoGenList:
2220 self._ModuleAutoGenList.append(Ma)
2221 for La in Ma.LibraryAutoGenList:
2222 if La not in self._LibraryAutoGenList:
2223 self._LibraryAutoGenList.append(La)
2224 if Ma not in La._ReferenceModules:
2225 La._ReferenceModules.append(Ma)
2226
2227 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2228 def _GetModuleAutoGenList(self):
2229 if self._ModuleAutoGenList == None:
2230 self._GetAutoGenObjectList()
2231 return self._ModuleAutoGenList
2232
2233 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2234 def _GetLibraryAutoGenList(self):
2235 if self._LibraryAutoGenList == None:
2236 self._GetAutoGenObjectList()
2237 return self._LibraryAutoGenList
2238
2239 ## Test if a module is supported by the platform
2240 #
2241 # An error will be raised directly if the module or its arch is not supported
2242 # by the platform or current configuration
2243 #
2244 def ValidModule(self, Module):
2245 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
2246 or Module in self._AsBuildModuleList
2247
2248 ## Resolve the library classes in a module to library instances
2249 #
2250 # This method will not only resolve library classes but also sort the library
2251 # instances according to the dependency-ship.
2252 #
2253 # @param Module The module from which the library classes will be resolved
2254 #
2255 # @retval library_list List of library instances sorted
2256 #
2257 def ApplyLibraryInstance(self, Module):
2258 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2259 if str(Module) not in self.Platform.Modules:
2260 return []
2261
2262 ModuleType = Module.ModuleType
2263
2264 # for overridding library instances with module specific setting
2265 PlatformModule = self.Platform.Modules[str(Module)]
2266
2267 # add forced library instances (specified under LibraryClasses sections)
2268 #
2269 # If a module has a MODULE_TYPE of USER_DEFINED,
2270 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2271 #
2272 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
2273 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
2274 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
2275 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
2276
2277 # add forced library instances (specified in module overrides)
2278 for LibraryClass in PlatformModule.LibraryClasses:
2279 if LibraryClass.startswith("NULL"):
2280 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
2281
2282 # EdkII module
2283 LibraryConsumerList = [Module]
2284 Constructor = []
2285 ConsumedByList = sdict()
2286 LibraryInstance = sdict()
2287
2288 EdkLogger.verbose("")
2289 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2290 while len(LibraryConsumerList) > 0:
2291 M = LibraryConsumerList.pop()
2292 for LibraryClassName in M.LibraryClasses:
2293 if LibraryClassName not in LibraryInstance:
2294 # override library instance for this module
2295 if LibraryClassName in PlatformModule.LibraryClasses:
2296 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
2297 else:
2298 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
2299 if LibraryPath == None or LibraryPath == "":
2300 LibraryPath = M.LibraryClasses[LibraryClassName]
2301 if LibraryPath == None or LibraryPath == "":
2302 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
2303 "Instance of library class [%s] is not found" % LibraryClassName,
2304 File=self.MetaFile,
2305 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
2306
2307 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
2308 # for those forced library instance (NULL library), add a fake library class
2309 if LibraryClassName.startswith("NULL"):
2310 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
2311 elif LibraryModule.LibraryClass == None \
2312 or len(LibraryModule.LibraryClass) == 0 \
2313 or (ModuleType != 'USER_DEFINED'
2314 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
2315 # only USER_DEFINED can link against any library instance despite of its SupModList
2316 EdkLogger.error("build", OPTION_MISSING,
2317 "Module type [%s] is not supported by library instance [%s]" \
2318 % (ModuleType, LibraryPath), File=self.MetaFile,
2319 ExtraData="consumed by [%s]" % str(Module))
2320
2321 LibraryInstance[LibraryClassName] = LibraryModule
2322 LibraryConsumerList.append(LibraryModule)
2323 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
2324 else:
2325 LibraryModule = LibraryInstance[LibraryClassName]
2326
2327 if LibraryModule == None:
2328 continue
2329
2330 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
2331 Constructor.append(LibraryModule)
2332
2333 if LibraryModule not in ConsumedByList:
2334 ConsumedByList[LibraryModule] = []
2335 # don't add current module itself to consumer list
2336 if M != Module:
2337 if M in ConsumedByList[LibraryModule]:
2338 continue
2339 ConsumedByList[LibraryModule].append(M)
2340 #
2341 # Initialize the sorted output list to the empty set
2342 #
2343 SortedLibraryList = []
2344 #
2345 # Q <- Set of all nodes with no incoming edges
2346 #
2347 LibraryList = [] #LibraryInstance.values()
2348 Q = []
2349 for LibraryClassName in LibraryInstance:
2350 M = LibraryInstance[LibraryClassName]
2351 LibraryList.append(M)
2352 if ConsumedByList[M] == []:
2353 Q.append(M)
2354
2355 #
2356 # start the DAG algorithm
2357 #
2358 while True:
2359 EdgeRemoved = True
2360 while Q == [] and EdgeRemoved:
2361 EdgeRemoved = False
2362 # for each node Item with a Constructor
2363 for Item in LibraryList:
2364 if Item not in Constructor:
2365 continue
2366 # for each Node without a constructor with an edge e from Item to Node
2367 for Node in ConsumedByList[Item]:
2368 if Node in Constructor:
2369 continue
2370 # remove edge e from the graph if Node has no constructor
2371 ConsumedByList[Item].remove(Node)
2372 EdgeRemoved = True
2373 if ConsumedByList[Item] == []:
2374 # insert Item into Q
2375 Q.insert(0, Item)
2376 break
2377 if Q != []:
2378 break
2379 # DAG is done if there's no more incoming edge for all nodes
2380 if Q == []:
2381 break
2382
2383 # remove node from Q
2384 Node = Q.pop()
2385 # output Node
2386 SortedLibraryList.append(Node)
2387
2388 # for each node Item with an edge e from Node to Item do
2389 for Item in LibraryList:
2390 if Node not in ConsumedByList[Item]:
2391 continue
2392 # remove edge e from the graph
2393 ConsumedByList[Item].remove(Node)
2394
2395 if ConsumedByList[Item] != []:
2396 continue
2397 # insert Item into Q, if Item has no other incoming edges
2398 Q.insert(0, Item)
2399
2400 #
2401 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2402 #
2403 for Item in LibraryList:
2404 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
2405 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
2406 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
2407 ExtraData=ErrorMessage, File=self.MetaFile)
2408 if Item not in SortedLibraryList:
2409 SortedLibraryList.append(Item)
2410
2411 #
2412 # Build the list of constructor and destructir names
2413 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2414 #
2415 SortedLibraryList.reverse()
2416 return SortedLibraryList
2417
2418
2419 ## Override PCD setting (type, value, ...)
2420 #
2421 # @param ToPcd The PCD to be overrided
2422 # @param FromPcd The PCD overrideing from
2423 #
2424 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
2425 #
2426 # in case there's PCDs coming from FDF file, which have no type given.
2427 # at this point, ToPcd.Type has the type found from dependent
2428 # package
2429 #
2430 TokenCName = ToPcd.TokenCName
2431 for PcdItem in GlobalData.MixedPcd:
2432 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
2433 TokenCName = PcdItem[0]
2434 break
2435 if FromPcd != None:
2436 if GlobalData.BuildOptionPcd:
2437 for pcd in GlobalData.BuildOptionPcd:
2438 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):
2439 FromPcd.DefaultValue = pcd[2]
2440 break
2441 if ToPcd.Pending and FromPcd.Type not in [None, '']:
2442 ToPcd.Type = FromPcd.Type
2443 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
2444 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
2445 if ToPcd.Type.strip() == "DynamicEx":
2446 ToPcd.Type = FromPcd.Type
2447 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
2448 and ToPcd.Type != FromPcd.Type:
2449 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
2450 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2451 % (ToPcd.TokenSpaceGuidCName, TokenCName,
2452 ToPcd.Type, Module, FromPcd.Type),
2453 File=self.MetaFile)
2454
2455 if FromPcd.MaxDatumSize not in [None, '']:
2456 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2457 if FromPcd.DefaultValue not in [None, '']:
2458 ToPcd.DefaultValue = FromPcd.DefaultValue
2459 if FromPcd.TokenValue not in [None, '']:
2460 ToPcd.TokenValue = FromPcd.TokenValue
2461 if FromPcd.MaxDatumSize not in [None, '']:
2462 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2463 if FromPcd.DatumType not in [None, '']:
2464 ToPcd.DatumType = FromPcd.DatumType
2465 if FromPcd.SkuInfoList not in [None, '', []]:
2466 ToPcd.SkuInfoList = FromPcd.SkuInfoList
2467 # Add Flexible PCD format parse
2468 PcdValue = ToPcd.DefaultValue
2469 if PcdValue:
2470 try:
2471 ToPcd.DefaultValue = ValueExpression(PcdValue)(True)
2472 except WrnExpression, Value:
2473 ToPcd.DefaultValue = Value.result
2474 except BadExpression, Value:
2475 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),
2476 File=self.MetaFile)
2477 if ToPcd.DefaultValue:
2478 _GuidDict = {}
2479 for Pkg in self.PackageList:
2480 Guids = Pkg.Guids
2481 _GuidDict.update(Guids)
2482 try:
2483 ToPcd.DefaultValue = ValueExpressionEx(ToPcd.DefaultValue, ToPcd.DatumType, _GuidDict)(True)
2484 except BadExpression, Value:
2485 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),
2486 File=self.MetaFile)
2487
2488 # check the validation of datum
2489 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
2490 if not IsValid:
2491 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
2492 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))
2493 ToPcd.validateranges = FromPcd.validateranges
2494 ToPcd.validlists = FromPcd.validlists
2495 ToPcd.expressions = FromPcd.expressions
2496
2497 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
2498 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
2499 % (ToPcd.TokenSpaceGuidCName, TokenCName))
2500 Value = ToPcd.DefaultValue
2501 if Value in [None, '']:
2502 ToPcd.MaxDatumSize = '1'
2503 elif Value[0] == 'L':
2504 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
2505 elif Value[0] == '{':
2506 ToPcd.MaxDatumSize = str(len(Value.split(',')))
2507 else:
2508 ToPcd.MaxDatumSize = str(len(Value) - 1)
2509
2510 # apply default SKU for dynamic PCDS if specified one is not available
2511 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
2512 and ToPcd.SkuInfoList in [None, {}, '']:
2513 if self.Platform.SkuName in self.Platform.SkuIds:
2514 SkuName = self.Platform.SkuName
2515 else:
2516 SkuName = 'DEFAULT'
2517 ToPcd.SkuInfoList = {
2518 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)
2519 }
2520
2521 ## Apply PCD setting defined platform to a module
2522 #
2523 # @param Module The module from which the PCD setting will be overrided
2524 #
2525 # @retval PCD_list The list PCDs with settings from platform
2526 #
2527 def ApplyPcdSetting(self, Module, Pcds):
2528 # for each PCD in module
2529 for Name, Guid in Pcds:
2530 PcdInModule = Pcds[Name, Guid]
2531 # find out the PCD setting in platform
2532 if (Name, Guid) in self.Platform.Pcds:
2533 PcdInPlatform = self.Platform.Pcds[Name, Guid]
2534 else:
2535 PcdInPlatform = None
2536 # then override the settings if any
2537 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
2538 # resolve the VariableGuid value
2539 for SkuId in PcdInModule.SkuInfoList:
2540 Sku = PcdInModule.SkuInfoList[SkuId]
2541 if Sku.VariableGuid == '': continue
2542 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)
2543 if Sku.VariableGuidValue == None:
2544 PackageList = "\n\t".join([str(P) for P in self.PackageList])
2545 EdkLogger.error(
2546 'build',
2547 RESOURCE_NOT_AVAILABLE,
2548 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
2549 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
2550 % (Guid, Name, str(Module)),
2551 File=self.MetaFile
2552 )
2553
2554 # override PCD settings with module specific setting
2555 if Module in self.Platform.Modules:
2556 PlatformModule = self.Platform.Modules[str(Module)]
2557 for Key in PlatformModule.Pcds:
2558 Flag = False
2559 if Key in Pcds:
2560 ToPcd = Pcds[Key]
2561 Flag = True
2562 elif Key in GlobalData.MixedPcd:
2563 for PcdItem in GlobalData.MixedPcd[Key]:
2564 if PcdItem in Pcds:
2565 ToPcd = Pcds[PcdItem]
2566 Flag = True
2567 break
2568 if Flag:
2569 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)
2570 return Pcds.values()
2571
2572 ## Resolve library names to library modules
2573 #
2574 # (for Edk.x modules)
2575 #
2576 # @param Module The module from which the library names will be resolved
2577 #
2578 # @retval library_list The list of library modules
2579 #
2580 def ResolveLibraryReference(self, Module):
2581 EdkLogger.verbose("")
2582 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2583 LibraryConsumerList = [Module]
2584
2585 # "CompilerStub" is a must for Edk modules
2586 if Module.Libraries:
2587 Module.Libraries.append("CompilerStub")
2588 LibraryList = []
2589 while len(LibraryConsumerList) > 0:
2590 M = LibraryConsumerList.pop()
2591 for LibraryName in M.Libraries:
2592 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2593 if Library == None:
2594 for Key in self.Platform.LibraryClasses.data.keys():
2595 if LibraryName.upper() == Key.upper():
2596 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2597 break
2598 if Library == None:
2599 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2600 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2601 continue
2602
2603 if Library not in LibraryList:
2604 LibraryList.append(Library)
2605 LibraryConsumerList.append(Library)
2606 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2607 return LibraryList
2608
2609 ## Calculate the priority value of the build option
2610 #
2611 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2612 #
2613 # @retval Value Priority value based on the priority list.
2614 #
2615 def CalculatePriorityValue(self, Key):
2616 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2617 PriorityValue = 0x11111
2618 if Target == "*":
2619 PriorityValue &= 0x01111
2620 if ToolChain == "*":
2621 PriorityValue &= 0x10111
2622 if Arch == "*":
2623 PriorityValue &= 0x11011
2624 if CommandType == "*":
2625 PriorityValue &= 0x11101
2626 if Attr == "*":
2627 PriorityValue &= 0x11110
2628
2629 return self.PrioList["0x%0.5x" % PriorityValue]
2630
2631
2632 ## Expand * in build option key
2633 #
2634 # @param Options Options to be expanded
2635 #
2636 # @retval options Options expanded
2637 #
2638 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2639 BuildOptions = {}
2640 FamilyMatch = False
2641 FamilyIsNull = True
2642
2643 OverrideList = {}
2644 #
2645 # Construct a list contain the build options which need override.
2646 #
2647 for Key in Options:
2648 #
2649 # Key[0] -- tool family
2650 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2651 #
2652 if (Key[0] == self.BuildRuleFamily and
2653 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2654 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2655 if Target == self.BuildTarget or Target == "*":
2656 if ToolChain == self.ToolChain or ToolChain == "*":
2657 if Arch == self.Arch or Arch == "*":
2658 if Options[Key].startswith("="):
2659 if OverrideList.get(Key[1]) != None:
2660 OverrideList.pop(Key[1])
2661 OverrideList[Key[1]] = Options[Key]
2662
2663 #
2664 # Use the highest priority value.
2665 #
2666 if (len(OverrideList) >= 2):
2667 KeyList = OverrideList.keys()
2668 for Index in range(len(KeyList)):
2669 NowKey = KeyList[Index]
2670 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2671 for Index1 in range(len(KeyList) - Index - 1):
2672 NextKey = KeyList[Index1 + Index + 1]
2673 #
2674 # Compare two Key, if one is included by another, choose the higher priority one
2675 #
2676 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2677 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2678 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2679 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2680 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2681 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2682 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2683 if Options.get((self.BuildRuleFamily, NextKey)) != None:
2684 Options.pop((self.BuildRuleFamily, NextKey))
2685 else:
2686 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2687 Options.pop((self.BuildRuleFamily, NowKey))
2688
2689 for Key in Options:
2690 if ModuleStyle != None and len (Key) > 2:
2691 # Check Module style is EDK or EDKII.
2692 # Only append build option for the matched style module.
2693 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2694 continue
2695 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2696 continue
2697 Family = Key[0]
2698 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2699 # if tool chain family doesn't match, skip it
2700 if Tool in self.ToolDefinition and Family != "":
2701 FamilyIsNull = False
2702 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2703 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2704 continue
2705 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2706 continue
2707 FamilyMatch = True
2708 # expand any wildcard
2709 if Target == "*" or Target == self.BuildTarget:
2710 if Tag == "*" or Tag == self.ToolChain:
2711 if Arch == "*" or Arch == self.Arch:
2712 if Tool not in BuildOptions:
2713 BuildOptions[Tool] = {}
2714 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2715 BuildOptions[Tool][Attr] = Options[Key]
2716 else:
2717 # append options for the same tool except PATH
2718 if Attr != 'PATH':
2719 BuildOptions[Tool][Attr] += " " + Options[Key]
2720 else:
2721 BuildOptions[Tool][Attr] = Options[Key]
2722 # Build Option Family has been checked, which need't to be checked again for family.
2723 if FamilyMatch or FamilyIsNull:
2724 return BuildOptions
2725
2726 for Key in Options:
2727 if ModuleStyle != None and len (Key) > 2:
2728 # Check Module style is EDK or EDKII.
2729 # Only append build option for the matched style module.
2730 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2731 continue
2732 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2733 continue
2734 Family = Key[0]
2735 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2736 # if tool chain family doesn't match, skip it
2737 if Tool not in self.ToolDefinition or Family == "":
2738 continue
2739 # option has been added before
2740 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2741 continue
2742
2743 # expand any wildcard
2744 if Target == "*" or Target == self.BuildTarget:
2745 if Tag == "*" or Tag == self.ToolChain:
2746 if Arch == "*" or Arch == self.Arch:
2747 if Tool not in BuildOptions:
2748 BuildOptions[Tool] = {}
2749 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2750 BuildOptions[Tool][Attr] = Options[Key]
2751 else:
2752 # append options for the same tool except PATH
2753 if Attr != 'PATH':
2754 BuildOptions[Tool][Attr] += " " + Options[Key]
2755 else:
2756 BuildOptions[Tool][Attr] = Options[Key]
2757 return BuildOptions
2758
2759 ## Append build options in platform to a module
2760 #
2761 # @param Module The module to which the build options will be appened
2762 #
2763 # @retval options The options appended with build options in platform
2764 #
2765 def ApplyBuildOption(self, Module):
2766 # Get the different options for the different style module
2767 if Module.AutoGenVersion < 0x00010005:
2768 PlatformOptions = self.EdkBuildOption
2769 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2770 else:
2771 PlatformOptions = self.EdkIIBuildOption
2772 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2773 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2774 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2775 if Module in self.Platform.Modules:
2776 PlatformModule = self.Platform.Modules[str(Module)]
2777 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2778 else:
2779 PlatformModuleOptions = {}
2780
2781 BuildRuleOrder = None
2782 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2783 for Tool in Options:
2784 for Attr in Options[Tool]:
2785 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2786 BuildRuleOrder = Options[Tool][Attr]
2787
2788 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2789 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2790 self.ToolDefinition.keys())
2791 BuildOptions = {}
2792 for Tool in AllTools:
2793 if Tool not in BuildOptions:
2794 BuildOptions[Tool] = {}
2795
2796 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2797 if Tool not in Options:
2798 continue
2799 for Attr in Options[Tool]:
2800 Value = Options[Tool][Attr]
2801 #
2802 # Do not generate it in Makefile
2803 #
2804 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2805 continue
2806 if Attr not in BuildOptions[Tool]:
2807 BuildOptions[Tool][Attr] = ""
2808 # check if override is indicated
2809 if Value.startswith('='):
2810 ToolPath = Value[1:]
2811 ToolPath = mws.handleWsMacro(ToolPath)
2812 BuildOptions[Tool][Attr] = ToolPath
2813 else:
2814 Value = mws.handleWsMacro(Value)
2815 if Attr != 'PATH':
2816 BuildOptions[Tool][Attr] += " " + Value
2817 else:
2818 BuildOptions[Tool][Attr] = Value
2819 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2820 #
2821 # Override UNI flag only for EDK module.
2822 #
2823 if 'BUILD' not in BuildOptions:
2824 BuildOptions['BUILD'] = {}
2825 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2826 return BuildOptions, BuildRuleOrder
2827
2828 Platform = property(_GetPlatform)
2829 Name = property(_GetName)
2830 Guid = property(_GetGuid)
2831 Version = property(_GetVersion)
2832
2833 OutputDir = property(_GetOutputDir)
2834 BuildDir = property(_GetBuildDir)
2835 MakeFileDir = property(_GetMakeFileDir)
2836 FdfFile = property(_GetFdfFile)
2837
2838 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2839 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2840 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2841 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2842 PackageList = property(_GetPackageList)
2843
2844 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2845 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2846 ToolChainFamily = property(_GetToolChainFamily)
2847 BuildRuleFamily = property(_GetBuildRuleFamily)
2848 BuildOption = property(_GetBuildOptions) # toolcode : option
2849 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2850 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2851
2852 BuildCommand = property(_GetBuildCommand)
2853 BuildRule = property(_GetBuildRule)
2854 ModuleAutoGenList = property(_GetModuleAutoGenList)
2855 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2856 GenFdsCommand = property(_GenFdsCommand)
2857
2858 ## ModuleAutoGen class
2859 #
2860 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2861 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2862 # to the [depex] section in module's inf file.
2863 #
2864 class ModuleAutoGen(AutoGen):
2865 ## Cache the timestamps of metafiles of every module in a class variable
2866 #
2867 TimeDict = {}
2868
2869 ## The real constructor of ModuleAutoGen
2870 #
2871 # This method is not supposed to be called by users of ModuleAutoGen. It's
2872 # only used by factory method __new__() to do real initialization work for an
2873 # object of ModuleAutoGen
2874 #
2875 # @param Workspace EdkIIWorkspaceBuild object
2876 # @param ModuleFile The path of module file
2877 # @param Target Build target (DEBUG, RELEASE)
2878 # @param Toolchain Name of tool chain
2879 # @param Arch The arch the module supports
2880 # @param PlatformFile Platform meta-file
2881 #
2882 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2883 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2884 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2885
2886 self.Workspace = Workspace
2887 self.WorkspaceDir = Workspace.WorkspaceDir
2888
2889 self.MetaFile = ModuleFile
2890 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2891 # check if this module is employed by active platform
2892 if not self.PlatformInfo.ValidModule(self.MetaFile):
2893 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2894 % (self.MetaFile, Arch))
2895 return False
2896
2897 self.SourceDir = self.MetaFile.SubDir
2898 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2899
2900 self.SourceOverrideDir = None
2901 # use overrided path defined in DSC file
2902 if self.MetaFile.Key in GlobalData.gOverrideDir:
2903 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2904
2905 self.ToolChain = Toolchain
2906 self.BuildTarget = Target
2907 self.Arch = Arch
2908 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2909 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2910
2911 self.IsMakeFileCreated = False
2912 self.IsCodeFileCreated = False
2913 self.IsAsBuiltInfCreated = False
2914 self.DepexGenerated = False
2915
2916 self.BuildDatabase = self.Workspace.BuildDatabase
2917 self.BuildRuleOrder = None
2918 self.BuildTime = 0
2919
2920 self._Module = None
2921 self._Name = None
2922 self._Guid = None
2923 self._Version = None
2924 self._ModuleType = None
2925 self._ComponentType = None
2926 self._PcdIsDriver = None
2927 self._AutoGenVersion = None
2928 self._LibraryFlag = None
2929 self._CustomMakefile = None
2930 self._Macro = None
2931
2932 self._BuildDir = None
2933 self._OutputDir = None
2934 self._FfsOutputDir = None
2935 self._DebugDir = None
2936 self._MakeFileDir = None
2937
2938 self._IncludePathList = None
2939 self._IncludePathLength = 0
2940 self._AutoGenFileList = None
2941 self._UnicodeFileList = None
2942 self._VfrFileList = None
2943 self._IdfFileList = None
2944 self._SourceFileList = None
2945 self._ObjectFileList = None
2946 self._BinaryFileList = None
2947
2948 self._DependentPackageList = None
2949 self._DependentLibraryList = None
2950 self._LibraryAutoGenList = None
2951 self._DerivedPackageList = None
2952 self._ModulePcdList = None
2953 self._LibraryPcdList = None
2954 self._PcdComments = sdict()
2955 self._GuidList = None
2956 self._GuidsUsedByPcd = None
2957 self._GuidComments = sdict()
2958 self._ProtocolList = None
2959 self._ProtocolComments = sdict()
2960 self._PpiList = None
2961 self._PpiComments = sdict()
2962 self._DepexList = None
2963 self._DepexExpressionList = None
2964 self._BuildOption = None
2965 self._BuildOptionIncPathList = None
2966 self._BuildTargets = None
2967 self._IntroBuildTargetList = None
2968 self._FinalBuildTargetList = None
2969 self._FileTypes = None
2970 self._BuildRules = None
2971
2972 self._TimeStampPath = None
2973
2974 self.AutoGenDepSet = set()
2975
2976
2977 ## The Modules referenced to this Library
2978 # Only Library has this attribute
2979 self._ReferenceModules = []
2980
2981 ## Store the FixedAtBuild Pcds
2982 #
2983 self._FixedAtBuildPcds = []
2984 self.ConstPcd = {}
2985 return True
2986
2987 def __repr__(self):
2988 return "%s [%s]" % (self.MetaFile, self.Arch)
2989
2990 # Get FixedAtBuild Pcds of this Module
2991 def _GetFixedAtBuildPcds(self):
2992 if self._FixedAtBuildPcds:
2993 return self._FixedAtBuildPcds
2994 for Pcd in self.ModulePcdList:
2995 if Pcd.Type != "FixedAtBuild":
2996 continue
2997 if Pcd not in self._FixedAtBuildPcds:
2998 self._FixedAtBuildPcds.append(Pcd)
2999
3000 return self._FixedAtBuildPcds
3001
3002 def _GetUniqueBaseName(self):
3003 BaseName = self.Name
3004 for Module in self.PlatformInfo.ModuleAutoGenList:
3005 if Module.MetaFile == self.MetaFile:
3006 continue
3007 if Module.Name == self.Name:
3008 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
3009 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
3010 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
3011 BaseName = '%s_%s' % (self.Name, self.Guid)
3012 return BaseName
3013
3014 # Macros could be used in build_rule.txt (also Makefile)
3015 def _GetMacros(self):
3016 if self._Macro == None:
3017 self._Macro = sdict()
3018 self._Macro["WORKSPACE" ] = self.WorkspaceDir
3019 self._Macro["MODULE_NAME" ] = self.Name
3020 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
3021 self._Macro["MODULE_GUID" ] = self.Guid
3022 self._Macro["MODULE_VERSION" ] = self.Version
3023 self._Macro["MODULE_TYPE" ] = self.ModuleType
3024 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
3025 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
3026 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
3027 self._Macro["MODULE_DIR" ] = self.SourceDir
3028
3029 self._Macro["BASE_NAME" ] = self.Name
3030
3031 self._Macro["ARCH" ] = self.Arch
3032 self._Macro["TOOLCHAIN" ] = self.ToolChain
3033 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
3034 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
3035 self._Macro["TARGET" ] = self.BuildTarget
3036
3037 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
3038 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
3039 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
3040 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
3041 self._Macro["OUTPUT_DIR" ] = self.OutputDir
3042 self._Macro["DEBUG_DIR" ] = self.DebugDir
3043 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
3044 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
3045 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
3046 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
3047 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
3048 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
3049 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
3050 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
3051 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
3052 return self._Macro
3053
3054 ## Return the module build data object
3055 def _GetModule(self):
3056 if self._Module == None:
3057 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
3058 return self._Module
3059
3060 ## Return the module name
3061 def _GetBaseName(self):
3062 return self.Module.BaseName
3063
3064 ## Return the module DxsFile if exist
3065 def _GetDxsFile(self):
3066 return self.Module.DxsFile
3067
3068 ## Return the module SourceOverridePath
3069 def _GetSourceOverridePath(self):
3070 return self.Module.SourceOverridePath
3071
3072 ## Return the module meta-file GUID
3073 def _GetGuid(self):
3074 #
3075 # To build same module more than once, the module path with FILE_GUID overridden has
3076 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3077 # in DSC. The overridden GUID can be retrieved from file name
3078 #
3079 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
3080 #
3081 # Length of GUID is 36
3082 #
3083 return os.path.basename(self.MetaFile.Path)[:36]
3084 return self.Module.Guid
3085
3086 ## Return the module version
3087 def _GetVersion(self):
3088 return self.Module.Version
3089
3090 ## Return the module type
3091 def _GetModuleType(self):
3092 return self.Module.ModuleType
3093
3094 ## Return the component type (for Edk.x style of module)
3095 def _GetComponentType(self):
3096 return self.Module.ComponentType
3097
3098 ## Return the build type
3099 def _GetBuildType(self):
3100 return self.Module.BuildType
3101
3102 ## Return the PCD_IS_DRIVER setting
3103 def _GetPcdIsDriver(self):
3104 return self.Module.PcdIsDriver
3105
3106 ## Return the autogen version, i.e. module meta-file version
3107 def _GetAutoGenVersion(self):
3108 return self.Module.AutoGenVersion
3109
3110 ## Check if the module is library or not
3111 def _IsLibrary(self):
3112 if self._LibraryFlag == None:
3113 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
3114 self._LibraryFlag = True
3115 else:
3116 self._LibraryFlag = False
3117 return self._LibraryFlag
3118
3119 ## Check if the module is binary module or not
3120 def _IsBinaryModule(self):
3121 return self.Module.IsBinaryModule
3122
3123 ## Return the directory to store intermediate files of the module
3124 def _GetBuildDir(self):
3125 if self._BuildDir == None:
3126 self._BuildDir = path.join(
3127 self.PlatformInfo.BuildDir,
3128 self.Arch,
3129 self.SourceDir,
3130 self.MetaFile.BaseName
3131 )
3132 CreateDirectory(self._BuildDir)
3133 return self._BuildDir
3134
3135 ## Return the directory to store the intermediate object files of the mdoule
3136 def _GetOutputDir(self):
3137 if self._OutputDir == None:
3138 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3139 CreateDirectory(self._OutputDir)
3140 return self._OutputDir
3141
3142 ## Return the directory to store ffs file
3143 def _GetFfsOutputDir(self):
3144 if self._FfsOutputDir == None:
3145 if GlobalData.gFdfParser != None:
3146 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)
3147 else:
3148 self._FfsOutputDir = ''
3149 return self._FfsOutputDir
3150
3151 ## Return the directory to store auto-gened source files of the mdoule
3152 def _GetDebugDir(self):
3153 if self._DebugDir == None:
3154 self._DebugDir = path.join(self.BuildDir, "DEBUG")
3155 CreateDirectory(self._DebugDir)
3156 return self._DebugDir
3157
3158 ## Return the path of custom file
3159 def _GetCustomMakefile(self):
3160 if self._CustomMakefile == None:
3161 self._CustomMakefile = {}
3162 for Type in self.Module.CustomMakefile:
3163 if Type in gMakeTypeMap:
3164 MakeType = gMakeTypeMap[Type]
3165 else:
3166 MakeType = 'nmake'
3167 if self.SourceOverrideDir != None:
3168 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
3169 if not os.path.exists(File):
3170 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3171 else:
3172 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3173 self._CustomMakefile[MakeType] = File
3174 return self._CustomMakefile
3175
3176 ## Return the directory of the makefile
3177 #
3178 # @retval string The directory string of module's makefile
3179 #
3180 def _GetMakeFileDir(self):
3181 return self.BuildDir
3182
3183 ## Return build command string
3184 #
3185 # @retval string Build command string
3186 #
3187 def _GetBuildCommand(self):
3188 return self.PlatformInfo.BuildCommand
3189
3190 ## Get object list of all packages the module and its dependent libraries belong to
3191 #
3192 # @retval list The list of package object
3193 #
3194 def _GetDerivedPackageList(self):
3195 PackageList = []
3196 for M in [self.Module] + self.DependentLibraryList:
3197 for Package in M.Packages:
3198 if Package in PackageList:
3199 continue
3200 PackageList.append(Package)
3201 return PackageList
3202
3203 ## Get the depex string
3204 #
3205 # @return : a string contain all depex expresion.
3206 def _GetDepexExpresionString(self):
3207 DepexStr = ''
3208 DepexList = []
3209 ## DPX_SOURCE IN Define section.
3210 if self.Module.DxsFile:
3211 return DepexStr
3212 for M in [self.Module] + self.DependentLibraryList:
3213 Filename = M.MetaFile.Path
3214 InfObj = InfSectionParser.InfSectionParser(Filename)
3215 DepexExpresionList = InfObj.GetDepexExpresionList()
3216 for DepexExpresion in DepexExpresionList:
3217 for key in DepexExpresion.keys():
3218 Arch, ModuleType = key
3219 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]
3220 # the type of build module is USER_DEFINED.
3221 # All different DEPEX section tags would be copied into the As Built INF file
3222 # and there would be separate DEPEX section tags
3223 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3224 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
3225 DepexList.append({(Arch, ModuleType): DepexExpr})
3226 else:
3227 if Arch.upper() == TAB_ARCH_COMMON or \
3228 (Arch.upper() == self.Arch.upper() and \
3229 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
3230 DepexList.append({(Arch, ModuleType): DepexExpr})
3231
3232 #the type of build module is USER_DEFINED.
3233 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3234 for Depex in DepexList:
3235 for key in Depex.keys():
3236 DepexStr += '[Depex.%s.%s]\n' % key
3237 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
3238 DepexStr += '\n\n'
3239 if not DepexStr:
3240 return '[Depex.%s]\n' % self.Arch
3241 return DepexStr
3242
3243 #the type of build module not is USER_DEFINED.
3244 Count = 0
3245 for Depex in DepexList:
3246 Count += 1
3247 if DepexStr != '':
3248 DepexStr += ' AND '
3249 DepexStr += '('
3250 for D in Depex.values():
3251 DepexStr += ' '.join([val for val in D])
3252 Index = DepexStr.find('END')
3253 if Index > -1 and Index == len(DepexStr) - 3:
3254 DepexStr = DepexStr[:-3]
3255 DepexStr = DepexStr.strip()
3256 DepexStr += ')'
3257 if Count == 1:
3258 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
3259 if not DepexStr:
3260 return '[Depex.%s]\n' % self.Arch
3261 return '[Depex.%s]\n# ' % self.Arch + DepexStr
3262
3263 ## Merge dependency expression
3264 #
3265 # @retval list The token list of the dependency expression after parsed
3266 #
3267 def _GetDepexTokenList(self):
3268 if self._DepexList == None:
3269 self._DepexList = {}
3270 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3271 return self._DepexList
3272
3273 self._DepexList[self.ModuleType] = []
3274
3275 for ModuleType in self._DepexList:
3276 DepexList = self._DepexList[ModuleType]
3277 #
3278 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3279 #
3280 for M in [self.Module] + self.DependentLibraryList:
3281 Inherited = False
3282 for D in M.Depex[self.Arch, ModuleType]:
3283 if DepexList != []:
3284 DepexList.append('AND')
3285 DepexList.append('(')
3286 DepexList.extend(D)
3287 if DepexList[-1] == 'END': # no need of a END at this time
3288 DepexList.pop()
3289 DepexList.append(')')
3290 Inherited = True
3291 if Inherited:
3292 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
3293 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
3294 break
3295 if len(DepexList) > 0:
3296 EdkLogger.verbose('')
3297 return self._DepexList
3298
3299 ## Merge dependency expression
3300 #
3301 # @retval list The token list of the dependency expression after parsed
3302 #
3303 def _GetDepexExpressionTokenList(self):
3304 if self._DepexExpressionList == None:
3305 self._DepexExpressionList = {}
3306 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3307 return self._DepexExpressionList
3308
3309 self._DepexExpressionList[self.ModuleType] = ''
3310
3311 for ModuleType in self._DepexExpressionList:
3312 DepexExpressionList = self._DepexExpressionList[ModuleType]
3313 #
3314 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3315 #
3316 for M in [self.Module] + self.DependentLibraryList:
3317 Inherited = False
3318 for D in M.DepexExpression[self.Arch, ModuleType]:
3319 if DepexExpressionList != '':
3320 DepexExpressionList += ' AND '
3321 DepexExpressionList += '('
3322 DepexExpressionList += D
3323 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
3324 DepexExpressionList += ')'
3325 Inherited = True
3326 if Inherited:
3327 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
3328 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
3329 break
3330 if len(DepexExpressionList) > 0:
3331 EdkLogger.verbose('')
3332 self._DepexExpressionList[ModuleType] = DepexExpressionList
3333 return self._DepexExpressionList
3334
3335 # Get the tiano core user extension, it is contain dependent library.
3336 # @retval: a list contain tiano core userextension.
3337 #
3338 def _GetTianoCoreUserExtensionList(self):
3339 TianoCoreUserExtentionList = []
3340 for M in [self.Module] + self.DependentLibraryList:
3341 Filename = M.MetaFile.Path
3342 InfObj = InfSectionParser.InfSectionParser(Filename)
3343 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()
3344 for TianoCoreUserExtent in TianoCoreUserExtenList:
3345 for Section in TianoCoreUserExtent.keys():
3346 ItemList = Section.split(TAB_SPLIT)
3347 Arch = self.Arch
3348 if len(ItemList) == 4:
3349 Arch = ItemList[3]
3350 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():
3351 TianoCoreList = []
3352 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])
3353 TianoCoreList.extend(TianoCoreUserExtent[Section][:])
3354 TianoCoreList.append('\n')
3355 TianoCoreUserExtentionList.append(TianoCoreList)
3356
3357 return TianoCoreUserExtentionList
3358
3359 ## Return the list of specification version required for the module
3360 #
3361 # @retval list The list of specification defined in module file
3362 #
3363 def _GetSpecification(self):
3364 return self.Module.Specification
3365
3366 ## Tool option for the module build
3367 #
3368 # @param PlatformInfo The object of PlatformBuildInfo
3369 # @retval dict The dict containing valid options
3370 #
3371 def _GetModuleBuildOption(self):
3372 if self._BuildOption == None:
3373 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
3374 if self.BuildRuleOrder:
3375 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
3376 return self._BuildOption
3377
3378 ## Get include path list from tool option for the module build
3379 #
3380 # @retval list The include path list
3381 #
3382 def _GetBuildOptionIncPathList(self):
3383 if self._BuildOptionIncPathList == None:
3384 #
3385 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3386 # is the former use /I , the Latter used -I to specify include directories
3387 #
3388 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
3389 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3390 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
3391 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3392 else:
3393 #
3394 # New ToolChainFamily, don't known whether there is option to specify include directories
3395 #
3396 self._BuildOptionIncPathList = []
3397 return self._BuildOptionIncPathList
3398
3399 BuildOptionIncPathList = []
3400 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3401 Attr = 'FLAGS'
3402 try:
3403 FlagOption = self.BuildOption[Tool][Attr]
3404 except KeyError:
3405 FlagOption = ''
3406
3407 if self.PlatformInfo.ToolChainFamily != 'RVCT':
3408 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
3409 else:
3410 #
3411 # RVCT may specify a list of directory seperated by commas
3412 #
3413 IncPathList = []
3414 for Path in gBuildOptIncludePattern.findall(FlagOption):
3415 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
3416 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
3417
3418 #
3419 # EDK II modules must not reference header files outside of the packages they depend on or
3420 # within the module's directory tree. Report error if violation.
3421 #
3422 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
3423 for Path in IncPathList:
3424 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
3425 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
3426 EdkLogger.error("build",
3427 PARAMETER_INVALID,
3428 ExtraData=ErrMsg,
3429 File=str(self.MetaFile))
3430
3431
3432 BuildOptionIncPathList += IncPathList
3433
3434 self._BuildOptionIncPathList = BuildOptionIncPathList
3435
3436 return self._BuildOptionIncPathList
3437
3438 ## Return a list of files which can be built from source
3439 #
3440 # What kind of files can be built is determined by build rules in
3441 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3442 #
3443 def _GetSourceFileList(self):
3444 if self._SourceFileList == None:
3445 self._SourceFileList = []
3446 for F in self.Module.Sources:
3447 # match tool chain
3448 if F.TagName not in ("", "*", self.ToolChain):
3449 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
3450 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
3451 continue
3452 # match tool chain family or build rule family
3453 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):
3454 EdkLogger.debug(
3455 EdkLogger.DEBUG_0,
3456 "The file [%s] must be built by tools of [%s], " \
3457 "but current toolchain family is [%s], buildrule family is [%s]" \
3458 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))
3459 continue
3460
3461 # add the file path into search path list for file including
3462 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
3463 self.IncludePathList.insert(0, F.Dir)
3464 self._SourceFileList.append(F)
3465
3466 self._MatchBuildRuleOrder(self._SourceFileList)
3467
3468 for F in self._SourceFileList:
3469 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
3470 return self._SourceFileList
3471
3472 def _MatchBuildRuleOrder(self, FileList):
3473 Order_Dict = {}
3474 self._GetModuleBuildOption()
3475 for SingleFile in FileList:
3476 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:
3477 key = SingleFile.Path.split(SingleFile.Ext)[0]
3478 if key in Order_Dict:
3479 Order_Dict[key].append(SingleFile.Ext)
3480 else:
3481 Order_Dict[key] = [SingleFile.Ext]
3482
3483 RemoveList = []
3484 for F in Order_Dict:
3485 if len(Order_Dict[F]) > 1:
3486 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))
3487 for Ext in Order_Dict[F][1:]:
3488 RemoveList.append(F + Ext)
3489
3490 for item in RemoveList:
3491 FileList.remove(item)
3492
3493 return FileList
3494
3495 ## Return the list of unicode files
3496 def _GetUnicodeFileList(self):
3497 if self._UnicodeFileList == None:
3498 if TAB_UNICODE_FILE in self.FileTypes:
3499 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
3500 else:
3501 self._UnicodeFileList = []
3502 return self._UnicodeFileList
3503
3504 ## Return the list of vfr files
3505 def _GetVfrFileList(self):
3506 if self._VfrFileList == None:
3507 if TAB_VFR_FILE in self.FileTypes:
3508 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]
3509 else:
3510 self._VfrFileList = []
3511 return self._VfrFileList
3512
3513 ## Return the list of Image Definition files
3514 def _GetIdfFileList(self):
3515 if self._IdfFileList == None:
3516 if TAB_IMAGE_FILE in self.FileTypes:
3517 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]
3518 else:
3519 self._IdfFileList = []
3520 return self._IdfFileList
3521
3522 ## Return a list of files which can be built from binary
3523 #
3524 # "Build" binary files are just to copy them to build directory.
3525 #
3526 # @retval list The list of files which can be built later
3527 #
3528 def _GetBinaryFiles(self):
3529 if self._BinaryFileList == None:
3530 self._BinaryFileList = []
3531 for F in self.Module.Binaries:
3532 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
3533 continue
3534 self._BinaryFileList.append(F)
3535 self._ApplyBuildRule(F, F.Type)
3536 return self._BinaryFileList
3537
3538 def _GetBuildRules(self):
3539 if self._BuildRules == None:
3540 BuildRules = {}
3541 BuildRuleDatabase = self.PlatformInfo.BuildRule
3542 for Type in BuildRuleDatabase.FileTypeList:
3543 #first try getting build rule by BuildRuleFamily
3544 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
3545 if not RuleObject:
3546 # build type is always module type, but ...
3547 if self.ModuleType != self.BuildType:
3548 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
3549 #second try getting build rule by ToolChainFamily
3550 if not RuleObject:
3551 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
3552 if not RuleObject:
3553 # build type is always module type, but ...
3554 if self.ModuleType != self.BuildType:
3555 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
3556 if not RuleObject:
3557 continue
3558 RuleObject = RuleObject.Instantiate(self.Macros)
3559 BuildRules[Type] = RuleObject
3560 for Ext in RuleObject.SourceFileExtList:
3561 BuildRules[Ext] = RuleObject
3562 self._BuildRules = BuildRules
3563 return self._BuildRules
3564
3565 def _ApplyBuildRule(self, File, FileType):
3566 if self._BuildTargets == None:
3567 self._IntroBuildTargetList = set()
3568 self._FinalBuildTargetList = set()
3569 self._BuildTargets = {}
3570 self._FileTypes = {}
3571
3572 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
3573 if not os.path.exists(SubDirectory):
3574 CreateDirectory(SubDirectory)
3575 LastTarget = None
3576 RuleChain = []
3577 SourceList = [File]
3578 Index = 0
3579 #
3580 # Make sure to get build rule order value
3581 #
3582 self._GetModuleBuildOption()
3583
3584 while Index < len(SourceList):
3585 Source = SourceList[Index]
3586 Index = Index + 1
3587
3588 if Source != File:
3589 CreateDirectory(Source.Dir)
3590
3591 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
3592 # Skip all files that are not binary libraries
3593 if not self.IsLibrary:
3594 continue
3595 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
3596 elif FileType in self.BuildRules:
3597 RuleObject = self.BuildRules[FileType]
3598 elif Source.Ext in self.BuildRules:
3599 RuleObject = self.BuildRules[Source.Ext]
3600 else:
3601 # stop at no more rules
3602 if LastTarget:
3603 self._FinalBuildTargetList.add(LastTarget)
3604 break
3605
3606 FileType = RuleObject.SourceFileType
3607 if FileType not in self._FileTypes:
3608 self._FileTypes[FileType] = set()
3609 self._FileTypes[FileType].add(Source)
3610
3611 # stop at STATIC_LIBRARY for library
3612 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
3613 if LastTarget:
3614 self._FinalBuildTargetList.add(LastTarget)
3615 break
3616
3617 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
3618 if not Target:
3619 if LastTarget:
3620 self._FinalBuildTargetList.add(LastTarget)
3621 break
3622 elif not Target.Outputs:
3623 # Only do build for target with outputs
3624 self._FinalBuildTargetList.add(Target)
3625
3626 if FileType not in self._BuildTargets:
3627 self._BuildTargets[FileType] = set()
3628 self._BuildTargets[FileType].add(Target)
3629
3630 if not Source.IsBinary and Source == File:
3631 self._IntroBuildTargetList.add(Target)
3632
3633 # to avoid cyclic rule
3634 if FileType in RuleChain:
3635 break
3636
3637 RuleChain.append(FileType)
3638 SourceList.extend(Target.Outputs)
3639 LastTarget = Target
3640 FileType = TAB_UNKNOWN_FILE
3641
3642 def _GetTargets(self):
3643 if self._BuildTargets == None:
3644 self._IntroBuildTargetList = set()
3645 self._FinalBuildTargetList = set()
3646 self._BuildTargets = {}
3647 self._FileTypes = {}
3648
3649 #TRICK: call _GetSourceFileList to apply build rule for source files
3650 if self.SourceFileList:
3651 pass
3652
3653 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3654 if self.BinaryFileList:
3655 pass
3656
3657 return self._BuildTargets
3658
3659 def _GetIntroTargetList(self):
3660 self._GetTargets()
3661 return self._IntroBuildTargetList
3662
3663 def _GetFinalTargetList(self):
3664 self._GetTargets()
3665 return self._FinalBuildTargetList
3666
3667 def _GetFileTypes(self):
3668 self._GetTargets()
3669 return self._FileTypes
3670
3671 ## Get the list of package object the module depends on
3672 #
3673 # @retval list The package object list
3674 #
3675 def _GetDependentPackageList(self):
3676 return self.Module.Packages
3677
3678 ## Return the list of auto-generated code file
3679 #
3680 # @retval list The list of auto-generated file
3681 #
3682 def _GetAutoGenFileList(self):
3683 UniStringAutoGenC = True
3684 IdfStringAutoGenC = True
3685 UniStringBinBuffer = StringIO()
3686 IdfGenBinBuffer = StringIO()
3687 if self.BuildType == 'UEFI_HII':
3688 UniStringAutoGenC = False
3689 IdfStringAutoGenC = False
3690 if self._AutoGenFileList == None:
3691 self._AutoGenFileList = {}
3692 AutoGenC = TemplateString()
3693 AutoGenH = TemplateString()
3694 StringH = TemplateString()
3695 StringIdf = TemplateString()
3696 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)
3697 #
3698 # AutoGen.c is generated if there are library classes in inf, or there are object files
3699 #
3700 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
3701 or TAB_OBJECT_FILE in self.FileTypes):
3702 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
3703 self._AutoGenFileList[AutoFile] = str(AutoGenC)
3704 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3705 if str(AutoGenH) != "":
3706 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
3707 self._AutoGenFileList[AutoFile] = str(AutoGenH)
3708 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3709 if str(StringH) != "":
3710 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
3711 self._AutoGenFileList[AutoFile] = str(StringH)
3712 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3713 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
3714 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
3715 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
3716 AutoFile.IsBinary = True
3717 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3718 if UniStringBinBuffer != None:
3719 UniStringBinBuffer.close()
3720 if str(StringIdf) != "":
3721 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)
3722 self._AutoGenFileList[AutoFile] = str(StringIdf)
3723 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3724 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":
3725 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)
3726 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()
3727 AutoFile.IsBinary = True
3728 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3729 if IdfGenBinBuffer != None:
3730 IdfGenBinBuffer.close()
3731 return self._AutoGenFileList
3732
3733 ## Return the list of library modules explicitly or implicityly used by this module
3734 def _GetLibraryList(self):
3735 if self._DependentLibraryList == None:
3736 # only merge library classes and PCD for non-library module
3737 if self.IsLibrary:
3738 self._DependentLibraryList = []
3739 else:
3740 if self.AutoGenVersion < 0x00010005:
3741 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
3742 else:
3743 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
3744 return self._DependentLibraryList
3745
3746 @staticmethod
3747 def UpdateComments(Recver, Src):
3748 for Key in Src:
3749 if Key not in Recver:
3750 Recver[Key] = []
3751 Recver[Key].extend(Src[Key])
3752 ## Get the list of PCDs from current module
3753 #
3754 # @retval list The list of PCD
3755 #
3756 def _GetModulePcdList(self):
3757 if self._ModulePcdList == None:
3758 # apply PCD settings from platform
3759 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
3760 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
3761 return self._ModulePcdList
3762
3763 ## Get the list of PCDs from dependent libraries
3764 #
3765 # @retval list The list of PCD
3766 #
3767 def _GetLibraryPcdList(self):
3768 if self._LibraryPcdList == None:
3769 Pcds = sdict()
3770 if not self.IsLibrary:
3771 # get PCDs from dependent libraries
3772 for Library in self.DependentLibraryList:
3773 self.UpdateComments(self._PcdComments, Library.PcdComments)
3774 for Key in Library.Pcds:
3775 # skip duplicated PCDs
3776 if Key in self.Module.Pcds or Key in Pcds:
3777 continue
3778 Pcds[Key] = copy.copy(Library.Pcds[Key])
3779 # apply PCD settings from platform
3780 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
3781 else:
3782 self._LibraryPcdList = []
3783 return self._LibraryPcdList
3784
3785 ## Get the GUID value mapping
3786 #
3787 # @retval dict The mapping between GUID cname and its value
3788 #
3789 def _GetGuidList(self):
3790 if self._GuidList == None:
3791 self._GuidList = sdict()
3792 self._GuidList.update(self.Module.Guids)
3793 for Library in self.DependentLibraryList:
3794 self._GuidList.update(Library.Guids)
3795 self.UpdateComments(self._GuidComments, Library.GuidComments)
3796 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
3797 return self._GuidList
3798
3799 def GetGuidsUsedByPcd(self):
3800 if self._GuidsUsedByPcd == None:
3801 self._GuidsUsedByPcd = sdict()
3802 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3803 for Library in self.DependentLibraryList:
3804 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3805 return self._GuidsUsedByPcd
3806 ## Get the protocol value mapping
3807 #
3808 # @retval dict The mapping between protocol cname and its value
3809 #
3810 def _GetProtocolList(self):
3811 if self._ProtocolList == None:
3812 self._ProtocolList = sdict()
3813 self._ProtocolList.update(self.Module.Protocols)
3814 for Library in self.DependentLibraryList:
3815 self._ProtocolList.update(Library.Protocols)
3816 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3817 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3818 return self._ProtocolList
3819
3820 ## Get the PPI value mapping
3821 #
3822 # @retval dict The mapping between PPI cname and its value
3823 #
3824 def _GetPpiList(self):
3825 if self._PpiList == None:
3826 self._PpiList = sdict()
3827 self._PpiList.update(self.Module.Ppis)
3828 for Library in self.DependentLibraryList:
3829 self._PpiList.update(Library.Ppis)
3830 self.UpdateComments(self._PpiComments, Library.PpiComments)
3831 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3832 return self._PpiList
3833
3834 ## Get the list of include search path
3835 #
3836 # @retval list The list path
3837 #
3838 def _GetIncludePathList(self):
3839 if self._IncludePathList == None:
3840 self._IncludePathList = []
3841 if self.AutoGenVersion < 0x00010005:
3842 for Inc in self.Module.Includes:
3843 if Inc not in self._IncludePathList:
3844 self._IncludePathList.append(Inc)
3845 # for Edk modules
3846 Inc = path.join(Inc, self.Arch.capitalize())
3847 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3848 self._IncludePathList.append(Inc)
3849 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3850 self._IncludePathList.append(self.DebugDir)
3851 else:
3852 self._IncludePathList.append(self.MetaFile.Dir)
3853 self._IncludePathList.append(self.DebugDir)
3854
3855 for Package in self.Module.Packages:
3856 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)
3857 if PackageDir not in self._IncludePathList:
3858 self._IncludePathList.append(PackageDir)
3859 IncludesList = Package.Includes
3860 if Package._PrivateIncludes:
3861 if not self.MetaFile.Path.startswith(PackageDir):
3862 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))
3863 for Inc in IncludesList:
3864 if Inc not in self._IncludePathList:
3865 self._IncludePathList.append(str(Inc))
3866 return self._IncludePathList
3867
3868 def _GetIncludePathLength(self):
3869 self._IncludePathLength = 0
3870 if self._IncludePathList:
3871 for inc in self._IncludePathList:
3872 self._IncludePathLength += len(' ' + inc)
3873 return self._IncludePathLength
3874
3875 ## Get HII EX PCDs which maybe used by VFR
3876 #
3877 # efivarstore used by VFR may relate with HII EX PCDs
3878 # Get the variable name and GUID from efivarstore and HII EX PCD
3879 # List the HII EX PCDs in As Built INF if both name and GUID match.
3880 #
3881 # @retval list HII EX PCDs
3882 #
3883 def _GetPcdsMaybeUsedByVfr(self):
3884 if not self.SourceFileList:
3885 return []
3886
3887 NameGuids = []
3888 for SrcFile in self.SourceFileList:
3889 if SrcFile.Ext.lower() != '.vfr':
3890 continue
3891 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3892 if not os.path.exists(Vfri):
3893 continue
3894 VfriFile = open(Vfri, 'r')
3895 Content = VfriFile.read()
3896 VfriFile.close()
3897 Pos = Content.find('efivarstore')
3898 while Pos != -1:
3899 #
3900 # Make sure 'efivarstore' is the start of efivarstore statement
3901 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3902 #
3903 Index = Pos - 1
3904 while Index >= 0 and Content[Index] in ' \t\r\n':
3905 Index -= 1
3906 if Index >= 0 and Content[Index] != ';':
3907 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3908 continue
3909 #
3910 # 'efivarstore' must be followed by name and guid
3911 #
3912 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3913 if not Name:
3914 break
3915 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3916 if not Guid:
3917 break
3918 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3919 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3920 Pos = Content.find('efivarstore', Name.end())
3921 if not NameGuids:
3922 return []
3923 HiiExPcds = []
3924 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3925 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3926 continue
3927 for SkuName in Pcd.SkuInfoList:
3928 SkuInfo = Pcd.SkuInfoList[SkuName]
3929 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3930 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)
3931 if not Value:
3932 continue
3933 Guid = GuidStructureStringToGuidString(Value)
3934 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3935 HiiExPcds.append(Pcd)
3936 break
3937
3938 return HiiExPcds
3939
3940 def _GenOffsetBin(self):
3941 VfrUniBaseName = {}
3942 for SourceFile in self.Module.Sources:
3943 if SourceFile.Type.upper() == ".VFR" :
3944 #
3945 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3946 #
3947 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3948 if SourceFile.Type.upper() == ".UNI" :
3949 #
3950 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3951 #
3952 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3953
3954 if len(VfrUniBaseName) == 0:
3955 return None
3956 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3957 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3958 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3959 if not VfrUniOffsetList:
3960 return None
3961
3962 OutputName = '%sOffset.bin' % self.Name
3963 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3964
3965 try:
3966 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3967 except:
3968 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3969
3970 # Use a instance of StringIO to cache data
3971 fStringIO = StringIO('')
3972
3973 for Item in VfrUniOffsetList:
3974 if (Item[0].find("Strings") != -1):
3975 #
3976 # UNI offset in image.
3977 # GUID + Offset
3978 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3979 #
3980 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3981 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3982 fStringIO.write(''.join(UniGuid))
3983 UniValue = pack ('Q', int (Item[1], 16))
3984 fStringIO.write (UniValue)
3985 else:
3986 #
3987 # VFR binary offset in image.
3988 # GUID + Offset
3989 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3990 #
3991 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3992 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3993 fStringIO.write(''.join(VfrGuid))
3994 type (Item[1])
3995 VfrValue = pack ('Q', int (Item[1], 16))
3996 fStringIO.write (VfrValue)
3997 #
3998 # write data into file.
3999 #
4000 try :
4001 fInputfile.write (fStringIO.getvalue())
4002 except:
4003 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
4004 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
4005
4006 fStringIO.close ()
4007 fInputfile.close ()
4008 return OutputName
4009
4010 ## Create AsBuilt INF file the module
4011 #
4012 def CreateAsBuiltInf(self, IsOnlyCopy = False):
4013 self.OutputFile = []
4014 if IsOnlyCopy:
4015 if GlobalData.gBinCacheDest:
4016 self.CopyModuleToCache()
4017 return
4018
4019 if self.IsAsBuiltInfCreated:
4020 return
4021
4022 # Skip the following code for EDK I inf
4023 if self.AutoGenVersion < 0x00010005:
4024 return
4025
4026 # Skip the following code for libraries
4027 if self.IsLibrary:
4028 return
4029
4030 # Skip the following code for modules with no source files
4031 if self.SourceFileList == None or self.SourceFileList == []:
4032 return
4033
4034 # Skip the following code for modules without any binary files
4035 if self.BinaryFileList <> None and self.BinaryFileList <> []:
4036 return
4037
4038 ### TODO: How to handles mixed source and binary modules
4039
4040 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
4041 # Also find all packages that the DynamicEx PCDs depend on
4042 Pcds = []
4043 PatchablePcds = []
4044 Packages = []
4045 PcdCheckList = []
4046 PcdTokenSpaceList = []
4047 for Pcd in self.ModulePcdList + self.LibraryPcdList:
4048 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
4049 PatchablePcds += [Pcd]
4050 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
4051 elif Pcd.Type in GenC.gDynamicExPcd:
4052 if Pcd not in Pcds:
4053 Pcds += [Pcd]
4054 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
4055 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
4056 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
4057 GuidList = sdict()
4058 GuidList.update(self.GuidList)
4059 for TokenSpace in self.GetGuidsUsedByPcd():
4060 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
4061 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
4062 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
4063 GuidList.pop(TokenSpace)
4064 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
4065 for Package in self.DerivedPackageList:
4066 if Package in Packages:
4067 continue
4068 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
4069 Found = False
4070 for Index in range(len(BeChecked)):
4071 for Item in CheckList[Index]:
4072 if Item in BeChecked[Index]:
4073 Packages += [Package]
4074 Found = True
4075 break
4076 if Found: break
4077
4078 VfrPcds = self._GetPcdsMaybeUsedByVfr()
4079 for Pkg in self.PlatformInfo.PackageList:
4080 if Pkg in Packages:
4081 continue
4082 for VfrPcd in VfrPcds:
4083 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
4084 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
4085 Packages += [Pkg]
4086 break
4087
4088 ModuleType = self.ModuleType
4089 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
4090 ModuleType = 'DXE_DRIVER'
4091
4092 DriverType = ''
4093 if self.PcdIsDriver != '':
4094 DriverType = self.PcdIsDriver
4095
4096 Guid = self.Guid
4097 MDefs = self.Module.Defines
4098
4099 AsBuiltInfDict = {
4100 'module_name' : self.Name,
4101 'module_guid' : Guid,
4102 'module_module_type' : ModuleType,
4103 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
4104 'pcd_is_driver_string' : [],
4105 'module_uefi_specification_version' : [],
4106 'module_pi_specification_version' : [],
4107 'module_entry_point' : self.Module.ModuleEntryPointList,
4108 'module_unload_image' : self.Module.ModuleUnloadImageList,
4109 'module_constructor' : self.Module.ConstructorList,
4110 'module_destructor' : self.Module.DestructorList,
4111 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
4112 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
4113 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
4114 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
4115 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
4116 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
4117 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
4118 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
4119 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
4120 'module_arch' : self.Arch,
4121 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],
4122 'binary_item' : [],
4123 'patchablepcd_item' : [],
4124 'pcd_item' : [],
4125 'protocol_item' : [],
4126 'ppi_item' : [],
4127 'guid_item' : [],
4128 'flags_item' : [],
4129 'libraryclasses_item' : []
4130 }
4131
4132 if 'MODULE_UNI_FILE' in MDefs:
4133 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])
4134 if os.path.isfile(UNIFile):
4135 shutil.copy2(UNIFile, self.OutputDir)
4136
4137 if self.AutoGenVersion > int(gInfSpecVersion, 0):
4138 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
4139 else:
4140 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
4141
4142 if DriverType:
4143 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
4144
4145 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
4146 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
4147 if 'PI_SPECIFICATION_VERSION' in self.Specification:
4148 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
4149
4150 OutputDir = self.OutputDir.replace('\\', '/').strip('/')
4151 DebugDir = self.DebugDir.replace('\\', '/').strip('/')
4152 for Item in self.CodaTargetList:
4153 File = Item.Target.Path.replace('\\', '/').strip('/').replace(DebugDir, '').strip('/')
4154 if File not in self.OutputFile:
4155 self.OutputFile.append(File)
4156 if os.path.isabs(File):
4157 File = File.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')
4158 if Item.Target.Ext.lower() == '.aml':
4159 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
4160 elif Item.Target.Ext.lower() == '.acpi':
4161 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
4162 elif Item.Target.Ext.lower() == '.efi':
4163 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
4164 else:
4165 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
4166 if self.DepexGenerated:
4167 if self.Name + '.depex' not in self.OutputFile:
4168 self.OutputFile.append(self.Name + '.depex')
4169 if self.ModuleType in ['PEIM']:
4170 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
4171 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4172 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
4173 if self.ModuleType in ['DXE_SMM_DRIVER']:
4174 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
4175
4176 Bin = self._GenOffsetBin()
4177 if Bin:
4178 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
4179 if Bin not in self.OutputFile:
4180 self.OutputFile.append(Bin)
4181
4182 for Root, Dirs, Files in os.walk(OutputDir):
4183 for File in Files:
4184 if File.lower().endswith('.pdb'):
4185 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
4186 if File not in self.OutputFile:
4187 self.OutputFile.append(File)
4188 HeaderComments = self.Module.HeaderComments
4189 StartPos = 0
4190 for Index in range(len(HeaderComments)):
4191 if HeaderComments[Index].find('@BinaryHeader') != -1:
4192 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
4193 StartPos = Index
4194 break
4195 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
4196 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
4197
4198 GenList = [
4199 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
4200 (self.PpiList, self._PpiComments, 'ppi_item'),
4201 (GuidList, self._GuidComments, 'guid_item')
4202 ]
4203 for Item in GenList:
4204 for CName in Item[0]:
4205 Comments = ''
4206 if CName in Item[1]:
4207 Comments = '\n '.join(Item[1][CName])
4208 Entry = CName
4209 if Comments:
4210 Entry = Comments + '\n ' + CName
4211 AsBuiltInfDict[Item[2]].append(Entry)
4212 PatchList = parsePcdInfoFromMapFile(
4213 os.path.join(self.OutputDir, self.Name + '.map'),
4214 os.path.join(self.OutputDir, self.Name + '.efi')
4215 )
4216 if PatchList:
4217 for Pcd in PatchablePcds:
4218 TokenCName = Pcd.TokenCName
4219 for PcdItem in GlobalData.MixedPcd:
4220 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4221 TokenCName = PcdItem[0]
4222 break
4223 for PatchPcd in PatchList:
4224 if TokenCName == PatchPcd[0]:
4225 break
4226 else:
4227 continue
4228 PcdValue = ''
4229 if Pcd.DatumType == 'BOOLEAN':
4230 BoolValue = Pcd.DefaultValue.upper()
4231 if BoolValue == 'TRUE':
4232 Pcd.DefaultValue = '1'
4233 elif BoolValue == 'FALSE':
4234 Pcd.DefaultValue = '0'
4235
4236 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4237 HexFormat = '0x%02x'
4238 if Pcd.DatumType == 'UINT16':
4239 HexFormat = '0x%04x'
4240 elif Pcd.DatumType == 'UINT32':
4241 HexFormat = '0x%08x'
4242 elif Pcd.DatumType == 'UINT64':
4243 HexFormat = '0x%016x'
4244 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
4245 else:
4246 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
4247 EdkLogger.error("build", AUTOGEN_ERROR,
4248 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)
4249 )
4250 ArraySize = int(Pcd.MaxDatumSize, 0)
4251 PcdValue = Pcd.DefaultValue
4252 if PcdValue[0] != '{':
4253 Unicode = False
4254 if PcdValue[0] == 'L':
4255 Unicode = True
4256 PcdValue = PcdValue.lstrip('L')
4257 PcdValue = eval(PcdValue)
4258 NewValue = '{'
4259 for Index in range(0, len(PcdValue)):
4260 if Unicode:
4261 CharVal = ord(PcdValue[Index])
4262 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
4263 + '0x%02x' % (CharVal >> 8) + ', '
4264 else:
4265 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
4266 Padding = '0x00, '
4267 if Unicode:
4268 Padding = Padding * 2
4269 ArraySize = ArraySize / 2
4270 if ArraySize < (len(PcdValue) + 1):
4271 EdkLogger.error("build", AUTOGEN_ERROR,
4272 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4273 )
4274 if ArraySize > len(PcdValue) + 1:
4275 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
4276 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
4277 elif len(PcdValue.split(',')) <= ArraySize:
4278 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
4279 PcdValue += '}'
4280 else:
4281 EdkLogger.error("build", AUTOGEN_ERROR,
4282 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4283 )
4284 PcdItem = '%s.%s|%s|0x%X' % \
4285 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])
4286 PcdComments = ''
4287 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4288 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
4289 if PcdComments:
4290 PcdItem = PcdComments + '\n ' + PcdItem
4291 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
4292
4293 HiiPcds = []
4294 for Pcd in Pcds + VfrPcds:
4295 PcdComments = ''
4296 PcdCommentList = []
4297 HiiInfo = ''
4298 SkuId = ''
4299 TokenCName = Pcd.TokenCName
4300 for PcdItem in GlobalData.MixedPcd:
4301 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4302 TokenCName = PcdItem[0]
4303 break
4304 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
4305 for SkuName in Pcd.SkuInfoList:
4306 SkuInfo = Pcd.SkuInfoList[SkuName]
4307 SkuId = SkuInfo.SkuId
4308 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
4309 break
4310 if SkuId:
4311 #
4312 # Don't generate duplicated HII PCD
4313 #
4314 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
4315 continue
4316 else:
4317 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
4318 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4319 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
4320 if HiiInfo:
4321 UsageIndex = -1
4322 UsageStr = ''
4323 for Index, Comment in enumerate(PcdCommentList):
4324 for Usage in UsageList:
4325 if Comment.find(Usage) != -1:
4326 UsageStr = Usage
4327 UsageIndex = Index
4328 break
4329 if UsageIndex != -1:
4330 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
4331 else:
4332 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
4333 PcdComments = '\n '.join(PcdCommentList)
4334 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName
4335 if PcdComments:
4336 PcdEntry = PcdComments + '\n ' + PcdEntry
4337 AsBuiltInfDict['pcd_item'] += [PcdEntry]
4338 for Item in self.BuildOption:
4339 if 'FLAGS' in self.BuildOption[Item]:
4340 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
4341
4342 # Generated LibraryClasses section in comments.
4343 for Library in self.LibraryAutoGenList:
4344 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
4345
4346 # Generated UserExtensions TianoCore section.
4347 # All tianocore user extensions are copied.
4348 UserExtStr = ''
4349 for TianoCore in self._GetTianoCoreUserExtensionList():
4350 UserExtStr += '\n'.join(TianoCore)
4351 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])
4352 if os.path.isfile(ExtensionFile):
4353 shutil.copy2(ExtensionFile, self.OutputDir)
4354 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr
4355
4356 # Generated depex expression section in comments.
4357 AsBuiltInfDict['depexsection_item'] = ''
4358 DepexExpresion = self._GetDepexExpresionString()
4359 if DepexExpresion:
4360 AsBuiltInfDict['depexsection_item'] = DepexExpresion
4361
4362 AsBuiltInf = TemplateString()
4363 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
4364
4365 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
4366
4367 self.IsAsBuiltInfCreated = True
4368 if GlobalData.gBinCacheDest:
4369 self.CopyModuleToCache()
4370
4371 def CopyModuleToCache(self):
4372 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4373 CreateDirectory (FileDir)
4374 HashFile = path.join(self.BuildDir, self.Name + '.hash')
4375 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')
4376 if os.path.exists(HashFile):
4377 shutil.copy2(HashFile, FileDir)
4378 if os.path.exists(ModuleFile):
4379 shutil.copy2(ModuleFile, FileDir)
4380 if not self.OutputFile:
4381 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]
4382 self.OutputFile = Ma.Binaries
4383 if self.OutputFile:
4384 for File in self.OutputFile:
4385 File = str(File)
4386 if not os.path.isabs(File):
4387 File = os.path.join(self.OutputDir, File)
4388 if os.path.exists(File):
4389 shutil.copy2(File, FileDir)
4390
4391 def AttemptModuleCacheCopy(self):
4392 if self.IsBinaryModule:
4393 return False
4394 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4395 HashFile = path.join(FileDir, self.Name + '.hash')
4396 if os.path.exists(HashFile):
4397 f = open(HashFile, 'r')
4398 CacheHash = f.read()
4399 f.close()
4400 if GlobalData.gModuleHash[self.Arch][self.Name]:
4401 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:
4402 for root, dir, files in os.walk(FileDir):
4403 for f in files:
4404 if self.Name + '.hash' in f:
4405 shutil.copy2(HashFile, self.BuildDir)
4406 else:
4407 File = path.join(root, f)
4408 shutil.copy2(File, self.OutputDir)
4409 if self.Name == "PcdPeim" or self.Name == "PcdDxe":
4410 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4411 return True
4412 return False
4413
4414 ## Create makefile for the module and its dependent libraries
4415 #
4416 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4417 # dependent libraries will be created
4418 #
4419 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):
4420 # Ignore generating makefile when it is a binary module
4421 if self.IsBinaryModule:
4422 return
4423
4424 if self.IsMakeFileCreated:
4425 return
4426 self.GenFfsList = GenFfsList
4427 if not self.IsLibrary and CreateLibraryMakeFile:
4428 for LibraryAutoGen in self.LibraryAutoGenList:
4429 LibraryAutoGen.CreateMakeFile()
4430
4431 if self.CanSkip():
4432 return
4433
4434 if len(self.CustomMakefile) == 0:
4435 Makefile = GenMake.ModuleMakefile(self)
4436 else:
4437 Makefile = GenMake.CustomMakefile(self)
4438 if Makefile.Generate():
4439 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
4440 (self.Name, self.Arch))
4441 else:
4442 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
4443 (self.Name, self.Arch))
4444
4445 self.CreateTimeStamp(Makefile)
4446 self.IsMakeFileCreated = True
4447
4448 def CopyBinaryFiles(self):
4449 for File in self.Module.Binaries:
4450 SrcPath = File.Path
4451 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
4452 CopyLongFilePath(SrcPath, DstPath)
4453 ## Create autogen code for the module and its dependent libraries
4454 #
4455 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4456 # dependent libraries will be created
4457 #
4458 def CreateCodeFile(self, CreateLibraryCodeFile=True):
4459 if self.IsCodeFileCreated:
4460 return
4461
4462 # Need to generate PcdDatabase even PcdDriver is binarymodule
4463 if self.IsBinaryModule and self.PcdIsDriver != '':
4464 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4465 return
4466 if self.IsBinaryModule:
4467 if self.IsLibrary:
4468 self.CopyBinaryFiles()
4469 return
4470
4471 if not self.IsLibrary and CreateLibraryCodeFile:
4472 for LibraryAutoGen in self.LibraryAutoGenList:
4473 LibraryAutoGen.CreateCodeFile()
4474
4475 if self.CanSkip():
4476 return
4477
4478 AutoGenList = []
4479 IgoredAutoGenList = []
4480
4481 for File in self.AutoGenFileList:
4482 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
4483 #Ignore Edk AutoGen.c
4484 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
4485 continue
4486
4487 AutoGenList.append(str(File))
4488 else:
4489 IgoredAutoGenList.append(str(File))
4490
4491 # Skip the following code for EDK I inf
4492 if self.AutoGenVersion < 0x00010005:
4493 return
4494
4495 for ModuleType in self.DepexList:
4496 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4497 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
4498 continue
4499
4500 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
4501 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
4502
4503 if len(Dpx.PostfixNotation) <> 0:
4504 self.DepexGenerated = True
4505
4506 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
4507 AutoGenList.append(str(DpxFile))
4508 else:
4509 IgoredAutoGenList.append(str(DpxFile))
4510
4511 if IgoredAutoGenList == []:
4512 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
4513 (" ".join(AutoGenList), self.Name, self.Arch))
4514 elif AutoGenList == []:
4515 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
4516 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
4517 else:
4518 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
4519 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
4520
4521 self.IsCodeFileCreated = True
4522 return AutoGenList
4523
4524 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4525 def _GetLibraryAutoGenList(self):
4526 if self._LibraryAutoGenList == None:
4527 self._LibraryAutoGenList = []
4528 for Library in self.DependentLibraryList:
4529 La = ModuleAutoGen(
4530 self.Workspace,
4531 Library.MetaFile,
4532 self.BuildTarget,
4533 self.ToolChain,
4534 self.Arch,
4535 self.PlatformInfo.MetaFile
4536 )
4537 if La not in self._LibraryAutoGenList:
4538 self._LibraryAutoGenList.append(La)
4539 for Lib in La.CodaTargetList:
4540 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
4541 return self._LibraryAutoGenList
4542
4543 def GenModuleHash(self):
4544 if self.Arch not in GlobalData.gModuleHash:
4545 GlobalData.gModuleHash[self.Arch] = {}
4546 m = hashlib.md5()
4547 # Add Platform level hash
4548 m.update(GlobalData.gPlatformHash)
4549 # Add Package level hash
4550 if self.DependentPackageList:
4551 for Pkg in self.DependentPackageList:
4552 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:
4553 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])
4554
4555 # Add Library hash
4556 if self.LibraryAutoGenList:
4557 for Lib in self.LibraryAutoGenList:
4558 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:
4559 Lib.GenModuleHash()
4560 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])
4561
4562 # Add Module self
4563 f = open(str(self.MetaFile), 'r')
4564 Content = f.read()
4565 f.close()
4566 m.update(Content)
4567 # Add Module's source files
4568 if self.SourceFileList:
4569 for File in self.SourceFileList:
4570 f = open(str(File), 'r')
4571 Content = f.read()
4572 f.close()
4573 m.update(Content)
4574
4575 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")
4576 if self.Name not in GlobalData.gModuleHash[self.Arch]:
4577 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()
4578 if GlobalData.gBinCacheSource:
4579 CacheValid = self.AttemptModuleCacheCopy()
4580 if CacheValid:
4581 return False
4582 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)
4583
4584 ## Decide whether we can skip the ModuleAutoGen process
4585 def CanSkipbyHash(self):
4586 if GlobalData.gUseHashCache:
4587 return not self.GenModuleHash()
4588
4589 ## Decide whether we can skip the ModuleAutoGen process
4590 # If any source file is newer than the module than we cannot skip
4591 #
4592 def CanSkip(self):
4593 if not os.path.exists(self.GetTimeStampPath()):
4594 return False
4595 #last creation time of the module
4596 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]
4597
4598 SrcTimeStamp = self.Workspace._SrcTimeStamp
4599 if SrcTimeStamp > DstTimeStamp:
4600 return False
4601
4602 with open(self.GetTimeStampPath(),'r') as f:
4603 for source in f:
4604 source = source.rstrip('\n')
4605 if not os.path.exists(source):
4606 return False
4607 if source not in ModuleAutoGen.TimeDict :
4608 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]
4609 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:
4610 return False
4611 return True
4612
4613 def GetTimeStampPath(self):
4614 if self._TimeStampPath == None:
4615 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')
4616 return self._TimeStampPath
4617 def CreateTimeStamp(self, Makefile):
4618
4619 FileSet = set()
4620
4621 FileSet.add (self.MetaFile.Path)
4622
4623 for SourceFile in self.Module.Sources:
4624 FileSet.add (SourceFile.Path)
4625
4626 for Lib in self.DependentLibraryList:
4627 FileSet.add (Lib.MetaFile.Path)
4628
4629 for f in self.AutoGenDepSet:
4630 FileSet.add (f.Path)
4631
4632 if os.path.exists (self.GetTimeStampPath()):
4633 os.remove (self.GetTimeStampPath())
4634 with open(self.GetTimeStampPath(), 'w+') as file:
4635 for f in FileSet:
4636 print >> file, f
4637
4638 Module = property(_GetModule)
4639 Name = property(_GetBaseName)
4640 Guid = property(_GetGuid)
4641 Version = property(_GetVersion)
4642 ModuleType = property(_GetModuleType)
4643 ComponentType = property(_GetComponentType)
4644 BuildType = property(_GetBuildType)
4645 PcdIsDriver = property(_GetPcdIsDriver)
4646 AutoGenVersion = property(_GetAutoGenVersion)
4647 Macros = property(_GetMacros)
4648 Specification = property(_GetSpecification)
4649
4650 IsLibrary = property(_IsLibrary)
4651 IsBinaryModule = property(_IsBinaryModule)
4652 BuildDir = property(_GetBuildDir)
4653 OutputDir = property(_GetOutputDir)
4654 FfsOutputDir = property(_GetFfsOutputDir)
4655 DebugDir = property(_GetDebugDir)
4656 MakeFileDir = property(_GetMakeFileDir)
4657 CustomMakefile = property(_GetCustomMakefile)
4658
4659 IncludePathList = property(_GetIncludePathList)
4660 IncludePathLength = property(_GetIncludePathLength)
4661 AutoGenFileList = property(_GetAutoGenFileList)
4662 UnicodeFileList = property(_GetUnicodeFileList)
4663 VfrFileList = property(_GetVfrFileList)
4664 SourceFileList = property(_GetSourceFileList)
4665 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
4666 Targets = property(_GetTargets)
4667 IntroTargetList = property(_GetIntroTargetList)
4668 CodaTargetList = property(_GetFinalTargetList)
4669 FileTypes = property(_GetFileTypes)
4670 BuildRules = property(_GetBuildRules)
4671 IdfFileList = property(_GetIdfFileList)
4672
4673 DependentPackageList = property(_GetDependentPackageList)
4674 DependentLibraryList = property(_GetLibraryList)
4675 LibraryAutoGenList = property(_GetLibraryAutoGenList)
4676 DerivedPackageList = property(_GetDerivedPackageList)
4677
4678 ModulePcdList = property(_GetModulePcdList)
4679 LibraryPcdList = property(_GetLibraryPcdList)
4680 GuidList = property(_GetGuidList)
4681 ProtocolList = property(_GetProtocolList)
4682 PpiList = property(_GetPpiList)
4683 DepexList = property(_GetDepexTokenList)
4684 DxsFile = property(_GetDxsFile)
4685 DepexExpressionList = property(_GetDepexExpressionTokenList)
4686 BuildOption = property(_GetModuleBuildOption)
4687 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
4688 BuildCommand = property(_GetBuildCommand)
4689
4690 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
4691
4692 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4693 if __name__ == '__main__':
4694 pass
4695
EFI Development Kit II mirror for PVE