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