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