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