]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTools:Override the MAKE_FLAGS by BuildOptions in DSC
[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 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 return Pcds.values()
2498
2499 ## Resolve library names to library modules
2500 #
2501 # (for Edk.x modules)
2502 #
2503 # @param Module The module from which the library names will be resolved
2504 #
2505 # @retval library_list The list of library modules
2506 #
2507 def ResolveLibraryReference(self, Module):
2508 EdkLogger.verbose("")
2509 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2510 LibraryConsumerList = [Module]
2511
2512 # "CompilerStub" is a must for Edk modules
2513 if Module.Libraries:
2514 Module.Libraries.append("CompilerStub")
2515 LibraryList = []
2516 while len(LibraryConsumerList) > 0:
2517 M = LibraryConsumerList.pop()
2518 for LibraryName in M.Libraries:
2519 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2520 if Library == None:
2521 for Key in self.Platform.LibraryClasses.data.keys():
2522 if LibraryName.upper() == Key.upper():
2523 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2524 break
2525 if Library == None:
2526 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2527 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2528 continue
2529
2530 if Library not in LibraryList:
2531 LibraryList.append(Library)
2532 LibraryConsumerList.append(Library)
2533 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2534 return LibraryList
2535
2536 ## Calculate the priority value of the build option
2537 #
2538 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2539 #
2540 # @retval Value Priority value based on the priority list.
2541 #
2542 def CalculatePriorityValue(self, Key):
2543 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2544 PriorityValue = 0x11111
2545 if Target == "*":
2546 PriorityValue &= 0x01111
2547 if ToolChain == "*":
2548 PriorityValue &= 0x10111
2549 if Arch == "*":
2550 PriorityValue &= 0x11011
2551 if CommandType == "*":
2552 PriorityValue &= 0x11101
2553 if Attr == "*":
2554 PriorityValue &= 0x11110
2555
2556 return self.PrioList["0x%0.5x" % PriorityValue]
2557
2558
2559 ## Expand * in build option key
2560 #
2561 # @param Options Options to be expanded
2562 #
2563 # @retval options Options expanded
2564 #
2565 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2566 BuildOptions = {}
2567 FamilyMatch = False
2568 FamilyIsNull = True
2569
2570 OverrideList = {}
2571 #
2572 # Construct a list contain the build options which need override.
2573 #
2574 for Key in Options:
2575 #
2576 # Key[0] -- tool family
2577 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2578 #
2579 if (Key[0] == self.BuildRuleFamily and
2580 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2581 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2582 if Target == self.BuildTarget or Target == "*":
2583 if ToolChain == self.ToolChain or ToolChain == "*":
2584 if Arch == self.Arch or Arch == "*":
2585 if Options[Key].startswith("="):
2586 if OverrideList.get(Key[1]) != None:
2587 OverrideList.pop(Key[1])
2588 OverrideList[Key[1]] = Options[Key]
2589
2590 #
2591 # Use the highest priority value.
2592 #
2593 if (len(OverrideList) >= 2):
2594 KeyList = OverrideList.keys()
2595 for Index in range(len(KeyList)):
2596 NowKey = KeyList[Index]
2597 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2598 for Index1 in range(len(KeyList) - Index - 1):
2599 NextKey = KeyList[Index1 + Index + 1]
2600 #
2601 # Compare two Key, if one is included by another, choose the higher priority one
2602 #
2603 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2604 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2605 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2606 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2607 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2608 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2609 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2610 if Options.get((self.BuildRuleFamily, NextKey)) != None:
2611 Options.pop((self.BuildRuleFamily, NextKey))
2612 else:
2613 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2614 Options.pop((self.BuildRuleFamily, NowKey))
2615
2616 for Key in Options:
2617 if ModuleStyle != None and len (Key) > 2:
2618 # Check Module style is EDK or EDKII.
2619 # Only append build option for the matched style module.
2620 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2621 continue
2622 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2623 continue
2624 Family = Key[0]
2625 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2626 # if tool chain family doesn't match, skip it
2627 if Tool in self.ToolDefinition and Family != "":
2628 FamilyIsNull = False
2629 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2630 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2631 continue
2632 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2633 continue
2634 FamilyMatch = True
2635 # expand any wildcard
2636 if Target == "*" or Target == self.BuildTarget:
2637 if Tag == "*" or Tag == self.ToolChain:
2638 if Arch == "*" or Arch == self.Arch:
2639 if Tool not in BuildOptions:
2640 BuildOptions[Tool] = {}
2641 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2642 BuildOptions[Tool][Attr] = Options[Key]
2643 else:
2644 # append options for the same tool except PATH
2645 if Attr != 'PATH':
2646 BuildOptions[Tool][Attr] += " " + Options[Key]
2647 else:
2648 BuildOptions[Tool][Attr] = Options[Key]
2649 # Build Option Family has been checked, which need't to be checked again for family.
2650 if FamilyMatch or FamilyIsNull:
2651 return BuildOptions
2652
2653 for Key in Options:
2654 if ModuleStyle != None and len (Key) > 2:
2655 # Check Module style is EDK or EDKII.
2656 # Only append build option for the matched style module.
2657 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2658 continue
2659 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2660 continue
2661 Family = Key[0]
2662 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2663 # if tool chain family doesn't match, skip it
2664 if Tool not in self.ToolDefinition or Family == "":
2665 continue
2666 # option has been added before
2667 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2668 continue
2669
2670 # expand any wildcard
2671 if Target == "*" or Target == self.BuildTarget:
2672 if Tag == "*" or Tag == self.ToolChain:
2673 if Arch == "*" or Arch == self.Arch:
2674 if Tool not in BuildOptions:
2675 BuildOptions[Tool] = {}
2676 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2677 BuildOptions[Tool][Attr] = Options[Key]
2678 else:
2679 # append options for the same tool except PATH
2680 if Attr != 'PATH':
2681 BuildOptions[Tool][Attr] += " " + Options[Key]
2682 else:
2683 BuildOptions[Tool][Attr] = Options[Key]
2684 return BuildOptions
2685
2686 ## Append build options in platform to a module
2687 #
2688 # @param Module The module to which the build options will be appened
2689 #
2690 # @retval options The options appended with build options in platform
2691 #
2692 def ApplyBuildOption(self, Module):
2693 # Get the different options for the different style module
2694 if Module.AutoGenVersion < 0x00010005:
2695 PlatformOptions = self.EdkBuildOption
2696 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2697 else:
2698 PlatformOptions = self.EdkIIBuildOption
2699 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2700 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2701 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2702 if Module in self.Platform.Modules:
2703 PlatformModule = self.Platform.Modules[str(Module)]
2704 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2705 else:
2706 PlatformModuleOptions = {}
2707
2708 BuildRuleOrder = None
2709 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2710 for Tool in Options:
2711 for Attr in Options[Tool]:
2712 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2713 BuildRuleOrder = Options[Tool][Attr]
2714
2715 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2716 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2717 self.ToolDefinition.keys())
2718 BuildOptions = {}
2719 for Tool in AllTools:
2720 if Tool not in BuildOptions:
2721 BuildOptions[Tool] = {}
2722
2723 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2724 if Tool not in Options:
2725 continue
2726 for Attr in Options[Tool]:
2727 Value = Options[Tool][Attr]
2728 #
2729 # Do not generate it in Makefile
2730 #
2731 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2732 continue
2733 if Attr not in BuildOptions[Tool]:
2734 BuildOptions[Tool][Attr] = ""
2735 # check if override is indicated
2736 if Value.startswith('='):
2737 ToolPath = Value[1:]
2738 ToolPath = mws.handleWsMacro(ToolPath)
2739 BuildOptions[Tool][Attr] = ToolPath
2740 else:
2741 Value = mws.handleWsMacro(Value)
2742 if Attr != 'PATH':
2743 BuildOptions[Tool][Attr] += " " + Value
2744 else:
2745 BuildOptions[Tool][Attr] = Value
2746 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2747 #
2748 # Override UNI flag only for EDK module.
2749 #
2750 if 'BUILD' not in BuildOptions:
2751 BuildOptions['BUILD'] = {}
2752 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2753 return BuildOptions, BuildRuleOrder
2754
2755 Platform = property(_GetPlatform)
2756 Name = property(_GetName)
2757 Guid = property(_GetGuid)
2758 Version = property(_GetVersion)
2759
2760 OutputDir = property(_GetOutputDir)
2761 BuildDir = property(_GetBuildDir)
2762 MakeFileDir = property(_GetMakeFileDir)
2763 FdfFile = property(_GetFdfFile)
2764
2765 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2766 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2767 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2768 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2769 PackageList = property(_GetPackageList)
2770
2771 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2772 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2773 ToolChainFamily = property(_GetToolChainFamily)
2774 BuildRuleFamily = property(_GetBuildRuleFamily)
2775 BuildOption = property(_GetBuildOptions) # toolcode : option
2776 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2777 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2778
2779 BuildCommand = property(_GetBuildCommand)
2780 BuildRule = property(_GetBuildRule)
2781 ModuleAutoGenList = property(_GetModuleAutoGenList)
2782 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2783 GenFdsCommand = property(_GenFdsCommand)
2784
2785 ## ModuleAutoGen class
2786 #
2787 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2788 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2789 # to the [depex] section in module's inf file.
2790 #
2791 class ModuleAutoGen(AutoGen):
2792 ## Cache the timestamps of metafiles of every module in a class variable
2793 #
2794 TimeDict = {}
2795
2796 ## The real constructor of ModuleAutoGen
2797 #
2798 # This method is not supposed to be called by users of ModuleAutoGen. It's
2799 # only used by factory method __new__() to do real initialization work for an
2800 # object of ModuleAutoGen
2801 #
2802 # @param Workspace EdkIIWorkspaceBuild object
2803 # @param ModuleFile The path of module file
2804 # @param Target Build target (DEBUG, RELEASE)
2805 # @param Toolchain Name of tool chain
2806 # @param Arch The arch the module supports
2807 # @param PlatformFile Platform meta-file
2808 #
2809 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2810 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2811 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2812
2813 self.Workspace = Workspace
2814 self.WorkspaceDir = Workspace.WorkspaceDir
2815
2816 self.MetaFile = ModuleFile
2817 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2818 # check if this module is employed by active platform
2819 if not self.PlatformInfo.ValidModule(self.MetaFile):
2820 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2821 % (self.MetaFile, Arch))
2822 return False
2823
2824 self.SourceDir = self.MetaFile.SubDir
2825 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2826
2827 self.SourceOverrideDir = None
2828 # use overrided path defined in DSC file
2829 if self.MetaFile.Key in GlobalData.gOverrideDir:
2830 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2831
2832 self.ToolChain = Toolchain
2833 self.BuildTarget = Target
2834 self.Arch = Arch
2835 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2836 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2837
2838 self.IsMakeFileCreated = False
2839 self.IsCodeFileCreated = False
2840 self.IsAsBuiltInfCreated = False
2841 self.DepexGenerated = False
2842
2843 self.BuildDatabase = self.Workspace.BuildDatabase
2844 self.BuildRuleOrder = None
2845 self.BuildTime = 0
2846
2847 self._Module = None
2848 self._Name = None
2849 self._Guid = None
2850 self._Version = None
2851 self._ModuleType = None
2852 self._ComponentType = None
2853 self._PcdIsDriver = None
2854 self._AutoGenVersion = None
2855 self._LibraryFlag = None
2856 self._CustomMakefile = None
2857 self._Macro = None
2858
2859 self._BuildDir = None
2860 self._OutputDir = None
2861 self._FfsOutputDir = None
2862 self._DebugDir = None
2863 self._MakeFileDir = None
2864
2865 self._IncludePathList = None
2866 self._IncludePathLength = 0
2867 self._AutoGenFileList = None
2868 self._UnicodeFileList = None
2869 self._VfrFileList = None
2870 self._IdfFileList = None
2871 self._SourceFileList = None
2872 self._ObjectFileList = None
2873 self._BinaryFileList = None
2874
2875 self._DependentPackageList = None
2876 self._DependentLibraryList = None
2877 self._LibraryAutoGenList = None
2878 self._DerivedPackageList = None
2879 self._ModulePcdList = None
2880 self._LibraryPcdList = None
2881 self._PcdComments = sdict()
2882 self._GuidList = None
2883 self._GuidsUsedByPcd = None
2884 self._GuidComments = sdict()
2885 self._ProtocolList = None
2886 self._ProtocolComments = sdict()
2887 self._PpiList = None
2888 self._PpiComments = sdict()
2889 self._DepexList = None
2890 self._DepexExpressionList = None
2891 self._BuildOption = None
2892 self._BuildOptionIncPathList = None
2893 self._BuildTargets = None
2894 self._IntroBuildTargetList = None
2895 self._FinalBuildTargetList = None
2896 self._FileTypes = None
2897 self._BuildRules = None
2898
2899 self._TimeStampPath = None
2900
2901 self.AutoGenDepSet = set()
2902
2903
2904 ## The Modules referenced to this Library
2905 # Only Library has this attribute
2906 self._ReferenceModules = []
2907
2908 ## Store the FixedAtBuild Pcds
2909 #
2910 self._FixedAtBuildPcds = []
2911 self.ConstPcd = {}
2912 return True
2913
2914 def __repr__(self):
2915 return "%s [%s]" % (self.MetaFile, self.Arch)
2916
2917 # Get FixedAtBuild Pcds of this Module
2918 def _GetFixedAtBuildPcds(self):
2919 if self._FixedAtBuildPcds:
2920 return self._FixedAtBuildPcds
2921 for Pcd in self.ModulePcdList:
2922 if Pcd.Type != "FixedAtBuild":
2923 continue
2924 if Pcd not in self._FixedAtBuildPcds:
2925 self._FixedAtBuildPcds.append(Pcd)
2926
2927 return self._FixedAtBuildPcds
2928
2929 def _GetUniqueBaseName(self):
2930 BaseName = self.Name
2931 for Module in self.PlatformInfo.ModuleAutoGenList:
2932 if Module.MetaFile == self.MetaFile:
2933 continue
2934 if Module.Name == self.Name:
2935 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2936 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2937 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2938 BaseName = '%s_%s' % (self.Name, self.Guid)
2939 return BaseName
2940
2941 # Macros could be used in build_rule.txt (also Makefile)
2942 def _GetMacros(self):
2943 if self._Macro == None:
2944 self._Macro = sdict()
2945 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2946 self._Macro["MODULE_NAME" ] = self.Name
2947 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2948 self._Macro["MODULE_GUID" ] = self.Guid
2949 self._Macro["MODULE_VERSION" ] = self.Version
2950 self._Macro["MODULE_TYPE" ] = self.ModuleType
2951 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2952 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2953 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2954 self._Macro["MODULE_DIR" ] = self.SourceDir
2955
2956 self._Macro["BASE_NAME" ] = self.Name
2957
2958 self._Macro["ARCH" ] = self.Arch
2959 self._Macro["TOOLCHAIN" ] = self.ToolChain
2960 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2961 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2962 self._Macro["TARGET" ] = self.BuildTarget
2963
2964 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
2965 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2966 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2967 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
2968 self._Macro["OUTPUT_DIR" ] = self.OutputDir
2969 self._Macro["DEBUG_DIR" ] = self.DebugDir
2970 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
2971 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
2972 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
2973 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
2974 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
2975 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
2976 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
2977 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
2978 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
2979 return self._Macro
2980
2981 ## Return the module build data object
2982 def _GetModule(self):
2983 if self._Module == None:
2984 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
2985 return self._Module
2986
2987 ## Return the module name
2988 def _GetBaseName(self):
2989 return self.Module.BaseName
2990
2991 ## Return the module DxsFile if exist
2992 def _GetDxsFile(self):
2993 return self.Module.DxsFile
2994
2995 ## Return the module SourceOverridePath
2996 def _GetSourceOverridePath(self):
2997 return self.Module.SourceOverridePath
2998
2999 ## Return the module meta-file GUID
3000 def _GetGuid(self):
3001 #
3002 # To build same module more than once, the module path with FILE_GUID overridden has
3003 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3004 # in DSC. The overridden GUID can be retrieved from file name
3005 #
3006 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
3007 #
3008 # Length of GUID is 36
3009 #
3010 return os.path.basename(self.MetaFile.Path)[:36]
3011 return self.Module.Guid
3012
3013 ## Return the module version
3014 def _GetVersion(self):
3015 return self.Module.Version
3016
3017 ## Return the module type
3018 def _GetModuleType(self):
3019 return self.Module.ModuleType
3020
3021 ## Return the component type (for Edk.x style of module)
3022 def _GetComponentType(self):
3023 return self.Module.ComponentType
3024
3025 ## Return the build type
3026 def _GetBuildType(self):
3027 return self.Module.BuildType
3028
3029 ## Return the PCD_IS_DRIVER setting
3030 def _GetPcdIsDriver(self):
3031 return self.Module.PcdIsDriver
3032
3033 ## Return the autogen version, i.e. module meta-file version
3034 def _GetAutoGenVersion(self):
3035 return self.Module.AutoGenVersion
3036
3037 ## Check if the module is library or not
3038 def _IsLibrary(self):
3039 if self._LibraryFlag == None:
3040 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
3041 self._LibraryFlag = True
3042 else:
3043 self._LibraryFlag = False
3044 return self._LibraryFlag
3045
3046 ## Check if the module is binary module or not
3047 def _IsBinaryModule(self):
3048 return self.Module.IsBinaryModule
3049
3050 ## Return the directory to store intermediate files of the module
3051 def _GetBuildDir(self):
3052 if self._BuildDir == None:
3053 self._BuildDir = path.join(
3054 self.PlatformInfo.BuildDir,
3055 self.Arch,
3056 self.SourceDir,
3057 self.MetaFile.BaseName
3058 )
3059 CreateDirectory(self._BuildDir)
3060 return self._BuildDir
3061
3062 ## Return the directory to store the intermediate object files of the mdoule
3063 def _GetOutputDir(self):
3064 if self._OutputDir == None:
3065 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3066 CreateDirectory(self._OutputDir)
3067 return self._OutputDir
3068
3069 ## Return the directory to store ffs file
3070 def _GetFfsOutputDir(self):
3071 if self._FfsOutputDir == None:
3072 if GlobalData.gFdfParser != None:
3073 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)
3074 else:
3075 self._FfsOutputDir = ''
3076 return self._FfsOutputDir
3077
3078 ## Return the directory to store auto-gened source files of the mdoule
3079 def _GetDebugDir(self):
3080 if self._DebugDir == None:
3081 self._DebugDir = path.join(self.BuildDir, "DEBUG")
3082 CreateDirectory(self._DebugDir)
3083 return self._DebugDir
3084
3085 ## Return the path of custom file
3086 def _GetCustomMakefile(self):
3087 if self._CustomMakefile == None:
3088 self._CustomMakefile = {}
3089 for Type in self.Module.CustomMakefile:
3090 if Type in gMakeTypeMap:
3091 MakeType = gMakeTypeMap[Type]
3092 else:
3093 MakeType = 'nmake'
3094 if self.SourceOverrideDir != None:
3095 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
3096 if not os.path.exists(File):
3097 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3098 else:
3099 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3100 self._CustomMakefile[MakeType] = File
3101 return self._CustomMakefile
3102
3103 ## Return the directory of the makefile
3104 #
3105 # @retval string The directory string of module's makefile
3106 #
3107 def _GetMakeFileDir(self):
3108 return self.BuildDir
3109
3110 ## Return build command string
3111 #
3112 # @retval string Build command string
3113 #
3114 def _GetBuildCommand(self):
3115 return self.PlatformInfo.BuildCommand
3116
3117 ## Get object list of all packages the module and its dependent libraries belong to
3118 #
3119 # @retval list The list of package object
3120 #
3121 def _GetDerivedPackageList(self):
3122 PackageList = []
3123 for M in [self.Module] + self.DependentLibraryList:
3124 for Package in M.Packages:
3125 if Package in PackageList:
3126 continue
3127 PackageList.append(Package)
3128 return PackageList
3129
3130 ## Get the depex string
3131 #
3132 # @return : a string contain all depex expresion.
3133 def _GetDepexExpresionString(self):
3134 DepexStr = ''
3135 DepexList = []
3136 ## DPX_SOURCE IN Define section.
3137 if self.Module.DxsFile:
3138 return DepexStr
3139 for M in [self.Module] + self.DependentLibraryList:
3140 Filename = M.MetaFile.Path
3141 InfObj = InfSectionParser.InfSectionParser(Filename)
3142 DepexExpresionList = InfObj.GetDepexExpresionList()
3143 for DepexExpresion in DepexExpresionList:
3144 for key in DepexExpresion.keys():
3145 Arch, ModuleType = key
3146 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]
3147 # the type of build module is USER_DEFINED.
3148 # All different DEPEX section tags would be copied into the As Built INF file
3149 # and there would be separate DEPEX section tags
3150 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3151 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
3152 DepexList.append({(Arch, ModuleType): DepexExpr})
3153 else:
3154 if Arch.upper() == TAB_ARCH_COMMON or \
3155 (Arch.upper() == self.Arch.upper() and \
3156 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
3157 DepexList.append({(Arch, ModuleType): DepexExpr})
3158
3159 #the type of build module is USER_DEFINED.
3160 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3161 for Depex in DepexList:
3162 for key in Depex.keys():
3163 DepexStr += '[Depex.%s.%s]\n' % key
3164 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
3165 DepexStr += '\n\n'
3166 if not DepexStr:
3167 return '[Depex.%s]\n' % self.Arch
3168 return DepexStr
3169
3170 #the type of build module not is USER_DEFINED.
3171 Count = 0
3172 for Depex in DepexList:
3173 Count += 1
3174 if DepexStr != '':
3175 DepexStr += ' AND '
3176 DepexStr += '('
3177 for D in Depex.values():
3178 DepexStr += ' '.join([val for val in D])
3179 Index = DepexStr.find('END')
3180 if Index > -1 and Index == len(DepexStr) - 3:
3181 DepexStr = DepexStr[:-3]
3182 DepexStr = DepexStr.strip()
3183 DepexStr += ')'
3184 if Count == 1:
3185 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
3186 if not DepexStr:
3187 return '[Depex.%s]\n' % self.Arch
3188 return '[Depex.%s]\n# ' % self.Arch + DepexStr
3189
3190 ## Merge dependency expression
3191 #
3192 # @retval list The token list of the dependency expression after parsed
3193 #
3194 def _GetDepexTokenList(self):
3195 if self._DepexList == None:
3196 self._DepexList = {}
3197 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3198 return self._DepexList
3199
3200 self._DepexList[self.ModuleType] = []
3201
3202 for ModuleType in self._DepexList:
3203 DepexList = self._DepexList[ModuleType]
3204 #
3205 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3206 #
3207 for M in [self.Module] + self.DependentLibraryList:
3208 Inherited = False
3209 for D in M.Depex[self.Arch, ModuleType]:
3210 if DepexList != []:
3211 DepexList.append('AND')
3212 DepexList.append('(')
3213 DepexList.extend(D)
3214 if DepexList[-1] == 'END': # no need of a END at this time
3215 DepexList.pop()
3216 DepexList.append(')')
3217 Inherited = True
3218 if Inherited:
3219 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
3220 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
3221 break
3222 if len(DepexList) > 0:
3223 EdkLogger.verbose('')
3224 return self._DepexList
3225
3226 ## Merge dependency expression
3227 #
3228 # @retval list The token list of the dependency expression after parsed
3229 #
3230 def _GetDepexExpressionTokenList(self):
3231 if self._DepexExpressionList == None:
3232 self._DepexExpressionList = {}
3233 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3234 return self._DepexExpressionList
3235
3236 self._DepexExpressionList[self.ModuleType] = ''
3237
3238 for ModuleType in self._DepexExpressionList:
3239 DepexExpressionList = self._DepexExpressionList[ModuleType]
3240 #
3241 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3242 #
3243 for M in [self.Module] + self.DependentLibraryList:
3244 Inherited = False
3245 for D in M.DepexExpression[self.Arch, ModuleType]:
3246 if DepexExpressionList != '':
3247 DepexExpressionList += ' AND '
3248 DepexExpressionList += '('
3249 DepexExpressionList += D
3250 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
3251 DepexExpressionList += ')'
3252 Inherited = True
3253 if Inherited:
3254 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
3255 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
3256 break
3257 if len(DepexExpressionList) > 0:
3258 EdkLogger.verbose('')
3259 self._DepexExpressionList[ModuleType] = DepexExpressionList
3260 return self._DepexExpressionList
3261
3262 # Get the tiano core user extension, it is contain dependent library.
3263 # @retval: a list contain tiano core userextension.
3264 #
3265 def _GetTianoCoreUserExtensionList(self):
3266 TianoCoreUserExtentionList = []
3267 for M in [self.Module] + self.DependentLibraryList:
3268 Filename = M.MetaFile.Path
3269 InfObj = InfSectionParser.InfSectionParser(Filename)
3270 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()
3271 for TianoCoreUserExtent in TianoCoreUserExtenList:
3272 for Section in TianoCoreUserExtent.keys():
3273 ItemList = Section.split(TAB_SPLIT)
3274 Arch = self.Arch
3275 if len(ItemList) == 4:
3276 Arch = ItemList[3]
3277 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():
3278 TianoCoreList = []
3279 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])
3280 TianoCoreList.extend(TianoCoreUserExtent[Section][:])
3281 TianoCoreList.append('\n')
3282 TianoCoreUserExtentionList.append(TianoCoreList)
3283
3284 return TianoCoreUserExtentionList
3285
3286 ## Return the list of specification version required for the module
3287 #
3288 # @retval list The list of specification defined in module file
3289 #
3290 def _GetSpecification(self):
3291 return self.Module.Specification
3292
3293 ## Tool option for the module build
3294 #
3295 # @param PlatformInfo The object of PlatformBuildInfo
3296 # @retval dict The dict containing valid options
3297 #
3298 def _GetModuleBuildOption(self):
3299 if self._BuildOption == None:
3300 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
3301 if self.BuildRuleOrder:
3302 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
3303 return self._BuildOption
3304
3305 ## Get include path list from tool option for the module build
3306 #
3307 # @retval list The include path list
3308 #
3309 def _GetBuildOptionIncPathList(self):
3310 if self._BuildOptionIncPathList == None:
3311 #
3312 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3313 # is the former use /I , the Latter used -I to specify include directories
3314 #
3315 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
3316 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3317 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
3318 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3319 else:
3320 #
3321 # New ToolChainFamily, don't known whether there is option to specify include directories
3322 #
3323 self._BuildOptionIncPathList = []
3324 return self._BuildOptionIncPathList
3325
3326 BuildOptionIncPathList = []
3327 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3328 Attr = 'FLAGS'
3329 try:
3330 FlagOption = self.BuildOption[Tool][Attr]
3331 except KeyError:
3332 FlagOption = ''
3333
3334 if self.PlatformInfo.ToolChainFamily != 'RVCT':
3335 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
3336 else:
3337 #
3338 # RVCT may specify a list of directory seperated by commas
3339 #
3340 IncPathList = []
3341 for Path in gBuildOptIncludePattern.findall(FlagOption):
3342 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
3343 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
3344
3345 #
3346 # EDK II modules must not reference header files outside of the packages they depend on or
3347 # within the module's directory tree. Report error if violation.
3348 #
3349 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
3350 for Path in IncPathList:
3351 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
3352 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
3353 EdkLogger.error("build",
3354 PARAMETER_INVALID,
3355 ExtraData=ErrMsg,
3356 File=str(self.MetaFile))
3357
3358
3359 BuildOptionIncPathList += IncPathList
3360
3361 self._BuildOptionIncPathList = BuildOptionIncPathList
3362
3363 return self._BuildOptionIncPathList
3364
3365 ## Return a list of files which can be built from source
3366 #
3367 # What kind of files can be built is determined by build rules in
3368 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3369 #
3370 def _GetSourceFileList(self):
3371 if self._SourceFileList == None:
3372 self._SourceFileList = []
3373 for F in self.Module.Sources:
3374 # match tool chain
3375 if F.TagName not in ("", "*", self.ToolChain):
3376 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
3377 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
3378 continue
3379 # match tool chain family or build rule family
3380 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):
3381 EdkLogger.debug(
3382 EdkLogger.DEBUG_0,
3383 "The file [%s] must be built by tools of [%s], " \
3384 "but current toolchain family is [%s], buildrule family is [%s]" \
3385 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))
3386 continue
3387
3388 # add the file path into search path list for file including
3389 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
3390 self.IncludePathList.insert(0, F.Dir)
3391 self._SourceFileList.append(F)
3392
3393 self._MatchBuildRuleOrder(self._SourceFileList)
3394
3395 for F in self._SourceFileList:
3396 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
3397 return self._SourceFileList
3398
3399 def _MatchBuildRuleOrder(self, FileList):
3400 Order_Dict = {}
3401 self._GetModuleBuildOption()
3402 for SingleFile in FileList:
3403 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:
3404 key = SingleFile.Path.split(SingleFile.Ext)[0]
3405 if key in Order_Dict:
3406 Order_Dict[key].append(SingleFile.Ext)
3407 else:
3408 Order_Dict[key] = [SingleFile.Ext]
3409
3410 RemoveList = []
3411 for F in Order_Dict:
3412 if len(Order_Dict[F]) > 1:
3413 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))
3414 for Ext in Order_Dict[F][1:]:
3415 RemoveList.append(F + Ext)
3416
3417 for item in RemoveList:
3418 FileList.remove(item)
3419
3420 return FileList
3421
3422 ## Return the list of unicode files
3423 def _GetUnicodeFileList(self):
3424 if self._UnicodeFileList == None:
3425 if TAB_UNICODE_FILE in self.FileTypes:
3426 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
3427 else:
3428 self._UnicodeFileList = []
3429 return self._UnicodeFileList
3430
3431 ## Return the list of vfr files
3432 def _GetVfrFileList(self):
3433 if self._VfrFileList == None:
3434 if TAB_VFR_FILE in self.FileTypes:
3435 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]
3436 else:
3437 self._VfrFileList = []
3438 return self._VfrFileList
3439
3440 ## Return the list of Image Definition files
3441 def _GetIdfFileList(self):
3442 if self._IdfFileList == None:
3443 if TAB_IMAGE_FILE in self.FileTypes:
3444 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]
3445 else:
3446 self._IdfFileList = []
3447 return self._IdfFileList
3448
3449 ## Return a list of files which can be built from binary
3450 #
3451 # "Build" binary files are just to copy them to build directory.
3452 #
3453 # @retval list The list of files which can be built later
3454 #
3455 def _GetBinaryFiles(self):
3456 if self._BinaryFileList == None:
3457 self._BinaryFileList = []
3458 for F in self.Module.Binaries:
3459 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
3460 continue
3461 self._BinaryFileList.append(F)
3462 self._ApplyBuildRule(F, F.Type)
3463 return self._BinaryFileList
3464
3465 def _GetBuildRules(self):
3466 if self._BuildRules == None:
3467 BuildRules = {}
3468 BuildRuleDatabase = self.PlatformInfo.BuildRule
3469 for Type in BuildRuleDatabase.FileTypeList:
3470 #first try getting build rule by BuildRuleFamily
3471 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
3472 if not RuleObject:
3473 # build type is always module type, but ...
3474 if self.ModuleType != self.BuildType:
3475 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
3476 #second try getting build rule by ToolChainFamily
3477 if not RuleObject:
3478 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
3479 if not RuleObject:
3480 # build type is always module type, but ...
3481 if self.ModuleType != self.BuildType:
3482 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
3483 if not RuleObject:
3484 continue
3485 RuleObject = RuleObject.Instantiate(self.Macros)
3486 BuildRules[Type] = RuleObject
3487 for Ext in RuleObject.SourceFileExtList:
3488 BuildRules[Ext] = RuleObject
3489 self._BuildRules = BuildRules
3490 return self._BuildRules
3491
3492 def _ApplyBuildRule(self, File, FileType):
3493 if self._BuildTargets == None:
3494 self._IntroBuildTargetList = set()
3495 self._FinalBuildTargetList = set()
3496 self._BuildTargets = {}
3497 self._FileTypes = {}
3498
3499 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
3500 if not os.path.exists(SubDirectory):
3501 CreateDirectory(SubDirectory)
3502 LastTarget = None
3503 RuleChain = []
3504 SourceList = [File]
3505 Index = 0
3506 #
3507 # Make sure to get build rule order value
3508 #
3509 self._GetModuleBuildOption()
3510
3511 while Index < len(SourceList):
3512 Source = SourceList[Index]
3513 Index = Index + 1
3514
3515 if Source != File:
3516 CreateDirectory(Source.Dir)
3517
3518 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
3519 # Skip all files that are not binary libraries
3520 if not self.IsLibrary:
3521 continue
3522 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
3523 elif FileType in self.BuildRules:
3524 RuleObject = self.BuildRules[FileType]
3525 elif Source.Ext in self.BuildRules:
3526 RuleObject = self.BuildRules[Source.Ext]
3527 else:
3528 # stop at no more rules
3529 if LastTarget:
3530 self._FinalBuildTargetList.add(LastTarget)
3531 break
3532
3533 FileType = RuleObject.SourceFileType
3534 if FileType not in self._FileTypes:
3535 self._FileTypes[FileType] = set()
3536 self._FileTypes[FileType].add(Source)
3537
3538 # stop at STATIC_LIBRARY for library
3539 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
3540 if LastTarget:
3541 self._FinalBuildTargetList.add(LastTarget)
3542 break
3543
3544 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
3545 if not Target:
3546 if LastTarget:
3547 self._FinalBuildTargetList.add(LastTarget)
3548 break
3549 elif not Target.Outputs:
3550 # Only do build for target with outputs
3551 self._FinalBuildTargetList.add(Target)
3552
3553 if FileType not in self._BuildTargets:
3554 self._BuildTargets[FileType] = set()
3555 self._BuildTargets[FileType].add(Target)
3556
3557 if not Source.IsBinary and Source == File:
3558 self._IntroBuildTargetList.add(Target)
3559
3560 # to avoid cyclic rule
3561 if FileType in RuleChain:
3562 break
3563
3564 RuleChain.append(FileType)
3565 SourceList.extend(Target.Outputs)
3566 LastTarget = Target
3567 FileType = TAB_UNKNOWN_FILE
3568
3569 def _GetTargets(self):
3570 if self._BuildTargets == None:
3571 self._IntroBuildTargetList = set()
3572 self._FinalBuildTargetList = set()
3573 self._BuildTargets = {}
3574 self._FileTypes = {}
3575
3576 #TRICK: call _GetSourceFileList to apply build rule for source files
3577 if self.SourceFileList:
3578 pass
3579
3580 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3581 if self.BinaryFileList:
3582 pass
3583
3584 return self._BuildTargets
3585
3586 def _GetIntroTargetList(self):
3587 self._GetTargets()
3588 return self._IntroBuildTargetList
3589
3590 def _GetFinalTargetList(self):
3591 self._GetTargets()
3592 return self._FinalBuildTargetList
3593
3594 def _GetFileTypes(self):
3595 self._GetTargets()
3596 return self._FileTypes
3597
3598 ## Get the list of package object the module depends on
3599 #
3600 # @retval list The package object list
3601 #
3602 def _GetDependentPackageList(self):
3603 return self.Module.Packages
3604
3605 ## Return the list of auto-generated code file
3606 #
3607 # @retval list The list of auto-generated file
3608 #
3609 def _GetAutoGenFileList(self):
3610 UniStringAutoGenC = True
3611 IdfStringAutoGenC = True
3612 UniStringBinBuffer = StringIO()
3613 IdfGenBinBuffer = StringIO()
3614 if self.BuildType == 'UEFI_HII':
3615 UniStringAutoGenC = False
3616 IdfStringAutoGenC = False
3617 if self._AutoGenFileList == None:
3618 self._AutoGenFileList = {}
3619 AutoGenC = TemplateString()
3620 AutoGenH = TemplateString()
3621 StringH = TemplateString()
3622 StringIdf = TemplateString()
3623 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)
3624 #
3625 # AutoGen.c is generated if there are library classes in inf, or there are object files
3626 #
3627 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
3628 or TAB_OBJECT_FILE in self.FileTypes):
3629 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
3630 self._AutoGenFileList[AutoFile] = str(AutoGenC)
3631 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3632 if str(AutoGenH) != "":
3633 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
3634 self._AutoGenFileList[AutoFile] = str(AutoGenH)
3635 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3636 if str(StringH) != "":
3637 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
3638 self._AutoGenFileList[AutoFile] = str(StringH)
3639 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3640 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
3641 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
3642 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
3643 AutoFile.IsBinary = True
3644 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3645 if UniStringBinBuffer != None:
3646 UniStringBinBuffer.close()
3647 if str(StringIdf) != "":
3648 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)
3649 self._AutoGenFileList[AutoFile] = str(StringIdf)
3650 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3651 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":
3652 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)
3653 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()
3654 AutoFile.IsBinary = True
3655 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3656 if IdfGenBinBuffer != None:
3657 IdfGenBinBuffer.close()
3658 return self._AutoGenFileList
3659
3660 ## Return the list of library modules explicitly or implicityly used by this module
3661 def _GetLibraryList(self):
3662 if self._DependentLibraryList == None:
3663 # only merge library classes and PCD for non-library module
3664 if self.IsLibrary:
3665 self._DependentLibraryList = []
3666 else:
3667 if self.AutoGenVersion < 0x00010005:
3668 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
3669 else:
3670 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
3671 return self._DependentLibraryList
3672
3673 @staticmethod
3674 def UpdateComments(Recver, Src):
3675 for Key in Src:
3676 if Key not in Recver:
3677 Recver[Key] = []
3678 Recver[Key].extend(Src[Key])
3679 ## Get the list of PCDs from current module
3680 #
3681 # @retval list The list of PCD
3682 #
3683 def _GetModulePcdList(self):
3684 if self._ModulePcdList == None:
3685 # apply PCD settings from platform
3686 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
3687 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
3688 return self._ModulePcdList
3689
3690 ## Get the list of PCDs from dependent libraries
3691 #
3692 # @retval list The list of PCD
3693 #
3694 def _GetLibraryPcdList(self):
3695 if self._LibraryPcdList == None:
3696 Pcds = sdict()
3697 if not self.IsLibrary:
3698 # get PCDs from dependent libraries
3699 for Library in self.DependentLibraryList:
3700 self.UpdateComments(self._PcdComments, Library.PcdComments)
3701 for Key in Library.Pcds:
3702 # skip duplicated PCDs
3703 if Key in self.Module.Pcds or Key in Pcds:
3704 continue
3705 Pcds[Key] = copy.copy(Library.Pcds[Key])
3706 # apply PCD settings from platform
3707 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
3708 else:
3709 self._LibraryPcdList = []
3710 return self._LibraryPcdList
3711
3712 ## Get the GUID value mapping
3713 #
3714 # @retval dict The mapping between GUID cname and its value
3715 #
3716 def _GetGuidList(self):
3717 if self._GuidList == None:
3718 self._GuidList = sdict()
3719 self._GuidList.update(self.Module.Guids)
3720 for Library in self.DependentLibraryList:
3721 self._GuidList.update(Library.Guids)
3722 self.UpdateComments(self._GuidComments, Library.GuidComments)
3723 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
3724 return self._GuidList
3725
3726 def GetGuidsUsedByPcd(self):
3727 if self._GuidsUsedByPcd == None:
3728 self._GuidsUsedByPcd = sdict()
3729 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3730 for Library in self.DependentLibraryList:
3731 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3732 return self._GuidsUsedByPcd
3733 ## Get the protocol value mapping
3734 #
3735 # @retval dict The mapping between protocol cname and its value
3736 #
3737 def _GetProtocolList(self):
3738 if self._ProtocolList == None:
3739 self._ProtocolList = sdict()
3740 self._ProtocolList.update(self.Module.Protocols)
3741 for Library in self.DependentLibraryList:
3742 self._ProtocolList.update(Library.Protocols)
3743 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3744 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3745 return self._ProtocolList
3746
3747 ## Get the PPI value mapping
3748 #
3749 # @retval dict The mapping between PPI cname and its value
3750 #
3751 def _GetPpiList(self):
3752 if self._PpiList == None:
3753 self._PpiList = sdict()
3754 self._PpiList.update(self.Module.Ppis)
3755 for Library in self.DependentLibraryList:
3756 self._PpiList.update(Library.Ppis)
3757 self.UpdateComments(self._PpiComments, Library.PpiComments)
3758 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3759 return self._PpiList
3760
3761 ## Get the list of include search path
3762 #
3763 # @retval list The list path
3764 #
3765 def _GetIncludePathList(self):
3766 if self._IncludePathList == None:
3767 self._IncludePathList = []
3768 if self.AutoGenVersion < 0x00010005:
3769 for Inc in self.Module.Includes:
3770 if Inc not in self._IncludePathList:
3771 self._IncludePathList.append(Inc)
3772 # for Edk modules
3773 Inc = path.join(Inc, self.Arch.capitalize())
3774 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3775 self._IncludePathList.append(Inc)
3776 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3777 self._IncludePathList.append(self.DebugDir)
3778 else:
3779 self._IncludePathList.append(self.MetaFile.Dir)
3780 self._IncludePathList.append(self.DebugDir)
3781
3782 for Package in self.Module.Packages:
3783 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)
3784 if PackageDir not in self._IncludePathList:
3785 self._IncludePathList.append(PackageDir)
3786 IncludesList = Package.Includes
3787 if Package._PrivateIncludes:
3788 if not self.MetaFile.Path.startswith(PackageDir):
3789 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))
3790 for Inc in IncludesList:
3791 if Inc not in self._IncludePathList:
3792 self._IncludePathList.append(str(Inc))
3793 return self._IncludePathList
3794
3795 def _GetIncludePathLength(self):
3796 self._IncludePathLength = 0
3797 if self._IncludePathList:
3798 for inc in self._IncludePathList:
3799 self._IncludePathLength += len(' ' + inc)
3800 return self._IncludePathLength
3801
3802 ## Get HII EX PCDs which maybe used by VFR
3803 #
3804 # efivarstore used by VFR may relate with HII EX PCDs
3805 # Get the variable name and GUID from efivarstore and HII EX PCD
3806 # List the HII EX PCDs in As Built INF if both name and GUID match.
3807 #
3808 # @retval list HII EX PCDs
3809 #
3810 def _GetPcdsMaybeUsedByVfr(self):
3811 if not self.SourceFileList:
3812 return []
3813
3814 NameGuids = []
3815 for SrcFile in self.SourceFileList:
3816 if SrcFile.Ext.lower() != '.vfr':
3817 continue
3818 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3819 if not os.path.exists(Vfri):
3820 continue
3821 VfriFile = open(Vfri, 'r')
3822 Content = VfriFile.read()
3823 VfriFile.close()
3824 Pos = Content.find('efivarstore')
3825 while Pos != -1:
3826 #
3827 # Make sure 'efivarstore' is the start of efivarstore statement
3828 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3829 #
3830 Index = Pos - 1
3831 while Index >= 0 and Content[Index] in ' \t\r\n':
3832 Index -= 1
3833 if Index >= 0 and Content[Index] != ';':
3834 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3835 continue
3836 #
3837 # 'efivarstore' must be followed by name and guid
3838 #
3839 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3840 if not Name:
3841 break
3842 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3843 if not Guid:
3844 break
3845 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3846 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3847 Pos = Content.find('efivarstore', Name.end())
3848 if not NameGuids:
3849 return []
3850 HiiExPcds = []
3851 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3852 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3853 continue
3854 for SkuName in Pcd.SkuInfoList:
3855 SkuInfo = Pcd.SkuInfoList[SkuName]
3856 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3857 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)
3858 if not Value:
3859 continue
3860 Guid = GuidStructureStringToGuidString(Value)
3861 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3862 HiiExPcds.append(Pcd)
3863 break
3864
3865 return HiiExPcds
3866
3867 def _GenOffsetBin(self):
3868 VfrUniBaseName = {}
3869 for SourceFile in self.Module.Sources:
3870 if SourceFile.Type.upper() == ".VFR" :
3871 #
3872 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3873 #
3874 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3875 if SourceFile.Type.upper() == ".UNI" :
3876 #
3877 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3878 #
3879 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3880
3881 if len(VfrUniBaseName) == 0:
3882 return None
3883 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3884 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3885 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3886 if not VfrUniOffsetList:
3887 return None
3888
3889 OutputName = '%sOffset.bin' % self.Name
3890 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3891
3892 try:
3893 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3894 except:
3895 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3896
3897 # Use a instance of StringIO to cache data
3898 fStringIO = StringIO('')
3899
3900 for Item in VfrUniOffsetList:
3901 if (Item[0].find("Strings") != -1):
3902 #
3903 # UNI offset in image.
3904 # GUID + Offset
3905 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3906 #
3907 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3908 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3909 fStringIO.write(''.join(UniGuid))
3910 UniValue = pack ('Q', int (Item[1], 16))
3911 fStringIO.write (UniValue)
3912 else:
3913 #
3914 # VFR binary offset in image.
3915 # GUID + Offset
3916 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3917 #
3918 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3919 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3920 fStringIO.write(''.join(VfrGuid))
3921 type (Item[1])
3922 VfrValue = pack ('Q', int (Item[1], 16))
3923 fStringIO.write (VfrValue)
3924 #
3925 # write data into file.
3926 #
3927 try :
3928 fInputfile.write (fStringIO.getvalue())
3929 except:
3930 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
3931 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
3932
3933 fStringIO.close ()
3934 fInputfile.close ()
3935 return OutputName
3936
3937 ## Create AsBuilt INF file the module
3938 #
3939 def CreateAsBuiltInf(self, IsOnlyCopy = False):
3940 self.OutputFile = []
3941 if IsOnlyCopy:
3942 if GlobalData.gBinCacheDest:
3943 self.CopyModuleToCache()
3944 return
3945
3946 if self.IsAsBuiltInfCreated:
3947 return
3948
3949 # Skip the following code for EDK I inf
3950 if self.AutoGenVersion < 0x00010005:
3951 return
3952
3953 # Skip the following code for libraries
3954 if self.IsLibrary:
3955 return
3956
3957 # Skip the following code for modules with no source files
3958 if self.SourceFileList == None or self.SourceFileList == []:
3959 return
3960
3961 # Skip the following code for modules without any binary files
3962 if self.BinaryFileList <> None and self.BinaryFileList <> []:
3963 return
3964
3965 ### TODO: How to handles mixed source and binary modules
3966
3967 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3968 # Also find all packages that the DynamicEx PCDs depend on
3969 Pcds = []
3970 PatchablePcds = []
3971 Packages = []
3972 PcdCheckList = []
3973 PcdTokenSpaceList = []
3974 for Pcd in self.ModulePcdList + self.LibraryPcdList:
3975 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
3976 PatchablePcds += [Pcd]
3977 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
3978 elif Pcd.Type in GenC.gDynamicExPcd:
3979 if Pcd not in Pcds:
3980 Pcds += [Pcd]
3981 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
3982 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
3983 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
3984 GuidList = sdict()
3985 GuidList.update(self.GuidList)
3986 for TokenSpace in self.GetGuidsUsedByPcd():
3987 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3988 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3989 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
3990 GuidList.pop(TokenSpace)
3991 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
3992 for Package in self.DerivedPackageList:
3993 if Package in Packages:
3994 continue
3995 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
3996 Found = False
3997 for Index in range(len(BeChecked)):
3998 for Item in CheckList[Index]:
3999 if Item in BeChecked[Index]:
4000 Packages += [Package]
4001 Found = True
4002 break
4003 if Found: break
4004
4005 VfrPcds = self._GetPcdsMaybeUsedByVfr()
4006 for Pkg in self.PlatformInfo.PackageList:
4007 if Pkg in Packages:
4008 continue
4009 for VfrPcd in VfrPcds:
4010 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
4011 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
4012 Packages += [Pkg]
4013 break
4014
4015 ModuleType = self.ModuleType
4016 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
4017 ModuleType = 'DXE_DRIVER'
4018
4019 DriverType = ''
4020 if self.PcdIsDriver != '':
4021 DriverType = self.PcdIsDriver
4022
4023 Guid = self.Guid
4024 MDefs = self.Module.Defines
4025
4026 AsBuiltInfDict = {
4027 'module_name' : self.Name,
4028 'module_guid' : Guid,
4029 'module_module_type' : ModuleType,
4030 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
4031 'pcd_is_driver_string' : [],
4032 'module_uefi_specification_version' : [],
4033 'module_pi_specification_version' : [],
4034 'module_entry_point' : self.Module.ModuleEntryPointList,
4035 'module_unload_image' : self.Module.ModuleUnloadImageList,
4036 'module_constructor' : self.Module.ConstructorList,
4037 'module_destructor' : self.Module.DestructorList,
4038 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
4039 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
4040 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
4041 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
4042 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
4043 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
4044 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
4045 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
4046 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
4047 'module_arch' : self.Arch,
4048 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],
4049 'binary_item' : [],
4050 'patchablepcd_item' : [],
4051 'pcd_item' : [],
4052 'protocol_item' : [],
4053 'ppi_item' : [],
4054 'guid_item' : [],
4055 'flags_item' : [],
4056 'libraryclasses_item' : []
4057 }
4058
4059 if 'MODULE_UNI_FILE' in MDefs:
4060 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])
4061 if os.path.isfile(UNIFile):
4062 shutil.copy2(UNIFile, self.OutputDir)
4063
4064 if self.AutoGenVersion > int(gInfSpecVersion, 0):
4065 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
4066 else:
4067 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
4068
4069 if DriverType:
4070 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
4071
4072 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
4073 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
4074 if 'PI_SPECIFICATION_VERSION' in self.Specification:
4075 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
4076
4077 OutputDir = self.OutputDir.replace('\\', '/').strip('/')
4078 DebugDir = self.DebugDir.replace('\\', '/').strip('/')
4079 for Item in self.CodaTargetList:
4080 File = Item.Target.Path.replace('\\', '/').strip('/').replace(DebugDir, '').strip('/')
4081 if File not in self.OutputFile:
4082 self.OutputFile.append(File)
4083 if os.path.isabs(File):
4084 File = File.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')
4085 if Item.Target.Ext.lower() == '.aml':
4086 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
4087 elif Item.Target.Ext.lower() == '.acpi':
4088 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
4089 elif Item.Target.Ext.lower() == '.efi':
4090 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
4091 else:
4092 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
4093 if self.DepexGenerated:
4094 if self.Name + '.depex' not in self.OutputFile:
4095 self.OutputFile.append(self.Name + '.depex')
4096 if self.ModuleType in ['PEIM']:
4097 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
4098 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4099 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
4100 if self.ModuleType in ['DXE_SMM_DRIVER']:
4101 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
4102
4103 Bin = self._GenOffsetBin()
4104 if Bin:
4105 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
4106 if Bin not in self.OutputFile:
4107 self.OutputFile.append(Bin)
4108
4109 for Root, Dirs, Files in os.walk(OutputDir):
4110 for File in Files:
4111 if File.lower().endswith('.pdb'):
4112 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
4113 if File not in self.OutputFile:
4114 self.OutputFile.append(File)
4115 HeaderComments = self.Module.HeaderComments
4116 StartPos = 0
4117 for Index in range(len(HeaderComments)):
4118 if HeaderComments[Index].find('@BinaryHeader') != -1:
4119 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
4120 StartPos = Index
4121 break
4122 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
4123 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
4124
4125 GenList = [
4126 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
4127 (self.PpiList, self._PpiComments, 'ppi_item'),
4128 (GuidList, self._GuidComments, 'guid_item')
4129 ]
4130 for Item in GenList:
4131 for CName in Item[0]:
4132 Comments = ''
4133 if CName in Item[1]:
4134 Comments = '\n '.join(Item[1][CName])
4135 Entry = CName
4136 if Comments:
4137 Entry = Comments + '\n ' + CName
4138 AsBuiltInfDict[Item[2]].append(Entry)
4139 PatchList = parsePcdInfoFromMapFile(
4140 os.path.join(self.OutputDir, self.Name + '.map'),
4141 os.path.join(self.OutputDir, self.Name + '.efi')
4142 )
4143 if PatchList:
4144 for Pcd in PatchablePcds:
4145 TokenCName = Pcd.TokenCName
4146 for PcdItem in GlobalData.MixedPcd:
4147 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4148 TokenCName = PcdItem[0]
4149 break
4150 for PatchPcd in PatchList:
4151 if TokenCName == PatchPcd[0]:
4152 break
4153 else:
4154 continue
4155 PcdValue = ''
4156 if Pcd.DatumType == 'BOOLEAN':
4157 BoolValue = Pcd.DefaultValue.upper()
4158 if BoolValue == 'TRUE':
4159 Pcd.DefaultValue = '1'
4160 elif BoolValue == 'FALSE':
4161 Pcd.DefaultValue = '0'
4162
4163 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4164 HexFormat = '0x%02x'
4165 if Pcd.DatumType == 'UINT16':
4166 HexFormat = '0x%04x'
4167 elif Pcd.DatumType == 'UINT32':
4168 HexFormat = '0x%08x'
4169 elif Pcd.DatumType == 'UINT64':
4170 HexFormat = '0x%016x'
4171 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
4172 else:
4173 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
4174 EdkLogger.error("build", AUTOGEN_ERROR,
4175 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)
4176 )
4177 ArraySize = int(Pcd.MaxDatumSize, 0)
4178 PcdValue = Pcd.DefaultValue
4179 if PcdValue[0] != '{':
4180 Unicode = False
4181 if PcdValue[0] == 'L':
4182 Unicode = True
4183 PcdValue = PcdValue.lstrip('L')
4184 PcdValue = eval(PcdValue)
4185 NewValue = '{'
4186 for Index in range(0, len(PcdValue)):
4187 if Unicode:
4188 CharVal = ord(PcdValue[Index])
4189 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
4190 + '0x%02x' % (CharVal >> 8) + ', '
4191 else:
4192 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
4193 Padding = '0x00, '
4194 if Unicode:
4195 Padding = Padding * 2
4196 ArraySize = ArraySize / 2
4197 if ArraySize < (len(PcdValue) + 1):
4198 EdkLogger.error("build", AUTOGEN_ERROR,
4199 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4200 )
4201 if ArraySize > len(PcdValue) + 1:
4202 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
4203 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
4204 elif len(PcdValue.split(',')) <= ArraySize:
4205 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
4206 PcdValue += '}'
4207 else:
4208 EdkLogger.error("build", AUTOGEN_ERROR,
4209 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4210 )
4211 PcdItem = '%s.%s|%s|0x%X' % \
4212 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])
4213 PcdComments = ''
4214 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4215 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
4216 if PcdComments:
4217 PcdItem = PcdComments + '\n ' + PcdItem
4218 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
4219
4220 HiiPcds = []
4221 for Pcd in Pcds + VfrPcds:
4222 PcdComments = ''
4223 PcdCommentList = []
4224 HiiInfo = ''
4225 SkuId = ''
4226 TokenCName = Pcd.TokenCName
4227 for PcdItem in GlobalData.MixedPcd:
4228 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4229 TokenCName = PcdItem[0]
4230 break
4231 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
4232 for SkuName in Pcd.SkuInfoList:
4233 SkuInfo = Pcd.SkuInfoList[SkuName]
4234 SkuId = SkuInfo.SkuId
4235 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
4236 break
4237 if SkuId:
4238 #
4239 # Don't generate duplicated HII PCD
4240 #
4241 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
4242 continue
4243 else:
4244 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
4245 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4246 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
4247 if HiiInfo:
4248 UsageIndex = -1
4249 UsageStr = ''
4250 for Index, Comment in enumerate(PcdCommentList):
4251 for Usage in UsageList:
4252 if Comment.find(Usage) != -1:
4253 UsageStr = Usage
4254 UsageIndex = Index
4255 break
4256 if UsageIndex != -1:
4257 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
4258 else:
4259 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
4260 PcdComments = '\n '.join(PcdCommentList)
4261 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName
4262 if PcdComments:
4263 PcdEntry = PcdComments + '\n ' + PcdEntry
4264 AsBuiltInfDict['pcd_item'] += [PcdEntry]
4265 for Item in self.BuildOption:
4266 if 'FLAGS' in self.BuildOption[Item]:
4267 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
4268
4269 # Generated LibraryClasses section in comments.
4270 for Library in self.LibraryAutoGenList:
4271 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
4272
4273 # Generated UserExtensions TianoCore section.
4274 # All tianocore user extensions are copied.
4275 UserExtStr = ''
4276 for TianoCore in self._GetTianoCoreUserExtensionList():
4277 UserExtStr += '\n'.join(TianoCore)
4278 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])
4279 if os.path.isfile(ExtensionFile):
4280 shutil.copy2(ExtensionFile, self.OutputDir)
4281 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr
4282
4283 # Generated depex expression section in comments.
4284 AsBuiltInfDict['depexsection_item'] = ''
4285 DepexExpresion = self._GetDepexExpresionString()
4286 if DepexExpresion:
4287 AsBuiltInfDict['depexsection_item'] = DepexExpresion
4288
4289 AsBuiltInf = TemplateString()
4290 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
4291
4292 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
4293
4294 self.IsAsBuiltInfCreated = True
4295 if GlobalData.gBinCacheDest:
4296 self.CopyModuleToCache()
4297
4298 def CopyModuleToCache(self):
4299 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4300 CreateDirectory (FileDir)
4301 HashFile = path.join(self.BuildDir, self.Name + '.hash')
4302 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')
4303 if os.path.exists(HashFile):
4304 shutil.copy2(HashFile, FileDir)
4305 if os.path.exists(ModuleFile):
4306 shutil.copy2(ModuleFile, FileDir)
4307 if not self.OutputFile:
4308 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]
4309 self.OutputFile = Ma.Binaries
4310 if self.OutputFile:
4311 for File in self.OutputFile:
4312 File = str(File)
4313 if not os.path.isabs(File):
4314 File = os.path.join(self.OutputDir, File)
4315 if os.path.exists(File):
4316 shutil.copy2(File, FileDir)
4317
4318 def AttemptModuleCacheCopy(self):
4319 if self.IsBinaryModule:
4320 return False
4321 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4322 HashFile = path.join(FileDir, self.Name + '.hash')
4323 if os.path.exists(HashFile):
4324 f = open(HashFile, 'r')
4325 CacheHash = f.read()
4326 f.close()
4327 if GlobalData.gModuleHash[self.Arch][self.Name]:
4328 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:
4329 for root, dir, files in os.walk(FileDir):
4330 for f in files:
4331 if self.Name + '.hash' in f:
4332 shutil.copy2(HashFile, self.BuildDir)
4333 else:
4334 File = path.join(root, f)
4335 shutil.copy2(File, self.OutputDir)
4336 if self.Name == "PcdPeim" or self.Name == "PcdDxe":
4337 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4338 return True
4339 return False
4340
4341 ## Create makefile for the module and its dependent libraries
4342 #
4343 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4344 # dependent libraries will be created
4345 #
4346 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):
4347 # Ignore generating makefile when it is a binary module
4348 if self.IsBinaryModule:
4349 return
4350
4351 if self.IsMakeFileCreated:
4352 return
4353 self.GenFfsList = GenFfsList
4354 if not self.IsLibrary and CreateLibraryMakeFile:
4355 for LibraryAutoGen in self.LibraryAutoGenList:
4356 LibraryAutoGen.CreateMakeFile()
4357
4358 if self.CanSkip():
4359 return
4360
4361 if len(self.CustomMakefile) == 0:
4362 Makefile = GenMake.ModuleMakefile(self)
4363 else:
4364 Makefile = GenMake.CustomMakefile(self)
4365 if Makefile.Generate():
4366 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
4367 (self.Name, self.Arch))
4368 else:
4369 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
4370 (self.Name, self.Arch))
4371
4372 self.CreateTimeStamp(Makefile)
4373 self.IsMakeFileCreated = True
4374
4375 def CopyBinaryFiles(self):
4376 for File in self.Module.Binaries:
4377 SrcPath = File.Path
4378 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
4379 CopyLongFilePath(SrcPath, DstPath)
4380 ## Create autogen code for the module and its dependent libraries
4381 #
4382 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4383 # dependent libraries will be created
4384 #
4385 def CreateCodeFile(self, CreateLibraryCodeFile=True):
4386 if self.IsCodeFileCreated:
4387 return
4388
4389 # Need to generate PcdDatabase even PcdDriver is binarymodule
4390 if self.IsBinaryModule and self.PcdIsDriver != '':
4391 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4392 return
4393 if self.IsBinaryModule:
4394 if self.IsLibrary:
4395 self.CopyBinaryFiles()
4396 return
4397
4398 if not self.IsLibrary and CreateLibraryCodeFile:
4399 for LibraryAutoGen in self.LibraryAutoGenList:
4400 LibraryAutoGen.CreateCodeFile()
4401
4402 if self.CanSkip():
4403 return
4404
4405 AutoGenList = []
4406 IgoredAutoGenList = []
4407
4408 for File in self.AutoGenFileList:
4409 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
4410 #Ignore Edk AutoGen.c
4411 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
4412 continue
4413
4414 AutoGenList.append(str(File))
4415 else:
4416 IgoredAutoGenList.append(str(File))
4417
4418 # Skip the following code for EDK I inf
4419 if self.AutoGenVersion < 0x00010005:
4420 return
4421
4422 for ModuleType in self.DepexList:
4423 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4424 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
4425 continue
4426
4427 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
4428 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
4429
4430 if len(Dpx.PostfixNotation) <> 0:
4431 self.DepexGenerated = True
4432
4433 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
4434 AutoGenList.append(str(DpxFile))
4435 else:
4436 IgoredAutoGenList.append(str(DpxFile))
4437
4438 if IgoredAutoGenList == []:
4439 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
4440 (" ".join(AutoGenList), self.Name, self.Arch))
4441 elif AutoGenList == []:
4442 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
4443 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
4444 else:
4445 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
4446 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
4447
4448 self.IsCodeFileCreated = True
4449 return AutoGenList
4450
4451 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4452 def _GetLibraryAutoGenList(self):
4453 if self._LibraryAutoGenList == None:
4454 self._LibraryAutoGenList = []
4455 for Library in self.DependentLibraryList:
4456 La = ModuleAutoGen(
4457 self.Workspace,
4458 Library.MetaFile,
4459 self.BuildTarget,
4460 self.ToolChain,
4461 self.Arch,
4462 self.PlatformInfo.MetaFile
4463 )
4464 if La not in self._LibraryAutoGenList:
4465 self._LibraryAutoGenList.append(La)
4466 for Lib in La.CodaTargetList:
4467 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
4468 return self._LibraryAutoGenList
4469
4470 def GenModuleHash(self):
4471 if self.Arch not in GlobalData.gModuleHash:
4472 GlobalData.gModuleHash[self.Arch] = {}
4473 m = hashlib.md5()
4474 # Add Platform level hash
4475 m.update(GlobalData.gPlatformHash)
4476 # Add Package level hash
4477 if self.DependentPackageList:
4478 for Pkg in self.DependentPackageList:
4479 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:
4480 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])
4481
4482 # Add Library hash
4483 if self.LibraryAutoGenList:
4484 for Lib in self.LibraryAutoGenList:
4485 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:
4486 Lib.GenModuleHash()
4487 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])
4488
4489 # Add Module self
4490 f = open(str(self.MetaFile), 'r')
4491 Content = f.read()
4492 f.close()
4493 m.update(Content)
4494 # Add Module's source files
4495 if self.SourceFileList:
4496 for File in self.SourceFileList:
4497 f = open(str(File), 'r')
4498 Content = f.read()
4499 f.close()
4500 m.update(Content)
4501
4502 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")
4503 if self.Name not in GlobalData.gModuleHash[self.Arch]:
4504 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()
4505 if GlobalData.gBinCacheSource:
4506 CacheValid = self.AttemptModuleCacheCopy()
4507 if CacheValid:
4508 return False
4509 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)
4510
4511 ## Decide whether we can skip the ModuleAutoGen process
4512 def CanSkipbyHash(self):
4513 if GlobalData.gUseHashCache:
4514 return not self.GenModuleHash()
4515
4516 ## Decide whether we can skip the ModuleAutoGen process
4517 # If any source file is newer than the module than we cannot skip
4518 #
4519 def CanSkip(self):
4520 if not os.path.exists(self.GetTimeStampPath()):
4521 return False
4522 #last creation time of the module
4523 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]
4524
4525 SrcTimeStamp = self.Workspace._SrcTimeStamp
4526 if SrcTimeStamp > DstTimeStamp:
4527 return False
4528
4529 with open(self.GetTimeStampPath(),'r') as f:
4530 for source in f:
4531 source = source.rstrip('\n')
4532 if not os.path.exists(source):
4533 return False
4534 if source not in ModuleAutoGen.TimeDict :
4535 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]
4536 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:
4537 return False
4538 return True
4539
4540 def GetTimeStampPath(self):
4541 if self._TimeStampPath == None:
4542 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')
4543 return self._TimeStampPath
4544 def CreateTimeStamp(self, Makefile):
4545
4546 FileSet = set()
4547
4548 FileSet.add (self.MetaFile.Path)
4549
4550 for SourceFile in self.Module.Sources:
4551 FileSet.add (SourceFile.Path)
4552
4553 for Lib in self.DependentLibraryList:
4554 FileSet.add (Lib.MetaFile.Path)
4555
4556 for f in self.AutoGenDepSet:
4557 FileSet.add (f.Path)
4558
4559 if os.path.exists (self.GetTimeStampPath()):
4560 os.remove (self.GetTimeStampPath())
4561 with open(self.GetTimeStampPath(), 'w+') as file:
4562 for f in FileSet:
4563 print >> file, f
4564
4565 Module = property(_GetModule)
4566 Name = property(_GetBaseName)
4567 Guid = property(_GetGuid)
4568 Version = property(_GetVersion)
4569 ModuleType = property(_GetModuleType)
4570 ComponentType = property(_GetComponentType)
4571 BuildType = property(_GetBuildType)
4572 PcdIsDriver = property(_GetPcdIsDriver)
4573 AutoGenVersion = property(_GetAutoGenVersion)
4574 Macros = property(_GetMacros)
4575 Specification = property(_GetSpecification)
4576
4577 IsLibrary = property(_IsLibrary)
4578 IsBinaryModule = property(_IsBinaryModule)
4579 BuildDir = property(_GetBuildDir)
4580 OutputDir = property(_GetOutputDir)
4581 FfsOutputDir = property(_GetFfsOutputDir)
4582 DebugDir = property(_GetDebugDir)
4583 MakeFileDir = property(_GetMakeFileDir)
4584 CustomMakefile = property(_GetCustomMakefile)
4585
4586 IncludePathList = property(_GetIncludePathList)
4587 IncludePathLength = property(_GetIncludePathLength)
4588 AutoGenFileList = property(_GetAutoGenFileList)
4589 UnicodeFileList = property(_GetUnicodeFileList)
4590 VfrFileList = property(_GetVfrFileList)
4591 SourceFileList = property(_GetSourceFileList)
4592 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
4593 Targets = property(_GetTargets)
4594 IntroTargetList = property(_GetIntroTargetList)
4595 CodaTargetList = property(_GetFinalTargetList)
4596 FileTypes = property(_GetFileTypes)
4597 BuildRules = property(_GetBuildRules)
4598 IdfFileList = property(_GetIdfFileList)
4599
4600 DependentPackageList = property(_GetDependentPackageList)
4601 DependentLibraryList = property(_GetLibraryList)
4602 LibraryAutoGenList = property(_GetLibraryAutoGenList)
4603 DerivedPackageList = property(_GetDerivedPackageList)
4604
4605 ModulePcdList = property(_GetModulePcdList)
4606 LibraryPcdList = property(_GetLibraryPcdList)
4607 GuidList = property(_GetGuidList)
4608 ProtocolList = property(_GetProtocolList)
4609 PpiList = property(_GetPpiList)
4610 DepexList = property(_GetDepexTokenList)
4611 DxsFile = property(_GetDxsFile)
4612 DepexExpressionList = property(_GetDepexExpressionTokenList)
4613 BuildOption = property(_GetModuleBuildOption)
4614 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
4615 BuildCommand = property(_GetBuildCommand)
4616
4617 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
4618
4619 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4620 if __name__ == '__main__':
4621 pass
4622