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


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