projects / mirror_edk2.git / blob
? search:


5baabf2a0c74f293648ef46e216fbef5ea8e496b
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
1 ## @file
2 # Generate AutoGen.h, AutoGen.c and *.depex files
3 #
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 ## Import Modules
15 #
16 import Common.LongFilePathOs as os
17 import re
18 import os.path as path
19 import copy
20 import uuid
21
22 import GenC
23 import GenMake
24 import GenDepex
25 from StringIO import StringIO
26
27 from StrGather import *
28 from BuildEngine import BuildRule
29
30 from Common.LongFilePathSupport import CopyLongFilePath
31 from Common.BuildToolError import *
32 from Common.DataType import *
33 from Common.Misc import *
34 from Common.String import *
35 import Common.GlobalData as GlobalData
36 from GenFds.FdfParser import *
37 from CommonDataClass.CommonClass import SkuInfoClass
38 from Workspace.BuildClassObject import *
39 from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile
40 import Common.VpdInfoFile as VpdInfoFile
41 from GenPcdDb import CreatePcdDatabaseCode
42 from Workspace.MetaFileCommentParser import UsageList
43 from Common.MultipleWorkspace import MultipleWorkspace as mws
44 import InfSectionParser
45 import datetime
46 import hashlib
47 from GenVar import VariableMgr,var_info
48 from collections import OrderedDict
49 from collections import defaultdict
50
51 ## Regular expression for splitting Dependency Expression string into tokens
52 gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")
53
54 ## Regular expression for match: PCD(xxxx.yyy)
55 gPCDAsGuidPattern = re.compile(r"^PCD\(.+\..+\)$")
56
57 #
58 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
59 # is the former use /I , the Latter used -I to specify include directories
60 #
61 gBuildOptIncludePatternMsft = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
62 gBuildOptIncludePatternOther = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
63
64 #
65 # Match name = variable
66 #
67 gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")
68 #
69 # The format of guid in efivarstore statement likes following and must be correct:
70 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
71 #
72 gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
73
74 ## Mapping Makefile type
75 gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}
76
77
78 ## Build rule configuration file
79 gDefaultBuildRuleFile = 'build_rule.txt'
80
81 ## Tools definition configuration file
82 gDefaultToolsDefFile = 'tools_def.txt'
83
84 ## Build rule default version
85 AutoGenReqBuildRuleVerNum = "0.1"
86
87 ## default file name for AutoGen
88 gAutoGenCodeFileName = "AutoGen.c"
89 gAutoGenHeaderFileName = "AutoGen.h"
90 gAutoGenStringFileName = "%(module_name)sStrDefs.h"
91 gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"
92 gAutoGenDepexFileName = "%(module_name)s.depex"
93 gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"
94 gAutoGenIdfFileName = "%(module_name)sIdf.hpk"
95 gInfSpecVersion = "0x00010017"
96
97 #
98 # Template string to generic AsBuilt INF
99 #
100 gAsBuiltInfHeaderString = TemplateString("""${header_comments}
101
102 # DO NOT EDIT
103 # FILE auto-generated
104
105 [Defines]
106 INF_VERSION = ${module_inf_version}
107 BASE_NAME = ${module_name}
108 FILE_GUID = ${module_guid}
109 MODULE_TYPE = ${module_module_type}${BEGIN}
110 VERSION_STRING = ${module_version_string}${END}${BEGIN}
111 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
112 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
113 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
114 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
115 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
116 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
117 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
118 SHADOW = ${module_shadow}${END}${BEGIN}
119 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
120 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
121 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
122 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
123 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
124 SPEC = ${module_spec}${END}${BEGIN}
125 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
126 MODULE_UNI_FILE = ${module_uni_file}${END}
127
128 [Packages.${module_arch}]${BEGIN}
129 ${package_item}${END}
130
131 [Binaries.${module_arch}]${BEGIN}
132 ${binary_item}${END}
133
134 [PatchPcd.${module_arch}]${BEGIN}
135 ${patchablepcd_item}
136 ${END}
137
138 [Protocols.${module_arch}]${BEGIN}
139 ${protocol_item}
140 ${END}
141
142 [Ppis.${module_arch}]${BEGIN}
143 ${ppi_item}
144 ${END}
145
146 [Guids.${module_arch}]${BEGIN}
147 ${guid_item}
148 ${END}
149
150 [PcdEx.${module_arch}]${BEGIN}
151 ${pcd_item}
152 ${END}
153
154 [LibraryClasses.${module_arch}]
155 ## @LIB_INSTANCES${BEGIN}
156 # ${libraryclasses_item}${END}
157
158 ${depexsection_item}
159
160 ${userextension_tianocore_item}
161
162 ${tail_comments}
163
164 [BuildOptions.${module_arch}]
165 ## @AsBuilt${BEGIN}
166 ## ${flags_item}${END}
167 """)
168
169 ## Base class for AutoGen
170 #
171 # This class just implements the cache mechanism of AutoGen objects.
172 #
173 class AutoGen(object):
174 # database to maintain the objects in each child class
175 __ObjectCache = {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object
176
177 ## Factory method
178 #
179 # @param Class class object of real AutoGen class
180 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
181 # @param Workspace Workspace directory or WorkspaceAutoGen object
182 # @param MetaFile The path of meta file
183 # @param Target Build target
184 # @param Toolchain Tool chain name
185 # @param Arch Target arch
186 # @param *args The specific class related parameters
187 # @param **kwargs The specific class related dict parameters
188 #
189 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
190 # check if the object has been created
191 Key = (Target, Toolchain, Arch, MetaFile)
192 try:
193 # if it exists, just return it directly
194 return cls.__ObjectCache[Key]
195 except:
196 # it didnt exist. create it, cache it, then return it
197 cls.__ObjectCache[Key] = super(AutoGen, cls).__new__(cls)
198 return cls.__ObjectCache[Key]
199
200 def __init__ (self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
201 super(AutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
202
203 ## hash() operator
204 #
205 # The file path of platform file will be used to represent hash value of this object
206 #
207 # @retval int Hash value of the file path of platform file
208 #
209 def __hash__(self):
210 return hash(self.MetaFile)
211
212 ## str() operator
213 #
214 # The file path of platform file will be used to represent this object
215 #
216 # @retval string String of platform file path
217 #
218 def __str__(self):
219 return str(self.MetaFile)
220
221 ## "==" operator
222 def __eq__(self, Other):
223 return Other and self.MetaFile == Other
224
225 ## Workspace AutoGen class
226 #
227 # This class is used mainly to control the whole platform build for different
228 # architecture. This class will generate top level makefile.
229 #
230 class WorkspaceAutoGen(AutoGen):
231 # call super().__init__ then call the worker function with different parameter count
232 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
233 try:
234 self._Init
235 except:
236 super(WorkspaceAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
237 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
238 self._Init = True
239
240 ## Initialize WorkspaceAutoGen
241 #
242 # @param WorkspaceDir Root directory of workspace
243 # @param ActivePlatform Meta-file of active platform
244 # @param Target Build target
245 # @param Toolchain Tool chain name
246 # @param ArchList List of architecture of current build
247 # @param MetaFileDb Database containing meta-files
248 # @param BuildConfig Configuration of build
249 # @param ToolDefinition Tool chain definitions
250 # @param FlashDefinitionFile File of flash definition
251 # @param Fds FD list to be generated
252 # @param Fvs FV list to be generated
253 # @param Caps Capsule list to be generated
254 # @param SkuId SKU id from command line
255 #
256 def _InitWorker(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,
257 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,
258 Progress=None, BuildModule=None):
259 if Fds is None:
260 Fds = []
261 if Fvs is None:
262 Fvs = []
263 if Caps is None:
264 Caps = []
265 self.BuildDatabase = MetaFileDb
266 self.MetaFile = ActivePlatform
267 self.WorkspaceDir = WorkspaceDir
268 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]
269 GlobalData.gActivePlatform = self.Platform
270 self.BuildTarget = Target
271 self.ToolChain = Toolchain
272 self.ArchList = ArchList
273 self.SkuId = SkuId
274 self.UniFlag = UniFlag
275
276 self.TargetTxt = BuildConfig
277 self.ToolDef = ToolDefinition
278 self.FdfFile = FlashDefinitionFile
279 self.FdTargetList = Fds
280 self.FvTargetList = Fvs
281 self.CapTargetList = Caps
282 self.AutoGenObjectList = []
283 self._BuildDir = None
284 self._FvDir = None
285 self._MakeFileDir = None
286 self._BuildCommand = None
287 self._GuidDict = {}
288
289 # there's many relative directory operations, so ...
290 os.chdir(self.WorkspaceDir)
291
292 #
293 # Merge Arch
294 #
295 if not self.ArchList:
296 ArchList = set(self.Platform.SupArchList)
297 else:
298 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)
299 if not ArchList:
300 EdkLogger.error("build", PARAMETER_INVALID,
301 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))
302 elif self.ArchList and len(ArchList) != len(self.ArchList):
303 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))
304 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
305 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))
306 self.ArchList = tuple(ArchList)
307
308 # Validate build target
309 if self.BuildTarget not in self.Platform.BuildTargets:
310 EdkLogger.error("build", PARAMETER_INVALID,
311 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"
312 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))
313
314
315 # parse FDF file to get PCDs in it, if any
316 if not self.FdfFile:
317 self.FdfFile = self.Platform.FlashDefinition
318
319 EdkLogger.info("")
320 if self.ArchList:
321 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))
322 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))
323 EdkLogger.info('%-16s = %s' % ("Toolchain", self.ToolChain))
324
325 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))
326 if BuildModule:
327 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))
328
329 if self.FdfFile:
330 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))
331
332 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)
333
334 if Progress:
335 Progress.Start("\nProcessing meta-data")
336
337 if self.FdfFile:
338 #
339 # Mark now build in AutoGen Phase
340 #
341 GlobalData.gAutoGenPhase = True
342 Fdf = FdfParser(self.FdfFile.Path)
343 Fdf.ParseFile()
344 GlobalData.gFdfParser = Fdf
345 GlobalData.gAutoGenPhase = False
346 PcdSet = Fdf.Profile.PcdDict
347 if Fdf.CurrentFdName and Fdf.CurrentFdName in Fdf.Profile.FdDict:
348 FdDict = Fdf.Profile.FdDict[Fdf.CurrentFdName]
349 for FdRegion in FdDict.RegionList:
350 if str(FdRegion.RegionType) is 'FILE' and self.Platform.VpdToolGuid in str(FdRegion.RegionDataList):
351 if int(FdRegion.Offset) % 8 != 0:
352 EdkLogger.error("build", FORMAT_INVALID, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion.Offset))
353 ModuleList = Fdf.Profile.InfList
354 self.FdfProfile = Fdf.Profile
355 for fvname in self.FvTargetList:
356 if fvname.upper() not in self.FdfProfile.FvDict:
357 EdkLogger.error("build", OPTION_VALUE_INVALID,
358 "No such an FV in FDF file: %s" % fvname)
359
360 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
361 # but the path (self.MetaFile.Path) is the real path
362 for key in self.FdfProfile.InfDict:
363 if key == 'ArchTBD':
364 Platform_cache = {}
365 MetaFile_cache = {}
366 for Arch in self.ArchList:
367 Platform_cache[Arch] = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
368 MetaFile_cache[Arch] = set()
369 for Pkey in Platform_cache[Arch].Modules:
370 MetaFile_cache[Arch].add(Platform_cache[Arch].Modules[Pkey].MetaFile)
371 for Inf in self.FdfProfile.InfDict[key]:
372 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
373 for Arch in self.ArchList:
374 if ModuleFile in MetaFile_cache[Arch]:
375 break
376 else:
377 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
378 if not ModuleData.IsBinaryModule:
379 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
380
381 else:
382 for Arch in self.ArchList:
383 if Arch == key:
384 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
385 MetaFileList = set()
386 for Pkey in Platform.Modules:
387 MetaFileList.add(Platform.Modules[Pkey].MetaFile)
388 for Inf in self.FdfProfile.InfDict[key]:
389 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
390 if ModuleFile in MetaFileList:
391 continue
392 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
393 if not ModuleData.IsBinaryModule:
394 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
395
396 else:
397 PcdSet = {}
398 ModuleList = []
399 self.FdfProfile = None
400 if self.FdTargetList:
401 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))
402 self.FdTargetList = []
403 if self.FvTargetList:
404 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))
405 self.FvTargetList = []
406 if self.CapTargetList:
407 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))
408 self.CapTargetList = []
409
410 # apply SKU and inject PCDs from Flash Definition file
411 for Arch in self.ArchList:
412 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
413
414 SourcePcdDict = {'DynamicEx':set(), 'PatchableInModule':set(),'Dynamic':set(),'FixedAtBuild':set()}
415 BinaryPcdDict = {'DynamicEx':set(), 'PatchableInModule':set()}
416 SourcePcdDict_Keys = SourcePcdDict.keys()
417 BinaryPcdDict_Keys = BinaryPcdDict.keys()
418
419 # generate the SourcePcdDict and BinaryPcdDict
420 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
421 for BuildData in PGen.BuildDatabase._CACHE_.values():
422 if BuildData.Arch != Arch:
423 continue
424 if BuildData.MetaFile.Ext == '.inf':
425 for key in BuildData.Pcds:
426 if BuildData.Pcds[key].Pending:
427 if key in Platform.Pcds:
428 PcdInPlatform = Platform.Pcds[key]
429 if PcdInPlatform.Type not in [None, '']:
430 BuildData.Pcds[key].Type = PcdInPlatform.Type
431
432 if BuildData.MetaFile in Platform.Modules:
433 PlatformModule = Platform.Modules[str(BuildData.MetaFile)]
434 if key in PlatformModule.Pcds:
435 PcdInPlatform = PlatformModule.Pcds[key]
436 if PcdInPlatform.Type not in [None, '']:
437 BuildData.Pcds[key].Type = PcdInPlatform.Type
438
439 if 'DynamicEx' in BuildData.Pcds[key].Type:
440 if BuildData.IsBinaryModule:
441 BinaryPcdDict['DynamicEx'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
442 else:
443 SourcePcdDict['DynamicEx'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
444
445 elif 'PatchableInModule' in BuildData.Pcds[key].Type:
446 if BuildData.MetaFile.Ext == '.inf':
447 if BuildData.IsBinaryModule:
448 BinaryPcdDict['PatchableInModule'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
449 else:
450 SourcePcdDict['PatchableInModule'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
451
452 elif 'Dynamic' in BuildData.Pcds[key].Type:
453 SourcePcdDict['Dynamic'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
454 elif 'FixedAtBuild' in BuildData.Pcds[key].Type:
455 SourcePcdDict['FixedAtBuild'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
456 else:
457 pass
458 #
459 # A PCD can only use one type for all source modules
460 #
461 for i in SourcePcdDict_Keys:
462 for j in SourcePcdDict_Keys:
463 if i != j:
464 Intersections = SourcePcdDict[i].intersection(SourcePcdDict[j])
465 if len(Intersections) > 0:
466 EdkLogger.error(
467 'build',
468 FORMAT_INVALID,
469 "Building modules from source INFs, following PCD use %s and %s access method. It must be corrected to use only one access method." % (i, j),
470 ExtraData="%s" % '\n\t'.join([str(P[1]+'.'+P[0]) for P in Intersections])
471 )
472
473 #
474 # intersection the BinaryPCD for Mixed PCD
475 #
476 for i in BinaryPcdDict_Keys:
477 for j in BinaryPcdDict_Keys:
478 if i != j:
479 Intersections = BinaryPcdDict[i].intersection(BinaryPcdDict[j])
480 for item in Intersections:
481 NewPcd1 = (item[0] + '_' + i, item[1])
482 NewPcd2 = (item[0] + '_' + j, item[1])
483 if item not in GlobalData.MixedPcd:
484 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
485 else:
486 if NewPcd1 not in GlobalData.MixedPcd[item]:
487 GlobalData.MixedPcd[item].append(NewPcd1)
488 if NewPcd2 not in GlobalData.MixedPcd[item]:
489 GlobalData.MixedPcd[item].append(NewPcd2)
490
491 #
492 # intersection the SourcePCD and BinaryPCD for Mixed PCD
493 #
494 for i in SourcePcdDict_Keys:
495 for j in BinaryPcdDict_Keys:
496 if i != j:
497 Intersections = SourcePcdDict[i].intersection(BinaryPcdDict[j])
498 for item in Intersections:
499 NewPcd1 = (item[0] + '_' + i, item[1])
500 NewPcd2 = (item[0] + '_' + j, item[1])
501 if item not in GlobalData.MixedPcd:
502 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
503 else:
504 if NewPcd1 not in GlobalData.MixedPcd[item]:
505 GlobalData.MixedPcd[item].append(NewPcd1)
506 if NewPcd2 not in GlobalData.MixedPcd[item]:
507 GlobalData.MixedPcd[item].append(NewPcd2)
508
509 for BuildData in PGen.BuildDatabase._CACHE_.values():
510 if BuildData.Arch != Arch:
511 continue
512 for key in BuildData.Pcds:
513 for SinglePcd in GlobalData.MixedPcd:
514 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
515 for item in GlobalData.MixedPcd[SinglePcd]:
516 Pcd_Type = item[0].split('_')[-1]
517 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in GenC.gDynamicExPcd) or \
518 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in GenC.gDynamicPcd):
519 Value = BuildData.Pcds[key]
520 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type
521 if len(key) == 2:
522 newkey = (Value.TokenCName, key[1])
523 elif len(key) == 3:
524 newkey = (Value.TokenCName, key[1], key[2])
525 del BuildData.Pcds[key]
526 BuildData.Pcds[newkey] = Value
527 break
528 break
529
530 # handle the mixed pcd in FDF file
531 for key in PcdSet:
532 if key in GlobalData.MixedPcd:
533 Value = PcdSet[key]
534 del PcdSet[key]
535 for item in GlobalData.MixedPcd[key]:
536 PcdSet[item] = Value
537
538 #Collect package set information from INF of FDF
539 PkgSet = set()
540 for Inf in ModuleList:
541 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
542 if ModuleFile in Platform.Modules:
543 continue
544 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
545 PkgSet.update(ModuleData.Packages)
546 Pkgs = list(PkgSet) + list(PGen.PackageList)
547 DecPcds = set()
548 DecPcdsKey = set()
549 for Pkg in Pkgs:
550 for Pcd in Pkg.Pcds:
551 DecPcds.add((Pcd[0], Pcd[1]))
552 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))
553
554 Platform.SkuName = self.SkuId
555 for Name, Guid in PcdSet:
556 if (Name, Guid) not in DecPcds:
557 EdkLogger.error(
558 'build',
559 PARSER_ERROR,
560 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),
561 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
562 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
563 )
564 else:
565 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
566 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \
567 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \
568 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:
569 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])
570 continue
571 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:
572 EdkLogger.error(
573 'build',
574 PARSER_ERROR,
575 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),
576 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
577 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
578 )
579
580 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
581 #
582 # Explicitly collect platform's dynamic PCDs
583 #
584 Pa.CollectPlatformDynamicPcds()
585 Pa.CollectFixedAtBuildPcds()
586 self.AutoGenObjectList.append(Pa)
587
588 #
589 # Generate Package level hash value
590 #
591 GlobalData.gPackageHash[Arch] = {}
592 if GlobalData.gUseHashCache:
593 for Pkg in Pkgs:
594 self._GenPkgLevelHash(Pkg)
595
596 #
597 # Check PCDs token value conflict in each DEC file.
598 #
599 self._CheckAllPcdsTokenValueConflict()
600
601 #
602 # Check PCD type and definition between DSC and DEC
603 #
604 self._CheckPcdDefineAndType()
605
606 # if self.FdfFile:
607 # self._CheckDuplicateInFV(Fdf)
608
609 #
610 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
611 #
612 content = 'gCommandLineDefines: '
613 content += str(GlobalData.gCommandLineDefines)
614 content += os.linesep
615 content += 'BuildOptionPcd: '
616 content += str(GlobalData.BuildOptionPcd)
617 content += os.linesep
618 content += 'Active Platform: '
619 content += str(self.Platform)
620 content += os.linesep
621 if self.FdfFile:
622 content += 'Flash Image Definition: '
623 content += str(self.FdfFile)
624 content += os.linesep
625 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)
626
627 #
628 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
629 #
630 PcdTokenNumber = 'PcdTokenNumber: '
631 if Pa.PcdTokenNumber:
632 if Pa.DynamicPcdList:
633 for Pcd in Pa.DynamicPcdList:
634 PcdTokenNumber += os.linesep
635 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))
636 PcdTokenNumber += ' : '
637 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])
638 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)
639
640 #
641 # Get set of workspace metafiles
642 #
643 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)
644
645 #
646 # Retrieve latest modified time of all metafiles
647 #
648 SrcTimeStamp = 0
649 for f in AllWorkSpaceMetaFiles:
650 if os.stat(f)[8] > SrcTimeStamp:
651 SrcTimeStamp = os.stat(f)[8]
652 self._SrcTimeStamp = SrcTimeStamp
653
654 if GlobalData.gUseHashCache:
655 m = hashlib.md5()
656 for files in AllWorkSpaceMetaFiles:
657 if files.endswith('.dec'):
658 continue
659 f = open(files, 'r')
660 Content = f.read()
661 f.close()
662 m.update(Content)
663 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)
664 GlobalData.gPlatformHash = m.hexdigest()
665
666 #
667 # Write metafile list to build directory
668 #
669 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')
670 if os.path.exists (AutoGenFilePath):
671 os.remove(AutoGenFilePath)
672 if not os.path.exists(self.BuildDir):
673 os.makedirs(self.BuildDir)
674 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:
675 for f in AllWorkSpaceMetaFiles:
676 print >> file, f
677 return True
678
679 def _GenPkgLevelHash(self, Pkg):
680 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)
681 CreateDirectory(PkgDir)
682 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')
683 m = hashlib.md5()
684 # Get .dec file's hash value
685 f = open(Pkg.MetaFile.Path, 'r')
686 Content = f.read()
687 f.close()
688 m.update(Content)
689 # Get include files hash value
690 if Pkg.Includes:
691 for inc in Pkg.Includes:
692 for Root, Dirs, Files in os.walk(str(inc)):
693 for File in Files:
694 File_Path = os.path.join(Root, File)
695 f = open(File_Path, 'r')
696 Content = f.read()
697 f.close()
698 m.update(Content)
699 SaveFileOnChange(HashFile, m.hexdigest(), True)
700 if Pkg.PackageName not in GlobalData.gPackageHash[Pkg.Arch]:
701 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()
702
703 def _GetMetaFiles(self, Target, Toolchain, Arch):
704 AllWorkSpaceMetaFiles = set()
705 #
706 # add fdf
707 #
708 if self.FdfFile:
709 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)
710 if self.FdfFile:
711 FdfFiles = GlobalData.gFdfParser.GetAllIncludedFile()
712 for f in FdfFiles:
713 AllWorkSpaceMetaFiles.add (f.FileName)
714 #
715 # add dsc
716 #
717 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)
718
719 #
720 # add build_rule.txt & tools_def.txt
721 #
722 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))
723 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))
724
725 # add BuildOption metafile
726 #
727 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))
728
729 # add PcdToken Number file for Dynamic/DynamicEx Pcd
730 #
731 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))
732
733 for Arch in self.ArchList:
734 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
735 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
736
737 #
738 # add dec
739 #
740 for Package in PGen.PackageList:
741 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)
742
743 #
744 # add included dsc
745 #
746 for filePath in Platform._RawData.IncludedFiles:
747 AllWorkSpaceMetaFiles.add(filePath.Path)
748
749 return AllWorkSpaceMetaFiles
750
751 ## _CheckDuplicateInFV() method
752 #
753 # Check whether there is duplicate modules/files exist in FV section.
754 # The check base on the file GUID;
755 #
756 def _CheckDuplicateInFV(self, Fdf):
757 for Fv in Fdf.Profile.FvDict:
758 _GuidDict = {}
759 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:
760 if FfsFile.InfFileName and FfsFile.NameGuid is None:
761 #
762 # Get INF file GUID
763 #
764 InfFoundFlag = False
765 for Pa in self.AutoGenObjectList:
766 if InfFoundFlag:
767 break
768 for Module in Pa.ModuleAutoGenList:
769 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):
770 InfFoundFlag = True
771 if not Module.Guid.upper() in _GuidDict.keys():
772 _GuidDict[Module.Guid.upper()] = FfsFile
773 break
774 else:
775 EdkLogger.error("build",
776 FORMAT_INVALID,
777 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
778 FfsFile.CurrentLineContent,
779 _GuidDict[Module.Guid.upper()].CurrentLineNum,
780 _GuidDict[Module.Guid.upper()].CurrentLineContent,
781 Module.Guid.upper()),
782 ExtraData=self.FdfFile)
783 #
784 # Some INF files not have entity in DSC file.
785 #
786 if not InfFoundFlag:
787 if FfsFile.InfFileName.find('$') == -1:
788 InfPath = NormPath(FfsFile.InfFileName)
789 if not os.path.exists(InfPath):
790 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))
791
792 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)
793 #
794 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
795 # BuildObject from one of AutoGenObjectList is enough.
796 #
797 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]
798 if not InfObj.Guid.upper() in _GuidDict.keys():
799 _GuidDict[InfObj.Guid.upper()] = FfsFile
800 else:
801 EdkLogger.error("build",
802 FORMAT_INVALID,
803 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
804 FfsFile.CurrentLineContent,
805 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,
806 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,
807 InfObj.Guid.upper()),
808 ExtraData=self.FdfFile)
809 InfFoundFlag = False
810
811 if FfsFile.NameGuid is not None:
812 #
813 # If the NameGuid reference a PCD name.
814 # The style must match: PCD(xxxx.yyy)
815 #
816 if gPCDAsGuidPattern.match(FfsFile.NameGuid):
817 #
818 # Replace the PCD value.
819 #
820 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")
821 PcdFoundFlag = False
822 for Pa in self.AutoGenObjectList:
823 if not PcdFoundFlag:
824 for PcdItem in Pa.AllPcdList:
825 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:
826 #
827 # First convert from CFormatGuid to GUID string
828 #
829 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)
830
831 if not _PcdGuidString:
832 #
833 # Then try Byte array.
834 #
835 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)
836
837 if not _PcdGuidString:
838 #
839 # Not Byte array or CFormat GUID, raise error.
840 #
841 EdkLogger.error("build",
842 FORMAT_INVALID,
843 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName, PcdItem.DefaultValue),
844 ExtraData=self.FdfFile)
845
846 if not _PcdGuidString.upper() in _GuidDict.keys():
847 _GuidDict[_PcdGuidString.upper()] = FfsFile
848 PcdFoundFlag = True
849 break
850 else:
851 EdkLogger.error("build",
852 FORMAT_INVALID,
853 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
854 FfsFile.CurrentLineContent,
855 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,
856 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,
857 FfsFile.NameGuid.upper()),
858 ExtraData=self.FdfFile)
859
860 if not FfsFile.NameGuid.upper() in _GuidDict.keys():
861 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile
862 else:
863 #
864 # Two raw file GUID conflict.
865 #
866 EdkLogger.error("build",
867 FORMAT_INVALID,
868 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
869 FfsFile.CurrentLineContent,
870 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,
871 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,
872 FfsFile.NameGuid.upper()),
873 ExtraData=self.FdfFile)
874
875
876 def _CheckPcdDefineAndType(self):
877 PcdTypeList = [
878 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
879 "Dynamic", #"DynamicHii", "DynamicVpd",
880 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
881 ]
882
883 # This dict store PCDs which are not used by any modules with specified arches
884 UnusedPcd = OrderedDict()
885 for Pa in self.AutoGenObjectList:
886 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
887 for Pcd in Pa.Platform.Pcds:
888 PcdType = Pa.Platform.Pcds[Pcd].Type
889
890 # If no PCD type, this PCD comes from FDF
891 if not PcdType:
892 continue
893
894 # Try to remove Hii and Vpd suffix
895 if PcdType.startswith("DynamicEx"):
896 PcdType = "DynamicEx"
897 elif PcdType.startswith("Dynamic"):
898 PcdType = "Dynamic"
899
900 for Package in Pa.PackageList:
901 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
902 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:
903 break
904 for Type in PcdTypeList:
905 if (Pcd[0], Pcd[1], Type) in Package.Pcds:
906 EdkLogger.error(
907 'build',
908 FORMAT_INVALID,
909 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
910 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),
911 ExtraData=None
912 )
913 return
914 else:
915 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)
916
917 for Pcd in UnusedPcd:
918 EdkLogger.warn(
919 'build',
920 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
921 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
922 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),
923 ExtraData=None
924 )
925
926 def __repr__(self):
927 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))
928
929 ## Return the directory to store FV files
930 def _GetFvDir(self):
931 if self._FvDir is None:
932 self._FvDir = path.join(self.BuildDir, 'FV')
933 return self._FvDir
934
935 ## Return the directory to store all intermediate and final files built
936 def _GetBuildDir(self):
937 if self._BuildDir is None:
938 return self.AutoGenObjectList[0].BuildDir
939
940 ## Return the build output directory platform specifies
941 def _GetOutputDir(self):
942 return self.Platform.OutputDirectory
943
944 ## Return platform name
945 def _GetName(self):
946 return self.Platform.PlatformName
947
948 ## Return meta-file GUID
949 def _GetGuid(self):
950 return self.Platform.Guid
951
952 ## Return platform version
953 def _GetVersion(self):
954 return self.Platform.Version
955
956 ## Return paths of tools
957 def _GetToolDefinition(self):
958 return self.AutoGenObjectList[0].ToolDefinition
959
960 ## Return directory of platform makefile
961 #
962 # @retval string Makefile directory
963 #
964 def _GetMakeFileDir(self):
965 if self._MakeFileDir is None:
966 self._MakeFileDir = self.BuildDir
967 return self._MakeFileDir
968
969 ## Return build command string
970 #
971 # @retval string Build command string
972 #
973 def _GetBuildCommand(self):
974 if self._BuildCommand is None:
975 # BuildCommand should be all the same. So just get one from platform AutoGen
976 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand
977 return self._BuildCommand
978
979 ## Check the PCDs token value conflict in each DEC file.
980 #
981 # Will cause build break and raise error message while two PCDs conflict.
982 #
983 # @return None
984 #
985 def _CheckAllPcdsTokenValueConflict(self):
986 for Pa in self.AutoGenObjectList:
987 for Package in Pa.PackageList:
988 PcdList = Package.Pcds.values()
989 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0)))
990 Count = 0
991 while (Count < len(PcdList) - 1) :
992 Item = PcdList[Count]
993 ItemNext = PcdList[Count + 1]
994 #
995 # Make sure in the same token space the TokenValue should be unique
996 #
997 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):
998 SameTokenValuePcdList = []
999 SameTokenValuePcdList.append(Item)
1000 SameTokenValuePcdList.append(ItemNext)
1001 RemainPcdListLength = len(PcdList) - Count - 2
1002 for ValueSameCount in range(RemainPcdListLength):
1003 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):
1004 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])
1005 else:
1006 break;
1007 #
1008 # Sort same token value PCD list with TokenGuid and TokenCName
1009 #
1010 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1011 SameTokenValuePcdListCount = 0
1012 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):
1013 Flag = False
1014 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]
1015 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]
1016
1017 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):
1018 for PcdItem in GlobalData.MixedPcd:
1019 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \
1020 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
1021 Flag = True
1022 if not Flag:
1023 EdkLogger.error(
1024 'build',
1025 FORMAT_INVALID,
1026 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1027 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),
1028 ExtraData=None
1029 )
1030 SameTokenValuePcdListCount += 1
1031 Count += SameTokenValuePcdListCount
1032 Count += 1
1033
1034 PcdList = Package.Pcds.values()
1035 PcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1036 Count = 0
1037 while (Count < len(PcdList) - 1) :
1038 Item = PcdList[Count]
1039 ItemNext = PcdList[Count + 1]
1040 #
1041 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1042 #
1043 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):
1044 EdkLogger.error(
1045 'build',
1046 FORMAT_INVALID,
1047 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1048 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),
1049 ExtraData=None
1050 )
1051 Count += 1
1052 ## Generate fds command
1053 def _GenFdsCommand(self):
1054 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()
1055
1056 ## Create makefile for the platform and modules in it
1057 #
1058 # @param CreateDepsMakeFile Flag indicating if the makefile for
1059 # modules will be created as well
1060 #
1061 def CreateMakeFile(self, CreateDepsMakeFile=False):
1062 if CreateDepsMakeFile:
1063 for Pa in self.AutoGenObjectList:
1064 Pa.CreateMakeFile(CreateDepsMakeFile)
1065
1066 ## Create autogen code for platform and modules
1067 #
1068 # Since there's no autogen code for platform, this method will do nothing
1069 # if CreateModuleCodeFile is set to False.
1070 #
1071 # @param CreateDepsCodeFile Flag indicating if creating module's
1072 # autogen code file or not
1073 #
1074 def CreateCodeFile(self, CreateDepsCodeFile=False):
1075 if not CreateDepsCodeFile:
1076 return
1077 for Pa in self.AutoGenObjectList:
1078 Pa.CreateCodeFile(CreateDepsCodeFile)
1079
1080 ## Create AsBuilt INF file the platform
1081 #
1082 def CreateAsBuiltInf(self):
1083 return
1084
1085 Name = property(_GetName)
1086 Guid = property(_GetGuid)
1087 Version = property(_GetVersion)
1088 OutputDir = property(_GetOutputDir)
1089
1090 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
1091
1092 BuildDir = property(_GetBuildDir)
1093 FvDir = property(_GetFvDir)
1094 MakeFileDir = property(_GetMakeFileDir)
1095 BuildCommand = property(_GetBuildCommand)
1096 GenFdsCommand = property(_GenFdsCommand)
1097
1098 ## AutoGen class for platform
1099 #
1100 # PlatformAutoGen class will process the original information in platform
1101 # file in order to generate makefile for platform.
1102 #
1103 class PlatformAutoGen(AutoGen):
1104 # call super().__init__ then call the worker function with different parameter count
1105 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
1106 try:
1107 self._Init
1108 except:
1109 super(PlatformAutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
1110 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch)
1111 self._Init = True
1112 #
1113 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1114 # correct PCD database
1115 #
1116 _DynaPcdList_ = []
1117 _NonDynaPcdList_ = []
1118 _PlatformPcds = {}
1119
1120 #
1121 # The priority list while override build option
1122 #
1123 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1124 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1125 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1126 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1127 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1128 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1129 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1130 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1131 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1132 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1133 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1134 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1135 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1136 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1137 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1138 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1139
1140 ## Initialize PlatformAutoGen
1141 #
1142 #
1143 # @param Workspace WorkspaceAutoGen object
1144 # @param PlatformFile Platform file (DSC file)
1145 # @param Target Build target (DEBUG, RELEASE)
1146 # @param Toolchain Name of tool chain
1147 # @param Arch arch of the platform supports
1148 #
1149 def _InitWorker(self, Workspace, PlatformFile, Target, Toolchain, Arch):
1150 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))
1151 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)
1152
1153 self.MetaFile = PlatformFile
1154 self.Workspace = Workspace
1155 self.WorkspaceDir = Workspace.WorkspaceDir
1156 self.ToolChain = Toolchain
1157 self.BuildTarget = Target
1158 self.Arch = Arch
1159 self.SourceDir = PlatformFile.SubDir
1160 self.SourceOverrideDir = None
1161 self.FdTargetList = self.Workspace.FdTargetList
1162 self.FvTargetList = self.Workspace.FvTargetList
1163 self.AllPcdList = []
1164 # get the original module/package/platform objects
1165 self.BuildDatabase = Workspace.BuildDatabase
1166 self.DscBuildDataObj = Workspace.Platform
1167 self._GuidDict = Workspace._GuidDict
1168
1169 # flag indicating if the makefile/C-code file has been created or not
1170 self.IsMakeFileCreated = False
1171 self.IsCodeFileCreated = False
1172
1173 self._Platform = None
1174 self._Name = None
1175 self._Guid = None
1176 self._Version = None
1177
1178 self._BuildRule = None
1179 self._SourceDir = None
1180 self._BuildDir = None
1181 self._OutputDir = None
1182 self._FvDir = None
1183 self._MakeFileDir = None
1184 self._FdfFile = None
1185
1186 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1187 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1188 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1189 self._NonDynamicPcdDict = {}
1190
1191 self._ToolDefinitions = None
1192 self._ToolDefFile = None # toolcode : tool path
1193 self._ToolChainFamily = None
1194 self._BuildRuleFamily = None
1195 self._BuildOption = None # toolcode : option
1196 self._EdkBuildOption = None # edktoolcode : option
1197 self._EdkIIBuildOption = None # edkiitoolcode : option
1198 self._PackageList = None
1199 self._ModuleAutoGenList = None
1200 self._LibraryAutoGenList = None
1201 self._BuildCommand = None
1202 self._AsBuildInfList = []
1203 self._AsBuildModuleList = []
1204
1205 self.VariableInfo = None
1206
1207 if GlobalData.gFdfParser is not None:
1208 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList
1209 for Inf in self._AsBuildInfList:
1210 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)
1211 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1212 if not M.IsSupportedArch:
1213 continue
1214 self._AsBuildModuleList.append(InfClass)
1215 # get library/modules for build
1216 self.LibraryBuildDirectoryList = []
1217 self.ModuleBuildDirectoryList = []
1218
1219 return True
1220
1221 def __repr__(self):
1222 return "%s [%s]" % (self.MetaFile, self.Arch)
1223
1224 ## Create autogen code for platform and modules
1225 #
1226 # Since there's no autogen code for platform, this method will do nothing
1227 # if CreateModuleCodeFile is set to False.
1228 #
1229 # @param CreateModuleCodeFile Flag indicating if creating module's
1230 # autogen code file or not
1231 #
1232 def CreateCodeFile(self, CreateModuleCodeFile=False):
1233 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1234 if self.IsCodeFileCreated or not CreateModuleCodeFile:
1235 return
1236
1237 for Ma in self.ModuleAutoGenList:
1238 Ma.CreateCodeFile(True)
1239
1240 # don't do this twice
1241 self.IsCodeFileCreated = True
1242
1243 ## Generate Fds Command
1244 def _GenFdsCommand(self):
1245 return self.Workspace.GenFdsCommand
1246
1247 ## Create makefile for the platform and mdoules in it
1248 #
1249 # @param CreateModuleMakeFile Flag indicating if the makefile for
1250 # modules will be created as well
1251 #
1252 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):
1253 if CreateModuleMakeFile:
1254 for ModuleFile in self.Platform.Modules:
1255 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,
1256 self.ToolChain, self.Arch, self.MetaFile)
1257 if (ModuleFile.File, self.Arch) in FfsCommand:
1258 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])
1259 else:
1260 Ma.CreateMakeFile(True)
1261 #Ma.CreateAsBuiltInf()
1262
1263 # no need to create makefile for the platform more than once
1264 if self.IsMakeFileCreated:
1265 return
1266
1267 # create library/module build dirs for platform
1268 Makefile = GenMake.PlatformMakefile(self)
1269 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()
1270 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()
1271
1272 self.IsMakeFileCreated = True
1273
1274 ## Deal with Shared FixedAtBuild Pcds
1275 #
1276 def CollectFixedAtBuildPcds(self):
1277 for LibAuto in self.LibraryAutoGenList:
1278 FixedAtBuildPcds = {}
1279 ShareFixedAtBuildPcdsSameValue = {}
1280 for Module in LibAuto._ReferenceModules:
1281 for Pcd in Module.FixedAtBuildPcds + 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 FdfModuleList = []
1392 for InfName in self._AsBuildInfList:
1393 InfName = mws.join(self.WorkspaceDir, InfName)
1394 FdfModuleList.append(os.path.normpath(InfName))
1395 for F in self.Platform.Modules.keys():
1396 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
1397 #GuidValue.update(M.Guids)
1398
1399 self.Platform.Modules[F].M = M
1400
1401 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:
1402 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1403 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1404 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
1405
1406 # Check the PCD from Binary INF or Source INF
1407 if M.IsBinaryModule == True:
1408 PcdFromModule.IsFromBinaryInf = True
1409
1410 # Check the PCD from DSC or not
1411 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
1412 PcdFromModule.IsFromDsc = True
1413 else:
1414 PcdFromModule.IsFromDsc = False
1415 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
1416 if F.Path not in FdfModuleList:
1417 # If one of the Source built modules listed in the DSC is not listed
1418 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1419 # access method (it is only listed in the DEC file that declares the
1420 # PCD as PcdsDynamic), then build tool will report warning message
1421 # notify the PI that they are attempting to build a module that must
1422 # be included in a flash image in order to be functional. These Dynamic
1423 # PCD will not be added into the Database unless it is used by other
1424 # modules that are included in the FDF file.
1425 if PcdFromModule.Type in GenC.gDynamicPcd and \
1426 PcdFromModule.IsFromBinaryInf == False:
1427 # Print warning message to let the developer make a determine.
1428 continue
1429 # If one of the Source built modules listed in the DSC is not listed in
1430 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1431 # access method (it is only listed in the DEC file that declares the
1432 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1433 # PCD to the Platform's PCD Database.
1434 if PcdFromModule.Type in GenC.gDynamicExPcd:
1435 continue
1436 #
1437 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1438 # it should be stored in Pcd PEI database, If a dynamic only
1439 # used by DXE module, it should be stored in DXE PCD database.
1440 # The default Phase is DXE
1441 #
1442 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1443 PcdFromModule.Phase = "PEI"
1444 if PcdFromModule not in self._DynaPcdList_:
1445 self._DynaPcdList_.append(PcdFromModule)
1446 elif PcdFromModule.Phase == 'PEI':
1447 # overwrite any the same PCD existing, if Phase is PEI
1448 Index = self._DynaPcdList_.index(PcdFromModule)
1449 self._DynaPcdList_[Index] = PcdFromModule
1450 elif PcdFromModule not in self._NonDynaPcdList_:
1451 self._NonDynaPcdList_.append(PcdFromModule)
1452 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1453 Index = self._NonDynaPcdList_.index(PcdFromModule)
1454 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1455 #The PCD from Binary INF will override the same one from source INF
1456 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1457 PcdFromModule.Pending = False
1458 self._NonDynaPcdList_.append (PcdFromModule)
1459 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1460 DscModuleList = []
1461 for ModuleInf in self.Platform.Modules.keys():
1462 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1463 # add the PCD from modules that listed in FDF but not in DSC to Database
1464 for InfName in FdfModuleList:
1465 if InfName not in DscModuleList:
1466 InfClass = PathClass(InfName)
1467 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1468 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1469 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1470 # For binary module, if in current arch, we need to list the PCDs into database.
1471 if not M.IsSupportedArch:
1472 continue
1473 # Override the module PCD setting by platform setting
1474 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1475 for PcdFromModule in ModulePcdList:
1476 PcdFromModule.IsFromBinaryInf = True
1477 PcdFromModule.IsFromDsc = False
1478 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1479 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1480 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1481 File=self.MetaFile,
1482 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1483 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1484 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1485 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1486 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1487 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1488 PcdFromModule.Phase = "PEI"
1489 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1490 self._DynaPcdList_.append(PcdFromModule)
1491 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1492 self._NonDynaPcdList_.append(PcdFromModule)
1493 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1494 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1495 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1496 # module & DXE module at a same time.
1497 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1498 # INF file as DynamicEx.
1499 Index = self._DynaPcdList_.index(PcdFromModule)
1500 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1501 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1502 for PcdFromModule in self._NonDynaPcdList_:
1503 # If a PCD is not listed in the DSC file, but binary INF files used by
1504 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1505 # section, AND all source INF files used by this platform the build
1506 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1507 # section, then the tools must NOT add the PCD to the Platform's PCD
1508 # Database; the build must assign the access method for this PCD as
1509 # PcdsPatchableInModule.
1510 if PcdFromModule not in self._DynaPcdList_:
1511 continue
1512 Index = self._DynaPcdList_.index(PcdFromModule)
1513 if PcdFromModule.IsFromDsc == False and \
1514 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1515 PcdFromModule.IsFromBinaryInf == True and \
1516 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1517 Index = self._DynaPcdList_.index(PcdFromModule)
1518 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1519
1520 # print out error information and break the build, if error found
1521 if len(NoDatumTypePcdList) > 0:
1522 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1523 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1524 File=self.MetaFile,
1525 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1526 % NoDatumTypePcdListString)
1527 self._NonDynamicPcdList = self._NonDynaPcdList_
1528 self._DynamicPcdList = self._DynaPcdList_
1529 #
1530 # Sort dynamic PCD list to:
1531 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1532 # try to be put header of dynamicd List
1533 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1534 #
1535 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1536 #
1537 UnicodePcdArray = set()
1538 HiiPcdArray = set()
1539 OtherPcdArray = set()
1540 VpdPcdDict = {}
1541 VpdFile = VpdInfoFile.VpdInfoFile()
1542 NeedProcessVpdMapFile = False
1543
1544 for pcd in self.Platform.Pcds.keys():
1545 if pcd not in self._PlatformPcds.keys():
1546 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]
1547
1548 for item in self._PlatformPcds:
1549 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1550 self._PlatformPcds[item].DatumType = "VOID*"
1551
1552 if (self.Workspace.ArchList[-1] == self.Arch):
1553 for Pcd in self._DynamicPcdList:
1554 # just pick the a value to determine whether is unicode string type
1555 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1556 Sku.VpdOffset = Sku.VpdOffset.strip()
1557
1558 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1559 Pcd.DatumType = "VOID*"
1560
1561 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1562 # if found HII type PCD then insert to right of UnicodeIndex
1563 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1564 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1565
1566 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1567 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1568 if PcdNvStoreDfBuffer:
1569 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)
1570 vardump = self.VariableInfo.dump()
1571 if vardump:
1572 PcdNvStoreDfBuffer.DefaultValue = vardump
1573 for skuname in PcdNvStoreDfBuffer.SkuInfoList:
1574 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump
1575 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))
1576
1577 PlatformPcds = self._PlatformPcds.keys()
1578 PlatformPcds.sort()
1579 #
1580 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1581 #
1582 VpdSkuMap = {}
1583 for PcdKey in PlatformPcds:
1584 Pcd = self._PlatformPcds[PcdKey]
1585 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1586 PcdKey in VpdPcdDict:
1587 Pcd = VpdPcdDict[PcdKey]
1588 SkuValueMap = {}
1589 DefaultSku = Pcd.SkuInfoList.get('DEFAULT')
1590 if DefaultSku:
1591 PcdValue = DefaultSku.DefaultValue
1592 if PcdValue not in SkuValueMap:
1593 SkuValueMap[PcdValue] = []
1594 VpdFile.Add(Pcd, 'DEFAULT',DefaultSku.VpdOffset)
1595 SkuValueMap[PcdValue].append(DefaultSku)
1596
1597 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1598 Sku.VpdOffset = Sku.VpdOffset.strip()
1599 PcdValue = Sku.DefaultValue
1600 if PcdValue == "":
1601 PcdValue = Pcd.DefaultValue
1602 if Sku.VpdOffset != '*':
1603 if PcdValue.startswith("{"):
1604 Alignment = 8
1605 elif PcdValue.startswith("L"):
1606 Alignment = 2
1607 else:
1608 Alignment = 1
1609 try:
1610 VpdOffset = int(Sku.VpdOffset)
1611 except:
1612 try:
1613 VpdOffset = int(Sku.VpdOffset, 16)
1614 except:
1615 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1616 if VpdOffset % Alignment != 0:
1617 if PcdValue.startswith("{"):
1618 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)
1619 else:
1620 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))
1621 if PcdValue not in SkuValueMap:
1622 SkuValueMap[PcdValue] = []
1623 VpdFile.Add(Pcd, SkuName,Sku.VpdOffset)
1624 SkuValueMap[PcdValue].append(Sku)
1625 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1626 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1627 NeedProcessVpdMapFile = True
1628 if self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == '':
1629 EdkLogger.error("Build", FILE_NOT_FOUND, \
1630 "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1631
1632 VpdSkuMap[PcdKey] = SkuValueMap
1633 #
1634 # Fix the PCDs define in VPD PCD section that never referenced by module.
1635 # An example is PCD for signature usage.
1636 #
1637 for DscPcd in PlatformPcds:
1638 DscPcdEntry = self._PlatformPcds[DscPcd]
1639 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1640 if not (self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == ''):
1641 FoundFlag = False
1642 for VpdPcd in VpdFile._VpdArray.keys():
1643 # This PCD has been referenced by module
1644 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1645 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1646 FoundFlag = True
1647
1648 # Not found, it should be signature
1649 if not FoundFlag :
1650 # just pick the a value to determine whether is unicode string type
1651 SkuValueMap = {}
1652 SkuObjList = DscPcdEntry.SkuInfoList.items()
1653 DefaultSku = DscPcdEntry.SkuInfoList.get('DEFAULT')
1654 if DefaultSku:
1655 defaultindex = SkuObjList.index(('DEFAULT',DefaultSku))
1656 SkuObjList[0],SkuObjList[defaultindex] = SkuObjList[defaultindex],SkuObjList[0]
1657 for (SkuName,Sku) in SkuObjList:
1658 Sku.VpdOffset = Sku.VpdOffset.strip()
1659
1660 # Need to iterate DEC pcd information to get the value & datumtype
1661 for eachDec in self.PackageList:
1662 for DecPcd in eachDec.Pcds:
1663 DecPcdEntry = eachDec.Pcds[DecPcd]
1664 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1665 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1666 # Print warning message to let the developer make a determine.
1667 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1668 File=self.MetaFile, \
1669 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1670 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1671
1672 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1673 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1674 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1675 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1676 # Only fix the value while no value provided in DSC file.
1677 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1678 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1679
1680 if DscPcdEntry not in self._DynamicPcdList:
1681 self._DynamicPcdList.append(DscPcdEntry)
1682 Sku.VpdOffset = Sku.VpdOffset.strip()
1683 PcdValue = Sku.DefaultValue
1684 if PcdValue == "":
1685 PcdValue = DscPcdEntry.DefaultValue
1686 if Sku.VpdOffset != '*':
1687 if PcdValue.startswith("{"):
1688 Alignment = 8
1689 elif PcdValue.startswith("L"):
1690 Alignment = 2
1691 else:
1692 Alignment = 1
1693 try:
1694 VpdOffset = int(Sku.VpdOffset)
1695 except:
1696 try:
1697 VpdOffset = int(Sku.VpdOffset, 16)
1698 except:
1699 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))
1700 if VpdOffset % Alignment != 0:
1701 if PcdValue.startswith("{"):
1702 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)
1703 else:
1704 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))
1705 if PcdValue not in SkuValueMap:
1706 SkuValueMap[PcdValue] = []
1707 VpdFile.Add(DscPcdEntry, SkuName,Sku.VpdOffset)
1708 SkuValueMap[PcdValue].append(Sku)
1709 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1710 NeedProcessVpdMapFile = True
1711 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1712 UnicodePcdArray.add(DscPcdEntry)
1713 elif len(Sku.VariableName) > 0:
1714 HiiPcdArray.add(DscPcdEntry)
1715 else:
1716 OtherPcdArray.add(DscPcdEntry)
1717
1718 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1719 VpdSkuMap[DscPcd] = SkuValueMap
1720 if (self.Platform.FlashDefinition is None or self.Platform.FlashDefinition == '') and \
1721 VpdFile.GetCount() != 0:
1722 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1723 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1724
1725 if VpdFile.GetCount() != 0:
1726
1727 self.FixVpdOffset(VpdFile)
1728
1729 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))
1730
1731 # Process VPD map file generated by third party BPDG tool
1732 if NeedProcessVpdMapFile:
1733 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1734 if os.path.exists(VpdMapFilePath):
1735 VpdFile.Read(VpdMapFilePath)
1736
1737 # Fixup "*" offset
1738 for pcd in VpdSkuMap:
1739 vpdinfo = VpdFile.GetVpdInfo(pcd)
1740 if vpdinfo is None:
1741 # just pick the a value to determine whether is unicode string type
1742 continue
1743 for pcdvalue in VpdSkuMap[pcd]:
1744 for sku in VpdSkuMap[pcd][pcdvalue]:
1745 for item in vpdinfo:
1746 if item[2] == pcdvalue:
1747 sku.VpdOffset = item[1]
1748 else:
1749 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1750
1751 # Delete the DynamicPcdList At the last time enter into this function
1752 for Pcd in self._DynamicPcdList:
1753 # just pick the a value to determine whether is unicode string type
1754 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1755 Sku.VpdOffset = Sku.VpdOffset.strip()
1756
1757 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1758 Pcd.DatumType = "VOID*"
1759
1760 PcdValue = Sku.DefaultValue
1761 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1762 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1763 UnicodePcdArray.add(Pcd)
1764 elif len(Sku.VariableName) > 0:
1765 # if found HII type PCD then insert to right of UnicodeIndex
1766 HiiPcdArray.add(Pcd)
1767 else:
1768 OtherPcdArray.add(Pcd)
1769 del self._DynamicPcdList[:]
1770 self._DynamicPcdList.extend(list(UnicodePcdArray))
1771 self._DynamicPcdList.extend(list(HiiPcdArray))
1772 self._DynamicPcdList.extend(list(OtherPcdArray))
1773 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]
1774 for pcd in self._DynamicPcdList:
1775 if len(pcd.SkuInfoList) == 1:
1776 for (SkuName,SkuId) in allskuset:
1777 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:
1778 continue
1779 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList['DEFAULT'])
1780 pcd.SkuInfoList[SkuName].SkuId = SkuId
1781 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1782
1783 def FixVpdOffset(self,VpdFile ):
1784 FvPath = os.path.join(self.BuildDir, "FV")
1785 if not os.path.exists(FvPath):
1786 try:
1787 os.makedirs(FvPath)
1788 except:
1789 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1790
1791 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1792
1793 if VpdFile.Write(VpdFilePath):
1794 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1795 BPDGToolName = None
1796 for ToolDef in self.ToolDefinition.values():
1797 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1798 if not ToolDef.has_key("PATH"):
1799 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1800 BPDGToolName = ToolDef["PATH"]
1801 break
1802 # Call third party GUID BPDG tool.
1803 if BPDGToolName is not None:
1804 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1805 else:
1806 EdkLogger.error("Build", FILE_NOT_FOUND, "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1807
1808 ## Return the platform build data object
1809 def _GetPlatform(self):
1810 if self._Platform is None:
1811 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1812 return self._Platform
1813
1814 ## Return platform name
1815 def _GetName(self):
1816 return self.Platform.PlatformName
1817
1818 ## Return the meta file GUID
1819 def _GetGuid(self):
1820 return self.Platform.Guid
1821
1822 ## Return the platform version
1823 def _GetVersion(self):
1824 return self.Platform.Version
1825
1826 ## Return the FDF file name
1827 def _GetFdfFile(self):
1828 if self._FdfFile is None:
1829 if self.Workspace.FdfFile != "":
1830 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)
1831 else:
1832 self._FdfFile = ''
1833 return self._FdfFile
1834
1835 ## Return the build output directory platform specifies
1836 def _GetOutputDir(self):
1837 return self.Platform.OutputDirectory
1838
1839 ## Return the directory to store all intermediate and final files built
1840 def _GetBuildDir(self):
1841 if self._BuildDir is None:
1842 if os.path.isabs(self.OutputDir):
1843 self._BuildDir = path.join(
1844 path.abspath(self.OutputDir),
1845 self.BuildTarget + "_" + self.ToolChain,
1846 )
1847 else:
1848 self._BuildDir = path.join(
1849 self.WorkspaceDir,
1850 self.OutputDir,
1851 self.BuildTarget + "_" + self.ToolChain,
1852 )
1853 GlobalData.gBuildDirectory = self._BuildDir
1854 return self._BuildDir
1855
1856 ## Return directory of platform makefile
1857 #
1858 # @retval string Makefile directory
1859 #
1860 def _GetMakeFileDir(self):
1861 if self._MakeFileDir is None:
1862 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1863 return self._MakeFileDir
1864
1865 ## Return build command string
1866 #
1867 # @retval string Build command string
1868 #
1869 def _GetBuildCommand(self):
1870 if self._BuildCommand is None:
1871 self._BuildCommand = []
1872 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1873 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1874 if "FLAGS" in self.ToolDefinition["MAKE"]:
1875 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1876 if NewOption != '':
1877 self._BuildCommand += SplitOption(NewOption)
1878 if "MAKE" in self.EdkIIBuildOption:
1879 if "FLAGS" in self.EdkIIBuildOption["MAKE"]:
1880 Flags = self.EdkIIBuildOption["MAKE"]["FLAGS"]
1881 if Flags.startswith('='):
1882 self._BuildCommand = [self._BuildCommand[0]] + [Flags[1:]]
1883 else:
1884 self._BuildCommand += [Flags]
1885 return self._BuildCommand
1886
1887 ## Get tool chain definition
1888 #
1889 # Get each tool defition for given tool chain from tools_def.txt and platform
1890 #
1891 def _GetToolDefinition(self):
1892 if self._ToolDefinitions is None:
1893 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1894 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1895 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1896 ExtraData="[%s]" % self.MetaFile)
1897 self._ToolDefinitions = {}
1898 DllPathList = set()
1899 for Def in ToolDefinition:
1900 Target, Tag, Arch, Tool, Attr = Def.split("_")
1901 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1902 continue
1903
1904 Value = ToolDefinition[Def]
1905 # don't record the DLL
1906 if Attr == "DLL":
1907 DllPathList.add(Value)
1908 continue
1909
1910 if Tool not in self._ToolDefinitions:
1911 self._ToolDefinitions[Tool] = {}
1912 self._ToolDefinitions[Tool][Attr] = Value
1913
1914 ToolsDef = ''
1915 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
1916 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
1917 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
1918 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
1919 MakeFlags = ''
1920 for Tool in self._ToolDefinitions:
1921 for Attr in self._ToolDefinitions[Tool]:
1922 Value = self._ToolDefinitions[Tool][Attr]
1923 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
1924 # check if override is indicated
1925 if self.BuildOption[Tool][Attr].startswith('='):
1926 Value = self.BuildOption[Tool][Attr][1:]
1927 else:
1928 if Attr != 'PATH':
1929 Value += " " + self.BuildOption[Tool][Attr]
1930 else:
1931 Value = self.BuildOption[Tool][Attr]
1932
1933 if Attr == "PATH":
1934 # Don't put MAKE definition in the file
1935 if Tool != "MAKE":
1936 ToolsDef += "%s = %s\n" % (Tool, Value)
1937 elif Attr != "DLL":
1938 # Don't put MAKE definition in the file
1939 if Tool == "MAKE":
1940 if Attr == "FLAGS":
1941 MakeFlags = Value
1942 else:
1943 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
1944 ToolsDef += "\n"
1945
1946 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
1947 for DllPath in DllPathList:
1948 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
1949 os.environ["MAKE_FLAGS"] = MakeFlags
1950
1951 return self._ToolDefinitions
1952
1953 ## Return the paths of tools
1954 def _GetToolDefFile(self):
1955 if self._ToolDefFile is None:
1956 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
1957 return self._ToolDefFile
1958
1959 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1960 def _GetToolChainFamily(self):
1961 if self._ToolChainFamily is None:
1962 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1963 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
1964 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
1965 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
1966 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1967 % self.ToolChain)
1968 self._ToolChainFamily = "MSFT"
1969 else:
1970 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
1971 return self._ToolChainFamily
1972
1973 def _GetBuildRuleFamily(self):
1974 if self._BuildRuleFamily is None:
1975 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1976 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
1977 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
1978 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
1979 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1980 % self.ToolChain)
1981 self._BuildRuleFamily = "MSFT"
1982 else:
1983 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
1984 return self._BuildRuleFamily
1985
1986 ## Return the build options specific for all modules in this platform
1987 def _GetBuildOptions(self):
1988 if self._BuildOption is None:
1989 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
1990 return self._BuildOption
1991
1992 ## Return the build options specific for EDK modules in this platform
1993 def _GetEdkBuildOptions(self):
1994 if self._EdkBuildOption is None:
1995 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
1996 return self._EdkBuildOption
1997
1998 ## Return the build options specific for EDKII modules in this platform
1999 def _GetEdkIIBuildOptions(self):
2000 if self._EdkIIBuildOption is None:
2001 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
2002 return self._EdkIIBuildOption
2003
2004 ## Parse build_rule.txt in Conf Directory.
2005 #
2006 # @retval BuildRule object
2007 #
2008 def _GetBuildRule(self):
2009 if self._BuildRule is None:
2010 BuildRuleFile = None
2011 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
2012 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
2013 if BuildRuleFile in [None, '']:
2014 BuildRuleFile = gDefaultBuildRuleFile
2015 self._BuildRule = BuildRule(BuildRuleFile)
2016 if self._BuildRule._FileVersion == "":
2017 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
2018 else:
2019 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
2020 # If Build Rule's version is less than the version number required by the tools, halting the build.
2021 EdkLogger.error("build", AUTOGEN_ERROR,
2022 ExtraData="The version number [%s] of build_rule.txt is less than the version number required by the AutoGen.(the minimum required version number is [%s])"\
2023 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
2024
2025 return self._BuildRule
2026
2027 ## Summarize the packages used by modules in this platform
2028 def _GetPackageList(self):
2029 if self._PackageList is None:
2030 self._PackageList = set()
2031 for La in self.LibraryAutoGenList:
2032 self._PackageList.update(La.DependentPackageList)
2033 for Ma in self.ModuleAutoGenList:
2034 self._PackageList.update(Ma.DependentPackageList)
2035 #Collect package set information from INF of FDF
2036 PkgSet = set()
2037 for ModuleFile in self._AsBuildModuleList:
2038 if ModuleFile in self.Platform.Modules:
2039 continue
2040 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
2041 PkgSet.update(ModuleData.Packages)
2042 self._PackageList = list(self._PackageList) + list (PkgSet)
2043 return self._PackageList
2044
2045 def _GetNonDynamicPcdDict(self):
2046 if self._NonDynamicPcdDict:
2047 return self._NonDynamicPcdDict
2048 for Pcd in self.NonDynamicPcdList:
2049 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
2050 return self._NonDynamicPcdDict
2051
2052 ## Get list of non-dynamic PCDs
2053 def _GetNonDynamicPcdList(self):
2054 if self._NonDynamicPcdList is None:
2055 self.CollectPlatformDynamicPcds()
2056 return self._NonDynamicPcdList
2057
2058 ## Get list of dynamic PCDs
2059 def _GetDynamicPcdList(self):
2060 if self._DynamicPcdList is None:
2061 self.CollectPlatformDynamicPcds()
2062 return self._DynamicPcdList
2063
2064 ## Generate Token Number for all PCD
2065 def _GetPcdTokenNumbers(self):
2066 if self._PcdTokenNumber is None:
2067 self._PcdTokenNumber = OrderedDict()
2068 TokenNumber = 1
2069 #
2070 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2071 # Such as:
2072 #
2073 # Dynamic PCD:
2074 # TokenNumber 0 ~ 10
2075 # DynamicEx PCD:
2076 # TokeNumber 11 ~ 20
2077 #
2078 for Pcd in self.DynamicPcdList:
2079 if Pcd.Phase == "PEI":
2080 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2081 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2082 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2083 TokenNumber += 1
2084
2085 for Pcd in self.DynamicPcdList:
2086 if Pcd.Phase == "PEI":
2087 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2088 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2089 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2090 TokenNumber += 1
2091
2092 for Pcd in self.DynamicPcdList:
2093 if Pcd.Phase == "DXE":
2094 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2095 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2096 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2097 TokenNumber += 1
2098
2099 for Pcd in self.DynamicPcdList:
2100 if Pcd.Phase == "DXE":
2101 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2102 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2103 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2104 TokenNumber += 1
2105
2106 for Pcd in self.NonDynamicPcdList:
2107 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2108 TokenNumber += 1
2109 return self._PcdTokenNumber
2110
2111 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2112 def _GetAutoGenObjectList(self):
2113 self._ModuleAutoGenList = []
2114 self._LibraryAutoGenList = []
2115 for ModuleFile in self.Platform.Modules:
2116 Ma = ModuleAutoGen(
2117 self.Workspace,
2118 ModuleFile,
2119 self.BuildTarget,
2120 self.ToolChain,
2121 self.Arch,
2122 self.MetaFile
2123 )
2124 if Ma not in self._ModuleAutoGenList:
2125 self._ModuleAutoGenList.append(Ma)
2126 for La in Ma.LibraryAutoGenList:
2127 if La not in self._LibraryAutoGenList:
2128 self._LibraryAutoGenList.append(La)
2129 if Ma not in La._ReferenceModules:
2130 La._ReferenceModules.append(Ma)
2131
2132 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2133 def _GetModuleAutoGenList(self):
2134 if self._ModuleAutoGenList is None:
2135 self._GetAutoGenObjectList()
2136 return self._ModuleAutoGenList
2137
2138 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2139 def _GetLibraryAutoGenList(self):
2140 if self._LibraryAutoGenList is None:
2141 self._GetAutoGenObjectList()
2142 return self._LibraryAutoGenList
2143
2144 ## Test if a module is supported by the platform
2145 #
2146 # An error will be raised directly if the module or its arch is not supported
2147 # by the platform or current configuration
2148 #
2149 def ValidModule(self, Module):
2150 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
2151 or Module in self._AsBuildModuleList
2152
2153 ## Resolve the library classes in a module to library instances
2154 #
2155 # This method will not only resolve library classes but also sort the library
2156 # instances according to the dependency-ship.
2157 #
2158 # @param Module The module from which the library classes will be resolved
2159 #
2160 # @retval library_list List of library instances sorted
2161 #
2162 def ApplyLibraryInstance(self, Module):
2163 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2164 if str(Module) not in self.Platform.Modules:
2165 return []
2166
2167 ModuleType = Module.ModuleType
2168
2169 # for overridding library instances with module specific setting
2170 PlatformModule = self.Platform.Modules[str(Module)]
2171
2172 # add forced library instances (specified under LibraryClasses sections)
2173 #
2174 # If a module has a MODULE_TYPE of USER_DEFINED,
2175 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2176 #
2177 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
2178 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
2179 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
2180 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
2181
2182 # add forced library instances (specified in module overrides)
2183 for LibraryClass in PlatformModule.LibraryClasses:
2184 if LibraryClass.startswith("NULL"):
2185 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
2186
2187 # EdkII module
2188 LibraryConsumerList = [Module]
2189 Constructor = []
2190 ConsumedByList = OrderedDict()
2191 LibraryInstance = OrderedDict()
2192
2193 EdkLogger.verbose("")
2194 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2195 while len(LibraryConsumerList) > 0:
2196 M = LibraryConsumerList.pop()
2197 for LibraryClassName in M.LibraryClasses:
2198 if LibraryClassName not in LibraryInstance:
2199 # override library instance for this module
2200 if LibraryClassName in PlatformModule.LibraryClasses:
2201 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
2202 else:
2203 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
2204 if LibraryPath is None or LibraryPath == "":
2205 LibraryPath = M.LibraryClasses[LibraryClassName]
2206 if LibraryPath is None or LibraryPath == "":
2207 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
2208 "Instance of library class [%s] is not found" % LibraryClassName,
2209 File=self.MetaFile,
2210 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
2211
2212 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
2213 # for those forced library instance (NULL library), add a fake library class
2214 if LibraryClassName.startswith("NULL"):
2215 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
2216 elif LibraryModule.LibraryClass is None \
2217 or len(LibraryModule.LibraryClass) == 0 \
2218 or (ModuleType != 'USER_DEFINED'
2219 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
2220 # only USER_DEFINED can link against any library instance despite of its SupModList
2221 EdkLogger.error("build", OPTION_MISSING,
2222 "Module type [%s] is not supported by library instance [%s]" \
2223 % (ModuleType, LibraryPath), File=self.MetaFile,
2224 ExtraData="consumed by [%s]" % str(Module))
2225
2226 LibraryInstance[LibraryClassName] = LibraryModule
2227 LibraryConsumerList.append(LibraryModule)
2228 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
2229 else:
2230 LibraryModule = LibraryInstance[LibraryClassName]
2231
2232 if LibraryModule is None:
2233 continue
2234
2235 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
2236 Constructor.append(LibraryModule)
2237
2238 if LibraryModule not in ConsumedByList:
2239 ConsumedByList[LibraryModule] = []
2240 # don't add current module itself to consumer list
2241 if M != Module:
2242 if M in ConsumedByList[LibraryModule]:
2243 continue
2244 ConsumedByList[LibraryModule].append(M)
2245 #
2246 # Initialize the sorted output list to the empty set
2247 #
2248 SortedLibraryList = []
2249 #
2250 # Q <- Set of all nodes with no incoming edges
2251 #
2252 LibraryList = [] #LibraryInstance.values()
2253 Q = []
2254 for LibraryClassName in LibraryInstance:
2255 M = LibraryInstance[LibraryClassName]
2256 LibraryList.append(M)
2257 if ConsumedByList[M] == []:
2258 Q.append(M)
2259
2260 #
2261 # start the DAG algorithm
2262 #
2263 while True:
2264 EdgeRemoved = True
2265 while Q == [] and EdgeRemoved:
2266 EdgeRemoved = False
2267 # for each node Item with a Constructor
2268 for Item in LibraryList:
2269 if Item not in Constructor:
2270 continue
2271 # for each Node without a constructor with an edge e from Item to Node
2272 for Node in ConsumedByList[Item]:
2273 if Node in Constructor:
2274 continue
2275 # remove edge e from the graph if Node has no constructor
2276 ConsumedByList[Item].remove(Node)
2277 EdgeRemoved = True
2278 if ConsumedByList[Item] == []:
2279 # insert Item into Q
2280 Q.insert(0, Item)
2281 break
2282 if Q != []:
2283 break
2284 # DAG is done if there's no more incoming edge for all nodes
2285 if Q == []:
2286 break
2287
2288 # remove node from Q
2289 Node = Q.pop()
2290 # output Node
2291 SortedLibraryList.append(Node)
2292
2293 # for each node Item with an edge e from Node to Item do
2294 for Item in LibraryList:
2295 if Node not in ConsumedByList[Item]:
2296 continue
2297 # remove edge e from the graph
2298 ConsumedByList[Item].remove(Node)
2299
2300 if ConsumedByList[Item] != []:
2301 continue
2302 # insert Item into Q, if Item has no other incoming edges
2303 Q.insert(0, Item)
2304
2305 #
2306 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2307 #
2308 for Item in LibraryList:
2309 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
2310 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
2311 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
2312 ExtraData=ErrorMessage, File=self.MetaFile)
2313 if Item not in SortedLibraryList:
2314 SortedLibraryList.append(Item)
2315
2316 #
2317 # Build the list of constructor and destructir names
2318 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2319 #
2320 SortedLibraryList.reverse()
2321 return SortedLibraryList
2322
2323
2324 ## Override PCD setting (type, value, ...)
2325 #
2326 # @param ToPcd The PCD to be overrided
2327 # @param FromPcd The PCD overrideing from
2328 #
2329 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
2330 #
2331 # in case there's PCDs coming from FDF file, which have no type given.
2332 # at this point, ToPcd.Type has the type found from dependent
2333 # package
2334 #
2335 TokenCName = ToPcd.TokenCName
2336 for PcdItem in GlobalData.MixedPcd:
2337 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
2338 TokenCName = PcdItem[0]
2339 break
2340 if FromPcd is not None:
2341 if ToPcd.Pending and FromPcd.Type not in [None, '']:
2342 ToPcd.Type = FromPcd.Type
2343 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
2344 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
2345 if ToPcd.Type.strip() == "DynamicEx":
2346 ToPcd.Type = FromPcd.Type
2347 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
2348 and ToPcd.Type != FromPcd.Type:
2349 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
2350 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2351 % (ToPcd.TokenSpaceGuidCName, TokenCName,
2352 ToPcd.Type, Module, FromPcd.Type),
2353 File=self.MetaFile)
2354
2355 if FromPcd.MaxDatumSize:
2356 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2357 if FromPcd.DefaultValue:
2358 ToPcd.DefaultValue = FromPcd.DefaultValue
2359 if FromPcd.TokenValue:
2360 ToPcd.TokenValue = FromPcd.TokenValue
2361 if FromPcd.DatumType:
2362 ToPcd.DatumType = FromPcd.DatumType
2363 if FromPcd.SkuInfoList:
2364 ToPcd.SkuInfoList = FromPcd.SkuInfoList
2365 # Add Flexible PCD format parse
2366 if ToPcd.DefaultValue:
2367 try:
2368 ToPcd.DefaultValue = ValueExpressionEx(ToPcd.DefaultValue, ToPcd.DatumType, self._GuidDict)(True)
2369 except BadExpression, Value:
2370 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),
2371 File=self.MetaFile)
2372
2373 # check the validation of datum
2374 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
2375 if not IsValid:
2376 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
2377 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))
2378 ToPcd.validateranges = FromPcd.validateranges
2379 ToPcd.validlists = FromPcd.validlists
2380 ToPcd.expressions = FromPcd.expressions
2381
2382 if FromPcd is not None and ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
2383 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
2384 % (ToPcd.TokenSpaceGuidCName, TokenCName))
2385 Value = ToPcd.DefaultValue
2386 if Value in [None, '']:
2387 ToPcd.MaxDatumSize = '1'
2388 elif Value[0] == 'L':
2389 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
2390 elif Value[0] == '{':
2391 ToPcd.MaxDatumSize = str(len(Value.split(',')))
2392 else:
2393 ToPcd.MaxDatumSize = str(len(Value) - 1)
2394
2395 # apply default SKU for dynamic PCDS if specified one is not available
2396 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
2397 and ToPcd.SkuInfoList in [None, {}, '']:
2398 if self.Platform.SkuName in self.Platform.SkuIds:
2399 SkuName = self.Platform.SkuName
2400 else:
2401 SkuName = 'DEFAULT'
2402 ToPcd.SkuInfoList = {
2403 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)
2404 }
2405
2406 ## Apply PCD setting defined platform to a module
2407 #
2408 # @param Module The module from which the PCD setting will be overrided
2409 #
2410 # @retval PCD_list The list PCDs with settings from platform
2411 #
2412 def ApplyPcdSetting(self, Module, Pcds):
2413 # for each PCD in module
2414 for Name, Guid in Pcds:
2415 PcdInModule = Pcds[Name, Guid]
2416 # find out the PCD setting in platform
2417 if (Name, Guid) in self.Platform.Pcds:
2418 PcdInPlatform = self.Platform.Pcds[Name, Guid]
2419 else:
2420 PcdInPlatform = None
2421 # then override the settings if any
2422 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
2423 # resolve the VariableGuid value
2424 for SkuId in PcdInModule.SkuInfoList:
2425 Sku = PcdInModule.SkuInfoList[SkuId]
2426 if Sku.VariableGuid == '': continue
2427 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)
2428 if Sku.VariableGuidValue is None:
2429 PackageList = "\n\t".join([str(P) for P in self.PackageList])
2430 EdkLogger.error(
2431 'build',
2432 RESOURCE_NOT_AVAILABLE,
2433 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
2434 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
2435 % (Guid, Name, str(Module)),
2436 File=self.MetaFile
2437 )
2438
2439 # override PCD settings with module specific setting
2440 if Module in self.Platform.Modules:
2441 PlatformModule = self.Platform.Modules[str(Module)]
2442 for Key in PlatformModule.Pcds:
2443 Flag = False
2444 if Key in Pcds:
2445 ToPcd = Pcds[Key]
2446 Flag = True
2447 elif Key in GlobalData.MixedPcd:
2448 for PcdItem in GlobalData.MixedPcd[Key]:
2449 if PcdItem in Pcds:
2450 ToPcd = Pcds[PcdItem]
2451 Flag = True
2452 break
2453 if Flag:
2454 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)
2455 # use PCD value to calculate the MaxDatumSize when it is not specified
2456 for Name, Guid in Pcds:
2457 Pcd = Pcds[Name, Guid]
2458 if Pcd.DatumType == "VOID*" and Pcd.MaxDatumSize in ['', None]:
2459 Value = Pcd.DefaultValue
2460 if Value in [None, '']:
2461 Pcd.MaxDatumSize = '1'
2462 elif Value[0] == 'L':
2463 Pcd.MaxDatumSize = str((len(Value) - 2) * 2)
2464 elif Value[0] == '{':
2465 Pcd.MaxDatumSize = str(len(Value.split(',')))
2466 else:
2467 Pcd.MaxDatumSize = str(len(Value) - 1)
2468 return Pcds.values()
2469
2470 ## Resolve library names to library modules
2471 #
2472 # (for Edk.x modules)
2473 #
2474 # @param Module The module from which the library names will be resolved
2475 #
2476 # @retval library_list The list of library modules
2477 #
2478 def ResolveLibraryReference(self, Module):
2479 EdkLogger.verbose("")
2480 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2481 LibraryConsumerList = [Module]
2482
2483 # "CompilerStub" is a must for Edk modules
2484 if Module.Libraries:
2485 Module.Libraries.append("CompilerStub")
2486 LibraryList = []
2487 while len(LibraryConsumerList) > 0:
2488 M = LibraryConsumerList.pop()
2489 for LibraryName in M.Libraries:
2490 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2491 if Library is None:
2492 for Key in self.Platform.LibraryClasses.data.keys():
2493 if LibraryName.upper() == Key.upper():
2494 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2495 break
2496 if Library is None:
2497 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2498 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2499 continue
2500
2501 if Library not in LibraryList:
2502 LibraryList.append(Library)
2503 LibraryConsumerList.append(Library)
2504 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2505 return LibraryList
2506
2507 ## Calculate the priority value of the build option
2508 #
2509 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2510 #
2511 # @retval Value Priority value based on the priority list.
2512 #
2513 def CalculatePriorityValue(self, Key):
2514 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2515 PriorityValue = 0x11111
2516 if Target == "*":
2517 PriorityValue &= 0x01111
2518 if ToolChain == "*":
2519 PriorityValue &= 0x10111
2520 if Arch == "*":
2521 PriorityValue &= 0x11011
2522 if CommandType == "*":
2523 PriorityValue &= 0x11101
2524 if Attr == "*":
2525 PriorityValue &= 0x11110
2526
2527 return self.PrioList["0x%0.5x" % PriorityValue]
2528
2529
2530 ## Expand * in build option key
2531 #
2532 # @param Options Options to be expanded
2533 #
2534 # @retval options Options expanded
2535 #
2536 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2537 BuildOptions = {}
2538 FamilyMatch = False
2539 FamilyIsNull = True
2540
2541 OverrideList = {}
2542 #
2543 # Construct a list contain the build options which need override.
2544 #
2545 for Key in Options:
2546 #
2547 # Key[0] -- tool family
2548 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2549 #
2550 if (Key[0] == self.BuildRuleFamily and
2551 (ModuleStyle is None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2552 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2553 if Target == self.BuildTarget or Target == "*":
2554 if ToolChain == self.ToolChain or ToolChain == "*":
2555 if Arch == self.Arch or Arch == "*":
2556 if Options[Key].startswith("="):
2557 if OverrideList.get(Key[1]) is not None:
2558 OverrideList.pop(Key[1])
2559 OverrideList[Key[1]] = Options[Key]
2560
2561 #
2562 # Use the highest priority value.
2563 #
2564 if (len(OverrideList) >= 2):
2565 KeyList = OverrideList.keys()
2566 for Index in range(len(KeyList)):
2567 NowKey = KeyList[Index]
2568 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2569 for Index1 in range(len(KeyList) - Index - 1):
2570 NextKey = KeyList[Index1 + Index + 1]
2571 #
2572 # Compare two Key, if one is included by another, choose the higher priority one
2573 #
2574 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2575 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2576 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2577 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2578 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2579 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2580 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2581 if Options.get((self.BuildRuleFamily, NextKey)) is not None:
2582 Options.pop((self.BuildRuleFamily, NextKey))
2583 else:
2584 if Options.get((self.BuildRuleFamily, NowKey)) is not None:
2585 Options.pop((self.BuildRuleFamily, NowKey))
2586
2587 for Key in Options:
2588 if ModuleStyle is not None and len (Key) > 2:
2589 # Check Module style is EDK or EDKII.
2590 # Only append build option for the matched style module.
2591 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2592 continue
2593 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2594 continue
2595 Family = Key[0]
2596 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2597 # if tool chain family doesn't match, skip it
2598 if Tool in self.ToolDefinition and Family != "":
2599 FamilyIsNull = False
2600 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2601 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2602 continue
2603 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2604 continue
2605 FamilyMatch = True
2606 # expand any wildcard
2607 if Target == "*" or Target == self.BuildTarget:
2608 if Tag == "*" or Tag == self.ToolChain:
2609 if Arch == "*" or Arch == self.Arch:
2610 if Tool not in BuildOptions:
2611 BuildOptions[Tool] = {}
2612 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2613 BuildOptions[Tool][Attr] = Options[Key]
2614 else:
2615 # append options for the same tool except PATH
2616 if Attr != 'PATH':
2617 BuildOptions[Tool][Attr] += " " + Options[Key]
2618 else:
2619 BuildOptions[Tool][Attr] = Options[Key]
2620 # Build Option Family has been checked, which need't to be checked again for family.
2621 if FamilyMatch or FamilyIsNull:
2622 return BuildOptions
2623
2624 for Key in Options:
2625 if ModuleStyle is not None and len (Key) > 2:
2626 # Check Module style is EDK or EDKII.
2627 # Only append build option for the matched style module.
2628 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2629 continue
2630 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2631 continue
2632 Family = Key[0]
2633 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2634 # if tool chain family doesn't match, skip it
2635 if Tool not in self.ToolDefinition or Family == "":
2636 continue
2637 # option has been added before
2638 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2639 continue
2640
2641 # expand any wildcard
2642 if Target == "*" or Target == self.BuildTarget:
2643 if Tag == "*" or Tag == self.ToolChain:
2644 if Arch == "*" or Arch == self.Arch:
2645 if Tool not in BuildOptions:
2646 BuildOptions[Tool] = {}
2647 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2648 BuildOptions[Tool][Attr] = Options[Key]
2649 else:
2650 # append options for the same tool except PATH
2651 if Attr != 'PATH':
2652 BuildOptions[Tool][Attr] += " " + Options[Key]
2653 else:
2654 BuildOptions[Tool][Attr] = Options[Key]
2655 return BuildOptions
2656
2657 ## Append build options in platform to a module
2658 #
2659 # @param Module The module to which the build options will be appened
2660 #
2661 # @retval options The options appended with build options in platform
2662 #
2663 def ApplyBuildOption(self, Module):
2664 # Get the different options for the different style module
2665 if Module.AutoGenVersion < 0x00010005:
2666 PlatformOptions = self.EdkBuildOption
2667 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2668 else:
2669 PlatformOptions = self.EdkIIBuildOption
2670 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2671 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2672 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2673 if Module in self.Platform.Modules:
2674 PlatformModule = self.Platform.Modules[str(Module)]
2675 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2676 else:
2677 PlatformModuleOptions = {}
2678
2679 BuildRuleOrder = None
2680 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2681 for Tool in Options:
2682 for Attr in Options[Tool]:
2683 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2684 BuildRuleOrder = Options[Tool][Attr]
2685
2686 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2687 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2688 self.ToolDefinition.keys())
2689 BuildOptions = defaultdict(lambda: defaultdict(str))
2690 for Tool in AllTools:
2691 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2692 if Tool not in Options:
2693 continue
2694 for Attr in Options[Tool]:
2695 #
2696 # Do not generate it in Makefile
2697 #
2698 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2699 continue
2700 Value = Options[Tool][Attr]
2701 # check if override is indicated
2702 if Value.startswith('='):
2703 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value[1:])
2704 else:
2705 if Attr != 'PATH':
2706 BuildOptions[Tool][Attr] += " " + mws.handleWsMacro(Value)
2707 else:
2708 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value)
2709
2710 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag is not None:
2711 #
2712 # Override UNI flag only for EDK module.
2713 #
2714 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2715 return BuildOptions, BuildRuleOrder
2716
2717 Platform = property(_GetPlatform)
2718 Name = property(_GetName)
2719 Guid = property(_GetGuid)
2720 Version = property(_GetVersion)
2721
2722 OutputDir = property(_GetOutputDir)
2723 BuildDir = property(_GetBuildDir)
2724 MakeFileDir = property(_GetMakeFileDir)
2725 FdfFile = property(_GetFdfFile)
2726
2727 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2728 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2729 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2730 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2731 PackageList = property(_GetPackageList)
2732
2733 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2734 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2735 ToolChainFamily = property(_GetToolChainFamily)
2736 BuildRuleFamily = property(_GetBuildRuleFamily)
2737 BuildOption = property(_GetBuildOptions) # toolcode : option
2738 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2739 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2740
2741 BuildCommand = property(_GetBuildCommand)
2742 BuildRule = property(_GetBuildRule)
2743 ModuleAutoGenList = property(_GetModuleAutoGenList)
2744 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2745 GenFdsCommand = property(_GenFdsCommand)
2746
2747 ## ModuleAutoGen class
2748 #
2749 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2750 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2751 # to the [depex] section in module's inf file.
2752 #
2753 class ModuleAutoGen(AutoGen):
2754 # call super().__init__ then call the worker function with different parameter count
2755 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
2756 try:
2757 self._Init
2758 except:
2759 super(ModuleAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
2760 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args)
2761 self._Init = True
2762
2763 ## Cache the timestamps of metafiles of every module in a class variable
2764 #
2765 TimeDict = {}
2766
2767 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
2768 obj = super(ModuleAutoGen, cls).__new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)
2769 # check if this module is employed by active platform
2770 if not PlatformAutoGen(Workspace, args[0], Target, Toolchain, Arch).ValidModule(MetaFile):
2771 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2772 % (MetaFile, Arch))
2773 return None
2774 return obj
2775
2776 ## Initialize ModuleAutoGen
2777 #
2778 # @param Workspace EdkIIWorkspaceBuild object
2779 # @param ModuleFile The path of module file
2780 # @param Target Build target (DEBUG, RELEASE)
2781 # @param Toolchain Name of tool chain
2782 # @param Arch The arch the module supports
2783 # @param PlatformFile Platform meta-file
2784 #
2785 def _InitWorker(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2786 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2787 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2788
2789 self.Workspace = Workspace
2790 self.WorkspaceDir = Workspace.WorkspaceDir
2791
2792 self.MetaFile = ModuleFile
2793 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2794
2795 self.SourceDir = self.MetaFile.SubDir
2796 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2797
2798 self.SourceOverrideDir = None
2799 # use overrided path defined in DSC file
2800 if self.MetaFile.Key in GlobalData.gOverrideDir:
2801 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2802
2803 self.ToolChain = Toolchain
2804 self.BuildTarget = Target
2805 self.Arch = Arch
2806 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2807 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2808
2809 self.IsMakeFileCreated = False
2810 self.IsCodeFileCreated = False
2811 self.IsAsBuiltInfCreated = False
2812 self.DepexGenerated = False
2813
2814 self.BuildDatabase = self.Workspace.BuildDatabase
2815 self.BuildRuleOrder = None
2816 self.BuildTime = 0
2817
2818 self._Module = None
2819 self._Name = None
2820 self._Guid = None
2821 self._Version = None
2822 self._ModuleType = None
2823 self._ComponentType = None
2824 self._PcdIsDriver = None
2825 self._AutoGenVersion = None
2826 self._LibraryFlag = None
2827 self._CustomMakefile = None
2828 self._Macro = None
2829
2830 self._BuildDir = None
2831 self._OutputDir = None
2832 self._FfsOutputDir = None
2833 self._DebugDir = None
2834 self._MakeFileDir = None
2835
2836 self._IncludePathList = None
2837 self._IncludePathLength = 0
2838 self._AutoGenFileList = None
2839 self._UnicodeFileList = None
2840 self._VfrFileList = None
2841 self._IdfFileList = None
2842 self._SourceFileList = None
2843 self._ObjectFileList = None
2844 self._BinaryFileList = None
2845
2846 self._DependentPackageList = None
2847 self._DependentLibraryList = None
2848 self._LibraryAutoGenList = None
2849 self._DerivedPackageList = None
2850 self._ModulePcdList = None
2851 self._LibraryPcdList = None
2852 self._PcdComments = OrderedDict()
2853 self._GuidList = None
2854 self._GuidsUsedByPcd = None
2855 self._GuidComments = OrderedDict()
2856 self._ProtocolList = None
2857 self._ProtocolComments = OrderedDict()
2858 self._PpiList = None
2859 self._PpiComments = OrderedDict()
2860 self._DepexList = None
2861 self._DepexExpressionList = None
2862 self._BuildOption = None
2863 self._BuildOptionIncPathList = None
2864 self._BuildTargets = None
2865 self._IntroBuildTargetList = None
2866 self._FinalBuildTargetList = None
2867 self._FileTypes = None
2868 self._BuildRules = None
2869
2870 self._TimeStampPath = None
2871
2872 self.AutoGenDepSet = set()
2873
2874
2875 ## The Modules referenced to this Library
2876 # Only Library has this attribute
2877 self._ReferenceModules = []
2878
2879 ## Store the FixedAtBuild Pcds
2880 #
2881 self._FixedAtBuildPcds = []
2882 self.ConstPcd = {}
2883 return True
2884
2885 def __repr__(self):
2886 return "%s [%s]" % (self.MetaFile, self.Arch)
2887
2888 # Get FixedAtBuild Pcds of this Module
2889 def _GetFixedAtBuildPcds(self):
2890 if self._FixedAtBuildPcds:
2891 return self._FixedAtBuildPcds
2892 for Pcd in self.ModulePcdList:
2893 if Pcd.Type != "FixedAtBuild":
2894 continue
2895 if Pcd not in self._FixedAtBuildPcds:
2896 self._FixedAtBuildPcds.append(Pcd)
2897
2898 return self._FixedAtBuildPcds
2899
2900 def _GetUniqueBaseName(self):
2901 BaseName = self.Name
2902 for Module in self.PlatformInfo.ModuleAutoGenList:
2903 if Module.MetaFile == self.MetaFile:
2904 continue
2905 if Module.Name == self.Name:
2906 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2907 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2908 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2909 BaseName = '%s_%s' % (self.Name, self.Guid)
2910 return BaseName
2911
2912 # Macros could be used in build_rule.txt (also Makefile)
2913 def _GetMacros(self):
2914 if self._Macro is None:
2915 self._Macro = OrderedDict()
2916 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2917 self._Macro["MODULE_NAME" ] = self.Name
2918 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2919 self._Macro["MODULE_GUID" ] = self.Guid
2920 self._Macro["MODULE_VERSION" ] = self.Version
2921 self._Macro["MODULE_TYPE" ] = self.ModuleType
2922 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2923 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2924 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2925 self._Macro["MODULE_DIR" ] = self.SourceDir
2926
2927 self._Macro["BASE_NAME" ] = self.Name
2928
2929 self._Macro["ARCH" ] = self.Arch
2930 self._Macro["TOOLCHAIN" ] = self.ToolChain
2931 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2932 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2933 self._Macro["TARGET" ] = self.BuildTarget
2934
2935 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
2936 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2937 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2938 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
2939 self._Macro["OUTPUT_DIR" ] = self.OutputDir
2940 self._Macro["DEBUG_DIR" ] = self.DebugDir
2941 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
2942 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
2943 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
2944 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
2945 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
2946 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
2947 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
2948 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
2949 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
2950 return self._Macro
2951
2952 ## Return the module build data object
2953 def _GetModule(self):
2954 if self._Module is None:
2955 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
2956 return self._Module
2957
2958 ## Return the module name
2959 def _GetBaseName(self):
2960 return self.Module.BaseName
2961
2962 ## Return the module DxsFile if exist
2963 def _GetDxsFile(self):
2964 return self.Module.DxsFile
2965
2966 ## Return the module SourceOverridePath
2967 def _GetSourceOverridePath(self):
2968 return self.Module.SourceOverridePath
2969
2970 ## Return the module meta-file GUID
2971 def _GetGuid(self):
2972 #
2973 # To build same module more than once, the module path with FILE_GUID overridden has
2974 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2975 # in DSC. The overridden GUID can be retrieved from file name
2976 #
2977 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
2978 #
2979 # Length of GUID is 36
2980 #
2981 return os.path.basename(self.MetaFile.Path)[:36]
2982 return self.Module.Guid
2983
2984 ## Return the module version
2985 def _GetVersion(self):
2986 return self.Module.Version
2987
2988 ## Return the module type
2989 def _GetModuleType(self):
2990 return self.Module.ModuleType
2991
2992 ## Return the component type (for Edk.x style of module)
2993 def _GetComponentType(self):
2994 return self.Module.ComponentType
2995
2996 ## Return the build type
2997 def _GetBuildType(self):
2998 return self.Module.BuildType
2999
3000 ## Return the PCD_IS_DRIVER setting
3001 def _GetPcdIsDriver(self):
3002 return self.Module.PcdIsDriver
3003
3004 ## Return the autogen version, i.e. module meta-file version
3005 def _GetAutoGenVersion(self):
3006 return self.Module.AutoGenVersion
3007
3008 ## Check if the module is library or not
3009 def _IsLibrary(self):
3010 if self._LibraryFlag is None:
3011 if self.Module.LibraryClass is not None and self.Module.LibraryClass != []:
3012 self._LibraryFlag = True
3013 else:
3014 self._LibraryFlag = False
3015 return self._LibraryFlag
3016
3017 ## Check if the module is binary module or not
3018 def _IsBinaryModule(self):
3019 return self.Module.IsBinaryModule
3020
3021 ## Return the directory to store intermediate files of the module
3022 def _GetBuildDir(self):
3023 if self._BuildDir is None:
3024 self._BuildDir = path.join(
3025 self.PlatformInfo.BuildDir,
3026 self.Arch,
3027 self.SourceDir,
3028 self.MetaFile.BaseName
3029 )
3030 CreateDirectory(self._BuildDir)
3031 return self._BuildDir
3032
3033 ## Return the directory to store the intermediate object files of the mdoule
3034 def _GetOutputDir(self):
3035 if self._OutputDir is None:
3036 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3037 CreateDirectory(self._OutputDir)
3038 return self._OutputDir
3039
3040 ## Return the directory to store ffs file
3041 def _GetFfsOutputDir(self):
3042 if self._FfsOutputDir is None:
3043 if GlobalData.gFdfParser is not None:
3044 self._FfsOutputDir = path.join(self.PlatformInfo<