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