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