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