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