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


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