]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/AutoGen.py
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools: PcdDataBase Optimization for multiple SkuIds
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
1 ## @file
2 # Generate AutoGen.h, AutoGen.c and *.depex files
3 #
4 # Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
9 #
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 #
13
14 ## Import Modules
15 #
16 import Common.LongFilePathOs as os
17 import re
18 import os.path as path
19 import copy
20 import uuid
21
22 import GenC
23 import GenMake
24 import GenDepex
25 from StringIO import StringIO
26
27 from StrGather import *
28 from BuildEngine import BuildRule
29
30 from Common.LongFilePathSupport import CopyLongFilePath
31 from Common.BuildToolError import *
32 from Common.DataType import *
33 from Common.Misc import *
34 from Common.String import *
35 import Common.GlobalData as GlobalData
36 from GenFds.FdfParser import *
37 from CommonDataClass.CommonClass import SkuInfoClass
38 from Workspace.BuildClassObject import *
39 from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile
40 import Common.VpdInfoFile as VpdInfoFile
41 from GenPcdDb import CreatePcdDatabaseCode
42 from Workspace.MetaFileCommentParser import UsageList
43 from Common.MultipleWorkspace import MultipleWorkspace as mws
44 import InfSectionParser
45 import datetime
46 import hashlib
47 from GenVar import VariableMgr,var_info
48
49 ## Regular expression for splitting Dependency Expression string into tokens
50 gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")
51
52 #
53 # Match name = variable
54 #
55 gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")
56 #
57 # The format of guid in efivarstore statement likes following and must be correct:
58 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
59 #
60 gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
61
62 ## Mapping Makefile type
63 gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}
64
65
66 ## Build rule configuration file
67 gDefaultBuildRuleFile = 'build_rule.txt'
68
69 ## Tools definition configuration file
70 gDefaultToolsDefFile = 'tools_def.txt'
71
72 ## Build rule default version
73 AutoGenReqBuildRuleVerNum = "0.1"
74
75 ## default file name for AutoGen
76 gAutoGenCodeFileName = "AutoGen.c"
77 gAutoGenHeaderFileName = "AutoGen.h"
78 gAutoGenStringFileName = "%(module_name)sStrDefs.h"
79 gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"
80 gAutoGenDepexFileName = "%(module_name)s.depex"
81 gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"
82 gAutoGenIdfFileName = "%(module_name)sIdf.hpk"
83 gInfSpecVersion = "0x00010017"
84
85 #
86 # Template string to generic AsBuilt INF
87 #
88 gAsBuiltInfHeaderString = TemplateString("""${header_comments}
89
90 # DO NOT EDIT
91 # FILE auto-generated
92
93 [Defines]
94 INF_VERSION = ${module_inf_version}
95 BASE_NAME = ${module_name}
96 FILE_GUID = ${module_guid}
97 MODULE_TYPE = ${module_module_type}${BEGIN}
98 VERSION_STRING = ${module_version_string}${END}${BEGIN}
99 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
100 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
101 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
102 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
103 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
104 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
105 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
106 SHADOW = ${module_shadow}${END}${BEGIN}
107 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
108 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
109 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
110 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
111 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
112 SPEC = ${module_spec}${END}${BEGIN}
113 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
114 MODULE_UNI_FILE = ${module_uni_file}${END}
115
116 [Packages.${module_arch}]${BEGIN}
117 ${package_item}${END}
118
119 [Binaries.${module_arch}]${BEGIN}
120 ${binary_item}${END}
121
122 [PatchPcd.${module_arch}]${BEGIN}
123 ${patchablepcd_item}
124 ${END}
125
126 [Protocols.${module_arch}]${BEGIN}
127 ${protocol_item}
128 ${END}
129
130 [Ppis.${module_arch}]${BEGIN}
131 ${ppi_item}
132 ${END}
133
134 [Guids.${module_arch}]${BEGIN}
135 ${guid_item}
136 ${END}
137
138 [PcdEx.${module_arch}]${BEGIN}
139 ${pcd_item}
140 ${END}
141
142 [LibraryClasses.${module_arch}]
143 ## @LIB_INSTANCES${BEGIN}
144 # ${libraryclasses_item}${END}
145
146 ${depexsection_item}
147
148 ${userextension_tianocore_item}
149
150 ${tail_comments}
151
152 [BuildOptions.${module_arch}]
153 ## @AsBuilt${BEGIN}
154 ## ${flags_item}${END}
155 """)
156
157 ## Base class for AutoGen
158 #
159 # This class just implements the cache mechanism of AutoGen objects.
160 #
161 class AutoGen(object):
162 # database to maintain the objects of xxxAutoGen
163 _CACHE_ = {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}
164
165 ## Factory method
166 #
167 # @param Class class object of real AutoGen class
168 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
169 # @param Workspace Workspace directory or WorkspaceAutoGen object
170 # @param MetaFile The path of meta file
171 # @param Target Build target
172 # @param Toolchain Tool chain name
173 # @param Arch Target arch
174 # @param *args The specific class related parameters
175 # @param **kwargs The specific class related dict parameters
176 #
177 def __new__(Class, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
178 # check if the object has been created
179 Key = (Target, Toolchain)
180 if Key not in Class._CACHE_ or Arch not in Class._CACHE_[Key] \
181 or MetaFile not in Class._CACHE_[Key][Arch]:
182 AutoGenObject = super(AutoGen, Class).__new__(Class)
183 # call real constructor
184 if not AutoGenObject._Init(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):
185 return None
186 if Key not in Class._CACHE_:
187 Class._CACHE_[Key] = {}
188 if Arch not in Class._CACHE_[Key]:
189 Class._CACHE_[Key][Arch] = {}
190 Class._CACHE_[Key][Arch][MetaFile] = AutoGenObject
191 else:
192 AutoGenObject = Class._CACHE_[Key][Arch][MetaFile]
193
194 return AutoGenObject
195
196 ## hash() operator
197 #
198 # The file path of platform file will be used to represent hash value of this object
199 #
200 # @retval int Hash value of the file path of platform file
201 #
202 def __hash__(self):
203 return hash(self.MetaFile)
204
205 ## str() operator
206 #
207 # The file path of platform file will be used to represent this object
208 #
209 # @retval string String of platform file path
210 #
211 def __str__(self):
212 return str(self.MetaFile)
213
214 ## "==" operator
215 def __eq__(self, Other):
216 return Other and self.MetaFile == Other
217
218 ## Workspace AutoGen class
219 #
220 # This class is used mainly to control the whole platform build for different
221 # architecture. This class will generate top level makefile.
222 #
223 class WorkspaceAutoGen(AutoGen):
224 ## Real constructor of WorkspaceAutoGen
225 #
226 # This method behaves the same as __init__ except that it needs explicit invoke
227 # (in super class's __new__ method)
228 #
229 # @param WorkspaceDir Root directory of workspace
230 # @param ActivePlatform Meta-file of active platform
231 # @param Target Build target
232 # @param Toolchain Tool chain name
233 # @param ArchList List of architecture of current build
234 # @param MetaFileDb Database containing meta-files
235 # @param BuildConfig Configuration of build
236 # @param ToolDefinition Tool chain definitions
237 # @param FlashDefinitionFile File of flash definition
238 # @param Fds FD list to be generated
239 # @param Fvs FV list to be generated
240 # @param Caps Capsule list to be generated
241 # @param SkuId SKU id from command line
242 #
243 def _Init(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,
244 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,
245 Progress=None, BuildModule=None):
246 if Fds is None:
247 Fds = []
248 if Fvs is None:
249 Fvs = []
250 if Caps is None:
251 Caps = []
252 self.BuildDatabase = MetaFileDb
253 self.MetaFile = ActivePlatform
254 self.WorkspaceDir = WorkspaceDir
255 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]
256 GlobalData.gActivePlatform = self.Platform
257 self.BuildTarget = Target
258 self.ToolChain = Toolchain
259 self.ArchList = ArchList
260 self.SkuId = SkuId
261 self.UniFlag = UniFlag
262
263 self.TargetTxt = BuildConfig
264 self.ToolDef = ToolDefinition
265 self.FdfFile = FlashDefinitionFile
266 self.FdTargetList = Fds
267 self.FvTargetList = Fvs
268 self.CapTargetList = Caps
269 self.AutoGenObjectList = []
270 self._BuildDir = None
271 self._FvDir = None
272 self._MakeFileDir = None
273 self._BuildCommand = None
274
275 # there's many relative directory operations, so ...
276 os.chdir(self.WorkspaceDir)
277
278 #
279 # Merge Arch
280 #
281 if not self.ArchList:
282 ArchList = set(self.Platform.SupArchList)
283 else:
284 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)
285 if not ArchList:
286 EdkLogger.error("build", PARAMETER_INVALID,
287 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))
288 elif self.ArchList and len(ArchList) != len(self.ArchList):
289 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))
290 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
291 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))
292 self.ArchList = tuple(ArchList)
293
294 # Validate build target
295 if self.BuildTarget not in self.Platform.BuildTargets:
296 EdkLogger.error("build", PARAMETER_INVALID,
297 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"
298 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))
299
300
301 # parse FDF file to get PCDs in it, if any
302 if not self.FdfFile:
303 self.FdfFile = self.Platform.FlashDefinition
304
305 EdkLogger.info("")
306 if self.ArchList:
307 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))
308 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))
309 EdkLogger.info('%-16s = %s' % ("Toolchain", self.ToolChain))
310
311 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))
312 if BuildModule:
313 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))
314
315 if self.FdfFile:
316 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))
317
318 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)
319
320 # if Progress:
321 # Progress.Start("\nProcessing meta-data")
322
323 if self.FdfFile:
324 #
325 # Mark now build in AutoGen Phase
326 #
327 GlobalData.gAutoGenPhase = True
328 Fdf = FdfParser(self.FdfFile.Path)
329 Fdf.ParseFile()
330 GlobalData.gFdfParser = Fdf
331 GlobalData.gAutoGenPhase = False
332 PcdSet = Fdf.Profile.PcdDict
333 if Fdf.CurrentFdName and Fdf.CurrentFdName in Fdf.Profile.FdDict:
334 FdDict = Fdf.Profile.FdDict[Fdf.CurrentFdName]
335 for FdRegion in FdDict.RegionList:
336 if str(FdRegion.RegionType) is 'FILE' and self.Platform.VpdToolGuid in str(FdRegion.RegionDataList):
337 if int(FdRegion.Offset) % 8 != 0:
338 EdkLogger.error("build", FORMAT_INVALID, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion.Offset))
339 ModuleList = Fdf.Profile.InfList
340 self.FdfProfile = Fdf.Profile
341 for fvname in self.FvTargetList:
342 if fvname.upper() not in self.FdfProfile.FvDict:
343 EdkLogger.error("build", OPTION_VALUE_INVALID,
344 "No such an FV in FDF file: %s" % fvname)
345
346 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
347 # but the path (self.MetaFile.Path) is the real path
348 for key in self.FdfProfile.InfDict:
349 if key == 'ArchTBD':
350 Platform_cache = {}
351 MetaFile_cache = {}
352 for Arch in self.ArchList:
353 Platform_cache[Arch] = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
354 MetaFile_cache[Arch] = []
355 for Pkey in Platform_cache[Arch].Modules.keys():
356 MetaFile_cache[Arch].append(Platform_cache[Arch].Modules[Pkey].MetaFile)
357 for Inf in self.FdfProfile.InfDict[key]:
358 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
359 for Arch in self.ArchList:
360 if ModuleFile in MetaFile_cache[Arch]:
361 break
362 else:
363 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
364 if not ModuleData.IsBinaryModule:
365 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
366
367 else:
368 for Arch in self.ArchList:
369 if Arch == key:
370 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
371 MetaFileList = []
372 for Pkey in Platform.Modules.keys():
373 MetaFileList.append(Platform.Modules[Pkey].MetaFile)
374 for Inf in self.FdfProfile.InfDict[key]:
375 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
376 if ModuleFile in MetaFileList:
377 continue
378 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
379 if not ModuleData.IsBinaryModule:
380 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)
381
382 else:
383 PcdSet = {}
384 ModuleList = []
385 self.FdfProfile = None
386 if self.FdTargetList:
387 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))
388 self.FdTargetList = []
389 if self.FvTargetList:
390 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))
391 self.FvTargetList = []
392 if self.CapTargetList:
393 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))
394 self.CapTargetList = []
395
396 # apply SKU and inject PCDs from Flash Definition file
397 for Arch in self.ArchList:
398 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
399
400 DecPcds = {}
401 DecPcdsKey = set()
402 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
403 if GlobalData.BuildOptionPcd:
404 for i, pcd in enumerate(GlobalData.BuildOptionPcd):
405 if type(pcd) is tuple:
406 continue
407 (pcdname, pcdvalue) = pcd.split('=')
408 if not pcdvalue:
409 EdkLogger.error('build', AUTOGEN_ERROR, "No Value specified for the PCD %s." % (pcdname))
410 if '.' in pcdname:
411 (TokenSpaceGuidCName, TokenCName) = pcdname.split('.')
412 HasTokenSpace = True
413 else:
414 TokenCName = pcdname
415 TokenSpaceGuidCName = ''
416 HasTokenSpace = False
417 TokenSpaceGuidCNameList = []
418 FoundFlag = False
419 PcdDatumType = ''
420 NewValue = ''
421 for package in PGen.PackageList:
422 for key in package.Pcds:
423 PcdItem = package.Pcds[key]
424 if HasTokenSpace:
425 if (PcdItem.TokenCName, PcdItem.TokenSpaceGuidCName) == (TokenCName, TokenSpaceGuidCName):
426 PcdDatumType = PcdItem.DatumType
427 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)
428 FoundFlag = True
429 else:
430 if PcdItem.TokenCName == TokenCName:
431 if not PcdItem.TokenSpaceGuidCName in TokenSpaceGuidCNameList:
432 if len (TokenSpaceGuidCNameList) < 1:
433 TokenSpaceGuidCNameList.append(PcdItem.TokenSpaceGuidCName)
434 PcdDatumType = PcdItem.DatumType
435 TokenSpaceGuidCName = PcdItem.TokenSpaceGuidCName
436 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)
437 FoundFlag = True
438 else:
439 EdkLogger.error(
440 'build',
441 AUTOGEN_ERROR,
442 "The Pcd %s is found under multiple different TokenSpaceGuid: %s and %s." % (TokenCName, PcdItem.TokenSpaceGuidCName, TokenSpaceGuidCNameList[0])
443 )
444
445 GlobalData.BuildOptionPcd[i] = (TokenSpaceGuidCName, TokenCName, NewValue)
446
447 if not FoundFlag:
448 if HasTokenSpace:
449 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s.%s is not found in the DEC file." % (TokenSpaceGuidCName, TokenCName))
450 else:
451 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s is not found in the DEC file." % (TokenCName))
452
453 for BuildData in PGen.BuildDatabase._CACHE_.values():
454 if BuildData.Arch != Arch:
455 continue
456 if BuildData.MetaFile.Ext == '.dec':
457 continue
458 for key in BuildData.Pcds:
459 PcdItem = BuildData.Pcds[key]
460 if (TokenSpaceGuidCName, TokenCName) == (PcdItem.TokenSpaceGuidCName, PcdItem.TokenCName):
461 PcdItem.DefaultValue = NewValue
462
463 if (TokenCName, TokenSpaceGuidCName) in PcdSet:
464 PcdSet[(TokenCName, TokenSpaceGuidCName)] = NewValue
465
466 SourcePcdDict = {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}
467 BinaryPcdDict = {'DynamicEx':[], 'PatchableInModule':[]}
468 SourcePcdDict_Keys = SourcePcdDict.keys()
469 BinaryPcdDict_Keys = BinaryPcdDict.keys()
470
471 # generate the SourcePcdDict and BinaryPcdDict
472 for BuildData in PGen.BuildDatabase._CACHE_.values():
473 if BuildData.Arch != Arch:
474 continue
475 if BuildData.MetaFile.Ext == '.inf':
476 for key in BuildData.Pcds:
477 if BuildData.Pcds[key].Pending:
478 if key in Platform.Pcds:
479 PcdInPlatform = Platform.Pcds[key]
480 if PcdInPlatform.Type not in [None, '']:
481 BuildData.Pcds[key].Type = PcdInPlatform.Type
482
483 if BuildData.MetaFile in Platform.Modules:
484 PlatformModule = Platform.Modules[str(BuildData.MetaFile)]
485 if key in PlatformModule.Pcds:
486 PcdInPlatform = PlatformModule.Pcds[key]
487 if PcdInPlatform.Type not in [None, '']:
488 BuildData.Pcds[key].Type = PcdInPlatform.Type
489
490 if 'DynamicEx' in BuildData.Pcds[key].Type:
491 if BuildData.IsBinaryModule:
492 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['DynamicEx']:
493 BinaryPcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
494 else:
495 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['DynamicEx']:
496 SourcePcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
497
498 elif 'PatchableInModule' in BuildData.Pcds[key].Type:
499 if BuildData.MetaFile.Ext == '.inf':
500 if BuildData.IsBinaryModule:
501 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['PatchableInModule']:
502 BinaryPcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
503 else:
504 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['PatchableInModule']:
505 SourcePcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
506
507 elif 'Dynamic' in BuildData.Pcds[key].Type:
508 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['Dynamic']:
509 SourcePcdDict['Dynamic'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
510 elif 'FixedAtBuild' in BuildData.Pcds[key].Type:
511 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['FixedAtBuild']:
512 SourcePcdDict['FixedAtBuild'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))
513 else:
514 pass
515 #
516 # A PCD can only use one type for all source modules
517 #
518 for i in SourcePcdDict_Keys:
519 for j in SourcePcdDict_Keys:
520 if i != j:
521 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(SourcePcdDict[j])))
522 if len(IntersectionList) > 0:
523 EdkLogger.error(
524 'build',
525 FORMAT_INVALID,
526 "Building modules from source INFs, following PCD use %s and %s access method. It must be corrected to use only one access method." % (i, j),
527 ExtraData="%s" % '\n\t'.join([str(P[1]+'.'+P[0]) for P in IntersectionList])
528 )
529 else:
530 pass
531
532 #
533 # intersection the BinaryPCD for Mixed PCD
534 #
535 for i in BinaryPcdDict_Keys:
536 for j in BinaryPcdDict_Keys:
537 if i != j:
538 IntersectionList = list(set(BinaryPcdDict[i]).intersection(set(BinaryPcdDict[j])))
539 for item in IntersectionList:
540 NewPcd1 = (item[0] + '_' + i, item[1])
541 NewPcd2 = (item[0] + '_' + j, item[1])
542 if item not in GlobalData.MixedPcd:
543 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
544 else:
545 if NewPcd1 not in GlobalData.MixedPcd[item]:
546 GlobalData.MixedPcd[item].append(NewPcd1)
547 if NewPcd2 not in GlobalData.MixedPcd[item]:
548 GlobalData.MixedPcd[item].append(NewPcd2)
549 else:
550 pass
551
552 #
553 # intersection the SourcePCD and BinaryPCD for Mixed PCD
554 #
555 for i in SourcePcdDict_Keys:
556 for j in BinaryPcdDict_Keys:
557 if i != j:
558 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(BinaryPcdDict[j])))
559 for item in IntersectionList:
560 NewPcd1 = (item[0] + '_' + i, item[1])
561 NewPcd2 = (item[0] + '_' + j, item[1])
562 if item not in GlobalData.MixedPcd:
563 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]
564 else:
565 if NewPcd1 not in GlobalData.MixedPcd[item]:
566 GlobalData.MixedPcd[item].append(NewPcd1)
567 if NewPcd2 not in GlobalData.MixedPcd[item]:
568 GlobalData.MixedPcd[item].append(NewPcd2)
569 else:
570 pass
571
572 for BuildData in PGen.BuildDatabase._CACHE_.values():
573 if BuildData.Arch != Arch:
574 continue
575 for key in BuildData.Pcds:
576 for SinglePcd in GlobalData.MixedPcd:
577 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
578 for item in GlobalData.MixedPcd[SinglePcd]:
579 Pcd_Type = item[0].split('_')[-1]
580 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in GenC.gDynamicExPcd) or \
581 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in GenC.gDynamicPcd):
582 Value = BuildData.Pcds[key]
583 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type
584 if len(key) == 2:
585 newkey = (Value.TokenCName, key[1])
586 elif len(key) == 3:
587 newkey = (Value.TokenCName, key[1], key[2])
588 del BuildData.Pcds[key]
589 BuildData.Pcds[newkey] = Value
590 break
591 else:
592 pass
593 break
594 else:
595 pass
596
597 # handle the mixed pcd in FDF file
598 for key in PcdSet:
599 if key in GlobalData.MixedPcd:
600 Value = PcdSet[key]
601 del PcdSet[key]
602 for item in GlobalData.MixedPcd[key]:
603 PcdSet[item] = Value
604
605 #Collect package set information from INF of FDF
606 PkgSet = set()
607 for Inf in ModuleList:
608 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)
609 if ModuleFile in Platform.Modules:
610 continue
611 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]
612 PkgSet.update(ModuleData.Packages)
613 Pkgs = list(PkgSet) + list(PGen.PackageList)
614 for Pkg in Pkgs:
615 for Pcd in Pkg.Pcds:
616 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]
617 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))
618
619 Platform.SkuName = self.SkuId
620 for Name, Guid in PcdSet:
621 if (Name, Guid) not in DecPcds:
622 EdkLogger.error(
623 'build',
624 PARSER_ERROR,
625 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),
626 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
627 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
628 )
629 else:
630 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
631 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \
632 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \
633 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:
634 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])
635 continue
636 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:
637 EdkLogger.error(
638 'build',
639 PARSER_ERROR,
640 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),
641 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],
642 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]
643 )
644
645 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
646 #
647 # Explicitly collect platform's dynamic PCDs
648 #
649 Pa.CollectPlatformDynamicPcds()
650 Pa.CollectFixedAtBuildPcds()
651 self.AutoGenObjectList.append(Pa)
652
653 #
654 # Generate Package level hash value
655 #
656 GlobalData.gPackageHash[Arch] = {}
657 if GlobalData.gUseHashCache:
658 for Pkg in Pkgs:
659 self._GenPkgLevelHash(Pkg)
660
661 #
662 # Check PCDs token value conflict in each DEC file.
663 #
664 self._CheckAllPcdsTokenValueConflict()
665
666 #
667 # Check PCD type and definition between DSC and DEC
668 #
669 self._CheckPcdDefineAndType()
670
671 # if self.FdfFile:
672 # self._CheckDuplicateInFV(Fdf)
673
674 #
675 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
676 #
677 content = 'gCommandLineDefines: '
678 content += str(GlobalData.gCommandLineDefines)
679 content += os.linesep
680 content += 'BuildOptionPcd: '
681 content += str(GlobalData.BuildOptionPcd)
682 content += os.linesep
683 content += 'Active Platform: '
684 content += str(self.Platform)
685 content += os.linesep
686 if self.FdfFile:
687 content += 'Flash Image Definition: '
688 content += str(self.FdfFile)
689 content += os.linesep
690 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)
691
692 #
693 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
694 #
695 PcdTokenNumber = 'PcdTokenNumber: '
696 if Pa.PcdTokenNumber:
697 if Pa.DynamicPcdList:
698 for Pcd in Pa.DynamicPcdList:
699 PcdTokenNumber += os.linesep
700 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))
701 PcdTokenNumber += ' : '
702 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])
703 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)
704
705 #
706 # Get set of workspace metafiles
707 #
708 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)
709
710 #
711 # Retrieve latest modified time of all metafiles
712 #
713 SrcTimeStamp = 0
714 for f in AllWorkSpaceMetaFiles:
715 if os.stat(f)[8] > SrcTimeStamp:
716 SrcTimeStamp = os.stat(f)[8]
717 self._SrcTimeStamp = SrcTimeStamp
718
719 if GlobalData.gUseHashCache:
720 m = hashlib.md5()
721 for files in AllWorkSpaceMetaFiles:
722 if files.endswith('.dec'):
723 continue
724 f = open(files, 'r')
725 Content = f.read()
726 f.close()
727 m.update(Content)
728 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)
729 GlobalData.gPlatformHash = m.hexdigest()
730
731 #
732 # Write metafile list to build directory
733 #
734 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')
735 if os.path.exists (AutoGenFilePath):
736 os.remove(AutoGenFilePath)
737 if not os.path.exists(self.BuildDir):
738 os.makedirs(self.BuildDir)
739 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:
740 for f in AllWorkSpaceMetaFiles:
741 print >> file, f
742 return True
743
744 def _GenPkgLevelHash(self, Pkg):
745 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)
746 CreateDirectory(PkgDir)
747 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')
748 m = hashlib.md5()
749 # Get .dec file's hash value
750 f = open(Pkg.MetaFile.Path, 'r')
751 Content = f.read()
752 f.close()
753 m.update(Content)
754 # Get include files hash value
755 if Pkg.Includes:
756 for inc in Pkg.Includes:
757 for Root, Dirs, Files in os.walk(str(inc)):
758 for File in Files:
759 File_Path = os.path.join(Root, File)
760 f = open(File_Path, 'r')
761 Content = f.read()
762 f.close()
763 m.update(Content)
764 SaveFileOnChange(HashFile, m.hexdigest(), True)
765 if Pkg.PackageName not in GlobalData.gPackageHash[Pkg.Arch]:
766 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()
767
768 def _GetMetaFiles(self, Target, Toolchain, Arch):
769 AllWorkSpaceMetaFiles = set()
770 #
771 # add fdf
772 #
773 if self.FdfFile:
774 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)
775 if self.FdfFile:
776 FdfFiles = GlobalData.gFdfParser.GetAllIncludedFile()
777 for f in FdfFiles:
778 AllWorkSpaceMetaFiles.add (f.FileName)
779 #
780 # add dsc
781 #
782 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)
783
784 #
785 # add build_rule.txt & tools_def.txt
786 #
787 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))
788 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))
789
790 # add BuildOption metafile
791 #
792 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))
793
794 # add PcdToken Number file for Dynamic/DynamicEx Pcd
795 #
796 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))
797
798 for Arch in self.ArchList:
799 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]
800 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)
801
802 #
803 # add dec
804 #
805 for Package in PGen.PackageList:
806 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)
807
808 #
809 # add included dsc
810 #
811 for filePath in Platform._RawData.IncludedFiles:
812 AllWorkSpaceMetaFiles.add(filePath.Path)
813
814 return AllWorkSpaceMetaFiles
815
816 ## _CheckDuplicateInFV() method
817 #
818 # Check whether there is duplicate modules/files exist in FV section.
819 # The check base on the file GUID;
820 #
821 def _CheckDuplicateInFV(self, Fdf):
822 for Fv in Fdf.Profile.FvDict:
823 _GuidDict = {}
824 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:
825 if FfsFile.InfFileName and FfsFile.NameGuid == None:
826 #
827 # Get INF file GUID
828 #
829 InfFoundFlag = False
830 for Pa in self.AutoGenObjectList:
831 if InfFoundFlag:
832 break
833 for Module in Pa.ModuleAutoGenList:
834 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):
835 InfFoundFlag = True
836 if not Module.Guid.upper() in _GuidDict.keys():
837 _GuidDict[Module.Guid.upper()] = FfsFile
838 break
839 else:
840 EdkLogger.error("build",
841 FORMAT_INVALID,
842 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
843 FfsFile.CurrentLineContent,
844 _GuidDict[Module.Guid.upper()].CurrentLineNum,
845 _GuidDict[Module.Guid.upper()].CurrentLineContent,
846 Module.Guid.upper()),
847 ExtraData=self.FdfFile)
848 #
849 # Some INF files not have entity in DSC file.
850 #
851 if not InfFoundFlag:
852 if FfsFile.InfFileName.find('$') == -1:
853 InfPath = NormPath(FfsFile.InfFileName)
854 if not os.path.exists(InfPath):
855 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))
856
857 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)
858 #
859 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
860 # BuildObject from one of AutoGenObjectList is enough.
861 #
862 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]
863 if not InfObj.Guid.upper() in _GuidDict.keys():
864 _GuidDict[InfObj.Guid.upper()] = FfsFile
865 else:
866 EdkLogger.error("build",
867 FORMAT_INVALID,
868 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
869 FfsFile.CurrentLineContent,
870 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,
871 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,
872 InfObj.Guid.upper()),
873 ExtraData=self.FdfFile)
874 InfFoundFlag = False
875
876 if FfsFile.NameGuid != None:
877 _CheckPCDAsGuidPattern = re.compile("^PCD\(.+\..+\)$")
878
879 #
880 # If the NameGuid reference a PCD name.
881 # The style must match: PCD(xxxx.yyy)
882 #
883 if _CheckPCDAsGuidPattern.match(FfsFile.NameGuid):
884 #
885 # Replace the PCD value.
886 #
887 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")
888 PcdFoundFlag = False
889 for Pa in self.AutoGenObjectList:
890 if not PcdFoundFlag:
891 for PcdItem in Pa.AllPcdList:
892 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:
893 #
894 # First convert from CFormatGuid to GUID string
895 #
896 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)
897
898 if not _PcdGuidString:
899 #
900 # Then try Byte array.
901 #
902 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)
903
904 if not _PcdGuidString:
905 #
906 # Not Byte array or CFormat GUID, raise error.
907 #
908 EdkLogger.error("build",
909 FORMAT_INVALID,
910 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName, PcdItem.DefaultValue),
911 ExtraData=self.FdfFile)
912
913 if not _PcdGuidString.upper() in _GuidDict.keys():
914 _GuidDict[_PcdGuidString.upper()] = FfsFile
915 PcdFoundFlag = True
916 break
917 else:
918 EdkLogger.error("build",
919 FORMAT_INVALID,
920 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
921 FfsFile.CurrentLineContent,
922 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,
923 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,
924 FfsFile.NameGuid.upper()),
925 ExtraData=self.FdfFile)
926
927 if not FfsFile.NameGuid.upper() in _GuidDict.keys():
928 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile
929 else:
930 #
931 # Two raw file GUID conflict.
932 #
933 EdkLogger.error("build",
934 FORMAT_INVALID,
935 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,
936 FfsFile.CurrentLineContent,
937 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,
938 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,
939 FfsFile.NameGuid.upper()),
940 ExtraData=self.FdfFile)
941
942
943 def _CheckPcdDefineAndType(self):
944 PcdTypeList = [
945 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
946 "Dynamic", #"DynamicHii", "DynamicVpd",
947 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
948 ]
949
950 # This dict store PCDs which are not used by any modules with specified arches
951 UnusedPcd = sdict()
952 for Pa in self.AutoGenObjectList:
953 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
954 for Pcd in Pa.Platform.Pcds:
955 PcdType = Pa.Platform.Pcds[Pcd].Type
956
957 # If no PCD type, this PCD comes from FDF
958 if not PcdType:
959 continue
960
961 # Try to remove Hii and Vpd suffix
962 if PcdType.startswith("DynamicEx"):
963 PcdType = "DynamicEx"
964 elif PcdType.startswith("Dynamic"):
965 PcdType = "Dynamic"
966
967 for Package in Pa.PackageList:
968 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
969 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:
970 break
971 for Type in PcdTypeList:
972 if (Pcd[0], Pcd[1], Type) in Package.Pcds:
973 EdkLogger.error(
974 'build',
975 FORMAT_INVALID,
976 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
977 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),
978 ExtraData=None
979 )
980 return
981 else:
982 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)
983
984 for Pcd in UnusedPcd:
985 EdkLogger.warn(
986 'build',
987 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
988 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
989 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),
990 ExtraData=None
991 )
992
993 def __repr__(self):
994 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))
995
996 ## Return the directory to store FV files
997 def _GetFvDir(self):
998 if self._FvDir == None:
999 self._FvDir = path.join(self.BuildDir, 'FV')
1000 return self._FvDir
1001
1002 ## Return the directory to store all intermediate and final files built
1003 def _GetBuildDir(self):
1004 if self._BuildDir == None:
1005 return self.AutoGenObjectList[0].BuildDir
1006
1007 ## Return the build output directory platform specifies
1008 def _GetOutputDir(self):
1009 return self.Platform.OutputDirectory
1010
1011 ## Return platform name
1012 def _GetName(self):
1013 return self.Platform.PlatformName
1014
1015 ## Return meta-file GUID
1016 def _GetGuid(self):
1017 return self.Platform.Guid
1018
1019 ## Return platform version
1020 def _GetVersion(self):
1021 return self.Platform.Version
1022
1023 ## Return paths of tools
1024 def _GetToolDefinition(self):
1025 return self.AutoGenObjectList[0].ToolDefinition
1026
1027 ## Return directory of platform makefile
1028 #
1029 # @retval string Makefile directory
1030 #
1031 def _GetMakeFileDir(self):
1032 if self._MakeFileDir == None:
1033 self._MakeFileDir = self.BuildDir
1034 return self._MakeFileDir
1035
1036 ## Return build command string
1037 #
1038 # @retval string Build command string
1039 #
1040 def _GetBuildCommand(self):
1041 if self._BuildCommand == None:
1042 # BuildCommand should be all the same. So just get one from platform AutoGen
1043 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand
1044 return self._BuildCommand
1045
1046 ## Check the PCDs token value conflict in each DEC file.
1047 #
1048 # Will cause build break and raise error message while two PCDs conflict.
1049 #
1050 # @return None
1051 #
1052 def _CheckAllPcdsTokenValueConflict(self):
1053 for Pa in self.AutoGenObjectList:
1054 for Package in Pa.PackageList:
1055 PcdList = Package.Pcds.values()
1056 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0)))
1057 Count = 0
1058 while (Count < len(PcdList) - 1) :
1059 Item = PcdList[Count]
1060 ItemNext = PcdList[Count + 1]
1061 #
1062 # Make sure in the same token space the TokenValue should be unique
1063 #
1064 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):
1065 SameTokenValuePcdList = []
1066 SameTokenValuePcdList.append(Item)
1067 SameTokenValuePcdList.append(ItemNext)
1068 RemainPcdListLength = len(PcdList) - Count - 2
1069 for ValueSameCount in range(RemainPcdListLength):
1070 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):
1071 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])
1072 else:
1073 break;
1074 #
1075 # Sort same token value PCD list with TokenGuid and TokenCName
1076 #
1077 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1078 SameTokenValuePcdListCount = 0
1079 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):
1080 Flag = False
1081 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]
1082 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]
1083
1084 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):
1085 for PcdItem in GlobalData.MixedPcd:
1086 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \
1087 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
1088 Flag = True
1089 if not Flag:
1090 EdkLogger.error(
1091 'build',
1092 FORMAT_INVALID,
1093 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1094 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),
1095 ExtraData=None
1096 )
1097 SameTokenValuePcdListCount += 1
1098 Count += SameTokenValuePcdListCount
1099 Count += 1
1100
1101 PcdList = Package.Pcds.values()
1102 PcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))
1103 Count = 0
1104 while (Count < len(PcdList) - 1) :
1105 Item = PcdList[Count]
1106 ItemNext = PcdList[Count + 1]
1107 #
1108 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1109 #
1110 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):
1111 EdkLogger.error(
1112 'build',
1113 FORMAT_INVALID,
1114 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1115 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),
1116 ExtraData=None
1117 )
1118 Count += 1
1119 ## Generate fds command
1120 def _GenFdsCommand(self):
1121 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()
1122
1123 ## Create makefile for the platform and modules in it
1124 #
1125 # @param CreateDepsMakeFile Flag indicating if the makefile for
1126 # modules will be created as well
1127 #
1128 def CreateMakeFile(self, CreateDepsMakeFile=False):
1129 if CreateDepsMakeFile:
1130 for Pa in self.AutoGenObjectList:
1131 Pa.CreateMakeFile(CreateDepsMakeFile)
1132
1133 ## Create autogen code for platform and modules
1134 #
1135 # Since there's no autogen code for platform, this method will do nothing
1136 # if CreateModuleCodeFile is set to False.
1137 #
1138 # @param CreateDepsCodeFile Flag indicating if creating module's
1139 # autogen code file or not
1140 #
1141 def CreateCodeFile(self, CreateDepsCodeFile=False):
1142 if not CreateDepsCodeFile:
1143 return
1144 for Pa in self.AutoGenObjectList:
1145 Pa.CreateCodeFile(CreateDepsCodeFile)
1146
1147 ## Create AsBuilt INF file the platform
1148 #
1149 def CreateAsBuiltInf(self):
1150 return
1151
1152 Name = property(_GetName)
1153 Guid = property(_GetGuid)
1154 Version = property(_GetVersion)
1155 OutputDir = property(_GetOutputDir)
1156
1157 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
1158
1159 BuildDir = property(_GetBuildDir)
1160 FvDir = property(_GetFvDir)
1161 MakeFileDir = property(_GetMakeFileDir)
1162 BuildCommand = property(_GetBuildCommand)
1163 GenFdsCommand = property(_GenFdsCommand)
1164
1165 ## AutoGen class for platform
1166 #
1167 # PlatformAutoGen class will process the original information in platform
1168 # file in order to generate makefile for platform.
1169 #
1170 class PlatformAutoGen(AutoGen):
1171 #
1172 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1173 # correct PCD database
1174 #
1175 _DynaPcdList_ = []
1176 _NonDynaPcdList_ = []
1177 _PlatformPcds = {}
1178
1179 #
1180 # The priority list while override build option
1181 #
1182 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1183 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1184 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1185 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1186 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1187 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1188 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1189 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1190 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1191 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1192 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1193 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1194 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1195 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1196 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1197 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1198
1199 ## The real constructor of PlatformAutoGen
1200 #
1201 # This method is not supposed to be called by users of PlatformAutoGen. It's
1202 # only used by factory method __new__() to do real initialization work for an
1203 # object of PlatformAutoGen
1204 #
1205 # @param Workspace WorkspaceAutoGen object
1206 # @param PlatformFile Platform file (DSC file)
1207 # @param Target Build target (DEBUG, RELEASE)
1208 # @param Toolchain Name of tool chain
1209 # @param Arch arch of the platform supports
1210 #
1211 def _Init(self, Workspace, PlatformFile, Target, Toolchain, Arch):
1212 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))
1213 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)
1214
1215 self.MetaFile = PlatformFile
1216 self.Workspace = Workspace
1217 self.WorkspaceDir = Workspace.WorkspaceDir
1218 self.ToolChain = Toolchain
1219 self.BuildTarget = Target
1220 self.Arch = Arch
1221 self.SourceDir = PlatformFile.SubDir
1222 self.SourceOverrideDir = None
1223 self.FdTargetList = self.Workspace.FdTargetList
1224 self.FvTargetList = self.Workspace.FvTargetList
1225 self.AllPcdList = []
1226 # get the original module/package/platform objects
1227 self.BuildDatabase = Workspace.BuildDatabase
1228 self.DscBuildDataObj = Workspace.Platform
1229
1230 # flag indicating if the makefile/C-code file has been created or not
1231 self.IsMakeFileCreated = False
1232 self.IsCodeFileCreated = False
1233
1234 self._Platform = None
1235 self._Name = None
1236 self._Guid = None
1237 self._Version = None
1238
1239 self._BuildRule = None
1240 self._SourceDir = None
1241 self._BuildDir = None
1242 self._OutputDir = None
1243 self._FvDir = None
1244 self._MakeFileDir = None
1245 self._FdfFile = None
1246
1247 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1248 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1249 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1250 self._NonDynamicPcdDict = {}
1251
1252 self._ToolDefinitions = None
1253 self._ToolDefFile = None # toolcode : tool path
1254 self._ToolChainFamily = None
1255 self._BuildRuleFamily = None
1256 self._BuildOption = None # toolcode : option
1257 self._EdkBuildOption = None # edktoolcode : option
1258 self._EdkIIBuildOption = None # edkiitoolcode : option
1259 self._PackageList = None
1260 self._ModuleAutoGenList = None
1261 self._LibraryAutoGenList = None
1262 self._BuildCommand = None
1263 self._AsBuildInfList = []
1264 self._AsBuildModuleList = []
1265 if GlobalData.gFdfParser != None:
1266 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList
1267 for Inf in self._AsBuildInfList:
1268 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)
1269 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1270 if not M.IsSupportedArch:
1271 continue
1272 self._AsBuildModuleList.append(InfClass)
1273 # get library/modules for build
1274 self.LibraryBuildDirectoryList = []
1275 self.ModuleBuildDirectoryList = []
1276 return True
1277
1278 def __repr__(self):
1279 return "%s [%s]" % (self.MetaFile, self.Arch)
1280
1281 ## Create autogen code for platform and modules
1282 #
1283 # Since there's no autogen code for platform, this method will do nothing
1284 # if CreateModuleCodeFile is set to False.
1285 #
1286 # @param CreateModuleCodeFile Flag indicating if creating module's
1287 # autogen code file or not
1288 #
1289 def CreateCodeFile(self, CreateModuleCodeFile=False):
1290 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1291 if self.IsCodeFileCreated or not CreateModuleCodeFile:
1292 return
1293
1294 for Ma in self.ModuleAutoGenList:
1295 Ma.CreateCodeFile(True)
1296
1297 # don't do this twice
1298 self.IsCodeFileCreated = True
1299
1300 ## Generate Fds Command
1301 def _GenFdsCommand(self):
1302 return self.Workspace.GenFdsCommand
1303
1304 ## Create makefile for the platform and mdoules in it
1305 #
1306 # @param CreateModuleMakeFile Flag indicating if the makefile for
1307 # modules will be created as well
1308 #
1309 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):
1310 if CreateModuleMakeFile:
1311 for ModuleFile in self.Platform.Modules:
1312 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,
1313 self.ToolChain, self.Arch, self.MetaFile)
1314 if (ModuleFile.File, self.Arch) in FfsCommand:
1315 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])
1316 else:
1317 Ma.CreateMakeFile(True)
1318 #Ma.CreateAsBuiltInf()
1319
1320 # no need to create makefile for the platform more than once
1321 if self.IsMakeFileCreated:
1322 return
1323
1324 # create library/module build dirs for platform
1325 Makefile = GenMake.PlatformMakefile(self)
1326 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()
1327 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()
1328
1329 self.IsMakeFileCreated = True
1330
1331 ## Deal with Shared FixedAtBuild Pcds
1332 #
1333 def CollectFixedAtBuildPcds(self):
1334 for LibAuto in self.LibraryAutoGenList:
1335 FixedAtBuildPcds = {}
1336 ShareFixedAtBuildPcdsSameValue = {}
1337 for Module in LibAuto._ReferenceModules:
1338 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:
1339 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1340 if key not in FixedAtBuildPcds:
1341 ShareFixedAtBuildPcdsSameValue[key] = True
1342 FixedAtBuildPcds[key] = Pcd.DefaultValue
1343 else:
1344 if FixedAtBuildPcds[key] != Pcd.DefaultValue:
1345 ShareFixedAtBuildPcdsSameValue[key] = False
1346 for Pcd in LibAuto.FixedAtBuildPcds:
1347 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1348 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:
1349 continue
1350 else:
1351 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]
1352 if DscPcd.Type != "FixedAtBuild":
1353 continue
1354 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:
1355 LibAuto.ConstPcd[key] = Pcd.DefaultValue
1356
1357 def CollectVariables(self, DynamicPcdSet):
1358 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(),self.DscBuildDataObj._GetSkuIds())
1359 Index = 0
1360 for Pcd in DynamicPcdSet:
1361 pcdname = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1362 for SkuName in Pcd.SkuInfoList:
1363 Sku = Pcd.SkuInfoList[SkuName]
1364 SkuId = Sku.SkuId
1365 if SkuId == None or SkuId == '':
1366 continue
1367 if len(Sku.VariableName) > 0:
1368 VariableGuidStructure = Sku.VariableGuidValue
1369 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)
1370 if Pcd.Phase == "DXE":
1371 for StorageName in Sku.DefaultStoreDict:
1372 VariableInfo.append_variable(var_info(Index,pcdname,StorageName,SkuName, StringToArray(Sku.VariableName),VariableGuid, Sku.VariableAttribute , Pcd.DefaultValue,Sku.DefaultStoreDict[StorageName],Pcd.DatumType))
1373 Index += 1
1374 return VariableInfo
1375 ## Collect dynamic PCDs
1376 #
1377 # Gather dynamic PCDs list from each module and their settings from platform
1378 # This interface should be invoked explicitly when platform action is created.
1379 #
1380 def CollectPlatformDynamicPcds(self):
1381 # Override the platform Pcd's value by build option
1382 if GlobalData.BuildOptionPcd:
1383 for key in self.Platform.Pcds:
1384 PlatformPcd = self.Platform.Pcds[key]
1385 for PcdItem in GlobalData.BuildOptionPcd:
1386 if (PlatformPcd.TokenSpaceGuidCName, PlatformPcd.TokenCName) == (PcdItem[0], PcdItem[1]):
1387 PlatformPcd.DefaultValue = PcdItem[2]
1388 if PlatformPcd.SkuInfoList:
1389 Sku = PlatformPcd.SkuInfoList[PlatformPcd.SkuInfoList.keys()[0]]
1390 Sku.DefaultValue = PcdItem[2]
1391 break
1392
1393 for key in self.Platform.Pcds:
1394 for SinglePcd in GlobalData.MixedPcd:
1395 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
1396 for item in GlobalData.MixedPcd[SinglePcd]:
1397 Pcd_Type = item[0].split('_')[-1]
1398 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 \
1399 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):
1400 Value = self.Platform.Pcds[key]
1401 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type
1402 if len(key) == 2:
1403 newkey = (Value.TokenCName, key[1])
1404 elif len(key) == 3:
1405 newkey = (Value.TokenCName, key[1], key[2])
1406 del self.Platform.Pcds[key]
1407 self.Platform.Pcds[newkey] = Value
1408 break
1409 else:
1410 pass
1411 break
1412 else:
1413 pass
1414
1415 # for gathering error information
1416 NoDatumTypePcdList = set()
1417 PcdNotInDb = []
1418 self._GuidValue = {}
1419 FdfModuleList = []
1420 for InfName in self._AsBuildInfList:
1421 InfName = mws.join(self.WorkspaceDir, InfName)
1422 FdfModuleList.append(os.path.normpath(InfName))
1423 for F in self.Platform.Modules.keys():
1424 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
1425 #GuidValue.update(M.Guids)
1426
1427 self.Platform.Modules[F].M = M
1428
1429 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:
1430 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1431 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1432 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
1433
1434 # Check the PCD from Binary INF or Source INF
1435 if M.IsBinaryModule == True:
1436 PcdFromModule.IsFromBinaryInf = True
1437
1438 # Check the PCD from DSC or not
1439 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
1440 PcdFromModule.IsFromDsc = True
1441 else:
1442 PcdFromModule.IsFromDsc = False
1443 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
1444 if F.Path not in FdfModuleList:
1445 # If one of the Source built modules listed in the DSC is not listed
1446 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1447 # access method (it is only listed in the DEC file that declares the
1448 # PCD as PcdsDynamic), then build tool will report warning message
1449 # notify the PI that they are attempting to build a module that must
1450 # be included in a flash image in order to be functional. These Dynamic
1451 # PCD will not be added into the Database unless it is used by other
1452 # modules that are included in the FDF file.
1453 if PcdFromModule.Type in GenC.gDynamicPcd and \
1454 PcdFromModule.IsFromBinaryInf == False:
1455 # Print warning message to let the developer make a determine.
1456 if PcdFromModule not in PcdNotInDb:
1457 PcdNotInDb.append(PcdFromModule)
1458 continue
1459 # If one of the Source built modules listed in the DSC is not listed in
1460 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1461 # access method (it is only listed in the DEC file that declares the
1462 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1463 # PCD to the Platform's PCD Database.
1464 if PcdFromModule.Type in GenC.gDynamicExPcd:
1465 if PcdFromModule not in PcdNotInDb:
1466 PcdNotInDb.append(PcdFromModule)
1467 continue
1468 #
1469 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1470 # it should be stored in Pcd PEI database, If a dynamic only
1471 # used by DXE module, it should be stored in DXE PCD database.
1472 # The default Phase is DXE
1473 #
1474 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1475 PcdFromModule.Phase = "PEI"
1476 if PcdFromModule not in self._DynaPcdList_:
1477 self._DynaPcdList_.append(PcdFromModule)
1478 elif PcdFromModule.Phase == 'PEI':
1479 # overwrite any the same PCD existing, if Phase is PEI
1480 Index = self._DynaPcdList_.index(PcdFromModule)
1481 self._DynaPcdList_[Index] = PcdFromModule
1482 elif PcdFromModule not in self._NonDynaPcdList_:
1483 self._NonDynaPcdList_.append(PcdFromModule)
1484 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1485 Index = self._NonDynaPcdList_.index(PcdFromModule)
1486 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1487 #The PCD from Binary INF will override the same one from source INF
1488 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1489 PcdFromModule.Pending = False
1490 self._NonDynaPcdList_.append (PcdFromModule)
1491 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1492 DscModuleList = []
1493 for ModuleInf in self.Platform.Modules.keys():
1494 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1495 # add the PCD from modules that listed in FDF but not in DSC to Database
1496 for InfName in FdfModuleList:
1497 if InfName not in DscModuleList:
1498 InfClass = PathClass(InfName)
1499 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1500 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1501 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1502 # For binary module, if in current arch, we need to list the PCDs into database.
1503 if not M.IsSupportedArch:
1504 continue
1505 # Override the module PCD setting by platform setting
1506 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1507 for PcdFromModule in ModulePcdList:
1508 PcdFromModule.IsFromBinaryInf = True
1509 PcdFromModule.IsFromDsc = False
1510 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1511 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1512 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1513 File=self.MetaFile,
1514 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1515 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1516 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1517 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1518 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1519 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1520 PcdFromModule.Phase = "PEI"
1521 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1522 self._DynaPcdList_.append(PcdFromModule)
1523 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1524 self._NonDynaPcdList_.append(PcdFromModule)
1525 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1526 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1527 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1528 # module & DXE module at a same time.
1529 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1530 # INF file as DynamicEx.
1531 Index = self._DynaPcdList_.index(PcdFromModule)
1532 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1533 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1534 for PcdFromModule in self._NonDynaPcdList_:
1535 # If a PCD is not listed in the DSC file, but binary INF files used by
1536 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1537 # section, AND all source INF files used by this platform the build
1538 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1539 # section, then the tools must NOT add the PCD to the Platform's PCD
1540 # Database; the build must assign the access method for this PCD as
1541 # PcdsPatchableInModule.
1542 if PcdFromModule not in self._DynaPcdList_:
1543 continue
1544 Index = self._DynaPcdList_.index(PcdFromModule)
1545 if PcdFromModule.IsFromDsc == False and \
1546 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1547 PcdFromModule.IsFromBinaryInf == True and \
1548 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1549 Index = self._DynaPcdList_.index(PcdFromModule)
1550 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1551
1552 # print out error information and break the build, if error found
1553 if len(NoDatumTypePcdList) > 0:
1554 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1555 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1556 File=self.MetaFile,
1557 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1558 % NoDatumTypePcdListString)
1559 self._NonDynamicPcdList = self._NonDynaPcdList_
1560 self._DynamicPcdList = self._DynaPcdList_
1561 #
1562 # Sort dynamic PCD list to:
1563 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1564 # try to be put header of dynamicd List
1565 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1566 #
1567 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1568 #
1569 UnicodePcdArray = []
1570 HiiPcdArray = []
1571 OtherPcdArray = []
1572 VpdPcdDict = {}
1573 VpdFile = VpdInfoFile.VpdInfoFile()
1574 NeedProcessVpdMapFile = False
1575
1576 for pcd in self.Platform.Pcds.keys():
1577 if pcd not in self._PlatformPcds.keys():
1578 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]
1579
1580 for item in self._PlatformPcds:
1581 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1582 self._PlatformPcds[item].DatumType = "VOID*"
1583
1584 if (self.Workspace.ArchList[-1] == self.Arch):
1585 for Pcd in self._DynamicPcdList:
1586 # just pick the a value to determine whether is unicode string type
1587 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1588 Sku.VpdOffset = Sku.VpdOffset.strip()
1589
1590 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1591 Pcd.DatumType = "VOID*"
1592
1593 PcdValue = Sku.DefaultValue
1594 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1595 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1596 UnicodePcdArray.append(Pcd)
1597 elif len(Sku.VariableName) > 0:
1598 # if found HII type PCD then insert to right of UnicodeIndex
1599 HiiPcdArray.append(Pcd)
1600 else:
1601 OtherPcdArray.append(Pcd)
1602 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1603 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1604
1605 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1606 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1607 if PcdNvStoreDfBuffer:
1608 var_info = self.CollectVariables(self._DynamicPcdList)
1609 default_skuobj = PcdNvStoreDfBuffer.SkuInfoList.get("DEFAULT")
1610 vardump = var_info.dump()
1611 if vardump:
1612 default_skuobj.DefaultValue = vardump
1613 PcdNvStoreDfBuffer.DefaultValue = vardump
1614 if default_skuobj:
1615 PcdNvStoreDfBuffer.SkuInfoList.clear()
1616 PcdNvStoreDfBuffer.SkuInfoList['DEFAULT'] = default_skuobj
1617 PcdNvStoreDfBuffer.MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))
1618
1619 PlatformPcds = self._PlatformPcds.keys()
1620 PlatformPcds.sort()
1621 #
1622 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1623 #
1624 for PcdKey in PlatformPcds:
1625 Pcd = self._PlatformPcds[PcdKey]
1626 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1627 PcdKey in VpdPcdDict:
1628 Pcd = VpdPcdDict[PcdKey]
1629 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1630 Sku.VpdOffset = Sku.VpdOffset.strip()
1631 PcdValue = Sku.DefaultValue
1632 if PcdValue == "":
1633 PcdValue = Pcd.DefaultValue
1634 if Sku.VpdOffset != '*':
1635 if PcdValue.startswith("{"):
1636 Alignment = 8
1637 elif PcdValue.startswith("L"):
1638 Alignment = 2
1639 else:
1640 Alignment = 1
1641 try:
1642 VpdOffset = int(Sku.VpdOffset)
1643 except:
1644 try:
1645 VpdOffset = int(Sku.VpdOffset, 16)
1646 except:
1647 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1648 if VpdOffset % Alignment != 0:
1649 if PcdValue.startswith("{"):
1650 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)
1651 else:
1652 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))
1653 VpdFile.Add(Pcd, Sku.VpdOffset)
1654 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1655 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1656 NeedProcessVpdMapFile = True
1657 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':
1658 EdkLogger.error("Build", FILE_NOT_FOUND, \
1659 "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.")
1660
1661
1662 #
1663 # Fix the PCDs define in VPD PCD section that never referenced by module.
1664 # An example is PCD for signature usage.
1665 #
1666 for DscPcd in PlatformPcds:
1667 DscPcdEntry = self._PlatformPcds[DscPcd]
1668 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1669 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):
1670 FoundFlag = False
1671 for VpdPcd in VpdFile._VpdArray.keys():
1672 # This PCD has been referenced by module
1673 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1674 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1675 FoundFlag = True
1676
1677 # Not found, it should be signature
1678 if not FoundFlag :
1679 # just pick the a value to determine whether is unicode string type
1680 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():
1681 Sku.VpdOffset = Sku.VpdOffset.strip()
1682
1683 # Need to iterate DEC pcd information to get the value & datumtype
1684 for eachDec in self.PackageList:
1685 for DecPcd in eachDec.Pcds:
1686 DecPcdEntry = eachDec.Pcds[DecPcd]
1687 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1688 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1689 # Print warning message to let the developer make a determine.
1690 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1691 File=self.MetaFile, \
1692 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1693 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1694
1695 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1696 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1697 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1698 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1699 # Only fix the value while no value provided in DSC file.
1700 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1701 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1702
1703 if DscPcdEntry not in self._DynamicPcdList:
1704 self._DynamicPcdList.append(DscPcdEntry)
1705 # Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]
1706 Sku.VpdOffset = Sku.VpdOffset.strip()
1707 PcdValue = Sku.DefaultValue
1708 if PcdValue == "":
1709 PcdValue = DscPcdEntry.DefaultValue
1710 if Sku.VpdOffset != '*':
1711 if PcdValue.startswith("{"):
1712 Alignment = 8
1713 elif PcdValue.startswith("L"):
1714 Alignment = 2
1715 else:
1716 Alignment = 1
1717 try:
1718 VpdOffset = int(Sku.VpdOffset)
1719 except:
1720 try:
1721 VpdOffset = int(Sku.VpdOffset, 16)
1722 except:
1723 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))
1724 if VpdOffset % Alignment != 0:
1725 if PcdValue.startswith("{"):
1726 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)
1727 else:
1728 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))
1729 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)
1730 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1731 NeedProcessVpdMapFile = True
1732 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1733 UnicodePcdArray.append(DscPcdEntry)
1734 elif len(Sku.VariableName) > 0:
1735 HiiPcdArray.append(DscPcdEntry)
1736 else:
1737 OtherPcdArray.append(DscPcdEntry)
1738
1739 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1740
1741
1742
1743 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \
1744 VpdFile.GetCount() != 0:
1745 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1746 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1747
1748 if VpdFile.GetCount() != 0:
1749 FvPath = os.path.join(self.BuildDir, "FV")
1750 if not os.path.exists(FvPath):
1751 try:
1752 os.makedirs(FvPath)
1753 except:
1754 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1755
1756 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1757
1758 if VpdFile.Write(VpdFilePath):
1759 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1760 BPDGToolName = None
1761 for ToolDef in self.ToolDefinition.values():
1762 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1763 if not ToolDef.has_key("PATH"):
1764 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1765 BPDGToolName = ToolDef["PATH"]
1766 break
1767 # Call third party GUID BPDG tool.
1768 if BPDGToolName != None:
1769 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1770 else:
1771 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.")
1772
1773 # Process VPD map file generated by third party BPDG tool
1774 if NeedProcessVpdMapFile:
1775 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1776 if os.path.exists(VpdMapFilePath):
1777 VpdFile.Read(VpdMapFilePath)
1778
1779 # Fixup "*" offset
1780 for Pcd in self._DynamicPcdList:
1781 # just pick the a value to determine whether is unicode string type
1782 i = 0
1783 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1784 if Sku.VpdOffset == "*":
1785 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[i].strip()
1786 i += 1
1787 else:
1788 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1789
1790 # Delete the DynamicPcdList At the last time enter into this function
1791 del self._DynamicPcdList[:]
1792 self._DynamicPcdList.extend(UnicodePcdArray)
1793 self._DynamicPcdList.extend(HiiPcdArray)
1794 self._DynamicPcdList.extend(OtherPcdArray)
1795 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]
1796 for pcd in self._DynamicPcdList:
1797 if len(pcd.SkuInfoList) == 1:
1798 for (SkuName,SkuId) in allskuset:
1799 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:
1800 continue
1801 pcd.SkuInfoList[SkuName] = pcd.SkuInfoList['DEFAULT']
1802 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1803
1804 ## Return the platform build data object
1805 def _GetPlatform(self):
1806 if self._Platform == None:
1807 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1808 return self._Platform
1809
1810 ## Return platform name
1811 def _GetName(self):
1812 return self.Platform.PlatformName
1813
1814 ## Return the meta file GUID
1815 def _GetGuid(self):
1816 return self.Platform.Guid
1817
1818 ## Return the platform version
1819 def _GetVersion(self):
1820 return self.Platform.Version
1821
1822 ## Return the FDF file name
1823 def _GetFdfFile(self):
1824 if self._FdfFile == None:
1825 if self.Workspace.FdfFile != "":
1826 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)
1827 else:
1828 self._FdfFile = ''
1829 return self._FdfFile
1830
1831 ## Return the build output directory platform specifies
1832 def _GetOutputDir(self):
1833 return self.Platform.OutputDirectory
1834
1835 ## Return the directory to store all intermediate and final files built
1836 def _GetBuildDir(self):
1837 if self._BuildDir == None:
1838 if os.path.isabs(self.OutputDir):
1839 self._BuildDir = path.join(
1840 path.abspath(self.OutputDir),
1841 self.BuildTarget + "_" + self.ToolChain,
1842 )
1843 else:
1844 self._BuildDir = path.join(
1845 self.WorkspaceDir,
1846 self.OutputDir,
1847 self.BuildTarget + "_" + self.ToolChain,
1848 )
1849 GlobalData.gBuildDirectory = self._BuildDir
1850 return self._BuildDir
1851
1852 ## Return directory of platform makefile
1853 #
1854 # @retval string Makefile directory
1855 #
1856 def _GetMakeFileDir(self):
1857 if self._MakeFileDir == None:
1858 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1859 return self._MakeFileDir
1860
1861 ## Return build command string
1862 #
1863 # @retval string Build command string
1864 #
1865 def _GetBuildCommand(self):
1866 if self._BuildCommand == None:
1867 self._BuildCommand = []
1868 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1869 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1870 if "FLAGS" in self.ToolDefinition["MAKE"]:
1871 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1872 if NewOption != '':
1873 self._BuildCommand += SplitOption(NewOption)
1874 return self._BuildCommand
1875
1876 ## Get tool chain definition
1877 #
1878 # Get each tool defition for given tool chain from tools_def.txt and platform
1879 #
1880 def _GetToolDefinition(self):
1881 if self._ToolDefinitions == None:
1882 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1883 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1884 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1885 ExtraData="[%s]" % self.MetaFile)
1886 self._ToolDefinitions = {}
1887 DllPathList = set()
1888 for Def in ToolDefinition:
1889 Target, Tag, Arch, Tool, Attr = Def.split("_")
1890 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1891 continue
1892
1893 Value = ToolDefinition[Def]
1894 # don't record the DLL
1895 if Attr == "DLL":
1896 DllPathList.add(Value)
1897 continue
1898
1899 if Tool not in self._ToolDefinitions:
1900 self._ToolDefinitions[Tool] = {}
1901 self._ToolDefinitions[Tool][Attr] = Value
1902
1903 ToolsDef = ''
1904 MakePath = ''
1905 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
1906 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
1907 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
1908 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
1909 MakeFlags = ''
1910 for Tool in self._ToolDefinitions:
1911 for Attr in self._ToolDefinitions[Tool]:
1912 Value = self._ToolDefinitions[Tool][Attr]
1913 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
1914 # check if override is indicated
1915 if self.BuildOption[Tool][Attr].startswith('='):
1916 Value = self.BuildOption[Tool][Attr][1:]
1917 else:
1918 if Attr != 'PATH':
1919 Value += " " + self.BuildOption[Tool][Attr]
1920 else:
1921 Value = self.BuildOption[Tool][Attr]
1922
1923 if Attr == "PATH":
1924 # Don't put MAKE definition in the file
1925 if Tool == "MAKE":
1926 MakePath = Value
1927 else:
1928 ToolsDef += "%s = %s\n" % (Tool, Value)
1929 elif Attr != "DLL":
1930 # Don't put MAKE definition in the file
1931 if Tool == "MAKE":
1932 if Attr == "FLAGS":
1933 MakeFlags = Value
1934 else:
1935 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
1936 ToolsDef += "\n"
1937
1938 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
1939 for DllPath in DllPathList:
1940 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
1941 os.environ["MAKE_FLAGS"] = MakeFlags
1942
1943 return self._ToolDefinitions
1944
1945 ## Return the paths of tools
1946 def _GetToolDefFile(self):
1947 if self._ToolDefFile == None:
1948 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
1949 return self._ToolDefFile
1950
1951 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1952 def _GetToolChainFamily(self):
1953 if self._ToolChainFamily == None:
1954 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1955 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
1956 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
1957 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
1958 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1959 % self.ToolChain)
1960 self._ToolChainFamily = "MSFT"
1961 else:
1962 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
1963 return self._ToolChainFamily
1964
1965 def _GetBuildRuleFamily(self):
1966 if self._BuildRuleFamily == None:
1967 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1968 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
1969 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
1970 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
1971 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1972 % self.ToolChain)
1973 self._BuildRuleFamily = "MSFT"
1974 else:
1975 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
1976 return self._BuildRuleFamily
1977
1978 ## Return the build options specific for all modules in this platform
1979 def _GetBuildOptions(self):
1980 if self._BuildOption == None:
1981 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
1982 return self._BuildOption
1983
1984 ## Return the build options specific for EDK modules in this platform
1985 def _GetEdkBuildOptions(self):
1986 if self._EdkBuildOption == None:
1987 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
1988 return self._EdkBuildOption
1989
1990 ## Return the build options specific for EDKII modules in this platform
1991 def _GetEdkIIBuildOptions(self):
1992 if self._EdkIIBuildOption == None:
1993 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
1994 return self._EdkIIBuildOption
1995
1996 ## Parse build_rule.txt in Conf Directory.
1997 #
1998 # @retval BuildRule object
1999 #
2000 def _GetBuildRule(self):
2001 if self._BuildRule == None:
2002 BuildRuleFile = None
2003 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
2004 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
2005 if BuildRuleFile in [None, '']:
2006 BuildRuleFile = gDefaultBuildRuleFile
2007 self._BuildRule = BuildRule(BuildRuleFile)
2008 if self._BuildRule._FileVersion == "":
2009 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
2010 else:
2011 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
2012 # If Build Rule's version is less than the version number required by the tools, halting the build.
2013 EdkLogger.error("build", AUTOGEN_ERROR,
2014 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])"\
2015 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
2016
2017 return self._BuildRule
2018
2019 ## Summarize the packages used by modules in this platform
2020 def _GetPackageList(self):
2021 if self._PackageList == None:
2022 self._PackageList = set()
2023 for La in self.LibraryAutoGenList:
2024 self._PackageList.update(La.DependentPackageList)
2025 for Ma in self.ModuleAutoGenList:
2026 self._PackageList.update(Ma.DependentPackageList)
2027 #Collect package set information from INF of FDF
2028 PkgSet = set()
2029 for ModuleFile in self._AsBuildModuleList:
2030 if ModuleFile in self.Platform.Modules:
2031 continue
2032 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
2033 PkgSet.update(ModuleData.Packages)
2034 self._PackageList = list(self._PackageList) + list (PkgSet)
2035 return self._PackageList
2036
2037 def _GetNonDynamicPcdDict(self):
2038 if self._NonDynamicPcdDict:
2039 return self._NonDynamicPcdDict
2040 for Pcd in self.NonDynamicPcdList:
2041 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
2042 return self._NonDynamicPcdDict
2043
2044 ## Get list of non-dynamic PCDs
2045 def _GetNonDynamicPcdList(self):
2046 if self._NonDynamicPcdList == None:
2047 self.CollectPlatformDynamicPcds()
2048 return self._NonDynamicPcdList
2049
2050 ## Get list of dynamic PCDs
2051 def _GetDynamicPcdList(self):
2052 if self._DynamicPcdList == None:
2053 self.CollectPlatformDynamicPcds()
2054 return self._DynamicPcdList
2055
2056 ## Generate Token Number for all PCD
2057 def _GetPcdTokenNumbers(self):
2058 if self._PcdTokenNumber == None:
2059 self._PcdTokenNumber = sdict()
2060 TokenNumber = 1
2061 #
2062 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2063 # Such as:
2064 #
2065 # Dynamic PCD:
2066 # TokenNumber 0 ~ 10
2067 # DynamicEx PCD:
2068 # TokeNumber 11 ~ 20
2069 #
2070 for Pcd in self.DynamicPcdList:
2071 if Pcd.Phase == "PEI":
2072 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2073 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2074 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2075 TokenNumber += 1
2076
2077 for Pcd in self.DynamicPcdList:
2078 if Pcd.Phase == "PEI":
2079 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2080 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2081 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2082 TokenNumber += 1
2083
2084 for Pcd in self.DynamicPcdList:
2085 if Pcd.Phase == "DXE":
2086 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2087 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2088 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2089 TokenNumber += 1
2090
2091 for Pcd in self.DynamicPcdList:
2092 if Pcd.Phase == "DXE":
2093 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2094 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2095 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2096 TokenNumber += 1
2097
2098 for Pcd in self.NonDynamicPcdList:
2099 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2100 TokenNumber += 1
2101 return self._PcdTokenNumber
2102
2103 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2104 def _GetAutoGenObjectList(self):
2105 self._ModuleAutoGenList = []
2106 self._LibraryAutoGenList = []
2107 for ModuleFile in self.Platform.Modules:
2108 Ma = ModuleAutoGen(
2109 self.Workspace,
2110 ModuleFile,
2111 self.BuildTarget,
2112 self.ToolChain,
2113 self.Arch,
2114 self.MetaFile
2115 )
2116 if Ma not in self._ModuleAutoGenList:
2117 self._ModuleAutoGenList.append(Ma)
2118 for La in Ma.LibraryAutoGenList:
2119 if La not in self._LibraryAutoGenList:
2120 self._LibraryAutoGenList.append(La)
2121 if Ma not in La._ReferenceModules:
2122 La._ReferenceModules.append(Ma)
2123
2124 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2125 def _GetModuleAutoGenList(self):
2126 if self._ModuleAutoGenList == None:
2127 self._GetAutoGenObjectList()
2128 return self._ModuleAutoGenList
2129
2130 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2131 def _GetLibraryAutoGenList(self):
2132 if self._LibraryAutoGenList == None:
2133 self._GetAutoGenObjectList()
2134 return self._LibraryAutoGenList
2135
2136 ## Test if a module is supported by the platform
2137 #
2138 # An error will be raised directly if the module or its arch is not supported
2139 # by the platform or current configuration
2140 #
2141 def ValidModule(self, Module):
2142 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
2143 or Module in self._AsBuildModuleList
2144
2145 ## Resolve the library classes in a module to library instances
2146 #
2147 # This method will not only resolve library classes but also sort the library
2148 # instances according to the dependency-ship.
2149 #
2150 # @param Module The module from which the library classes will be resolved
2151 #
2152 # @retval library_list List of library instances sorted
2153 #
2154 def ApplyLibraryInstance(self, Module):
2155 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2156 if str(Module) not in self.Platform.Modules:
2157 return []
2158
2159 ModuleType = Module.ModuleType
2160
2161 # for overridding library instances with module specific setting
2162 PlatformModule = self.Platform.Modules[str(Module)]
2163
2164 # add forced library instances (specified under LibraryClasses sections)
2165 #
2166 # If a module has a MODULE_TYPE of USER_DEFINED,
2167 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2168 #
2169 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
2170 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
2171 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
2172 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
2173
2174 # add forced library instances (specified in module overrides)
2175 for LibraryClass in PlatformModule.LibraryClasses:
2176 if LibraryClass.startswith("NULL"):
2177 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
2178
2179 # EdkII module
2180 LibraryConsumerList = [Module]
2181 Constructor = []
2182 ConsumedByList = sdict()
2183 LibraryInstance = sdict()
2184
2185 EdkLogger.verbose("")
2186 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2187 while len(LibraryConsumerList) > 0:
2188 M = LibraryConsumerList.pop()
2189 for LibraryClassName in M.LibraryClasses:
2190 if LibraryClassName not in LibraryInstance:
2191 # override library instance for this module
2192 if LibraryClassName in PlatformModule.LibraryClasses:
2193 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
2194 else:
2195 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
2196 if LibraryPath == None or LibraryPath == "":
2197 LibraryPath = M.LibraryClasses[LibraryClassName]
2198 if LibraryPath == None or LibraryPath == "":
2199 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
2200 "Instance of library class [%s] is not found" % LibraryClassName,
2201 File=self.MetaFile,
2202 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
2203
2204 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
2205 # for those forced library instance (NULL library), add a fake library class
2206 if LibraryClassName.startswith("NULL"):
2207 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
2208 elif LibraryModule.LibraryClass == None \
2209 or len(LibraryModule.LibraryClass) == 0 \
2210 or (ModuleType != 'USER_DEFINED'
2211 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
2212 # only USER_DEFINED can link against any library instance despite of its SupModList
2213 EdkLogger.error("build", OPTION_MISSING,
2214 "Module type [%s] is not supported by library instance [%s]" \
2215 % (ModuleType, LibraryPath), File=self.MetaFile,
2216 ExtraData="consumed by [%s]" % str(Module))
2217
2218 LibraryInstance[LibraryClassName] = LibraryModule
2219 LibraryConsumerList.append(LibraryModule)
2220 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
2221 else:
2222 LibraryModule = LibraryInstance[LibraryClassName]
2223
2224 if LibraryModule == None:
2225 continue
2226
2227 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
2228 Constructor.append(LibraryModule)
2229
2230 if LibraryModule not in ConsumedByList:
2231 ConsumedByList[LibraryModule] = []
2232 # don't add current module itself to consumer list
2233 if M != Module:
2234 if M in ConsumedByList[LibraryModule]:
2235 continue
2236 ConsumedByList[LibraryModule].append(M)
2237 #
2238 # Initialize the sorted output list to the empty set
2239 #
2240 SortedLibraryList = []
2241 #
2242 # Q <- Set of all nodes with no incoming edges
2243 #
2244 LibraryList = [] #LibraryInstance.values()
2245 Q = []
2246 for LibraryClassName in LibraryInstance:
2247 M = LibraryInstance[LibraryClassName]
2248 LibraryList.append(M)
2249 if ConsumedByList[M] == []:
2250 Q.append(M)
2251
2252 #
2253 # start the DAG algorithm
2254 #
2255 while True:
2256 EdgeRemoved = True
2257 while Q == [] and EdgeRemoved:
2258 EdgeRemoved = False
2259 # for each node Item with a Constructor
2260 for Item in LibraryList:
2261 if Item not in Constructor:
2262 continue
2263 # for each Node without a constructor with an edge e from Item to Node
2264 for Node in ConsumedByList[Item]:
2265 if Node in Constructor:
2266 continue
2267 # remove edge e from the graph if Node has no constructor
2268 ConsumedByList[Item].remove(Node)
2269 EdgeRemoved = True
2270 if ConsumedByList[Item] == []:
2271 # insert Item into Q
2272 Q.insert(0, Item)
2273 break
2274 if Q != []:
2275 break
2276 # DAG is done if there's no more incoming edge for all nodes
2277 if Q == []:
2278 break
2279
2280 # remove node from Q
2281 Node = Q.pop()
2282 # output Node
2283 SortedLibraryList.append(Node)
2284
2285 # for each node Item with an edge e from Node to Item do
2286 for Item in LibraryList:
2287 if Node not in ConsumedByList[Item]:
2288 continue
2289 # remove edge e from the graph
2290 ConsumedByList[Item].remove(Node)
2291
2292 if ConsumedByList[Item] != []:
2293 continue
2294 # insert Item into Q, if Item has no other incoming edges
2295 Q.insert(0, Item)
2296
2297 #
2298 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2299 #
2300 for Item in LibraryList:
2301 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
2302 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
2303 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
2304 ExtraData=ErrorMessage, File=self.MetaFile)
2305 if Item not in SortedLibraryList:
2306 SortedLibraryList.append(Item)
2307
2308 #
2309 # Build the list of constructor and destructir names
2310 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2311 #
2312 SortedLibraryList.reverse()
2313 return SortedLibraryList
2314
2315
2316 ## Override PCD setting (type, value, ...)
2317 #
2318 # @param ToPcd The PCD to be overrided
2319 # @param FromPcd The PCD overrideing from
2320 #
2321 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
2322 #
2323 # in case there's PCDs coming from FDF file, which have no type given.
2324 # at this point, ToPcd.Type has the type found from dependent
2325 # package
2326 #
2327 TokenCName = ToPcd.TokenCName
2328 for PcdItem in GlobalData.MixedPcd:
2329 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
2330 TokenCName = PcdItem[0]
2331 break
2332 if FromPcd != None:
2333 if GlobalData.BuildOptionPcd:
2334 for pcd in GlobalData.BuildOptionPcd:
2335 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):
2336 FromPcd.DefaultValue = pcd[2]
2337 break
2338 if ToPcd.Pending and FromPcd.Type not in [None, '']:
2339 ToPcd.Type = FromPcd.Type
2340 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
2341 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
2342 if ToPcd.Type.strip() == "DynamicEx":
2343 ToPcd.Type = FromPcd.Type
2344 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
2345 and ToPcd.Type != FromPcd.Type:
2346 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
2347 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2348 % (ToPcd.TokenSpaceGuidCName, TokenCName,
2349 ToPcd.Type, Module, FromPcd.Type),
2350 File=self.MetaFile)
2351
2352 if FromPcd.MaxDatumSize not in [None, '']:
2353 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2354 if FromPcd.DefaultValue not in [None, '']:
2355 ToPcd.DefaultValue = FromPcd.DefaultValue
2356 if FromPcd.TokenValue not in [None, '']:
2357 ToPcd.TokenValue = FromPcd.TokenValue
2358 if FromPcd.MaxDatumSize not in [None, '']:
2359 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2360 if FromPcd.DatumType not in [None, '']:
2361 ToPcd.DatumType = FromPcd.DatumType
2362 if FromPcd.SkuInfoList not in [None, '', []]:
2363 ToPcd.SkuInfoList = FromPcd.SkuInfoList
2364
2365 # check the validation of datum
2366 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
2367 if not IsValid:
2368 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
2369 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))
2370 ToPcd.validateranges = FromPcd.validateranges
2371 ToPcd.validlists = FromPcd.validlists
2372 ToPcd.expressions = FromPcd.expressions
2373
2374 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
2375 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
2376 % (ToPcd.TokenSpaceGuidCName, TokenCName))
2377 Value = ToPcd.DefaultValue
2378 if Value in [None, '']:
2379 ToPcd.MaxDatumSize = '1'
2380 elif Value[0] == 'L':
2381 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
2382 elif Value[0] == '{':
2383 ToPcd.MaxDatumSize = str(len(Value.split(',')))
2384 else:
2385 ToPcd.MaxDatumSize = str(len(Value) - 1)
2386
2387 # apply default SKU for dynamic PCDS if specified one is not available
2388 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
2389 and ToPcd.SkuInfoList in [None, {}, '']:
2390 if self.Platform.SkuName in self.Platform.SkuIds:
2391 SkuName = self.Platform.SkuName
2392 else:
2393 SkuName = 'DEFAULT'
2394 ToPcd.SkuInfoList = {
2395 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)
2396 }
2397
2398 ## Apply PCD setting defined platform to a module
2399 #
2400 # @param Module The module from which the PCD setting will be overrided
2401 #
2402 # @retval PCD_list The list PCDs with settings from platform
2403 #
2404 def ApplyPcdSetting(self, Module, Pcds):
2405 # for each PCD in module
2406 for Name, Guid in Pcds:
2407 PcdInModule = Pcds[Name, Guid]
2408 # find out the PCD setting in platform
2409 if (Name, Guid) in self.Platform.Pcds:
2410 PcdInPlatform = self.Platform.Pcds[Name, Guid]
2411 else:
2412 PcdInPlatform = None
2413 # then override the settings if any
2414 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
2415 # resolve the VariableGuid value
2416 for SkuId in PcdInModule.SkuInfoList:
2417 Sku = PcdInModule.SkuInfoList[SkuId]
2418 if Sku.VariableGuid == '': continue
2419 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)
2420 if Sku.VariableGuidValue == None:
2421 PackageList = "\n\t".join([str(P) for P in self.PackageList])
2422 EdkLogger.error(
2423 'build',
2424 RESOURCE_NOT_AVAILABLE,
2425 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
2426 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
2427 % (Guid, Name, str(Module)),
2428 File=self.MetaFile
2429 )
2430
2431 # override PCD settings with module specific setting
2432 if Module in self.Platform.Modules:
2433 PlatformModule = self.Platform.Modules[str(Module)]
2434 for Key in PlatformModule.Pcds:
2435 Flag = False
2436 if Key in Pcds:
2437 ToPcd = Pcds[Key]
2438 Flag = True
2439 elif Key in GlobalData.MixedPcd:
2440 for PcdItem in GlobalData.MixedPcd[Key]:
2441 if PcdItem in Pcds:
2442 ToPcd = Pcds[PcdItem]
2443 Flag = True
2444 break
2445 if Flag:
2446 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)
2447 return Pcds.values()
2448
2449 ## Resolve library names to library modules
2450 #
2451 # (for Edk.x modules)
2452 #
2453 # @param Module The module from which the library names will be resolved
2454 #
2455 # @retval library_list The list of library modules
2456 #
2457 def ResolveLibraryReference(self, Module):
2458 EdkLogger.verbose("")
2459 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2460 LibraryConsumerList = [Module]
2461
2462 # "CompilerStub" is a must for Edk modules
2463 if Module.Libraries:
2464 Module.Libraries.append("CompilerStub")
2465 LibraryList = []
2466 while len(LibraryConsumerList) > 0:
2467 M = LibraryConsumerList.pop()
2468 for LibraryName in M.Libraries:
2469 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2470 if Library == None:
2471 for Key in self.Platform.LibraryClasses.data.keys():
2472 if LibraryName.upper() == Key.upper():
2473 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2474 break
2475 if Library == None:
2476 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2477 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2478 continue
2479
2480 if Library not in LibraryList:
2481 LibraryList.append(Library)
2482 LibraryConsumerList.append(Library)
2483 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2484 return LibraryList
2485
2486 ## Calculate the priority value of the build option
2487 #
2488 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2489 #
2490 # @retval Value Priority value based on the priority list.
2491 #
2492 def CalculatePriorityValue(self, Key):
2493 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2494 PriorityValue = 0x11111
2495 if Target == "*":
2496 PriorityValue &= 0x01111
2497 if ToolChain == "*":
2498 PriorityValue &= 0x10111
2499 if Arch == "*":
2500 PriorityValue &= 0x11011
2501 if CommandType == "*":
2502 PriorityValue &= 0x11101
2503 if Attr == "*":
2504 PriorityValue &= 0x11110
2505
2506 return self.PrioList["0x%0.5x" % PriorityValue]
2507
2508
2509 ## Expand * in build option key
2510 #
2511 # @param Options Options to be expanded
2512 #
2513 # @retval options Options expanded
2514 #
2515 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2516 BuildOptions = {}
2517 FamilyMatch = False
2518 FamilyIsNull = True
2519
2520 OverrideList = {}
2521 #
2522 # Construct a list contain the build options which need override.
2523 #
2524 for Key in Options:
2525 #
2526 # Key[0] -- tool family
2527 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2528 #
2529 if (Key[0] == self.BuildRuleFamily and
2530 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2531 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2532 if Target == self.BuildTarget or Target == "*":
2533 if ToolChain == self.ToolChain or ToolChain == "*":
2534 if Arch == self.Arch or Arch == "*":
2535 if Options[Key].startswith("="):
2536 if OverrideList.get(Key[1]) != None:
2537 OverrideList.pop(Key[1])
2538 OverrideList[Key[1]] = Options[Key]
2539
2540 #
2541 # Use the highest priority value.
2542 #
2543 if (len(OverrideList) >= 2):
2544 KeyList = OverrideList.keys()
2545 for Index in range(len(KeyList)):
2546 NowKey = KeyList[Index]
2547 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2548 for Index1 in range(len(KeyList) - Index - 1):
2549 NextKey = KeyList[Index1 + Index + 1]
2550 #
2551 # Compare two Key, if one is included by another, choose the higher priority one
2552 #
2553 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2554 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2555 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2556 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2557 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2558 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2559 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2560 if Options.get((self.BuildRuleFamily, NextKey)) != None:
2561 Options.pop((self.BuildRuleFamily, NextKey))
2562 else:
2563 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2564 Options.pop((self.BuildRuleFamily, NowKey))
2565
2566 for Key in Options:
2567 if ModuleStyle != None and len (Key) > 2:
2568 # Check Module style is EDK or EDKII.
2569 # Only append build option for the matched style module.
2570 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2571 continue
2572 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2573 continue
2574 Family = Key[0]
2575 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2576 # if tool chain family doesn't match, skip it
2577 if Tool in self.ToolDefinition and Family != "":
2578 FamilyIsNull = False
2579 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2580 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2581 continue
2582 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2583 continue
2584 FamilyMatch = True
2585 # expand any wildcard
2586 if Target == "*" or Target == self.BuildTarget:
2587 if Tag == "*" or Tag == self.ToolChain:
2588 if Arch == "*" or Arch == self.Arch:
2589 if Tool not in BuildOptions:
2590 BuildOptions[Tool] = {}
2591 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2592 BuildOptions[Tool][Attr] = Options[Key]
2593 else:
2594 # append options for the same tool except PATH
2595 if Attr != 'PATH':
2596 BuildOptions[Tool][Attr] += " " + Options[Key]
2597 else:
2598 BuildOptions[Tool][Attr] = Options[Key]
2599 # Build Option Family has been checked, which need't to be checked again for family.
2600 if FamilyMatch or FamilyIsNull:
2601 return BuildOptions
2602
2603 for Key in Options:
2604 if ModuleStyle != None and len (Key) > 2:
2605 # Check Module style is EDK or EDKII.
2606 # Only append build option for the matched style module.
2607 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2608 continue
2609 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2610 continue
2611 Family = Key[0]
2612 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2613 # if tool chain family doesn't match, skip it
2614 if Tool not in self.ToolDefinition or Family == "":
2615 continue
2616 # option has been added before
2617 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2618 continue
2619
2620 # expand any wildcard
2621 if Target == "*" or Target == self.BuildTarget:
2622 if Tag == "*" or Tag == self.ToolChain:
2623 if Arch == "*" or Arch == self.Arch:
2624 if Tool not in BuildOptions:
2625 BuildOptions[Tool] = {}
2626 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2627 BuildOptions[Tool][Attr] = Options[Key]
2628 else:
2629 # append options for the same tool except PATH
2630 if Attr != 'PATH':
2631 BuildOptions[Tool][Attr] += " " + Options[Key]
2632 else:
2633 BuildOptions[Tool][Attr] = Options[Key]
2634 return BuildOptions
2635
2636 ## Append build options in platform to a module
2637 #
2638 # @param Module The module to which the build options will be appened
2639 #
2640 # @retval options The options appended with build options in platform
2641 #
2642 def ApplyBuildOption(self, Module):
2643 # Get the different options for the different style module
2644 if Module.AutoGenVersion < 0x00010005:
2645 PlatformOptions = self.EdkBuildOption
2646 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2647 else:
2648 PlatformOptions = self.EdkIIBuildOption
2649 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2650 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2651 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2652 if Module in self.Platform.Modules:
2653 PlatformModule = self.Platform.Modules[str(Module)]
2654 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2655 else:
2656 PlatformModuleOptions = {}
2657
2658 BuildRuleOrder = None
2659 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2660 for Tool in Options:
2661 for Attr in Options[Tool]:
2662 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2663 BuildRuleOrder = Options[Tool][Attr]
2664
2665 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2666 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2667 self.ToolDefinition.keys())
2668 BuildOptions = {}
2669 for Tool in AllTools:
2670 if Tool not in BuildOptions:
2671 BuildOptions[Tool] = {}
2672
2673 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2674 if Tool not in Options:
2675 continue
2676 for Attr in Options[Tool]:
2677 Value = Options[Tool][Attr]
2678 #
2679 # Do not generate it in Makefile
2680 #
2681 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2682 continue
2683 if Attr not in BuildOptions[Tool]:
2684 BuildOptions[Tool][Attr] = ""
2685 # check if override is indicated
2686 if Value.startswith('='):
2687 ToolPath = Value[1:]
2688 ToolPath = mws.handleWsMacro(ToolPath)
2689 BuildOptions[Tool][Attr] = ToolPath
2690 else:
2691 Value = mws.handleWsMacro(Value)
2692 if Attr != 'PATH':
2693 BuildOptions[Tool][Attr] += " " + Value
2694 else:
2695 BuildOptions[Tool][Attr] = Value
2696 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2697 #
2698 # Override UNI flag only for EDK module.
2699 #
2700 if 'BUILD' not in BuildOptions:
2701 BuildOptions['BUILD'] = {}
2702 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2703 return BuildOptions, BuildRuleOrder
2704
2705 Platform = property(_GetPlatform)
2706 Name = property(_GetName)
2707 Guid = property(_GetGuid)
2708 Version = property(_GetVersion)
2709
2710 OutputDir = property(_GetOutputDir)
2711 BuildDir = property(_GetBuildDir)
2712 MakeFileDir = property(_GetMakeFileDir)
2713 FdfFile = property(_GetFdfFile)
2714
2715 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2716 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2717 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2718 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2719 PackageList = property(_GetPackageList)
2720
2721 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2722 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2723 ToolChainFamily = property(_GetToolChainFamily)
2724 BuildRuleFamily = property(_GetBuildRuleFamily)
2725 BuildOption = property(_GetBuildOptions) # toolcode : option
2726 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2727 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2728
2729 BuildCommand = property(_GetBuildCommand)
2730 BuildRule = property(_GetBuildRule)
2731 ModuleAutoGenList = property(_GetModuleAutoGenList)
2732 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2733 GenFdsCommand = property(_GenFdsCommand)
2734
2735 ## ModuleAutoGen class
2736 #
2737 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2738 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2739 # to the [depex] section in module's inf file.
2740 #
2741 class ModuleAutoGen(AutoGen):
2742 ## Cache the timestamps of metafiles of every module in a class variable
2743 #
2744 TimeDict = {}
2745
2746 ## The real constructor of ModuleAutoGen
2747 #
2748 # This method is not supposed to be called by users of ModuleAutoGen. It's
2749 # only used by factory method __new__() to do real initialization work for an
2750 # object of ModuleAutoGen
2751 #
2752 # @param Workspace EdkIIWorkspaceBuild object
2753 # @param ModuleFile The path of module file
2754 # @param Target Build target (DEBUG, RELEASE)
2755 # @param Toolchain Name of tool chain
2756 # @param Arch The arch the module supports
2757 # @param PlatformFile Platform meta-file
2758 #
2759 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2760 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2761 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2762
2763 self.Workspace = Workspace
2764 self.WorkspaceDir = Workspace.WorkspaceDir
2765
2766 self.MetaFile = ModuleFile
2767 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2768 # check if this module is employed by active platform
2769 if not self.PlatformInfo.ValidModule(self.MetaFile):
2770 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2771 % (self.MetaFile, Arch))
2772 return False
2773
2774 self.SourceDir = self.MetaFile.SubDir
2775 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2776
2777 self.SourceOverrideDir = None
2778 # use overrided path defined in DSC file
2779 if self.MetaFile.Key in GlobalData.gOverrideDir:
2780 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2781
2782 self.ToolChain = Toolchain
2783 self.BuildTarget = Target
2784 self.Arch = Arch
2785 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2786 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2787
2788 self.IsMakeFileCreated = False
2789 self.IsCodeFileCreated = False
2790 self.IsAsBuiltInfCreated = False
2791 self.DepexGenerated = False
2792
2793 self.BuildDatabase = self.Workspace.BuildDatabase
2794 self.BuildRuleOrder = None
2795 self.BuildTime = 0
2796
2797 self._Module = None
2798 self._Name = None
2799 self._Guid = None
2800 self._Version = None
2801 self._ModuleType = None
2802 self._ComponentType = None
2803 self._PcdIsDriver = None
2804 self._AutoGenVersion = None
2805 self._LibraryFlag = None
2806 self._CustomMakefile = None
2807 self._Macro = None
2808
2809 self._BuildDir = None
2810 self._OutputDir = None
2811 self._FfsOutputDir = None
2812 self._DebugDir = None
2813 self._MakeFileDir = None
2814
2815 self._IncludePathList = None
2816 self._IncludePathLength = 0
2817 self._AutoGenFileList = None
2818 self._UnicodeFileList = None
2819 self._VfrFileList = None
2820 self._IdfFileList = None
2821 self._SourceFileList = None
2822 self._ObjectFileList = None
2823 self._BinaryFileList = None
2824
2825 self._DependentPackageList = None
2826 self._DependentLibraryList = None
2827 self._LibraryAutoGenList = None
2828 self._DerivedPackageList = None
2829 self._ModulePcdList = None
2830 self._LibraryPcdList = None
2831 self._PcdComments = sdict()
2832 self._GuidList = None
2833 self._GuidsUsedByPcd = None
2834 self._GuidComments = sdict()
2835 self._ProtocolList = None
2836 self._ProtocolComments = sdict()
2837 self._PpiList = None
2838 self._PpiComments = sdict()
2839 self._DepexList = None
2840 self._DepexExpressionList = None
2841 self._BuildOption = None
2842 self._BuildOptionIncPathList = None
2843 self._BuildTargets = None
2844 self._IntroBuildTargetList = None
2845 self._FinalBuildTargetList = None
2846 self._FileTypes = None
2847 self._BuildRules = None
2848
2849 self._TimeStampPath = None
2850
2851 self.AutoGenDepSet = set()
2852
2853
2854 ## The Modules referenced to this Library
2855 # Only Library has this attribute
2856 self._ReferenceModules = []
2857
2858 ## Store the FixedAtBuild Pcds
2859 #
2860 self._FixedAtBuildPcds = []
2861 self.ConstPcd = {}
2862 return True
2863
2864 def __repr__(self):
2865 return "%s [%s]" % (self.MetaFile, self.Arch)
2866
2867 # Get FixedAtBuild Pcds of this Module
2868 def _GetFixedAtBuildPcds(self):
2869 if self._FixedAtBuildPcds:
2870 return self._FixedAtBuildPcds
2871 for Pcd in self.ModulePcdList:
2872 if Pcd.Type != "FixedAtBuild":
2873 continue
2874 if Pcd not in self._FixedAtBuildPcds:
2875 self._FixedAtBuildPcds.append(Pcd)
2876
2877 return self._FixedAtBuildPcds
2878
2879 def _GetUniqueBaseName(self):
2880 BaseName = self.Name
2881 for Module in self.PlatformInfo.ModuleAutoGenList:
2882 if Module.MetaFile == self.MetaFile:
2883 continue
2884 if Module.Name == self.Name:
2885 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2886 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2887 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2888 BaseName = '%s_%s' % (self.Name, self.Guid)
2889 return BaseName
2890
2891 # Macros could be used in build_rule.txt (also Makefile)
2892 def _GetMacros(self):
2893 if self._Macro == None:
2894 self._Macro = sdict()
2895 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2896 self._Macro["MODULE_NAME" ] = self.Name
2897 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2898 self._Macro["MODULE_GUID" ] = self.Guid
2899 self._Macro["MODULE_VERSION" ] = self.Version
2900 self._Macro["MODULE_TYPE" ] = self.ModuleType
2901 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2902 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2903 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2904 self._Macro["MODULE_DIR" ] = self.SourceDir
2905
2906 self._Macro["BASE_NAME" ] = self.Name
2907
2908 self._Macro["ARCH" ] = self.Arch
2909 self._Macro["TOOLCHAIN" ] = self.ToolChain
2910 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2911 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2912 self._Macro["TARGET" ] = self.BuildTarget
2913
2914 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
2915 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2916 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2917 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
2918 self._Macro["OUTPUT_DIR" ] = self.OutputDir
2919 self._Macro["DEBUG_DIR" ] = self.DebugDir
2920 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
2921 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
2922 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
2923 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
2924 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
2925 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
2926 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
2927 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
2928 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
2929 return self._Macro
2930
2931 ## Return the module build data object
2932 def _GetModule(self):
2933 if self._Module == None:
2934 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
2935 return self._Module
2936
2937 ## Return the module name
2938 def _GetBaseName(self):
2939 return self.Module.BaseName
2940
2941 ## Return the module DxsFile if exist
2942 def _GetDxsFile(self):
2943 return self.Module.DxsFile
2944
2945 ## Return the module SourceOverridePath
2946 def _GetSourceOverridePath(self):
2947 return self.Module.SourceOverridePath
2948
2949 ## Return the module meta-file GUID
2950 def _GetGuid(self):
2951 #
2952 # To build same module more than once, the module path with FILE_GUID overridden has
2953 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2954 # in DSC. The overridden GUID can be retrieved from file name
2955 #
2956 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
2957 #
2958 # Length of GUID is 36
2959 #
2960 return os.path.basename(self.MetaFile.Path)[:36]
2961 return self.Module.Guid
2962
2963 ## Return the module version
2964 def _GetVersion(self):
2965 return self.Module.Version
2966
2967 ## Return the module type
2968 def _GetModuleType(self):
2969 return self.Module.ModuleType
2970
2971 ## Return the component type (for Edk.x style of module)
2972 def _GetComponentType(self):
2973 return self.Module.ComponentType
2974
2975 ## Return the build type
2976 def _GetBuildType(self):
2977 return self.Module.BuildType
2978
2979 ## Return the PCD_IS_DRIVER setting
2980 def _GetPcdIsDriver(self):
2981 return self.Module.PcdIsDriver
2982
2983 ## Return the autogen version, i.e. module meta-file version
2984 def _GetAutoGenVersion(self):
2985 return self.Module.AutoGenVersion
2986
2987 ## Check if the module is library or not
2988 def _IsLibrary(self):
2989 if self._LibraryFlag == None:
2990 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
2991 self._LibraryFlag = True
2992 else:
2993 self._LibraryFlag = False
2994 return self._LibraryFlag
2995
2996 ## Check if the module is binary module or not
2997 def _IsBinaryModule(self):
2998 return self.Module.IsBinaryModule
2999
3000 ## Return the directory to store intermediate files of the module
3001 def _GetBuildDir(self):
3002 if self._BuildDir == None:
3003 self._BuildDir = path.join(
3004 self.PlatformInfo.BuildDir,
3005 self.Arch,
3006 self.SourceDir,
3007 self.MetaFile.BaseName
3008 )
3009 CreateDirectory(self._BuildDir)
3010 return self._BuildDir
3011
3012 ## Return the directory to store the intermediate object files of the mdoule
3013 def _GetOutputDir(self):
3014 if self._OutputDir == None:
3015 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3016 CreateDirectory(self._OutputDir)
3017 return self._OutputDir
3018
3019 ## Return the directory to store ffs file
3020 def _GetFfsOutputDir(self):
3021 if self._FfsOutputDir == None:
3022 if GlobalData.gFdfParser != None:
3023 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)
3024 else:
3025 self._FfsOutputDir = ''
3026 return self._FfsOutputDir
3027
3028 ## Return the directory to store auto-gened source files of the mdoule
3029 def _GetDebugDir(self):
3030 if self._DebugDir == None:
3031 self._DebugDir = path.join(self.BuildDir, "DEBUG")
3032 CreateDirectory(self._DebugDir)
3033 return self._DebugDir
3034
3035 ## Return the path of custom file
3036 def _GetCustomMakefile(self):
3037 if self._CustomMakefile == None:
3038 self._CustomMakefile = {}
3039 for Type in self.Module.CustomMakefile:
3040 if Type in gMakeTypeMap:
3041 MakeType = gMakeTypeMap[Type]
3042 else:
3043 MakeType = 'nmake'
3044 if self.SourceOverrideDir != None:
3045 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
3046 if not os.path.exists(File):
3047 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3048 else:
3049 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3050 self._CustomMakefile[MakeType] = File
3051 return self._CustomMakefile
3052
3053 ## Return the directory of the makefile
3054 #
3055 # @retval string The directory string of module's makefile
3056 #
3057 def _GetMakeFileDir(self):
3058 return self.BuildDir
3059
3060 ## Return build command string
3061 #
3062 # @retval string Build command string
3063 #
3064 def _GetBuildCommand(self):
3065 return self.PlatformInfo.BuildCommand
3066
3067 ## Get object list of all packages the module and its dependent libraries belong to
3068 #
3069 # @retval list The list of package object
3070 #
3071 def _GetDerivedPackageList(self):
3072 PackageList = []
3073 for M in [self.Module] + self.DependentLibraryList:
3074 for Package in M.Packages:
3075 if Package in PackageList:
3076 continue
3077 PackageList.append(Package)
3078 return PackageList
3079
3080 ## Get the depex string
3081 #
3082 # @return : a string contain all depex expresion.
3083 def _GetDepexExpresionString(self):
3084 DepexStr = ''
3085 DepexList = []
3086 ## DPX_SOURCE IN Define section.
3087 if self.Module.DxsFile:
3088 return DepexStr
3089 for M in [self.Module] + self.DependentLibraryList:
3090 Filename = M.MetaFile.Path
3091 InfObj = InfSectionParser.InfSectionParser(Filename)
3092 DepexExpresionList = InfObj.GetDepexExpresionList()
3093 for DepexExpresion in DepexExpresionList:
3094 for key in DepexExpresion.keys():
3095 Arch, ModuleType = key
3096 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]
3097 # the type of build module is USER_DEFINED.
3098 # All different DEPEX section tags would be copied into the As Built INF file
3099 # and there would be separate DEPEX section tags
3100 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3101 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
3102 DepexList.append({(Arch, ModuleType): DepexExpr})
3103 else:
3104 if Arch.upper() == TAB_ARCH_COMMON or \
3105 (Arch.upper() == self.Arch.upper() and \
3106 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
3107 DepexList.append({(Arch, ModuleType): DepexExpr})
3108
3109 #the type of build module is USER_DEFINED.
3110 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3111 for Depex in DepexList:
3112 for key in Depex.keys():
3113 DepexStr += '[Depex.%s.%s]\n' % key
3114 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
3115 DepexStr += '\n\n'
3116 if not DepexStr:
3117 return '[Depex.%s]\n' % self.Arch
3118 return DepexStr
3119
3120 #the type of build module not is USER_DEFINED.
3121 Count = 0
3122 for Depex in DepexList:
3123 Count += 1
3124 if DepexStr != '':
3125 DepexStr += ' AND '
3126 DepexStr += '('
3127 for D in Depex.values():
3128 DepexStr += ' '.join([val for val in D])
3129 Index = DepexStr.find('END')
3130 if Index > -1 and Index == len(DepexStr) - 3:
3131 DepexStr = DepexStr[:-3]
3132 DepexStr = DepexStr.strip()
3133 DepexStr += ')'
3134 if Count == 1:
3135 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
3136 if not DepexStr:
3137 return '[Depex.%s]\n' % self.Arch
3138 return '[Depex.%s]\n# ' % self.Arch + DepexStr
3139
3140 ## Merge dependency expression
3141 #
3142 # @retval list The token list of the dependency expression after parsed
3143 #
3144 def _GetDepexTokenList(self):
3145 if self._DepexList == None:
3146 self._DepexList = {}
3147 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3148 return self._DepexList
3149
3150 self._DepexList[self.ModuleType] = []
3151
3152 for ModuleType in self._DepexList:
3153 DepexList = self._DepexList[ModuleType]
3154 #
3155 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3156 #
3157 for M in [self.Module] + self.DependentLibraryList:
3158 Inherited = False
3159 for D in M.Depex[self.Arch, ModuleType]:
3160 if DepexList != []:
3161 DepexList.append('AND')
3162 DepexList.append('(')
3163 DepexList.extend(D)
3164 if DepexList[-1] == 'END': # no need of a END at this time
3165 DepexList.pop()
3166 DepexList.append(')')
3167 Inherited = True
3168 if Inherited:
3169 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
3170 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
3171 break
3172 if len(DepexList) > 0:
3173 EdkLogger.verbose('')
3174 return self._DepexList
3175
3176 ## Merge dependency expression
3177 #
3178 # @retval list The token list of the dependency expression after parsed
3179 #
3180 def _GetDepexExpressionTokenList(self):
3181 if self._DepexExpressionList == None:
3182 self._DepexExpressionList = {}
3183 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3184 return self._DepexExpressionList
3185
3186 self._DepexExpressionList[self.ModuleType] = ''
3187
3188 for ModuleType in self._DepexExpressionList:
3189 DepexExpressionList = self._DepexExpressionList[ModuleType]
3190 #
3191 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3192 #
3193 for M in [self.Module] + self.DependentLibraryList:
3194 Inherited = False
3195 for D in M.DepexExpression[self.Arch, ModuleType]:
3196 if DepexExpressionList != '':
3197 DepexExpressionList += ' AND '
3198 DepexExpressionList += '('
3199 DepexExpressionList += D
3200 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
3201 DepexExpressionList += ')'
3202 Inherited = True
3203 if Inherited:
3204 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
3205 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
3206 break
3207 if len(DepexExpressionList) > 0:
3208 EdkLogger.verbose('')
3209 self._DepexExpressionList[ModuleType] = DepexExpressionList
3210 return self._DepexExpressionList
3211
3212 # Get the tiano core user extension, it is contain dependent library.
3213 # @retval: a list contain tiano core userextension.
3214 #
3215 def _GetTianoCoreUserExtensionList(self):
3216 TianoCoreUserExtentionList = []
3217 for M in [self.Module] + self.DependentLibraryList:
3218 Filename = M.MetaFile.Path
3219 InfObj = InfSectionParser.InfSectionParser(Filename)
3220 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()
3221 for TianoCoreUserExtent in TianoCoreUserExtenList:
3222 for Section in TianoCoreUserExtent.keys():
3223 ItemList = Section.split(TAB_SPLIT)
3224 Arch = self.Arch
3225 if len(ItemList) == 4:
3226 Arch = ItemList[3]
3227 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():
3228 TianoCoreList = []
3229 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])
3230 TianoCoreList.extend(TianoCoreUserExtent[Section][:])
3231 TianoCoreList.append('\n')
3232 TianoCoreUserExtentionList.append(TianoCoreList)
3233
3234 return TianoCoreUserExtentionList
3235
3236 ## Return the list of specification version required for the module
3237 #
3238 # @retval list The list of specification defined in module file
3239 #
3240 def _GetSpecification(self):
3241 return self.Module.Specification
3242
3243 ## Tool option for the module build
3244 #
3245 # @param PlatformInfo The object of PlatformBuildInfo
3246 # @retval dict The dict containing valid options
3247 #
3248 def _GetModuleBuildOption(self):
3249 if self._BuildOption == None:
3250 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
3251 if self.BuildRuleOrder:
3252 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
3253 return self._BuildOption
3254
3255 ## Get include path list from tool option for the module build
3256 #
3257 # @retval list The include path list
3258 #
3259 def _GetBuildOptionIncPathList(self):
3260 if self._BuildOptionIncPathList == None:
3261 #
3262 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3263 # is the former use /I , the Latter used -I to specify include directories
3264 #
3265 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
3266 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3267 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
3268 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3269 else:
3270 #
3271 # New ToolChainFamily, don't known whether there is option to specify include directories
3272 #
3273 self._BuildOptionIncPathList = []
3274 return self._BuildOptionIncPathList
3275
3276 BuildOptionIncPathList = []
3277 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3278 Attr = 'FLAGS'
3279 try:
3280 FlagOption = self.BuildOption[Tool][Attr]
3281 except KeyError:
3282 FlagOption = ''
3283
3284 if self.PlatformInfo.ToolChainFamily != 'RVCT':
3285 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
3286 else:
3287 #
3288 # RVCT may specify a list of directory seperated by commas
3289 #
3290 IncPathList = []
3291 for Path in gBuildOptIncludePattern.findall(FlagOption):
3292 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
3293 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
3294
3295 #
3296 # EDK II modules must not reference header files outside of the packages they depend on or
3297 # within the module's directory tree. Report error if violation.
3298 #
3299 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
3300 for Path in IncPathList:
3301 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
3302 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
3303 EdkLogger.error("build",
3304 PARAMETER_INVALID,
3305 ExtraData=ErrMsg,
3306 File=str(self.MetaFile))
3307
3308
3309 BuildOptionIncPathList += IncPathList
3310
3311 self._BuildOptionIncPathList = BuildOptionIncPathList
3312
3313 return self._BuildOptionIncPathList
3314
3315 ## Return a list of files which can be built from source
3316 #
3317 # What kind of files can be built is determined by build rules in
3318 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3319 #
3320 def _GetSourceFileList(self):
3321 if self._SourceFileList == None:
3322 self._SourceFileList = []
3323 for F in self.Module.Sources:
3324 # match tool chain
3325 if F.TagName not in ("", "*", self.ToolChain):
3326 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
3327 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
3328 continue
3329 # match tool chain family or build rule family
3330 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):
3331 EdkLogger.debug(
3332 EdkLogger.DEBUG_0,
3333 "The file [%s] must be built by tools of [%s], " \
3334 "but current toolchain family is [%s], buildrule family is [%s]" \
3335 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))
3336 continue
3337
3338 # add the file path into search path list for file including
3339 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
3340 self.IncludePathList.insert(0, F.Dir)
3341 self._SourceFileList.append(F)
3342
3343 self._MatchBuildRuleOrder(self._SourceFileList)
3344
3345 for F in self._SourceFileList:
3346 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
3347 return self._SourceFileList
3348
3349 def _MatchBuildRuleOrder(self, FileList):
3350 Order_Dict = {}
3351 self._GetModuleBuildOption()
3352 for SingleFile in FileList:
3353 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:
3354 key = SingleFile.Path.split(SingleFile.Ext)[0]
3355 if key in Order_Dict:
3356 Order_Dict[key].append(SingleFile.Ext)
3357 else:
3358 Order_Dict[key] = [SingleFile.Ext]
3359
3360 RemoveList = []
3361 for F in Order_Dict:
3362 if len(Order_Dict[F]) > 1:
3363 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))
3364 for Ext in Order_Dict[F][1:]:
3365 RemoveList.append(F + Ext)
3366
3367 for item in RemoveList:
3368 FileList.remove(item)
3369
3370 return FileList
3371
3372 ## Return the list of unicode files
3373 def _GetUnicodeFileList(self):
3374 if self._UnicodeFileList == None:
3375 if TAB_UNICODE_FILE in self.FileTypes:
3376 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
3377 else:
3378 self._UnicodeFileList = []
3379 return self._UnicodeFileList
3380
3381 ## Return the list of vfr files
3382 def _GetVfrFileList(self):
3383 if self._VfrFileList == None:
3384 if TAB_VFR_FILE in self.FileTypes:
3385 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]
3386 else:
3387 self._VfrFileList = []
3388 return self._VfrFileList
3389
3390 ## Return the list of Image Definition files
3391 def _GetIdfFileList(self):
3392 if self._IdfFileList == None:
3393 if TAB_IMAGE_FILE in self.FileTypes:
3394 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]
3395 else:
3396 self._IdfFileList = []
3397 return self._IdfFileList
3398
3399 ## Return a list of files which can be built from binary
3400 #
3401 # "Build" binary files are just to copy them to build directory.
3402 #
3403 # @retval list The list of files which can be built later
3404 #
3405 def _GetBinaryFiles(self):
3406 if self._BinaryFileList == None:
3407 self._BinaryFileList = []
3408 for F in self.Module.Binaries:
3409 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
3410 continue
3411 self._BinaryFileList.append(F)
3412 self._ApplyBuildRule(F, F.Type)
3413 return self._BinaryFileList
3414
3415 def _GetBuildRules(self):
3416 if self._BuildRules == None:
3417 BuildRules = {}
3418 BuildRuleDatabase = self.PlatformInfo.BuildRule
3419 for Type in BuildRuleDatabase.FileTypeList:
3420 #first try getting build rule by BuildRuleFamily
3421 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
3422 if not RuleObject:
3423 # build type is always module type, but ...
3424 if self.ModuleType != self.BuildType:
3425 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
3426 #second try getting build rule by ToolChainFamily
3427 if not RuleObject:
3428 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
3429 if not RuleObject:
3430 # build type is always module type, but ...
3431 if self.ModuleType != self.BuildType:
3432 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
3433 if not RuleObject:
3434 continue
3435 RuleObject = RuleObject.Instantiate(self.Macros)
3436 BuildRules[Type] = RuleObject
3437 for Ext in RuleObject.SourceFileExtList:
3438 BuildRules[Ext] = RuleObject
3439 self._BuildRules = BuildRules
3440 return self._BuildRules
3441
3442 def _ApplyBuildRule(self, File, FileType):
3443 if self._BuildTargets == None:
3444 self._IntroBuildTargetList = set()
3445 self._FinalBuildTargetList = set()
3446 self._BuildTargets = {}
3447 self._FileTypes = {}
3448
3449 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
3450 if not os.path.exists(SubDirectory):
3451 CreateDirectory(SubDirectory)
3452 LastTarget = None
3453 RuleChain = []
3454 SourceList = [File]
3455 Index = 0
3456 #
3457 # Make sure to get build rule order value
3458 #
3459 self._GetModuleBuildOption()
3460
3461 while Index < len(SourceList):
3462 Source = SourceList[Index]
3463 Index = Index + 1
3464
3465 if Source != File:
3466 CreateDirectory(Source.Dir)
3467
3468 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
3469 # Skip all files that are not binary libraries
3470 if not self.IsLibrary:
3471 continue
3472 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
3473 elif FileType in self.BuildRules:
3474 RuleObject = self.BuildRules[FileType]
3475 elif Source.Ext in self.BuildRules:
3476 RuleObject = self.BuildRules[Source.Ext]
3477 else:
3478 # stop at no more rules
3479 if LastTarget:
3480 self._FinalBuildTargetList.add(LastTarget)
3481 break
3482
3483 FileType = RuleObject.SourceFileType
3484 if FileType not in self._FileTypes:
3485 self._FileTypes[FileType] = set()
3486 self._FileTypes[FileType].add(Source)
3487
3488 # stop at STATIC_LIBRARY for library
3489 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
3490 if LastTarget:
3491 self._FinalBuildTargetList.add(LastTarget)
3492 break
3493
3494 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
3495 if not Target:
3496 if LastTarget:
3497 self._FinalBuildTargetList.add(LastTarget)
3498 break
3499 elif not Target.Outputs:
3500 # Only do build for target with outputs
3501 self._FinalBuildTargetList.add(Target)
3502
3503 if FileType not in self._BuildTargets:
3504 self._BuildTargets[FileType] = set()
3505 self._BuildTargets[FileType].add(Target)
3506
3507 if not Source.IsBinary and Source == File:
3508 self._IntroBuildTargetList.add(Target)
3509
3510 # to avoid cyclic rule
3511 if FileType in RuleChain:
3512 break
3513
3514 RuleChain.append(FileType)
3515 SourceList.extend(Target.Outputs)
3516 LastTarget = Target
3517 FileType = TAB_UNKNOWN_FILE
3518
3519 def _GetTargets(self):
3520 if self._BuildTargets == None:
3521 self._IntroBuildTargetList = set()
3522 self._FinalBuildTargetList = set()
3523 self._BuildTargets = {}
3524 self._FileTypes = {}
3525
3526 #TRICK: call _GetSourceFileList to apply build rule for source files
3527 if self.SourceFileList:
3528 pass
3529
3530 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3531 if self.BinaryFileList:
3532 pass
3533
3534 return self._BuildTargets
3535
3536 def _GetIntroTargetList(self):
3537 self._GetTargets()
3538 return self._IntroBuildTargetList
3539
3540 def _GetFinalTargetList(self):
3541 self._GetTargets()
3542 return self._FinalBuildTargetList
3543
3544 def _GetFileTypes(self):
3545 self._GetTargets()
3546 return self._FileTypes
3547
3548 ## Get the list of package object the module depends on
3549 #
3550 # @retval list The package object list
3551 #
3552 def _GetDependentPackageList(self):
3553 return self.Module.Packages
3554
3555 ## Return the list of auto-generated code file
3556 #
3557 # @retval list The list of auto-generated file
3558 #
3559 def _GetAutoGenFileList(self):
3560 UniStringAutoGenC = True
3561 IdfStringAutoGenC = True
3562 UniStringBinBuffer = StringIO()
3563 IdfGenBinBuffer = StringIO()
3564 if self.BuildType == 'UEFI_HII':
3565 UniStringAutoGenC = False
3566 IdfStringAutoGenC = False
3567 if self._AutoGenFileList == None:
3568 self._AutoGenFileList = {}
3569 AutoGenC = TemplateString()
3570 AutoGenH = TemplateString()
3571 StringH = TemplateString()
3572 StringIdf = TemplateString()
3573 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)
3574 #
3575 # AutoGen.c is generated if there are library classes in inf, or there are object files
3576 #
3577 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
3578 or TAB_OBJECT_FILE in self.FileTypes):
3579 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
3580 self._AutoGenFileList[AutoFile] = str(AutoGenC)
3581 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3582 if str(AutoGenH) != "":
3583 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
3584 self._AutoGenFileList[AutoFile] = str(AutoGenH)
3585 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3586 if str(StringH) != "":
3587 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
3588 self._AutoGenFileList[AutoFile] = str(StringH)
3589 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3590 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
3591 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
3592 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
3593 AutoFile.IsBinary = True
3594 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3595 if UniStringBinBuffer != None:
3596 UniStringBinBuffer.close()
3597 if str(StringIdf) != "":
3598 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)
3599 self._AutoGenFileList[AutoFile] = str(StringIdf)
3600 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3601 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":
3602 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)
3603 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()
3604 AutoFile.IsBinary = True
3605 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3606 if IdfGenBinBuffer != None:
3607 IdfGenBinBuffer.close()
3608 return self._AutoGenFileList
3609
3610 ## Return the list of library modules explicitly or implicityly used by this module
3611 def _GetLibraryList(self):
3612 if self._DependentLibraryList == None:
3613 # only merge library classes and PCD for non-library module
3614 if self.IsLibrary:
3615 self._DependentLibraryList = []
3616 else:
3617 if self.AutoGenVersion < 0x00010005:
3618 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
3619 else:
3620 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
3621 return self._DependentLibraryList
3622
3623 @staticmethod
3624 def UpdateComments(Recver, Src):
3625 for Key in Src:
3626 if Key not in Recver:
3627 Recver[Key] = []
3628 Recver[Key].extend(Src[Key])
3629 ## Get the list of PCDs from current module
3630 #
3631 # @retval list The list of PCD
3632 #
3633 def _GetModulePcdList(self):
3634 if self._ModulePcdList == None:
3635 # apply PCD settings from platform
3636 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
3637 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
3638 return self._ModulePcdList
3639
3640 ## Get the list of PCDs from dependent libraries
3641 #
3642 # @retval list The list of PCD
3643 #
3644 def _GetLibraryPcdList(self):
3645 if self._LibraryPcdList == None:
3646 Pcds = sdict()
3647 if not self.IsLibrary:
3648 # get PCDs from dependent libraries
3649 for Library in self.DependentLibraryList:
3650 self.UpdateComments(self._PcdComments, Library.PcdComments)
3651 for Key in Library.Pcds:
3652 # skip duplicated PCDs
3653 if Key in self.Module.Pcds or Key in Pcds:
3654 continue
3655 Pcds[Key] = copy.copy(Library.Pcds[Key])
3656 # apply PCD settings from platform
3657 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
3658 else:
3659 self._LibraryPcdList = []
3660 return self._LibraryPcdList
3661
3662 ## Get the GUID value mapping
3663 #
3664 # @retval dict The mapping between GUID cname and its value
3665 #
3666 def _GetGuidList(self):
3667 if self._GuidList == None:
3668 self._GuidList = sdict()
3669 self._GuidList.update(self.Module.Guids)
3670 for Library in self.DependentLibraryList:
3671 self._GuidList.update(Library.Guids)
3672 self.UpdateComments(self._GuidComments, Library.GuidComments)
3673 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
3674 return self._GuidList
3675
3676 def GetGuidsUsedByPcd(self):
3677 if self._GuidsUsedByPcd == None:
3678 self._GuidsUsedByPcd = sdict()
3679 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3680 for Library in self.DependentLibraryList:
3681 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3682 return self._GuidsUsedByPcd
3683 ## Get the protocol value mapping
3684 #
3685 # @retval dict The mapping between protocol cname and its value
3686 #
3687 def _GetProtocolList(self):
3688 if self._ProtocolList == None:
3689 self._ProtocolList = sdict()
3690 self._ProtocolList.update(self.Module.Protocols)
3691 for Library in self.DependentLibraryList:
3692 self._ProtocolList.update(Library.Protocols)
3693 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3694 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3695 return self._ProtocolList
3696
3697 ## Get the PPI value mapping
3698 #
3699 # @retval dict The mapping between PPI cname and its value
3700 #
3701 def _GetPpiList(self):
3702 if self._PpiList == None:
3703 self._PpiList = sdict()
3704 self._PpiList.update(self.Module.Ppis)
3705 for Library in self.DependentLibraryList:
3706 self._PpiList.update(Library.Ppis)
3707 self.UpdateComments(self._PpiComments, Library.PpiComments)
3708 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3709 return self._PpiList
3710
3711 ## Get the list of include search path
3712 #
3713 # @retval list The list path
3714 #
3715 def _GetIncludePathList(self):
3716 if self._IncludePathList == None:
3717 self._IncludePathList = []
3718 if self.AutoGenVersion < 0x00010005:
3719 for Inc in self.Module.Includes:
3720 if Inc not in self._IncludePathList:
3721 self._IncludePathList.append(Inc)
3722 # for Edk modules
3723 Inc = path.join(Inc, self.Arch.capitalize())
3724 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3725 self._IncludePathList.append(Inc)
3726 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3727 self._IncludePathList.append(self.DebugDir)
3728 else:
3729 self._IncludePathList.append(self.MetaFile.Dir)
3730 self._IncludePathList.append(self.DebugDir)
3731
3732 for Package in self.Module.Packages:
3733 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)
3734 if PackageDir not in self._IncludePathList:
3735 self._IncludePathList.append(PackageDir)
3736 IncludesList = Package.Includes
3737 if Package._PrivateIncludes:
3738 if not self.MetaFile.Path.startswith(PackageDir):
3739 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))
3740 for Inc in IncludesList:
3741 if Inc not in self._IncludePathList:
3742 self._IncludePathList.append(str(Inc))
3743 return self._IncludePathList
3744
3745 def _GetIncludePathLength(self):
3746 self._IncludePathLength = 0
3747 if self._IncludePathList:
3748 for inc in self._IncludePathList:
3749 self._IncludePathLength += len(' ' + inc)
3750 return self._IncludePathLength
3751
3752 ## Get HII EX PCDs which maybe used by VFR
3753 #
3754 # efivarstore used by VFR may relate with HII EX PCDs
3755 # Get the variable name and GUID from efivarstore and HII EX PCD
3756 # List the HII EX PCDs in As Built INF if both name and GUID match.
3757 #
3758 # @retval list HII EX PCDs
3759 #
3760 def _GetPcdsMaybeUsedByVfr(self):
3761 if not self.SourceFileList:
3762 return []
3763
3764 NameGuids = []
3765 for SrcFile in self.SourceFileList:
3766 if SrcFile.Ext.lower() != '.vfr':
3767 continue
3768 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3769 if not os.path.exists(Vfri):
3770 continue
3771 VfriFile = open(Vfri, 'r')
3772 Content = VfriFile.read()
3773 VfriFile.close()
3774 Pos = Content.find('efivarstore')
3775 while Pos != -1:
3776 #
3777 # Make sure 'efivarstore' is the start of efivarstore statement
3778 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3779 #
3780 Index = Pos - 1
3781 while Index >= 0 and Content[Index] in ' \t\r\n':
3782 Index -= 1
3783 if Index >= 0 and Content[Index] != ';':
3784 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3785 continue
3786 #
3787 # 'efivarstore' must be followed by name and guid
3788 #
3789 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3790 if not Name:
3791 break
3792 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3793 if not Guid:
3794 break
3795 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3796 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3797 Pos = Content.find('efivarstore', Name.end())
3798 if not NameGuids:
3799 return []
3800 HiiExPcds = []
3801 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3802 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3803 continue
3804 for SkuName in Pcd.SkuInfoList:
3805 SkuInfo = Pcd.SkuInfoList[SkuName]
3806 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3807 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)
3808 if not Value:
3809 continue
3810 Guid = GuidStructureStringToGuidString(Value)
3811 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3812 HiiExPcds.append(Pcd)
3813 break
3814
3815 return HiiExPcds
3816
3817 def _GenOffsetBin(self):
3818 VfrUniBaseName = {}
3819 for SourceFile in self.Module.Sources:
3820 if SourceFile.Type.upper() == ".VFR" :
3821 #
3822 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3823 #
3824 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3825 if SourceFile.Type.upper() == ".UNI" :
3826 #
3827 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3828 #
3829 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3830
3831 if len(VfrUniBaseName) == 0:
3832 return None
3833 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3834 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3835 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3836 if not VfrUniOffsetList:
3837 return None
3838
3839 OutputName = '%sOffset.bin' % self.Name
3840 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3841
3842 try:
3843 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3844 except:
3845 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3846
3847 # Use a instance of StringIO to cache data
3848 fStringIO = StringIO('')
3849
3850 for Item in VfrUniOffsetList:
3851 if (Item[0].find("Strings") != -1):
3852 #
3853 # UNI offset in image.
3854 # GUID + Offset
3855 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3856 #
3857 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3858 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3859 fStringIO.write(''.join(UniGuid))
3860 UniValue = pack ('Q', int (Item[1], 16))
3861 fStringIO.write (UniValue)
3862 else:
3863 #
3864 # VFR binary offset in image.
3865 # GUID + Offset
3866 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3867 #
3868 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3869 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3870 fStringIO.write(''.join(VfrGuid))
3871 type (Item[1])
3872 VfrValue = pack ('Q', int (Item[1], 16))
3873 fStringIO.write (VfrValue)
3874 #
3875 # write data into file.
3876 #
3877 try :
3878 fInputfile.write (fStringIO.getvalue())
3879 except:
3880 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
3881 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
3882
3883 fStringIO.close ()
3884 fInputfile.close ()
3885 return OutputName
3886
3887 ## Create AsBuilt INF file the module
3888 #
3889 def CreateAsBuiltInf(self, IsOnlyCopy = False):
3890 self.OutputFile = []
3891 if IsOnlyCopy:
3892 if GlobalData.gBinCacheDest:
3893 self.CopyModuleToCache()
3894 return
3895
3896 if self.IsAsBuiltInfCreated:
3897 return
3898
3899 # Skip the following code for EDK I inf
3900 if self.AutoGenVersion < 0x00010005:
3901 return
3902
3903 # Skip the following code for libraries
3904 if self.IsLibrary:
3905 return
3906
3907 # Skip the following code for modules with no source files
3908 if self.SourceFileList == None or self.SourceFileList == []:
3909 return
3910
3911 # Skip the following code for modules without any binary files
3912 if self.BinaryFileList <> None and self.BinaryFileList <> []:
3913 return
3914
3915 ### TODO: How to handles mixed source and binary modules
3916
3917 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3918 # Also find all packages that the DynamicEx PCDs depend on
3919 Pcds = []
3920 PatchablePcds = []
3921 Packages = []
3922 PcdCheckList = []
3923 PcdTokenSpaceList = []
3924 for Pcd in self.ModulePcdList + self.LibraryPcdList:
3925 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
3926 PatchablePcds += [Pcd]
3927 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
3928 elif Pcd.Type in GenC.gDynamicExPcd:
3929 if Pcd not in Pcds:
3930 Pcds += [Pcd]
3931 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
3932 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
3933 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
3934 GuidList = sdict()
3935 GuidList.update(self.GuidList)
3936 for TokenSpace in self.GetGuidsUsedByPcd():
3937 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3938 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3939 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
3940 GuidList.pop(TokenSpace)
3941 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
3942 for Package in self.DerivedPackageList:
3943 if Package in Packages:
3944 continue
3945 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
3946 Found = False
3947 for Index in range(len(BeChecked)):
3948 for Item in CheckList[Index]:
3949 if Item in BeChecked[Index]:
3950 Packages += [Package]
3951 Found = True
3952 break
3953 if Found: break
3954
3955 VfrPcds = self._GetPcdsMaybeUsedByVfr()
3956 for Pkg in self.PlatformInfo.PackageList:
3957 if Pkg in Packages:
3958 continue
3959 for VfrPcd in VfrPcds:
3960 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
3961 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
3962 Packages += [Pkg]
3963 break
3964
3965 ModuleType = self.ModuleType
3966 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
3967 ModuleType = 'DXE_DRIVER'
3968
3969 DriverType = ''
3970 if self.PcdIsDriver != '':
3971 DriverType = self.PcdIsDriver
3972
3973 Guid = self.Guid
3974 MDefs = self.Module.Defines
3975
3976 AsBuiltInfDict = {
3977 'module_name' : self.Name,
3978 'module_guid' : Guid,
3979 'module_module_type' : ModuleType,
3980 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
3981 'pcd_is_driver_string' : [],
3982 'module_uefi_specification_version' : [],
3983 'module_pi_specification_version' : [],
3984 'module_entry_point' : self.Module.ModuleEntryPointList,
3985 'module_unload_image' : self.Module.ModuleUnloadImageList,
3986 'module_constructor' : self.Module.ConstructorList,
3987 'module_destructor' : self.Module.DestructorList,
3988 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
3989 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
3990 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
3991 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
3992 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
3993 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
3994 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
3995 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
3996 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
3997 'module_arch' : self.Arch,
3998 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],
3999 'binary_item' : [],
4000 'patchablepcd_item' : [],
4001 'pcd_item' : [],
4002 'protocol_item' : [],
4003 'ppi_item' : [],
4004 'guid_item' : [],
4005 'flags_item' : [],
4006 'libraryclasses_item' : []
4007 }
4008
4009 if 'MODULE_UNI_FILE' in MDefs:
4010 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])
4011 if os.path.isfile(UNIFile):
4012 shutil.copy2(UNIFile, self.OutputDir)
4013
4014 if self.AutoGenVersion > int(gInfSpecVersion, 0):
4015 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
4016 else:
4017 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
4018
4019 if DriverType:
4020 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
4021
4022 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
4023 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
4024 if 'PI_SPECIFICATION_VERSION' in self.Specification:
4025 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
4026
4027 OutputDir = self.OutputDir.replace('\\', '/').strip('/')
4028 for Item in self.CodaTargetList:
4029 File = Item.Target.Path.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')
4030 if File not in self.OutputFile:
4031 self.OutputFile.append(File)
4032 if Item.Target.Ext.lower() == '.aml':
4033 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
4034 elif Item.Target.Ext.lower() == '.acpi':
4035 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
4036 elif Item.Target.Ext.lower() == '.efi':
4037 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
4038 else:
4039 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
4040 if self.DepexGenerated:
4041 if self.Name + '.depex' not in self.OutputFile:
4042 self.OutputFile.append(self.Name + '.depex')
4043 if self.ModuleType in ['PEIM']:
4044 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
4045 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4046 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
4047 if self.ModuleType in ['DXE_SMM_DRIVER']:
4048 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
4049
4050 Bin = self._GenOffsetBin()
4051 if Bin:
4052 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
4053 if Bin not in self.OutputFile:
4054 self.OutputFile.append(Bin)
4055
4056 for Root, Dirs, Files in os.walk(OutputDir):
4057 for File in Files:
4058 if File.lower().endswith('.pdb'):
4059 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
4060 if File not in self.OutputFile:
4061 self.OutputFile.append(File)
4062 HeaderComments = self.Module.HeaderComments
4063 StartPos = 0
4064 for Index in range(len(HeaderComments)):
4065 if HeaderComments[Index].find('@BinaryHeader') != -1:
4066 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
4067 StartPos = Index
4068 break
4069 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
4070 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
4071
4072 GenList = [
4073 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
4074 (self.PpiList, self._PpiComments, 'ppi_item'),
4075 (GuidList, self._GuidComments, 'guid_item')
4076 ]
4077 for Item in GenList:
4078 for CName in Item[0]:
4079 Comments = ''
4080 if CName in Item[1]:
4081 Comments = '\n '.join(Item[1][CName])
4082 Entry = CName
4083 if Comments:
4084 Entry = Comments + '\n ' + CName
4085 AsBuiltInfDict[Item[2]].append(Entry)
4086 PatchList = parsePcdInfoFromMapFile(
4087 os.path.join(self.OutputDir, self.Name + '.map'),
4088 os.path.join(self.OutputDir, self.Name + '.efi')
4089 )
4090 if PatchList:
4091 for Pcd in PatchablePcds:
4092 TokenCName = Pcd.TokenCName
4093 for PcdItem in GlobalData.MixedPcd:
4094 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4095 TokenCName = PcdItem[0]
4096 break
4097 for PatchPcd in PatchList:
4098 if TokenCName == PatchPcd[0]:
4099 break
4100 else:
4101 continue
4102 PcdValue = ''
4103 if Pcd.DatumType == 'BOOLEAN':
4104 BoolValue = Pcd.DefaultValue.upper()
4105 if BoolValue == 'TRUE':
4106 Pcd.DefaultValue = '1'
4107 elif BoolValue == 'FALSE':
4108 Pcd.DefaultValue = '0'
4109
4110 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4111 HexFormat = '0x%02x'
4112 if Pcd.DatumType == 'UINT16':
4113 HexFormat = '0x%04x'
4114 elif Pcd.DatumType == 'UINT32':
4115 HexFormat = '0x%08x'
4116 elif Pcd.DatumType == 'UINT64':
4117 HexFormat = '0x%016x'
4118 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
4119 else:
4120 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
4121 EdkLogger.error("build", AUTOGEN_ERROR,
4122 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)
4123 )
4124 ArraySize = int(Pcd.MaxDatumSize, 0)
4125 PcdValue = Pcd.DefaultValue
4126 if PcdValue[0] != '{':
4127 Unicode = False
4128 if PcdValue[0] == 'L':
4129 Unicode = True
4130 PcdValue = PcdValue.lstrip('L')
4131 PcdValue = eval(PcdValue)
4132 NewValue = '{'
4133 for Index in range(0, len(PcdValue)):
4134 if Unicode:
4135 CharVal = ord(PcdValue[Index])
4136 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
4137 + '0x%02x' % (CharVal >> 8) + ', '
4138 else:
4139 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
4140 Padding = '0x00, '
4141 if Unicode:
4142 Padding = Padding * 2
4143 ArraySize = ArraySize / 2
4144 if ArraySize < (len(PcdValue) + 1):
4145 EdkLogger.error("build", AUTOGEN_ERROR,
4146 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4147 )
4148 if ArraySize > len(PcdValue) + 1:
4149 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
4150 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
4151 elif len(PcdValue.split(',')) <= ArraySize:
4152 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
4153 PcdValue += '}'
4154 else:
4155 EdkLogger.error("build", AUTOGEN_ERROR,
4156 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4157 )
4158 PcdItem = '%s.%s|%s|0x%X' % \
4159 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])
4160 PcdComments = ''
4161 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4162 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
4163 if PcdComments:
4164 PcdItem = PcdComments + '\n ' + PcdItem
4165 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
4166
4167 HiiPcds = []
4168 for Pcd in Pcds + VfrPcds:
4169 PcdComments = ''
4170 PcdCommentList = []
4171 HiiInfo = ''
4172 SkuId = ''
4173 TokenCName = Pcd.TokenCName
4174 for PcdItem in GlobalData.MixedPcd:
4175 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4176 TokenCName = PcdItem[0]
4177 break
4178 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
4179 for SkuName in Pcd.SkuInfoList:
4180 SkuInfo = Pcd.SkuInfoList[SkuName]
4181 SkuId = SkuInfo.SkuId
4182 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
4183 break
4184 if SkuId:
4185 #
4186 # Don't generate duplicated HII PCD
4187 #
4188 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
4189 continue
4190 else:
4191 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
4192 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4193 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
4194 if HiiInfo:
4195 UsageIndex = -1
4196 UsageStr = ''
4197 for Index, Comment in enumerate(PcdCommentList):
4198 for Usage in UsageList:
4199 if Comment.find(Usage) != -1:
4200 UsageStr = Usage
4201 UsageIndex = Index
4202 break
4203 if UsageIndex != -1:
4204 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
4205 else:
4206 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
4207 PcdComments = '\n '.join(PcdCommentList)
4208 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName
4209 if PcdComments:
4210 PcdEntry = PcdComments + '\n ' + PcdEntry
4211 AsBuiltInfDict['pcd_item'] += [PcdEntry]
4212 for Item in self.BuildOption:
4213 if 'FLAGS' in self.BuildOption[Item]:
4214 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
4215
4216 # Generated LibraryClasses section in comments.
4217 for Library in self.LibraryAutoGenList:
4218 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
4219
4220 # Generated UserExtensions TianoCore section.
4221 # All tianocore user extensions are copied.
4222 UserExtStr = ''
4223 for TianoCore in self._GetTianoCoreUserExtensionList():
4224 UserExtStr += '\n'.join(TianoCore)
4225 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])
4226 if os.path.isfile(ExtensionFile):
4227 shutil.copy2(ExtensionFile, self.OutputDir)
4228 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr
4229
4230 # Generated depex expression section in comments.
4231 AsBuiltInfDict['depexsection_item'] = ''
4232 DepexExpresion = self._GetDepexExpresionString()
4233 if DepexExpresion:
4234 AsBuiltInfDict['depexsection_item'] = DepexExpresion
4235
4236 AsBuiltInf = TemplateString()
4237 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
4238
4239 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
4240
4241 self.IsAsBuiltInfCreated = True
4242 if GlobalData.gBinCacheDest:
4243 self.CopyModuleToCache()
4244
4245 def CopyModuleToCache(self):
4246 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4247 CreateDirectory (FileDir)
4248 HashFile = path.join(self.BuildDir, self.Name + '.hash')
4249 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')
4250 if os.path.exists(HashFile):
4251 shutil.copy2(HashFile, FileDir)
4252 if os.path.exists(ModuleFile):
4253 shutil.copy2(ModuleFile, FileDir)
4254 if not self.OutputFile:
4255 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]
4256 self.OutputFile = Ma.Binaries
4257 if self.OutputFile:
4258 for File in self.OutputFile:
4259 File = str(File)
4260 if not os.path.isabs(File):
4261 File = os.path.join(self.OutputDir, File)
4262 if os.path.exists(File):
4263 shutil.copy2(File, FileDir)
4264
4265 def AttemptModuleCacheCopy(self):
4266 if self.IsBinaryModule:
4267 return False
4268 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4269 HashFile = path.join(FileDir, self.Name + '.hash')
4270 if os.path.exists(HashFile):
4271 f = open(HashFile, 'r')
4272 CacheHash = f.read()
4273 f.close()
4274 if GlobalData.gModuleHash[self.Arch][self.Name]:
4275 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:
4276 for root, dir, files in os.walk(FileDir):
4277 for f in files:
4278 if self.Name + '.hash' in f:
4279 shutil.copy2(HashFile, self.BuildDir)
4280 else:
4281 File = path.join(root, f)
4282 shutil.copy2(File, self.OutputDir)
4283 if self.Name == "PcdPeim" or self.Name == "PcdDxe":
4284 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4285 return True
4286 return False
4287
4288 ## Create makefile for the module and its dependent libraries
4289 #
4290 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4291 # dependent libraries will be created
4292 #
4293 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):
4294 # Ignore generating makefile when it is a binary module
4295 if self.IsBinaryModule:
4296 return
4297
4298 if self.IsMakeFileCreated:
4299 return
4300 self.GenFfsList = GenFfsList
4301 if not self.IsLibrary and CreateLibraryMakeFile:
4302 for LibraryAutoGen in self.LibraryAutoGenList:
4303 LibraryAutoGen.CreateMakeFile()
4304
4305 if self.CanSkip():
4306 return
4307
4308 if len(self.CustomMakefile) == 0:
4309 Makefile = GenMake.ModuleMakefile(self)
4310 else:
4311 Makefile = GenMake.CustomMakefile(self)
4312 if Makefile.Generate():
4313 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
4314 (self.Name, self.Arch))
4315 else:
4316 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
4317 (self.Name, self.Arch))
4318
4319 self.CreateTimeStamp(Makefile)
4320 self.IsMakeFileCreated = True
4321
4322 def CopyBinaryFiles(self):
4323 for File in self.Module.Binaries:
4324 SrcPath = File.Path
4325 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
4326 CopyLongFilePath(SrcPath, DstPath)
4327 ## Create autogen code for the module and its dependent libraries
4328 #
4329 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4330 # dependent libraries will be created
4331 #
4332 def CreateCodeFile(self, CreateLibraryCodeFile=True):
4333 if self.IsCodeFileCreated:
4334 return
4335
4336 # Need to generate PcdDatabase even PcdDriver is binarymodule
4337 if self.IsBinaryModule and self.PcdIsDriver != '':
4338 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4339 return
4340 if self.IsBinaryModule:
4341 if self.IsLibrary:
4342 self.CopyBinaryFiles()
4343 return
4344
4345 if not self.IsLibrary and CreateLibraryCodeFile:
4346 for LibraryAutoGen in self.LibraryAutoGenList:
4347 LibraryAutoGen.CreateCodeFile()
4348
4349 if self.CanSkip():
4350 return
4351
4352 AutoGenList = []
4353 IgoredAutoGenList = []
4354
4355 for File in self.AutoGenFileList:
4356 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
4357 #Ignore Edk AutoGen.c
4358 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
4359 continue
4360
4361 AutoGenList.append(str(File))
4362 else:
4363 IgoredAutoGenList.append(str(File))
4364
4365 # Skip the following code for EDK I inf
4366 if self.AutoGenVersion < 0x00010005:
4367 return
4368
4369 for ModuleType in self.DepexList:
4370 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4371 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
4372 continue
4373
4374 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
4375 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
4376
4377 if len(Dpx.PostfixNotation) <> 0:
4378 self.DepexGenerated = True
4379
4380 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
4381 AutoGenList.append(str(DpxFile))
4382 else:
4383 IgoredAutoGenList.append(str(DpxFile))
4384
4385 if IgoredAutoGenList == []:
4386 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
4387 (" ".join(AutoGenList), self.Name, self.Arch))
4388 elif AutoGenList == []:
4389 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
4390 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
4391 else:
4392 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
4393 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
4394
4395 self.IsCodeFileCreated = True
4396 return AutoGenList
4397
4398 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4399 def _GetLibraryAutoGenList(self):
4400 if self._LibraryAutoGenList == None:
4401 self._LibraryAutoGenList = []
4402 for Library in self.DependentLibraryList:
4403 La = ModuleAutoGen(
4404 self.Workspace,
4405 Library.MetaFile,
4406 self.BuildTarget,
4407 self.ToolChain,
4408 self.Arch,
4409 self.PlatformInfo.MetaFile
4410 )
4411 if La not in self._LibraryAutoGenList:
4412 self._LibraryAutoGenList.append(La)
4413 for Lib in La.CodaTargetList:
4414 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
4415 return self._LibraryAutoGenList
4416
4417 def GenModuleHash(self):
4418 if self.Arch not in GlobalData.gModuleHash:
4419 GlobalData.gModuleHash[self.Arch] = {}
4420 m = hashlib.md5()
4421 # Add Platform level hash
4422 m.update(GlobalData.gPlatformHash)
4423 # Add Package level hash
4424 if self.DependentPackageList:
4425 for Pkg in self.DependentPackageList:
4426 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:
4427 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])
4428
4429 # Add Library hash
4430 if self.LibraryAutoGenList:
4431 for Lib in self.LibraryAutoGenList:
4432 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:
4433 Lib.GenModuleHash()
4434 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])
4435
4436 # Add Module self
4437 f = open(str(self.MetaFile), 'r')
4438 Content = f.read()
4439 f.close()
4440 m.update(Content)
4441 # Add Module's source files
4442 if self.SourceFileList:
4443 for File in self.SourceFileList:
4444 f = open(str(File), 'r')
4445 Content = f.read()
4446 f.close()
4447 m.update(Content)
4448
4449 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")
4450 if self.Name not in GlobalData.gModuleHash[self.Arch]:
4451 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()
4452 if GlobalData.gBinCacheSource:
4453 CacheValid = self.AttemptModuleCacheCopy()
4454 if CacheValid:
4455 return False
4456 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)
4457
4458 ## Decide whether we can skip the ModuleAutoGen process
4459 def CanSkipbyHash(self):
4460 if GlobalData.gUseHashCache:
4461 return not self.GenModuleHash()
4462
4463 ## Decide whether we can skip the ModuleAutoGen process
4464 # If any source file is newer than the module than we cannot skip
4465 #
4466 def CanSkip(self):
4467 if not os.path.exists(self.GetTimeStampPath()):
4468 return False
4469 #last creation time of the module
4470 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]
4471
4472 SrcTimeStamp = self.Workspace._SrcTimeStamp
4473 if SrcTimeStamp > DstTimeStamp:
4474 return False
4475
4476 with open(self.GetTimeStampPath(),'r') as f:
4477 for source in f:
4478 source = source.rstrip('\n')
4479 if not os.path.exists(source):
4480 return False
4481 if source not in ModuleAutoGen.TimeDict :
4482 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]
4483 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:
4484 return False
4485 return True
4486
4487 def GetTimeStampPath(self):
4488 if self._TimeStampPath == None:
4489 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')
4490 return self._TimeStampPath
4491 def CreateTimeStamp(self, Makefile):
4492
4493 FileSet = set()
4494
4495 FileSet.add (self.MetaFile.Path)
4496
4497 for SourceFile in self.Module.Sources:
4498 FileSet.add (SourceFile.Path)
4499
4500 for Lib in self.DependentLibraryList:
4501 FileSet.add (Lib.MetaFile.Path)
4502
4503 for f in self.AutoGenDepSet:
4504 FileSet.add (f.Path)
4505
4506 if os.path.exists (self.GetTimeStampPath()):
4507 os.remove (self.GetTimeStampPath())
4508 with open(self.GetTimeStampPath(), 'w+') as file:
4509 for f in FileSet:
4510 print >> file, f
4511
4512 Module = property(_GetModule)
4513 Name = property(_GetBaseName)
4514 Guid = property(_GetGuid)
4515 Version = property(_GetVersion)
4516 ModuleType = property(_GetModuleType)
4517 ComponentType = property(_GetComponentType)
4518 BuildType = property(_GetBuildType)
4519 PcdIsDriver = property(_GetPcdIsDriver)
4520 AutoGenVersion = property(_GetAutoGenVersion)
4521 Macros = property(_GetMacros)
4522 Specification = property(_GetSpecification)
4523
4524 IsLibrary = property(_IsLibrary)
4525 IsBinaryModule = property(_IsBinaryModule)
4526 BuildDir = property(_GetBuildDir)
4527 OutputDir = property(_GetOutputDir)
4528 FfsOutputDir = property(_GetFfsOutputDir)
4529 DebugDir = property(_GetDebugDir)
4530 MakeFileDir = property(_GetMakeFileDir)
4531 CustomMakefile = property(_GetCustomMakefile)
4532
4533 IncludePathList = property(_GetIncludePathList)
4534 IncludePathLength = property(_GetIncludePathLength)
4535 AutoGenFileList = property(_GetAutoGenFileList)
4536 UnicodeFileList = property(_GetUnicodeFileList)
4537 VfrFileList = property(_GetVfrFileList)
4538 SourceFileList = property(_GetSourceFileList)
4539 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
4540 Targets = property(_GetTargets)
4541 IntroTargetList = property(_GetIntroTargetList)
4542 CodaTargetList = property(_GetFinalTargetList)
4543 FileTypes = property(_GetFileTypes)
4544 BuildRules = property(_GetBuildRules)
4545 IdfFileList = property(_GetIdfFileList)
4546
4547 DependentPackageList = property(_GetDependentPackageList)
4548 DependentLibraryList = property(_GetLibraryList)
4549 LibraryAutoGenList = property(_GetLibraryAutoGenList)
4550 DerivedPackageList = property(_GetDerivedPackageList)
4551
4552 ModulePcdList = property(_GetModulePcdList)
4553 LibraryPcdList = property(_GetLibraryPcdList)
4554 GuidList = property(_GetGuidList)
4555 ProtocolList = property(_GetProtocolList)
4556 PpiList = property(_GetPpiList)
4557 DepexList = property(_GetDepexTokenList)
4558 DxsFile = property(_GetDxsFile)
4559 DepexExpressionList = property(_GetDepexExpressionTokenList)
4560 BuildOption = property(_GetModuleBuildOption)
4561 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
4562 BuildCommand = property(_GetBuildCommand)
4563
4564 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
4565
4566 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4567 if __name__ == '__main__':
4568 pass
4569
EFI Development Kit II mirror for PVE