]> 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: Collect DynamicHii PCD values and assign it to VPD PCD Value
[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 Variable,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
1229 # flag indicating if the makefile/C-code file has been created or not
1230 self.IsMakeFileCreated = False
1231 self.IsCodeFileCreated = False
1232
1233 self._Platform = None
1234 self._Name = None
1235 self._Guid = None
1236 self._Version = None
1237
1238 self._BuildRule = None
1239 self._SourceDir = None
1240 self._BuildDir = None
1241 self._OutputDir = None
1242 self._FvDir = None
1243 self._MakeFileDir = None
1244 self._FdfFile = None
1245
1246 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1247 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1248 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1249 self._NonDynamicPcdDict = {}
1250
1251 self._ToolDefinitions = None
1252 self._ToolDefFile = None # toolcode : tool path
1253 self._ToolChainFamily = None
1254 self._BuildRuleFamily = None
1255 self._BuildOption = None # toolcode : option
1256 self._EdkBuildOption = None # edktoolcode : option
1257 self._EdkIIBuildOption = None # edkiitoolcode : option
1258 self._PackageList = None
1259 self._ModuleAutoGenList = None
1260 self._LibraryAutoGenList = None
1261 self._BuildCommand = None
1262 self._AsBuildInfList = []
1263 self._AsBuildModuleList = []
1264 if GlobalData.gFdfParser != None:
1265 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList
1266 for Inf in self._AsBuildInfList:
1267 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)
1268 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1269 if not M.IsSupportedArch:
1270 continue
1271 self._AsBuildModuleList.append(InfClass)
1272 # get library/modules for build
1273 self.LibraryBuildDirectoryList = []
1274 self.ModuleBuildDirectoryList = []
1275 return True
1276
1277 def __repr__(self):
1278 return "%s [%s]" % (self.MetaFile, self.Arch)
1279
1280 ## Create autogen code for platform and modules
1281 #
1282 # Since there's no autogen code for platform, this method will do nothing
1283 # if CreateModuleCodeFile is set to False.
1284 #
1285 # @param CreateModuleCodeFile Flag indicating if creating module's
1286 # autogen code file or not
1287 #
1288 def CreateCodeFile(self, CreateModuleCodeFile=False):
1289 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1290 if self.IsCodeFileCreated or not CreateModuleCodeFile:
1291 return
1292
1293 for Ma in self.ModuleAutoGenList:
1294 Ma.CreateCodeFile(True)
1295
1296 # don't do this twice
1297 self.IsCodeFileCreated = True
1298
1299 ## Generate Fds Command
1300 def _GenFdsCommand(self):
1301 return self.Workspace.GenFdsCommand
1302
1303 ## Create makefile for the platform and mdoules in it
1304 #
1305 # @param CreateModuleMakeFile Flag indicating if the makefile for
1306 # modules will be created as well
1307 #
1308 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):
1309 if CreateModuleMakeFile:
1310 for ModuleFile in self.Platform.Modules:
1311 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,
1312 self.ToolChain, self.Arch, self.MetaFile)
1313 if (ModuleFile.File, self.Arch) in FfsCommand:
1314 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])
1315 else:
1316 Ma.CreateMakeFile(True)
1317 #Ma.CreateAsBuiltInf()
1318
1319 # no need to create makefile for the platform more than once
1320 if self.IsMakeFileCreated:
1321 return
1322
1323 # create library/module build dirs for platform
1324 Makefile = GenMake.PlatformMakefile(self)
1325 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()
1326 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()
1327
1328 self.IsMakeFileCreated = True
1329
1330 ## Deal with Shared FixedAtBuild Pcds
1331 #
1332 def CollectFixedAtBuildPcds(self):
1333 for LibAuto in self.LibraryAutoGenList:
1334 FixedAtBuildPcds = {}
1335 ShareFixedAtBuildPcdsSameValue = {}
1336 for Module in LibAuto._ReferenceModules:
1337 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:
1338 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1339 if key not in FixedAtBuildPcds:
1340 ShareFixedAtBuildPcdsSameValue[key] = True
1341 FixedAtBuildPcds[key] = Pcd.DefaultValue
1342 else:
1343 if FixedAtBuildPcds[key] != Pcd.DefaultValue:
1344 ShareFixedAtBuildPcdsSameValue[key] = False
1345 for Pcd in LibAuto.FixedAtBuildPcds:
1346 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1347 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:
1348 continue
1349 else:
1350 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]
1351 if DscPcd.Type != "FixedAtBuild":
1352 continue
1353 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:
1354 LibAuto.ConstPcd[key] = Pcd.DefaultValue
1355
1356 def CollectVariables(self, DynamicPcdSet):
1357 VariableInfo = Variable()
1358 Index = 0
1359 for Pcd in DynamicPcdSet:
1360 if not hasattr(Pcd,"DefaultStoreName"):
1361 Pcd.DefaultStoreName = ['0']
1362 for StorageName in Pcd.DefaultStoreName:
1363 pcdname = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
1364 for SkuName in Pcd.SkuInfoList:
1365 Sku = Pcd.SkuInfoList[SkuName]
1366 SkuId = Sku.SkuId
1367 if SkuId == None or SkuId == '':
1368 continue
1369 if len(Sku.VariableName) > 0:
1370 VariableGuidStructure = Sku.VariableGuidValue
1371 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)
1372 if Pcd.Phase == "DXE":
1373 VariableInfo.append_variable(var_info(Index,pcdname,StorageName,SkuId, StringToArray(Sku.VariableName),VariableGuid, Sku.VariableAttribute , Pcd.DefaultValue,Sku.HiiDefaultValue,Pcd.DatumType))
1374 Index += 1
1375 return VariableInfo
1376 ## Collect dynamic PCDs
1377 #
1378 # Gather dynamic PCDs list from each module and their settings from platform
1379 # This interface should be invoked explicitly when platform action is created.
1380 #
1381 def CollectPlatformDynamicPcds(self):
1382 # Override the platform Pcd's value by build option
1383 if GlobalData.BuildOptionPcd:
1384 for key in self.Platform.Pcds:
1385 PlatformPcd = self.Platform.Pcds[key]
1386 for PcdItem in GlobalData.BuildOptionPcd:
1387 if (PlatformPcd.TokenSpaceGuidCName, PlatformPcd.TokenCName) == (PcdItem[0], PcdItem[1]):
1388 PlatformPcd.DefaultValue = PcdItem[2]
1389 if PlatformPcd.SkuInfoList:
1390 Sku = PlatformPcd.SkuInfoList[PlatformPcd.SkuInfoList.keys()[0]]
1391 Sku.DefaultValue = PcdItem[2]
1392 break
1393
1394 for key in self.Platform.Pcds:
1395 for SinglePcd in GlobalData.MixedPcd:
1396 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:
1397 for item in GlobalData.MixedPcd[SinglePcd]:
1398 Pcd_Type = item[0].split('_')[-1]
1399 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 \
1400 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):
1401 Value = self.Platform.Pcds[key]
1402 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type
1403 if len(key) == 2:
1404 newkey = (Value.TokenCName, key[1])
1405 elif len(key) == 3:
1406 newkey = (Value.TokenCName, key[1], key[2])
1407 del self.Platform.Pcds[key]
1408 self.Platform.Pcds[newkey] = Value
1409 break
1410 else:
1411 pass
1412 break
1413 else:
1414 pass
1415
1416 # for gathering error information
1417 NoDatumTypePcdList = set()
1418 PcdNotInDb = []
1419 self._GuidValue = {}
1420 FdfModuleList = []
1421 for InfName in self._AsBuildInfList:
1422 InfName = mws.join(self.WorkspaceDir, InfName)
1423 FdfModuleList.append(os.path.normpath(InfName))
1424 for F in self.Platform.Modules.keys():
1425 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)
1426 #GuidValue.update(M.Guids)
1427
1428 self.Platform.Modules[F].M = M
1429
1430 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:
1431 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1432 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1433 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))
1434
1435 # Check the PCD from Binary INF or Source INF
1436 if M.IsBinaryModule == True:
1437 PcdFromModule.IsFromBinaryInf = True
1438
1439 # Check the PCD from DSC or not
1440 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():
1441 PcdFromModule.IsFromDsc = True
1442 else:
1443 PcdFromModule.IsFromDsc = False
1444 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:
1445 if F.Path not in FdfModuleList:
1446 # If one of the Source built modules listed in the DSC is not listed
1447 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1448 # access method (it is only listed in the DEC file that declares the
1449 # PCD as PcdsDynamic), then build tool will report warning message
1450 # notify the PI that they are attempting to build a module that must
1451 # be included in a flash image in order to be functional. These Dynamic
1452 # PCD will not be added into the Database unless it is used by other
1453 # modules that are included in the FDF file.
1454 if PcdFromModule.Type in GenC.gDynamicPcd and \
1455 PcdFromModule.IsFromBinaryInf == False:
1456 # Print warning message to let the developer make a determine.
1457 if PcdFromModule not in PcdNotInDb:
1458 PcdNotInDb.append(PcdFromModule)
1459 continue
1460 # If one of the Source built modules listed in the DSC is not listed in
1461 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1462 # access method (it is only listed in the DEC file that declares the
1463 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1464 # PCD to the Platform's PCD Database.
1465 if PcdFromModule.Type in GenC.gDynamicExPcd:
1466 if PcdFromModule not in PcdNotInDb:
1467 PcdNotInDb.append(PcdFromModule)
1468 continue
1469 #
1470 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1471 # it should be stored in Pcd PEI database, If a dynamic only
1472 # used by DXE module, it should be stored in DXE PCD database.
1473 # The default Phase is DXE
1474 #
1475 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1476 PcdFromModule.Phase = "PEI"
1477 if PcdFromModule not in self._DynaPcdList_:
1478 self._DynaPcdList_.append(PcdFromModule)
1479 elif PcdFromModule.Phase == 'PEI':
1480 # overwrite any the same PCD existing, if Phase is PEI
1481 Index = self._DynaPcdList_.index(PcdFromModule)
1482 self._DynaPcdList_[Index] = PcdFromModule
1483 elif PcdFromModule not in self._NonDynaPcdList_:
1484 self._NonDynaPcdList_.append(PcdFromModule)
1485 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:
1486 Index = self._NonDynaPcdList_.index(PcdFromModule)
1487 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:
1488 #The PCD from Binary INF will override the same one from source INF
1489 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])
1490 PcdFromModule.Pending = False
1491 self._NonDynaPcdList_.append (PcdFromModule)
1492 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1493 DscModuleList = []
1494 for ModuleInf in self.Platform.Modules.keys():
1495 DscModuleList.append (os.path.normpath(ModuleInf.Path))
1496 # add the PCD from modules that listed in FDF but not in DSC to Database
1497 for InfName in FdfModuleList:
1498 if InfName not in DscModuleList:
1499 InfClass = PathClass(InfName)
1500 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]
1501 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1502 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1503 # For binary module, if in current arch, we need to list the PCDs into database.
1504 if not M.IsSupportedArch:
1505 continue
1506 # Override the module PCD setting by platform setting
1507 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)
1508 for PcdFromModule in ModulePcdList:
1509 PcdFromModule.IsFromBinaryInf = True
1510 PcdFromModule.IsFromDsc = False
1511 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1512 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:
1513 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1514 File=self.MetaFile,
1515 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1516 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))
1517 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1518 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:
1519 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))
1520 if M.ModuleType in ["PEIM", "PEI_CORE"]:
1521 PcdFromModule.Phase = "PEI"
1522 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:
1523 self._DynaPcdList_.append(PcdFromModule)
1524 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:
1525 self._NonDynaPcdList_.append(PcdFromModule)
1526 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:
1527 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1528 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1529 # module & DXE module at a same time.
1530 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1531 # INF file as DynamicEx.
1532 Index = self._DynaPcdList_.index(PcdFromModule)
1533 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase
1534 self._DynaPcdList_[Index].Type = PcdFromModule.Type
1535 for PcdFromModule in self._NonDynaPcdList_:
1536 # If a PCD is not listed in the DSC file, but binary INF files used by
1537 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1538 # section, AND all source INF files used by this platform the build
1539 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1540 # section, then the tools must NOT add the PCD to the Platform's PCD
1541 # Database; the build must assign the access method for this PCD as
1542 # PcdsPatchableInModule.
1543 if PcdFromModule not in self._DynaPcdList_:
1544 continue
1545 Index = self._DynaPcdList_.index(PcdFromModule)
1546 if PcdFromModule.IsFromDsc == False and \
1547 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \
1548 PcdFromModule.IsFromBinaryInf == True and \
1549 self._DynaPcdList_[Index].IsFromBinaryInf == False:
1550 Index = self._DynaPcdList_.index(PcdFromModule)
1551 self._DynaPcdList_.remove (self._DynaPcdList_[Index])
1552
1553 # print out error information and break the build, if error found
1554 if len(NoDatumTypePcdList) > 0:
1555 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)
1556 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",
1557 File=self.MetaFile,
1558 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1559 % NoDatumTypePcdListString)
1560 self._NonDynamicPcdList = self._NonDynaPcdList_
1561 self._DynamicPcdList = self._DynaPcdList_
1562 #
1563 # Sort dynamic PCD list to:
1564 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1565 # try to be put header of dynamicd List
1566 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1567 #
1568 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1569 #
1570 UnicodePcdArray = []
1571 HiiPcdArray = []
1572 OtherPcdArray = []
1573 VpdPcdDict = {}
1574 VpdFile = VpdInfoFile.VpdInfoFile()
1575 NeedProcessVpdMapFile = False
1576
1577 for pcd in self.Platform.Pcds.keys():
1578 if pcd not in self._PlatformPcds.keys():
1579 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]
1580
1581 for item in self._PlatformPcds:
1582 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1583 self._PlatformPcds[item].DatumType = "VOID*"
1584
1585 if (self.Workspace.ArchList[-1] == self.Arch):
1586 for Pcd in self._DynamicPcdList:
1587 # just pick the a value to determine whether is unicode string type
1588 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]
1589 Sku.VpdOffset = Sku.VpdOffset.strip()
1590
1591 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1592 Pcd.DatumType = "VOID*"
1593
1594 PcdValue = Sku.DefaultValue
1595 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):
1596 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1597 UnicodePcdArray.append(Pcd)
1598 elif len(Sku.VariableName) > 0:
1599 # if found HII type PCD then insert to right of UnicodeIndex
1600 HiiPcdArray.append(Pcd)
1601 else:
1602 OtherPcdArray.append(Pcd)
1603 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1604 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd
1605
1606 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1607 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1608 if PcdNvStoreDfBuffer:
1609 var_info = self.CollectVariables(self._DynamicPcdList)
1610 default_skuobj = PcdNvStoreDfBuffer.SkuInfoList.get("DEFAULT")
1611 default_skuobj.DefaultValue = var_info.dump()
1612 if default_skuobj:
1613 PcdNvStoreDfBuffer.SkuInfoList.clear()
1614 PcdNvStoreDfBuffer.SkuInfoList['DEFAULT'] = default_skuobj
1615 PcdNvStoreDfBuffer.MaxDatumSize = len(default_skuobj.DefaultValue.split(","))
1616
1617 PlatformPcds = self._PlatformPcds.keys()
1618 PlatformPcds.sort()
1619 #
1620 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1621 #
1622 for PcdKey in PlatformPcds:
1623 Pcd = self._PlatformPcds[PcdKey]
1624 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \
1625 PcdKey in VpdPcdDict:
1626 Pcd = VpdPcdDict[PcdKey]
1627 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1628 Sku.VpdOffset = Sku.VpdOffset.strip()
1629 PcdValue = Sku.DefaultValue
1630 if PcdValue == "":
1631 PcdValue = Pcd.DefaultValue
1632 if Sku.VpdOffset != '*':
1633 if PcdValue.startswith("{"):
1634 Alignment = 8
1635 elif PcdValue.startswith("L"):
1636 Alignment = 2
1637 else:
1638 Alignment = 1
1639 try:
1640 VpdOffset = int(Sku.VpdOffset)
1641 except:
1642 try:
1643 VpdOffset = int(Sku.VpdOffset, 16)
1644 except:
1645 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1646 if VpdOffset % Alignment != 0:
1647 if PcdValue.startswith("{"):
1648 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)
1649 else:
1650 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))
1651 VpdFile.Add(Pcd, Sku.VpdOffset)
1652 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1653 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1654 NeedProcessVpdMapFile = True
1655 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':
1656 EdkLogger.error("Build", FILE_NOT_FOUND, \
1657 "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.")
1658
1659
1660 #
1661 # Fix the PCDs define in VPD PCD section that never referenced by module.
1662 # An example is PCD for signature usage.
1663 #
1664 for DscPcd in PlatformPcds:
1665 DscPcdEntry = self._PlatformPcds[DscPcd]
1666 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1667 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):
1668 FoundFlag = False
1669 for VpdPcd in VpdFile._VpdArray.keys():
1670 # This PCD has been referenced by module
1671 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1672 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):
1673 FoundFlag = True
1674
1675 # Not found, it should be signature
1676 if not FoundFlag :
1677 # just pick the a value to determine whether is unicode string type
1678 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():
1679 Sku.VpdOffset = Sku.VpdOffset.strip()
1680
1681 # Need to iterate DEC pcd information to get the value & datumtype
1682 for eachDec in self.PackageList:
1683 for DecPcd in eachDec.Pcds:
1684 DecPcdEntry = eachDec.Pcds[DecPcd]
1685 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \
1686 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):
1687 # Print warning message to let the developer make a determine.
1688 EdkLogger.warn("build", "Unreferenced vpd pcd used!",
1689 File=self.MetaFile, \
1690 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \
1691 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))
1692
1693 DscPcdEntry.DatumType = DecPcdEntry.DatumType
1694 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue
1695 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue
1696 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]
1697 # Only fix the value while no value provided in DSC file.
1698 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):
1699 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue
1700
1701 if DscPcdEntry not in self._DynamicPcdList:
1702 self._DynamicPcdList.append(DscPcdEntry)
1703 # Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]
1704 Sku.VpdOffset = Sku.VpdOffset.strip()
1705 PcdValue = Sku.DefaultValue
1706 if PcdValue == "":
1707 PcdValue = DscPcdEntry.DefaultValue
1708 if Sku.VpdOffset != '*':
1709 if PcdValue.startswith("{"):
1710 Alignment = 8
1711 elif PcdValue.startswith("L"):
1712 Alignment = 2
1713 else:
1714 Alignment = 1
1715 try:
1716 VpdOffset = int(Sku.VpdOffset)
1717 except:
1718 try:
1719 VpdOffset = int(Sku.VpdOffset, 16)
1720 except:
1721 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))
1722 if VpdOffset % Alignment != 0:
1723 if PcdValue.startswith("{"):
1724 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)
1725 else:
1726 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))
1727 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)
1728 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":
1729 NeedProcessVpdMapFile = True
1730 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):
1731 UnicodePcdArray.append(DscPcdEntry)
1732 elif len(Sku.VariableName) > 0:
1733 HiiPcdArray.append(DscPcdEntry)
1734 else:
1735 OtherPcdArray.append(DscPcdEntry)
1736
1737 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1738
1739
1740
1741 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \
1742 VpdFile.GetCount() != 0:
1743 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,
1744 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))
1745
1746 if VpdFile.GetCount() != 0:
1747 FvPath = os.path.join(self.BuildDir, "FV")
1748 if not os.path.exists(FvPath):
1749 try:
1750 os.makedirs(FvPath)
1751 except:
1752 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)
1753
1754 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)
1755
1756 if VpdFile.Write(VpdFilePath):
1757 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1758 BPDGToolName = None
1759 for ToolDef in self.ToolDefinition.values():
1760 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:
1761 if not ToolDef.has_key("PATH"):
1762 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)
1763 BPDGToolName = ToolDef["PATH"]
1764 break
1765 # Call third party GUID BPDG tool.
1766 if BPDGToolName != None:
1767 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)
1768 else:
1769 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.")
1770
1771 # Process VPD map file generated by third party BPDG tool
1772 if NeedProcessVpdMapFile:
1773 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)
1774 if os.path.exists(VpdMapFilePath):
1775 VpdFile.Read(VpdMapFilePath)
1776
1777 # Fixup "*" offset
1778 for Pcd in self._DynamicPcdList:
1779 # just pick the a value to determine whether is unicode string type
1780 i = 0
1781 for (SkuName,Sku) in Pcd.SkuInfoList.items():
1782 if Sku.VpdOffset == "*":
1783 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[i].strip()
1784 i += 1
1785 else:
1786 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)
1787
1788 # Delete the DynamicPcdList At the last time enter into this function
1789 del self._DynamicPcdList[:]
1790 self._DynamicPcdList.extend(UnicodePcdArray)
1791 self._DynamicPcdList.extend(HiiPcdArray)
1792 self._DynamicPcdList.extend(OtherPcdArray)
1793 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList
1794
1795 ## Return the platform build data object
1796 def _GetPlatform(self):
1797 if self._Platform == None:
1798 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
1799 return self._Platform
1800
1801 ## Return platform name
1802 def _GetName(self):
1803 return self.Platform.PlatformName
1804
1805 ## Return the meta file GUID
1806 def _GetGuid(self):
1807 return self.Platform.Guid
1808
1809 ## Return the platform version
1810 def _GetVersion(self):
1811 return self.Platform.Version
1812
1813 ## Return the FDF file name
1814 def _GetFdfFile(self):
1815 if self._FdfFile == None:
1816 if self.Workspace.FdfFile != "":
1817 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)
1818 else:
1819 self._FdfFile = ''
1820 return self._FdfFile
1821
1822 ## Return the build output directory platform specifies
1823 def _GetOutputDir(self):
1824 return self.Platform.OutputDirectory
1825
1826 ## Return the directory to store all intermediate and final files built
1827 def _GetBuildDir(self):
1828 if self._BuildDir == None:
1829 if os.path.isabs(self.OutputDir):
1830 self._BuildDir = path.join(
1831 path.abspath(self.OutputDir),
1832 self.BuildTarget + "_" + self.ToolChain,
1833 )
1834 else:
1835 self._BuildDir = path.join(
1836 self.WorkspaceDir,
1837 self.OutputDir,
1838 self.BuildTarget + "_" + self.ToolChain,
1839 )
1840 GlobalData.gBuildDirectory = self._BuildDir
1841 return self._BuildDir
1842
1843 ## Return directory of platform makefile
1844 #
1845 # @retval string Makefile directory
1846 #
1847 def _GetMakeFileDir(self):
1848 if self._MakeFileDir == None:
1849 self._MakeFileDir = path.join(self.BuildDir, self.Arch)
1850 return self._MakeFileDir
1851
1852 ## Return build command string
1853 #
1854 # @retval string Build command string
1855 #
1856 def _GetBuildCommand(self):
1857 if self._BuildCommand == None:
1858 self._BuildCommand = []
1859 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:
1860 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])
1861 if "FLAGS" in self.ToolDefinition["MAKE"]:
1862 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()
1863 if NewOption != '':
1864 self._BuildCommand += SplitOption(NewOption)
1865 return self._BuildCommand
1866
1867 ## Get tool chain definition
1868 #
1869 # Get each tool defition for given tool chain from tools_def.txt and platform
1870 #
1871 def _GetToolDefinition(self):
1872 if self._ToolDefinitions == None:
1873 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary
1874 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:
1875 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",
1876 ExtraData="[%s]" % self.MetaFile)
1877 self._ToolDefinitions = {}
1878 DllPathList = set()
1879 for Def in ToolDefinition:
1880 Target, Tag, Arch, Tool, Attr = Def.split("_")
1881 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:
1882 continue
1883
1884 Value = ToolDefinition[Def]
1885 # don't record the DLL
1886 if Attr == "DLL":
1887 DllPathList.add(Value)
1888 continue
1889
1890 if Tool not in self._ToolDefinitions:
1891 self._ToolDefinitions[Tool] = {}
1892 self._ToolDefinitions[Tool][Attr] = Value
1893
1894 ToolsDef = ''
1895 MakePath = ''
1896 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:
1897 if "FLAGS" not in self._ToolDefinitions["MAKE"]:
1898 self._ToolDefinitions["MAKE"]["FLAGS"] = ""
1899 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"
1900 MakeFlags = ''
1901 for Tool in self._ToolDefinitions:
1902 for Attr in self._ToolDefinitions[Tool]:
1903 Value = self._ToolDefinitions[Tool][Attr]
1904 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:
1905 # check if override is indicated
1906 if self.BuildOption[Tool][Attr].startswith('='):
1907 Value = self.BuildOption[Tool][Attr][1:]
1908 else:
1909 if Attr != 'PATH':
1910 Value += " " + self.BuildOption[Tool][Attr]
1911 else:
1912 Value = self.BuildOption[Tool][Attr]
1913
1914 if Attr == "PATH":
1915 # Don't put MAKE definition in the file
1916 if Tool == "MAKE":
1917 MakePath = Value
1918 else:
1919 ToolsDef += "%s = %s\n" % (Tool, Value)
1920 elif Attr != "DLL":
1921 # Don't put MAKE definition in the file
1922 if Tool == "MAKE":
1923 if Attr == "FLAGS":
1924 MakeFlags = Value
1925 else:
1926 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)
1927 ToolsDef += "\n"
1928
1929 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)
1930 for DllPath in DllPathList:
1931 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]
1932 os.environ["MAKE_FLAGS"] = MakeFlags
1933
1934 return self._ToolDefinitions
1935
1936 ## Return the paths of tools
1937 def _GetToolDefFile(self):
1938 if self._ToolDefFile == None:
1939 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)
1940 return self._ToolDefFile
1941
1942 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1943 def _GetToolChainFamily(self):
1944 if self._ToolChainFamily == None:
1945 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1946 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \
1947 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \
1948 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:
1949 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1950 % self.ToolChain)
1951 self._ToolChainFamily = "MSFT"
1952 else:
1953 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]
1954 return self._ToolChainFamily
1955
1956 def _GetBuildRuleFamily(self):
1957 if self._BuildRuleFamily == None:
1958 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase
1959 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \
1960 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \
1961 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:
1962 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1963 % self.ToolChain)
1964 self._BuildRuleFamily = "MSFT"
1965 else:
1966 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]
1967 return self._BuildRuleFamily
1968
1969 ## Return the build options specific for all modules in this platform
1970 def _GetBuildOptions(self):
1971 if self._BuildOption == None:
1972 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)
1973 return self._BuildOption
1974
1975 ## Return the build options specific for EDK modules in this platform
1976 def _GetEdkBuildOptions(self):
1977 if self._EdkBuildOption == None:
1978 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)
1979 return self._EdkBuildOption
1980
1981 ## Return the build options specific for EDKII modules in this platform
1982 def _GetEdkIIBuildOptions(self):
1983 if self._EdkIIBuildOption == None:
1984 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)
1985 return self._EdkIIBuildOption
1986
1987 ## Parse build_rule.txt in Conf Directory.
1988 #
1989 # @retval BuildRule object
1990 #
1991 def _GetBuildRule(self):
1992 if self._BuildRule == None:
1993 BuildRuleFile = None
1994 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:
1995 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]
1996 if BuildRuleFile in [None, '']:
1997 BuildRuleFile = gDefaultBuildRuleFile
1998 self._BuildRule = BuildRule(BuildRuleFile)
1999 if self._BuildRule._FileVersion == "":
2000 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum
2001 else:
2002 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :
2003 # If Build Rule's version is less than the version number required by the tools, halting the build.
2004 EdkLogger.error("build", AUTOGEN_ERROR,
2005 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])"\
2006 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))
2007
2008 return self._BuildRule
2009
2010 ## Summarize the packages used by modules in this platform
2011 def _GetPackageList(self):
2012 if self._PackageList == None:
2013 self._PackageList = set()
2014 for La in self.LibraryAutoGenList:
2015 self._PackageList.update(La.DependentPackageList)
2016 for Ma in self.ModuleAutoGenList:
2017 self._PackageList.update(Ma.DependentPackageList)
2018 #Collect package set information from INF of FDF
2019 PkgSet = set()
2020 for ModuleFile in self._AsBuildModuleList:
2021 if ModuleFile in self.Platform.Modules:
2022 continue
2023 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]
2024 PkgSet.update(ModuleData.Packages)
2025 self._PackageList = list(self._PackageList) + list (PkgSet)
2026 return self._PackageList
2027
2028 def _GetNonDynamicPcdDict(self):
2029 if self._NonDynamicPcdDict:
2030 return self._NonDynamicPcdDict
2031 for Pcd in self.NonDynamicPcdList:
2032 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd
2033 return self._NonDynamicPcdDict
2034
2035 ## Get list of non-dynamic PCDs
2036 def _GetNonDynamicPcdList(self):
2037 if self._NonDynamicPcdList == None:
2038 self.CollectPlatformDynamicPcds()
2039 return self._NonDynamicPcdList
2040
2041 ## Get list of dynamic PCDs
2042 def _GetDynamicPcdList(self):
2043 if self._DynamicPcdList == None:
2044 self.CollectPlatformDynamicPcds()
2045 return self._DynamicPcdList
2046
2047 ## Generate Token Number for all PCD
2048 def _GetPcdTokenNumbers(self):
2049 if self._PcdTokenNumber == None:
2050 self._PcdTokenNumber = sdict()
2051 TokenNumber = 1
2052 #
2053 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2054 # Such as:
2055 #
2056 # Dynamic PCD:
2057 # TokenNumber 0 ~ 10
2058 # DynamicEx PCD:
2059 # TokeNumber 11 ~ 20
2060 #
2061 for Pcd in self.DynamicPcdList:
2062 if Pcd.Phase == "PEI":
2063 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2064 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2065 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2066 TokenNumber += 1
2067
2068 for Pcd in self.DynamicPcdList:
2069 if Pcd.Phase == "PEI":
2070 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2071 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2072 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2073 TokenNumber += 1
2074
2075 for Pcd in self.DynamicPcdList:
2076 if Pcd.Phase == "DXE":
2077 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2078 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2079 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2080 TokenNumber += 1
2081
2082 for Pcd in self.DynamicPcdList:
2083 if Pcd.Phase == "DXE":
2084 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2085 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))
2086 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2087 TokenNumber += 1
2088
2089 for Pcd in self.NonDynamicPcdList:
2090 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber
2091 TokenNumber += 1
2092 return self._PcdTokenNumber
2093
2094 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2095 def _GetAutoGenObjectList(self):
2096 self._ModuleAutoGenList = []
2097 self._LibraryAutoGenList = []
2098 for ModuleFile in self.Platform.Modules:
2099 Ma = ModuleAutoGen(
2100 self.Workspace,
2101 ModuleFile,
2102 self.BuildTarget,
2103 self.ToolChain,
2104 self.Arch,
2105 self.MetaFile
2106 )
2107 if Ma not in self._ModuleAutoGenList:
2108 self._ModuleAutoGenList.append(Ma)
2109 for La in Ma.LibraryAutoGenList:
2110 if La not in self._LibraryAutoGenList:
2111 self._LibraryAutoGenList.append(La)
2112 if Ma not in La._ReferenceModules:
2113 La._ReferenceModules.append(Ma)
2114
2115 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2116 def _GetModuleAutoGenList(self):
2117 if self._ModuleAutoGenList == None:
2118 self._GetAutoGenObjectList()
2119 return self._ModuleAutoGenList
2120
2121 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2122 def _GetLibraryAutoGenList(self):
2123 if self._LibraryAutoGenList == None:
2124 self._GetAutoGenObjectList()
2125 return self._LibraryAutoGenList
2126
2127 ## Test if a module is supported by the platform
2128 #
2129 # An error will be raised directly if the module or its arch is not supported
2130 # by the platform or current configuration
2131 #
2132 def ValidModule(self, Module):
2133 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \
2134 or Module in self._AsBuildModuleList
2135
2136 ## Resolve the library classes in a module to library instances
2137 #
2138 # This method will not only resolve library classes but also sort the library
2139 # instances according to the dependency-ship.
2140 #
2141 # @param Module The module from which the library classes will be resolved
2142 #
2143 # @retval library_list List of library instances sorted
2144 #
2145 def ApplyLibraryInstance(self, Module):
2146 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2147 if str(Module) not in self.Platform.Modules:
2148 return []
2149
2150 ModuleType = Module.ModuleType
2151
2152 # for overridding library instances with module specific setting
2153 PlatformModule = self.Platform.Modules[str(Module)]
2154
2155 # add forced library instances (specified under LibraryClasses sections)
2156 #
2157 # If a module has a MODULE_TYPE of USER_DEFINED,
2158 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2159 #
2160 if Module.ModuleType != SUP_MODULE_USER_DEFINED:
2161 for LibraryClass in self.Platform.LibraryClasses.GetKeys():
2162 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:
2163 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]
2164
2165 # add forced library instances (specified in module overrides)
2166 for LibraryClass in PlatformModule.LibraryClasses:
2167 if LibraryClass.startswith("NULL"):
2168 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]
2169
2170 # EdkII module
2171 LibraryConsumerList = [Module]
2172 Constructor = []
2173 ConsumedByList = sdict()
2174 LibraryInstance = sdict()
2175
2176 EdkLogger.verbose("")
2177 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2178 while len(LibraryConsumerList) > 0:
2179 M = LibraryConsumerList.pop()
2180 for LibraryClassName in M.LibraryClasses:
2181 if LibraryClassName not in LibraryInstance:
2182 # override library instance for this module
2183 if LibraryClassName in PlatformModule.LibraryClasses:
2184 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]
2185 else:
2186 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]
2187 if LibraryPath == None or LibraryPath == "":
2188 LibraryPath = M.LibraryClasses[LibraryClassName]
2189 if LibraryPath == None or LibraryPath == "":
2190 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,
2191 "Instance of library class [%s] is not found" % LibraryClassName,
2192 File=self.MetaFile,
2193 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))
2194
2195 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]
2196 # for those forced library instance (NULL library), add a fake library class
2197 if LibraryClassName.startswith("NULL"):
2198 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))
2199 elif LibraryModule.LibraryClass == None \
2200 or len(LibraryModule.LibraryClass) == 0 \
2201 or (ModuleType != 'USER_DEFINED'
2202 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):
2203 # only USER_DEFINED can link against any library instance despite of its SupModList
2204 EdkLogger.error("build", OPTION_MISSING,
2205 "Module type [%s] is not supported by library instance [%s]" \
2206 % (ModuleType, LibraryPath), File=self.MetaFile,
2207 ExtraData="consumed by [%s]" % str(Module))
2208
2209 LibraryInstance[LibraryClassName] = LibraryModule
2210 LibraryConsumerList.append(LibraryModule)
2211 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))
2212 else:
2213 LibraryModule = LibraryInstance[LibraryClassName]
2214
2215 if LibraryModule == None:
2216 continue
2217
2218 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:
2219 Constructor.append(LibraryModule)
2220
2221 if LibraryModule not in ConsumedByList:
2222 ConsumedByList[LibraryModule] = []
2223 # don't add current module itself to consumer list
2224 if M != Module:
2225 if M in ConsumedByList[LibraryModule]:
2226 continue
2227 ConsumedByList[LibraryModule].append(M)
2228 #
2229 # Initialize the sorted output list to the empty set
2230 #
2231 SortedLibraryList = []
2232 #
2233 # Q <- Set of all nodes with no incoming edges
2234 #
2235 LibraryList = [] #LibraryInstance.values()
2236 Q = []
2237 for LibraryClassName in LibraryInstance:
2238 M = LibraryInstance[LibraryClassName]
2239 LibraryList.append(M)
2240 if ConsumedByList[M] == []:
2241 Q.append(M)
2242
2243 #
2244 # start the DAG algorithm
2245 #
2246 while True:
2247 EdgeRemoved = True
2248 while Q == [] and EdgeRemoved:
2249 EdgeRemoved = False
2250 # for each node Item with a Constructor
2251 for Item in LibraryList:
2252 if Item not in Constructor:
2253 continue
2254 # for each Node without a constructor with an edge e from Item to Node
2255 for Node in ConsumedByList[Item]:
2256 if Node in Constructor:
2257 continue
2258 # remove edge e from the graph if Node has no constructor
2259 ConsumedByList[Item].remove(Node)
2260 EdgeRemoved = True
2261 if ConsumedByList[Item] == []:
2262 # insert Item into Q
2263 Q.insert(0, Item)
2264 break
2265 if Q != []:
2266 break
2267 # DAG is done if there's no more incoming edge for all nodes
2268 if Q == []:
2269 break
2270
2271 # remove node from Q
2272 Node = Q.pop()
2273 # output Node
2274 SortedLibraryList.append(Node)
2275
2276 # for each node Item with an edge e from Node to Item do
2277 for Item in LibraryList:
2278 if Node not in ConsumedByList[Item]:
2279 continue
2280 # remove edge e from the graph
2281 ConsumedByList[Item].remove(Node)
2282
2283 if ConsumedByList[Item] != []:
2284 continue
2285 # insert Item into Q, if Item has no other incoming edges
2286 Q.insert(0, Item)
2287
2288 #
2289 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2290 #
2291 for Item in LibraryList:
2292 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:
2293 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])
2294 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),
2295 ExtraData=ErrorMessage, File=self.MetaFile)
2296 if Item not in SortedLibraryList:
2297 SortedLibraryList.append(Item)
2298
2299 #
2300 # Build the list of constructor and destructir names
2301 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2302 #
2303 SortedLibraryList.reverse()
2304 return SortedLibraryList
2305
2306
2307 ## Override PCD setting (type, value, ...)
2308 #
2309 # @param ToPcd The PCD to be overrided
2310 # @param FromPcd The PCD overrideing from
2311 #
2312 def _OverridePcd(self, ToPcd, FromPcd, Module=""):
2313 #
2314 # in case there's PCDs coming from FDF file, which have no type given.
2315 # at this point, ToPcd.Type has the type found from dependent
2316 # package
2317 #
2318 TokenCName = ToPcd.TokenCName
2319 for PcdItem in GlobalData.MixedPcd:
2320 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
2321 TokenCName = PcdItem[0]
2322 break
2323 if FromPcd != None:
2324 if GlobalData.BuildOptionPcd:
2325 for pcd in GlobalData.BuildOptionPcd:
2326 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):
2327 FromPcd.DefaultValue = pcd[2]
2328 break
2329 if ToPcd.Pending and FromPcd.Type not in [None, '']:
2330 ToPcd.Type = FromPcd.Type
2331 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\
2332 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):
2333 if ToPcd.Type.strip() == "DynamicEx":
2334 ToPcd.Type = FromPcd.Type
2335 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \
2336 and ToPcd.Type != FromPcd.Type:
2337 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",
2338 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2339 % (ToPcd.TokenSpaceGuidCName, TokenCName,
2340 ToPcd.Type, Module, FromPcd.Type),
2341 File=self.MetaFile)
2342
2343 if FromPcd.MaxDatumSize not in [None, '']:
2344 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2345 if FromPcd.DefaultValue not in [None, '']:
2346 ToPcd.DefaultValue = FromPcd.DefaultValue
2347 if FromPcd.TokenValue not in [None, '']:
2348 ToPcd.TokenValue = FromPcd.TokenValue
2349 if FromPcd.MaxDatumSize not in [None, '']:
2350 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize
2351 if FromPcd.DatumType not in [None, '']:
2352 ToPcd.DatumType = FromPcd.DatumType
2353 if FromPcd.SkuInfoList not in [None, '', []]:
2354 ToPcd.SkuInfoList = FromPcd.SkuInfoList
2355
2356 # check the validation of datum
2357 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)
2358 if not IsValid:
2359 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,
2360 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))
2361 ToPcd.validateranges = FromPcd.validateranges
2362 ToPcd.validlists = FromPcd.validlists
2363 ToPcd.expressions = FromPcd.expressions
2364
2365 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:
2366 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \
2367 % (ToPcd.TokenSpaceGuidCName, TokenCName))
2368 Value = ToPcd.DefaultValue
2369 if Value in [None, '']:
2370 ToPcd.MaxDatumSize = '1'
2371 elif Value[0] == 'L':
2372 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)
2373 elif Value[0] == '{':
2374 ToPcd.MaxDatumSize = str(len(Value.split(',')))
2375 else:
2376 ToPcd.MaxDatumSize = str(len(Value) - 1)
2377
2378 # apply default SKU for dynamic PCDS if specified one is not available
2379 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \
2380 and ToPcd.SkuInfoList in [None, {}, '']:
2381 if self.Platform.SkuName in self.Platform.SkuIds:
2382 SkuName = self.Platform.SkuName
2383 else:
2384 SkuName = 'DEFAULT'
2385 ToPcd.SkuInfoList = {
2386 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName], '', '', '', '', '', ToPcd.DefaultValue)
2387 }
2388
2389 ## Apply PCD setting defined platform to a module
2390 #
2391 # @param Module The module from which the PCD setting will be overrided
2392 #
2393 # @retval PCD_list The list PCDs with settings from platform
2394 #
2395 def ApplyPcdSetting(self, Module, Pcds):
2396 # for each PCD in module
2397 for Name, Guid in Pcds:
2398 PcdInModule = Pcds[Name, Guid]
2399 # find out the PCD setting in platform
2400 if (Name, Guid) in self.Platform.Pcds:
2401 PcdInPlatform = self.Platform.Pcds[Name, Guid]
2402 else:
2403 PcdInPlatform = None
2404 # then override the settings if any
2405 self._OverridePcd(PcdInModule, PcdInPlatform, Module)
2406 # resolve the VariableGuid value
2407 for SkuId in PcdInModule.SkuInfoList:
2408 Sku = PcdInModule.SkuInfoList[SkuId]
2409 if Sku.VariableGuid == '': continue
2410 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)
2411 if Sku.VariableGuidValue == None:
2412 PackageList = "\n\t".join([str(P) for P in self.PackageList])
2413 EdkLogger.error(
2414 'build',
2415 RESOURCE_NOT_AVAILABLE,
2416 "Value of GUID [%s] is not found in" % Sku.VariableGuid,
2417 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \
2418 % (Guid, Name, str(Module)),
2419 File=self.MetaFile
2420 )
2421
2422 # override PCD settings with module specific setting
2423 if Module in self.Platform.Modules:
2424 PlatformModule = self.Platform.Modules[str(Module)]
2425 for Key in PlatformModule.Pcds:
2426 Flag = False
2427 if Key in Pcds:
2428 ToPcd = Pcds[Key]
2429 Flag = True
2430 elif Key in GlobalData.MixedPcd:
2431 for PcdItem in GlobalData.MixedPcd[Key]:
2432 if PcdItem in Pcds:
2433 ToPcd = Pcds[PcdItem]
2434 Flag = True
2435 break
2436 if Flag:
2437 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)
2438 return Pcds.values()
2439
2440 ## Resolve library names to library modules
2441 #
2442 # (for Edk.x modules)
2443 #
2444 # @param Module The module from which the library names will be resolved
2445 #
2446 # @retval library_list The list of library modules
2447 #
2448 def ResolveLibraryReference(self, Module):
2449 EdkLogger.verbose("")
2450 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))
2451 LibraryConsumerList = [Module]
2452
2453 # "CompilerStub" is a must for Edk modules
2454 if Module.Libraries:
2455 Module.Libraries.append("CompilerStub")
2456 LibraryList = []
2457 while len(LibraryConsumerList) > 0:
2458 M = LibraryConsumerList.pop()
2459 for LibraryName in M.Libraries:
2460 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']
2461 if Library == None:
2462 for Key in self.Platform.LibraryClasses.data.keys():
2463 if LibraryName.upper() == Key.upper():
2464 Library = self.Platform.LibraryClasses[Key, ':dummy:']
2465 break
2466 if Library == None:
2467 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),
2468 ExtraData="\t%s [%s]" % (str(Module), self.Arch))
2469 continue
2470
2471 if Library not in LibraryList:
2472 LibraryList.append(Library)
2473 LibraryConsumerList.append(Library)
2474 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))
2475 return LibraryList
2476
2477 ## Calculate the priority value of the build option
2478 #
2479 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2480 #
2481 # @retval Value Priority value based on the priority list.
2482 #
2483 def CalculatePriorityValue(self, Key):
2484 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')
2485 PriorityValue = 0x11111
2486 if Target == "*":
2487 PriorityValue &= 0x01111
2488 if ToolChain == "*":
2489 PriorityValue &= 0x10111
2490 if Arch == "*":
2491 PriorityValue &= 0x11011
2492 if CommandType == "*":
2493 PriorityValue &= 0x11101
2494 if Attr == "*":
2495 PriorityValue &= 0x11110
2496
2497 return self.PrioList["0x%0.5x" % PriorityValue]
2498
2499
2500 ## Expand * in build option key
2501 #
2502 # @param Options Options to be expanded
2503 #
2504 # @retval options Options expanded
2505 #
2506 def _ExpandBuildOption(self, Options, ModuleStyle=None):
2507 BuildOptions = {}
2508 FamilyMatch = False
2509 FamilyIsNull = True
2510
2511 OverrideList = {}
2512 #
2513 # Construct a list contain the build options which need override.
2514 #
2515 for Key in Options:
2516 #
2517 # Key[0] -- tool family
2518 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2519 #
2520 if (Key[0] == self.BuildRuleFamily and
2521 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):
2522 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')
2523 if Target == self.BuildTarget or Target == "*":
2524 if ToolChain == self.ToolChain or ToolChain == "*":
2525 if Arch == self.Arch or Arch == "*":
2526 if Options[Key].startswith("="):
2527 if OverrideList.get(Key[1]) != None:
2528 OverrideList.pop(Key[1])
2529 OverrideList[Key[1]] = Options[Key]
2530
2531 #
2532 # Use the highest priority value.
2533 #
2534 if (len(OverrideList) >= 2):
2535 KeyList = OverrideList.keys()
2536 for Index in range(len(KeyList)):
2537 NowKey = KeyList[Index]
2538 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")
2539 for Index1 in range(len(KeyList) - Index - 1):
2540 NextKey = KeyList[Index1 + Index + 1]
2541 #
2542 # Compare two Key, if one is included by another, choose the higher priority one
2543 #
2544 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")
2545 if Target1 == Target2 or Target1 == "*" or Target2 == "*":
2546 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":
2547 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":
2548 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":
2549 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":
2550 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):
2551 if Options.get((self.BuildRuleFamily, NextKey)) != None:
2552 Options.pop((self.BuildRuleFamily, NextKey))
2553 else:
2554 if Options.get((self.BuildRuleFamily, NowKey)) != None:
2555 Options.pop((self.BuildRuleFamily, NowKey))
2556
2557 for Key in Options:
2558 if ModuleStyle != None and len (Key) > 2:
2559 # Check Module style is EDK or EDKII.
2560 # Only append build option for the matched style module.
2561 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2562 continue
2563 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2564 continue
2565 Family = Key[0]
2566 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2567 # if tool chain family doesn't match, skip it
2568 if Tool in self.ToolDefinition and Family != "":
2569 FamilyIsNull = False
2570 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":
2571 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:
2572 continue
2573 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2574 continue
2575 FamilyMatch = True
2576 # expand any wildcard
2577 if Target == "*" or Target == self.BuildTarget:
2578 if Tag == "*" or Tag == self.ToolChain:
2579 if Arch == "*" or Arch == self.Arch:
2580 if Tool not in BuildOptions:
2581 BuildOptions[Tool] = {}
2582 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2583 BuildOptions[Tool][Attr] = Options[Key]
2584 else:
2585 # append options for the same tool except PATH
2586 if Attr != 'PATH':
2587 BuildOptions[Tool][Attr] += " " + Options[Key]
2588 else:
2589 BuildOptions[Tool][Attr] = Options[Key]
2590 # Build Option Family has been checked, which need't to be checked again for family.
2591 if FamilyMatch or FamilyIsNull:
2592 return BuildOptions
2593
2594 for Key in Options:
2595 if ModuleStyle != None and len (Key) > 2:
2596 # Check Module style is EDK or EDKII.
2597 # Only append build option for the matched style module.
2598 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:
2599 continue
2600 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:
2601 continue
2602 Family = Key[0]
2603 Target, Tag, Arch, Tool, Attr = Key[1].split("_")
2604 # if tool chain family doesn't match, skip it
2605 if Tool not in self.ToolDefinition or Family == "":
2606 continue
2607 # option has been added before
2608 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:
2609 continue
2610
2611 # expand any wildcard
2612 if Target == "*" or Target == self.BuildTarget:
2613 if Tag == "*" or Tag == self.ToolChain:
2614 if Arch == "*" or Arch == self.Arch:
2615 if Tool not in BuildOptions:
2616 BuildOptions[Tool] = {}
2617 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):
2618 BuildOptions[Tool][Attr] = Options[Key]
2619 else:
2620 # append options for the same tool except PATH
2621 if Attr != 'PATH':
2622 BuildOptions[Tool][Attr] += " " + Options[Key]
2623 else:
2624 BuildOptions[Tool][Attr] = Options[Key]
2625 return BuildOptions
2626
2627 ## Append build options in platform to a module
2628 #
2629 # @param Module The module to which the build options will be appened
2630 #
2631 # @retval options The options appended with build options in platform
2632 #
2633 def ApplyBuildOption(self, Module):
2634 # Get the different options for the different style module
2635 if Module.AutoGenVersion < 0x00010005:
2636 PlatformOptions = self.EdkBuildOption
2637 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)
2638 else:
2639 PlatformOptions = self.EdkIIBuildOption
2640 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)
2641 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)
2642 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)
2643 if Module in self.Platform.Modules:
2644 PlatformModule = self.Platform.Modules[str(Module)]
2645 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)
2646 else:
2647 PlatformModuleOptions = {}
2648
2649 BuildRuleOrder = None
2650 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2651 for Tool in Options:
2652 for Attr in Options[Tool]:
2653 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2654 BuildRuleOrder = Options[Tool][Attr]
2655
2656 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +
2657 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +
2658 self.ToolDefinition.keys())
2659 BuildOptions = {}
2660 for Tool in AllTools:
2661 if Tool not in BuildOptions:
2662 BuildOptions[Tool] = {}
2663
2664 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:
2665 if Tool not in Options:
2666 continue
2667 for Attr in Options[Tool]:
2668 Value = Options[Tool][Attr]
2669 #
2670 # Do not generate it in Makefile
2671 #
2672 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:
2673 continue
2674 if Attr not in BuildOptions[Tool]:
2675 BuildOptions[Tool][Attr] = ""
2676 # check if override is indicated
2677 if Value.startswith('='):
2678 ToolPath = Value[1:]
2679 ToolPath = mws.handleWsMacro(ToolPath)
2680 BuildOptions[Tool][Attr] = ToolPath
2681 else:
2682 Value = mws.handleWsMacro(Value)
2683 if Attr != 'PATH':
2684 BuildOptions[Tool][Attr] += " " + Value
2685 else:
2686 BuildOptions[Tool][Attr] = Value
2687 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:
2688 #
2689 # Override UNI flag only for EDK module.
2690 #
2691 if 'BUILD' not in BuildOptions:
2692 BuildOptions['BUILD'] = {}
2693 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag
2694 return BuildOptions, BuildRuleOrder
2695
2696 Platform = property(_GetPlatform)
2697 Name = property(_GetName)
2698 Guid = property(_GetGuid)
2699 Version = property(_GetVersion)
2700
2701 OutputDir = property(_GetOutputDir)
2702 BuildDir = property(_GetBuildDir)
2703 MakeFileDir = property(_GetMakeFileDir)
2704 FdfFile = property(_GetFdfFile)
2705
2706 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2707 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2708 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2709 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)
2710 PackageList = property(_GetPackageList)
2711
2712 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path
2713 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path
2714 ToolChainFamily = property(_GetToolChainFamily)
2715 BuildRuleFamily = property(_GetBuildRuleFamily)
2716 BuildOption = property(_GetBuildOptions) # toolcode : option
2717 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option
2718 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option
2719
2720 BuildCommand = property(_GetBuildCommand)
2721 BuildRule = property(_GetBuildRule)
2722 ModuleAutoGenList = property(_GetModuleAutoGenList)
2723 LibraryAutoGenList = property(_GetLibraryAutoGenList)
2724 GenFdsCommand = property(_GenFdsCommand)
2725
2726 ## ModuleAutoGen class
2727 #
2728 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2729 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2730 # to the [depex] section in module's inf file.
2731 #
2732 class ModuleAutoGen(AutoGen):
2733 ## Cache the timestamps of metafiles of every module in a class variable
2734 #
2735 TimeDict = {}
2736
2737 ## The real constructor of ModuleAutoGen
2738 #
2739 # This method is not supposed to be called by users of ModuleAutoGen. It's
2740 # only used by factory method __new__() to do real initialization work for an
2741 # object of ModuleAutoGen
2742 #
2743 # @param Workspace EdkIIWorkspaceBuild object
2744 # @param ModuleFile The path of module file
2745 # @param Target Build target (DEBUG, RELEASE)
2746 # @param Toolchain Name of tool chain
2747 # @param Arch The arch the module supports
2748 # @param PlatformFile Platform meta-file
2749 #
2750 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):
2751 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))
2752 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)
2753
2754 self.Workspace = Workspace
2755 self.WorkspaceDir = Workspace.WorkspaceDir
2756
2757 self.MetaFile = ModuleFile
2758 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)
2759 # check if this module is employed by active platform
2760 if not self.PlatformInfo.ValidModule(self.MetaFile):
2761 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2762 % (self.MetaFile, Arch))
2763 return False
2764
2765 self.SourceDir = self.MetaFile.SubDir
2766 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)
2767
2768 self.SourceOverrideDir = None
2769 # use overrided path defined in DSC file
2770 if self.MetaFile.Key in GlobalData.gOverrideDir:
2771 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]
2772
2773 self.ToolChain = Toolchain
2774 self.BuildTarget = Target
2775 self.Arch = Arch
2776 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily
2777 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily
2778
2779 self.IsMakeFileCreated = False
2780 self.IsCodeFileCreated = False
2781 self.IsAsBuiltInfCreated = False
2782 self.DepexGenerated = False
2783
2784 self.BuildDatabase = self.Workspace.BuildDatabase
2785 self.BuildRuleOrder = None
2786 self.BuildTime = 0
2787
2788 self._Module = None
2789 self._Name = None
2790 self._Guid = None
2791 self._Version = None
2792 self._ModuleType = None
2793 self._ComponentType = None
2794 self._PcdIsDriver = None
2795 self._AutoGenVersion = None
2796 self._LibraryFlag = None
2797 self._CustomMakefile = None
2798 self._Macro = None
2799
2800 self._BuildDir = None
2801 self._OutputDir = None
2802 self._FfsOutputDir = None
2803 self._DebugDir = None
2804 self._MakeFileDir = None
2805
2806 self._IncludePathList = None
2807 self._IncludePathLength = 0
2808 self._AutoGenFileList = None
2809 self._UnicodeFileList = None
2810 self._VfrFileList = None
2811 self._IdfFileList = None
2812 self._SourceFileList = None
2813 self._ObjectFileList = None
2814 self._BinaryFileList = None
2815
2816 self._DependentPackageList = None
2817 self._DependentLibraryList = None
2818 self._LibraryAutoGenList = None
2819 self._DerivedPackageList = None
2820 self._ModulePcdList = None
2821 self._LibraryPcdList = None
2822 self._PcdComments = sdict()
2823 self._GuidList = None
2824 self._GuidsUsedByPcd = None
2825 self._GuidComments = sdict()
2826 self._ProtocolList = None
2827 self._ProtocolComments = sdict()
2828 self._PpiList = None
2829 self._PpiComments = sdict()
2830 self._DepexList = None
2831 self._DepexExpressionList = None
2832 self._BuildOption = None
2833 self._BuildOptionIncPathList = None
2834 self._BuildTargets = None
2835 self._IntroBuildTargetList = None
2836 self._FinalBuildTargetList = None
2837 self._FileTypes = None
2838 self._BuildRules = None
2839
2840 self._TimeStampPath = None
2841
2842 self.AutoGenDepSet = set()
2843
2844
2845 ## The Modules referenced to this Library
2846 # Only Library has this attribute
2847 self._ReferenceModules = []
2848
2849 ## Store the FixedAtBuild Pcds
2850 #
2851 self._FixedAtBuildPcds = []
2852 self.ConstPcd = {}
2853 return True
2854
2855 def __repr__(self):
2856 return "%s [%s]" % (self.MetaFile, self.Arch)
2857
2858 # Get FixedAtBuild Pcds of this Module
2859 def _GetFixedAtBuildPcds(self):
2860 if self._FixedAtBuildPcds:
2861 return self._FixedAtBuildPcds
2862 for Pcd in self.ModulePcdList:
2863 if Pcd.Type != "FixedAtBuild":
2864 continue
2865 if Pcd not in self._FixedAtBuildPcds:
2866 self._FixedAtBuildPcds.append(Pcd)
2867
2868 return self._FixedAtBuildPcds
2869
2870 def _GetUniqueBaseName(self):
2871 BaseName = self.Name
2872 for Module in self.PlatformInfo.ModuleAutoGenList:
2873 if Module.MetaFile == self.MetaFile:
2874 continue
2875 if Module.Name == self.Name:
2876 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):
2877 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'
2878 ' %s\n %s' % (Module.MetaFile, self.MetaFile))
2879 BaseName = '%s_%s' % (self.Name, self.Guid)
2880 return BaseName
2881
2882 # Macros could be used in build_rule.txt (also Makefile)
2883 def _GetMacros(self):
2884 if self._Macro == None:
2885 self._Macro = sdict()
2886 self._Macro["WORKSPACE" ] = self.WorkspaceDir
2887 self._Macro["MODULE_NAME" ] = self.Name
2888 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()
2889 self._Macro["MODULE_GUID" ] = self.Guid
2890 self._Macro["MODULE_VERSION" ] = self.Version
2891 self._Macro["MODULE_TYPE" ] = self.ModuleType
2892 self._Macro["MODULE_FILE" ] = str(self.MetaFile)
2893 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName
2894 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir
2895 self._Macro["MODULE_DIR" ] = self.SourceDir
2896
2897 self._Macro["BASE_NAME" ] = self.Name
2898
2899 self._Macro["ARCH" ] = self.Arch
2900 self._Macro["TOOLCHAIN" ] = self.ToolChain
2901 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain
2902 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain
2903 self._Macro["TARGET" ] = self.BuildTarget
2904
2905 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir
2906 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2907 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)
2908 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir
2909 self._Macro["OUTPUT_DIR" ] = self.OutputDir
2910 self._Macro["DEBUG_DIR" ] = self.DebugDir
2911 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir
2912 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir
2913 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name
2914 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid
2915 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version
2916 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir
2917 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)
2918 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir
2919 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir
2920 return self._Macro
2921
2922 ## Return the module build data object
2923 def _GetModule(self):
2924 if self._Module == None:
2925 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]
2926 return self._Module
2927
2928 ## Return the module name
2929 def _GetBaseName(self):
2930 return self.Module.BaseName
2931
2932 ## Return the module DxsFile if exist
2933 def _GetDxsFile(self):
2934 return self.Module.DxsFile
2935
2936 ## Return the module SourceOverridePath
2937 def _GetSourceOverridePath(self):
2938 return self.Module.SourceOverridePath
2939
2940 ## Return the module meta-file GUID
2941 def _GetGuid(self):
2942 #
2943 # To build same module more than once, the module path with FILE_GUID overridden has
2944 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2945 # in DSC. The overridden GUID can be retrieved from file name
2946 #
2947 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):
2948 #
2949 # Length of GUID is 36
2950 #
2951 return os.path.basename(self.MetaFile.Path)[:36]
2952 return self.Module.Guid
2953
2954 ## Return the module version
2955 def _GetVersion(self):
2956 return self.Module.Version
2957
2958 ## Return the module type
2959 def _GetModuleType(self):
2960 return self.Module.ModuleType
2961
2962 ## Return the component type (for Edk.x style of module)
2963 def _GetComponentType(self):
2964 return self.Module.ComponentType
2965
2966 ## Return the build type
2967 def _GetBuildType(self):
2968 return self.Module.BuildType
2969
2970 ## Return the PCD_IS_DRIVER setting
2971 def _GetPcdIsDriver(self):
2972 return self.Module.PcdIsDriver
2973
2974 ## Return the autogen version, i.e. module meta-file version
2975 def _GetAutoGenVersion(self):
2976 return self.Module.AutoGenVersion
2977
2978 ## Check if the module is library or not
2979 def _IsLibrary(self):
2980 if self._LibraryFlag == None:
2981 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:
2982 self._LibraryFlag = True
2983 else:
2984 self._LibraryFlag = False
2985 return self._LibraryFlag
2986
2987 ## Check if the module is binary module or not
2988 def _IsBinaryModule(self):
2989 return self.Module.IsBinaryModule
2990
2991 ## Return the directory to store intermediate files of the module
2992 def _GetBuildDir(self):
2993 if self._BuildDir == None:
2994 self._BuildDir = path.join(
2995 self.PlatformInfo.BuildDir,
2996 self.Arch,
2997 self.SourceDir,
2998 self.MetaFile.BaseName
2999 )
3000 CreateDirectory(self._BuildDir)
3001 return self._BuildDir
3002
3003 ## Return the directory to store the intermediate object files of the mdoule
3004 def _GetOutputDir(self):
3005 if self._OutputDir == None:
3006 self._OutputDir = path.join(self.BuildDir, "OUTPUT")
3007 CreateDirectory(self._OutputDir)
3008 return self._OutputDir
3009
3010 ## Return the directory to store ffs file
3011 def _GetFfsOutputDir(self):
3012 if self._FfsOutputDir == None:
3013 if GlobalData.gFdfParser != None:
3014 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)
3015 else:
3016 self._FfsOutputDir = ''
3017 return self._FfsOutputDir
3018
3019 ## Return the directory to store auto-gened source files of the mdoule
3020 def _GetDebugDir(self):
3021 if self._DebugDir == None:
3022 self._DebugDir = path.join(self.BuildDir, "DEBUG")
3023 CreateDirectory(self._DebugDir)
3024 return self._DebugDir
3025
3026 ## Return the path of custom file
3027 def _GetCustomMakefile(self):
3028 if self._CustomMakefile == None:
3029 self._CustomMakefile = {}
3030 for Type in self.Module.CustomMakefile:
3031 if Type in gMakeTypeMap:
3032 MakeType = gMakeTypeMap[Type]
3033 else:
3034 MakeType = 'nmake'
3035 if self.SourceOverrideDir != None:
3036 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])
3037 if not os.path.exists(File):
3038 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3039 else:
3040 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])
3041 self._CustomMakefile[MakeType] = File
3042 return self._CustomMakefile
3043
3044 ## Return the directory of the makefile
3045 #
3046 # @retval string The directory string of module's makefile
3047 #
3048 def _GetMakeFileDir(self):
3049 return self.BuildDir
3050
3051 ## Return build command string
3052 #
3053 # @retval string Build command string
3054 #
3055 def _GetBuildCommand(self):
3056 return self.PlatformInfo.BuildCommand
3057
3058 ## Get object list of all packages the module and its dependent libraries belong to
3059 #
3060 # @retval list The list of package object
3061 #
3062 def _GetDerivedPackageList(self):
3063 PackageList = []
3064 for M in [self.Module] + self.DependentLibraryList:
3065 for Package in M.Packages:
3066 if Package in PackageList:
3067 continue
3068 PackageList.append(Package)
3069 return PackageList
3070
3071 ## Get the depex string
3072 #
3073 # @return : a string contain all depex expresion.
3074 def _GetDepexExpresionString(self):
3075 DepexStr = ''
3076 DepexList = []
3077 ## DPX_SOURCE IN Define section.
3078 if self.Module.DxsFile:
3079 return DepexStr
3080 for M in [self.Module] + self.DependentLibraryList:
3081 Filename = M.MetaFile.Path
3082 InfObj = InfSectionParser.InfSectionParser(Filename)
3083 DepexExpresionList = InfObj.GetDepexExpresionList()
3084 for DepexExpresion in DepexExpresionList:
3085 for key in DepexExpresion.keys():
3086 Arch, ModuleType = key
3087 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]
3088 # the type of build module is USER_DEFINED.
3089 # All different DEPEX section tags would be copied into the As Built INF file
3090 # and there would be separate DEPEX section tags
3091 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3092 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):
3093 DepexList.append({(Arch, ModuleType): DepexExpr})
3094 else:
3095 if Arch.upper() == TAB_ARCH_COMMON or \
3096 (Arch.upper() == self.Arch.upper() and \
3097 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):
3098 DepexList.append({(Arch, ModuleType): DepexExpr})
3099
3100 #the type of build module is USER_DEFINED.
3101 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:
3102 for Depex in DepexList:
3103 for key in Depex.keys():
3104 DepexStr += '[Depex.%s.%s]\n' % key
3105 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])
3106 DepexStr += '\n\n'
3107 if not DepexStr:
3108 return '[Depex.%s]\n' % self.Arch
3109 return DepexStr
3110
3111 #the type of build module not is USER_DEFINED.
3112 Count = 0
3113 for Depex in DepexList:
3114 Count += 1
3115 if DepexStr != '':
3116 DepexStr += ' AND '
3117 DepexStr += '('
3118 for D in Depex.values():
3119 DepexStr += ' '.join([val for val in D])
3120 Index = DepexStr.find('END')
3121 if Index > -1 and Index == len(DepexStr) - 3:
3122 DepexStr = DepexStr[:-3]
3123 DepexStr = DepexStr.strip()
3124 DepexStr += ')'
3125 if Count == 1:
3126 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()
3127 if not DepexStr:
3128 return '[Depex.%s]\n' % self.Arch
3129 return '[Depex.%s]\n# ' % self.Arch + DepexStr
3130
3131 ## Merge dependency expression
3132 #
3133 # @retval list The token list of the dependency expression after parsed
3134 #
3135 def _GetDepexTokenList(self):
3136 if self._DepexList == None:
3137 self._DepexList = {}
3138 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3139 return self._DepexList
3140
3141 self._DepexList[self.ModuleType] = []
3142
3143 for ModuleType in self._DepexList:
3144 DepexList = self._DepexList[ModuleType]
3145 #
3146 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3147 #
3148 for M in [self.Module] + self.DependentLibraryList:
3149 Inherited = False
3150 for D in M.Depex[self.Arch, ModuleType]:
3151 if DepexList != []:
3152 DepexList.append('AND')
3153 DepexList.append('(')
3154 DepexList.extend(D)
3155 if DepexList[-1] == 'END': # no need of a END at this time
3156 DepexList.pop()
3157 DepexList.append(')')
3158 Inherited = True
3159 if Inherited:
3160 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))
3161 if 'BEFORE' in DepexList or 'AFTER' in DepexList:
3162 break
3163 if len(DepexList) > 0:
3164 EdkLogger.verbose('')
3165 return self._DepexList
3166
3167 ## Merge dependency expression
3168 #
3169 # @retval list The token list of the dependency expression after parsed
3170 #
3171 def _GetDepexExpressionTokenList(self):
3172 if self._DepexExpressionList == None:
3173 self._DepexExpressionList = {}
3174 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:
3175 return self._DepexExpressionList
3176
3177 self._DepexExpressionList[self.ModuleType] = ''
3178
3179 for ModuleType in self._DepexExpressionList:
3180 DepexExpressionList = self._DepexExpressionList[ModuleType]
3181 #
3182 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3183 #
3184 for M in [self.Module] + self.DependentLibraryList:
3185 Inherited = False
3186 for D in M.DepexExpression[self.Arch, ModuleType]:
3187 if DepexExpressionList != '':
3188 DepexExpressionList += ' AND '
3189 DepexExpressionList += '('
3190 DepexExpressionList += D
3191 DepexExpressionList = DepexExpressionList.rstrip('END').strip()
3192 DepexExpressionList += ')'
3193 Inherited = True
3194 if Inherited:
3195 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))
3196 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:
3197 break
3198 if len(DepexExpressionList) > 0:
3199 EdkLogger.verbose('')
3200 self._DepexExpressionList[ModuleType] = DepexExpressionList
3201 return self._DepexExpressionList
3202
3203 # Get the tiano core user extension, it is contain dependent library.
3204 # @retval: a list contain tiano core userextension.
3205 #
3206 def _GetTianoCoreUserExtensionList(self):
3207 TianoCoreUserExtentionList = []
3208 for M in [self.Module] + self.DependentLibraryList:
3209 Filename = M.MetaFile.Path
3210 InfObj = InfSectionParser.InfSectionParser(Filename)
3211 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()
3212 for TianoCoreUserExtent in TianoCoreUserExtenList:
3213 for Section in TianoCoreUserExtent.keys():
3214 ItemList = Section.split(TAB_SPLIT)
3215 Arch = self.Arch
3216 if len(ItemList) == 4:
3217 Arch = ItemList[3]
3218 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():
3219 TianoCoreList = []
3220 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])
3221 TianoCoreList.extend(TianoCoreUserExtent[Section][:])
3222 TianoCoreList.append('\n')
3223 TianoCoreUserExtentionList.append(TianoCoreList)
3224
3225 return TianoCoreUserExtentionList
3226
3227 ## Return the list of specification version required for the module
3228 #
3229 # @retval list The list of specification defined in module file
3230 #
3231 def _GetSpecification(self):
3232 return self.Module.Specification
3233
3234 ## Tool option for the module build
3235 #
3236 # @param PlatformInfo The object of PlatformBuildInfo
3237 # @retval dict The dict containing valid options
3238 #
3239 def _GetModuleBuildOption(self):
3240 if self._BuildOption == None:
3241 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)
3242 if self.BuildRuleOrder:
3243 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]
3244 return self._BuildOption
3245
3246 ## Get include path list from tool option for the module build
3247 #
3248 # @retval list The include path list
3249 #
3250 def _GetBuildOptionIncPathList(self):
3251 if self._BuildOptionIncPathList == None:
3252 #
3253 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3254 # is the former use /I , the Latter used -I to specify include directories
3255 #
3256 if self.PlatformInfo.ToolChainFamily in ('MSFT'):
3257 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3258 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):
3259 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)
3260 else:
3261 #
3262 # New ToolChainFamily, don't known whether there is option to specify include directories
3263 #
3264 self._BuildOptionIncPathList = []
3265 return self._BuildOptionIncPathList
3266
3267 BuildOptionIncPathList = []
3268 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3269 Attr = 'FLAGS'
3270 try:
3271 FlagOption = self.BuildOption[Tool][Attr]
3272 except KeyError:
3273 FlagOption = ''
3274
3275 if self.PlatformInfo.ToolChainFamily != 'RVCT':
3276 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]
3277 else:
3278 #
3279 # RVCT may specify a list of directory seperated by commas
3280 #
3281 IncPathList = []
3282 for Path in gBuildOptIncludePattern.findall(FlagOption):
3283 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)
3284 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]
3285
3286 #
3287 # EDK II modules must not reference header files outside of the packages they depend on or
3288 # within the module's directory tree. Report error if violation.
3289 #
3290 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:
3291 for Path in IncPathList:
3292 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):
3293 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)
3294 EdkLogger.error("build",
3295 PARAMETER_INVALID,
3296 ExtraData=ErrMsg,
3297 File=str(self.MetaFile))
3298
3299
3300 BuildOptionIncPathList += IncPathList
3301
3302 self._BuildOptionIncPathList = BuildOptionIncPathList
3303
3304 return self._BuildOptionIncPathList
3305
3306 ## Return a list of files which can be built from source
3307 #
3308 # What kind of files can be built is determined by build rules in
3309 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3310 #
3311 def _GetSourceFileList(self):
3312 if self._SourceFileList == None:
3313 self._SourceFileList = []
3314 for F in self.Module.Sources:
3315 # match tool chain
3316 if F.TagName not in ("", "*", self.ToolChain):
3317 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "
3318 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))
3319 continue
3320 # match tool chain family or build rule family
3321 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):
3322 EdkLogger.debug(
3323 EdkLogger.DEBUG_0,
3324 "The file [%s] must be built by tools of [%s], " \
3325 "but current toolchain family is [%s], buildrule family is [%s]" \
3326 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))
3327 continue
3328
3329 # add the file path into search path list for file including
3330 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:
3331 self.IncludePathList.insert(0, F.Dir)
3332 self._SourceFileList.append(F)
3333
3334 self._MatchBuildRuleOrder(self._SourceFileList)
3335
3336 for F in self._SourceFileList:
3337 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)
3338 return self._SourceFileList
3339
3340 def _MatchBuildRuleOrder(self, FileList):
3341 Order_Dict = {}
3342 self._GetModuleBuildOption()
3343 for SingleFile in FileList:
3344 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:
3345 key = SingleFile.Path.split(SingleFile.Ext)[0]
3346 if key in Order_Dict:
3347 Order_Dict[key].append(SingleFile.Ext)
3348 else:
3349 Order_Dict[key] = [SingleFile.Ext]
3350
3351 RemoveList = []
3352 for F in Order_Dict:
3353 if len(Order_Dict[F]) > 1:
3354 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))
3355 for Ext in Order_Dict[F][1:]:
3356 RemoveList.append(F + Ext)
3357
3358 for item in RemoveList:
3359 FileList.remove(item)
3360
3361 return FileList
3362
3363 ## Return the list of unicode files
3364 def _GetUnicodeFileList(self):
3365 if self._UnicodeFileList == None:
3366 if TAB_UNICODE_FILE in self.FileTypes:
3367 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]
3368 else:
3369 self._UnicodeFileList = []
3370 return self._UnicodeFileList
3371
3372 ## Return the list of vfr files
3373 def _GetVfrFileList(self):
3374 if self._VfrFileList == None:
3375 if TAB_VFR_FILE in self.FileTypes:
3376 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]
3377 else:
3378 self._VfrFileList = []
3379 return self._VfrFileList
3380
3381 ## Return the list of Image Definition files
3382 def _GetIdfFileList(self):
3383 if self._IdfFileList == None:
3384 if TAB_IMAGE_FILE in self.FileTypes:
3385 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]
3386 else:
3387 self._IdfFileList = []
3388 return self._IdfFileList
3389
3390 ## Return a list of files which can be built from binary
3391 #
3392 # "Build" binary files are just to copy them to build directory.
3393 #
3394 # @retval list The list of files which can be built later
3395 #
3396 def _GetBinaryFiles(self):
3397 if self._BinaryFileList == None:
3398 self._BinaryFileList = []
3399 for F in self.Module.Binaries:
3400 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:
3401 continue
3402 self._BinaryFileList.append(F)
3403 self._ApplyBuildRule(F, F.Type)
3404 return self._BinaryFileList
3405
3406 def _GetBuildRules(self):
3407 if self._BuildRules == None:
3408 BuildRules = {}
3409 BuildRuleDatabase = self.PlatformInfo.BuildRule
3410 for Type in BuildRuleDatabase.FileTypeList:
3411 #first try getting build rule by BuildRuleFamily
3412 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]
3413 if not RuleObject:
3414 # build type is always module type, but ...
3415 if self.ModuleType != self.BuildType:
3416 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]
3417 #second try getting build rule by ToolChainFamily
3418 if not RuleObject:
3419 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]
3420 if not RuleObject:
3421 # build type is always module type, but ...
3422 if self.ModuleType != self.BuildType:
3423 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]
3424 if not RuleObject:
3425 continue
3426 RuleObject = RuleObject.Instantiate(self.Macros)
3427 BuildRules[Type] = RuleObject
3428 for Ext in RuleObject.SourceFileExtList:
3429 BuildRules[Ext] = RuleObject
3430 self._BuildRules = BuildRules
3431 return self._BuildRules
3432
3433 def _ApplyBuildRule(self, File, FileType):
3434 if self._BuildTargets == None:
3435 self._IntroBuildTargetList = set()
3436 self._FinalBuildTargetList = set()
3437 self._BuildTargets = {}
3438 self._FileTypes = {}
3439
3440 SubDirectory = os.path.join(self.OutputDir, File.SubDir)
3441 if not os.path.exists(SubDirectory):
3442 CreateDirectory(SubDirectory)
3443 LastTarget = None
3444 RuleChain = []
3445 SourceList = [File]
3446 Index = 0
3447 #
3448 # Make sure to get build rule order value
3449 #
3450 self._GetModuleBuildOption()
3451
3452 while Index < len(SourceList):
3453 Source = SourceList[Index]
3454 Index = Index + 1
3455
3456 if Source != File:
3457 CreateDirectory(Source.Dir)
3458
3459 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:
3460 # Skip all files that are not binary libraries
3461 if not self.IsLibrary:
3462 continue
3463 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]
3464 elif FileType in self.BuildRules:
3465 RuleObject = self.BuildRules[FileType]
3466 elif Source.Ext in self.BuildRules:
3467 RuleObject = self.BuildRules[Source.Ext]
3468 else:
3469 # stop at no more rules
3470 if LastTarget:
3471 self._FinalBuildTargetList.add(LastTarget)
3472 break
3473
3474 FileType = RuleObject.SourceFileType
3475 if FileType not in self._FileTypes:
3476 self._FileTypes[FileType] = set()
3477 self._FileTypes[FileType].add(Source)
3478
3479 # stop at STATIC_LIBRARY for library
3480 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:
3481 if LastTarget:
3482 self._FinalBuildTargetList.add(LastTarget)
3483 break
3484
3485 Target = RuleObject.Apply(Source, self.BuildRuleOrder)
3486 if not Target:
3487 if LastTarget:
3488 self._FinalBuildTargetList.add(LastTarget)
3489 break
3490 elif not Target.Outputs:
3491 # Only do build for target with outputs
3492 self._FinalBuildTargetList.add(Target)
3493
3494 if FileType not in self._BuildTargets:
3495 self._BuildTargets[FileType] = set()
3496 self._BuildTargets[FileType].add(Target)
3497
3498 if not Source.IsBinary and Source == File:
3499 self._IntroBuildTargetList.add(Target)
3500
3501 # to avoid cyclic rule
3502 if FileType in RuleChain:
3503 break
3504
3505 RuleChain.append(FileType)
3506 SourceList.extend(Target.Outputs)
3507 LastTarget = Target
3508 FileType = TAB_UNKNOWN_FILE
3509
3510 def _GetTargets(self):
3511 if self._BuildTargets == None:
3512 self._IntroBuildTargetList = set()
3513 self._FinalBuildTargetList = set()
3514 self._BuildTargets = {}
3515 self._FileTypes = {}
3516
3517 #TRICK: call _GetSourceFileList to apply build rule for source files
3518 if self.SourceFileList:
3519 pass
3520
3521 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3522 if self.BinaryFileList:
3523 pass
3524
3525 return self._BuildTargets
3526
3527 def _GetIntroTargetList(self):
3528 self._GetTargets()
3529 return self._IntroBuildTargetList
3530
3531 def _GetFinalTargetList(self):
3532 self._GetTargets()
3533 return self._FinalBuildTargetList
3534
3535 def _GetFileTypes(self):
3536 self._GetTargets()
3537 return self._FileTypes
3538
3539 ## Get the list of package object the module depends on
3540 #
3541 # @retval list The package object list
3542 #
3543 def _GetDependentPackageList(self):
3544 return self.Module.Packages
3545
3546 ## Return the list of auto-generated code file
3547 #
3548 # @retval list The list of auto-generated file
3549 #
3550 def _GetAutoGenFileList(self):
3551 UniStringAutoGenC = True
3552 IdfStringAutoGenC = True
3553 UniStringBinBuffer = StringIO()
3554 IdfGenBinBuffer = StringIO()
3555 if self.BuildType == 'UEFI_HII':
3556 UniStringAutoGenC = False
3557 IdfStringAutoGenC = False
3558 if self._AutoGenFileList == None:
3559 self._AutoGenFileList = {}
3560 AutoGenC = TemplateString()
3561 AutoGenH = TemplateString()
3562 StringH = TemplateString()
3563 StringIdf = TemplateString()
3564 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)
3565 #
3566 # AutoGen.c is generated if there are library classes in inf, or there are object files
3567 #
3568 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0
3569 or TAB_OBJECT_FILE in self.FileTypes):
3570 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)
3571 self._AutoGenFileList[AutoFile] = str(AutoGenC)
3572 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3573 if str(AutoGenH) != "":
3574 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)
3575 self._AutoGenFileList[AutoFile] = str(AutoGenH)
3576 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3577 if str(StringH) != "":
3578 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)
3579 self._AutoGenFileList[AutoFile] = str(StringH)
3580 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3581 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":
3582 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)
3583 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()
3584 AutoFile.IsBinary = True
3585 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3586 if UniStringBinBuffer != None:
3587 UniStringBinBuffer.close()
3588 if str(StringIdf) != "":
3589 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)
3590 self._AutoGenFileList[AutoFile] = str(StringIdf)
3591 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3592 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":
3593 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)
3594 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()
3595 AutoFile.IsBinary = True
3596 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)
3597 if IdfGenBinBuffer != None:
3598 IdfGenBinBuffer.close()
3599 return self._AutoGenFileList
3600
3601 ## Return the list of library modules explicitly or implicityly used by this module
3602 def _GetLibraryList(self):
3603 if self._DependentLibraryList == None:
3604 # only merge library classes and PCD for non-library module
3605 if self.IsLibrary:
3606 self._DependentLibraryList = []
3607 else:
3608 if self.AutoGenVersion < 0x00010005:
3609 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)
3610 else:
3611 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)
3612 return self._DependentLibraryList
3613
3614 @staticmethod
3615 def UpdateComments(Recver, Src):
3616 for Key in Src:
3617 if Key not in Recver:
3618 Recver[Key] = []
3619 Recver[Key].extend(Src[Key])
3620 ## Get the list of PCDs from current module
3621 #
3622 # @retval list The list of PCD
3623 #
3624 def _GetModulePcdList(self):
3625 if self._ModulePcdList == None:
3626 # apply PCD settings from platform
3627 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)
3628 self.UpdateComments(self._PcdComments, self.Module.PcdComments)
3629 return self._ModulePcdList
3630
3631 ## Get the list of PCDs from dependent libraries
3632 #
3633 # @retval list The list of PCD
3634 #
3635 def _GetLibraryPcdList(self):
3636 if self._LibraryPcdList == None:
3637 Pcds = sdict()
3638 if not self.IsLibrary:
3639 # get PCDs from dependent libraries
3640 for Library in self.DependentLibraryList:
3641 self.UpdateComments(self._PcdComments, Library.PcdComments)
3642 for Key in Library.Pcds:
3643 # skip duplicated PCDs
3644 if Key in self.Module.Pcds or Key in Pcds:
3645 continue
3646 Pcds[Key] = copy.copy(Library.Pcds[Key])
3647 # apply PCD settings from platform
3648 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)
3649 else:
3650 self._LibraryPcdList = []
3651 return self._LibraryPcdList
3652
3653 ## Get the GUID value mapping
3654 #
3655 # @retval dict The mapping between GUID cname and its value
3656 #
3657 def _GetGuidList(self):
3658 if self._GuidList == None:
3659 self._GuidList = sdict()
3660 self._GuidList.update(self.Module.Guids)
3661 for Library in self.DependentLibraryList:
3662 self._GuidList.update(Library.Guids)
3663 self.UpdateComments(self._GuidComments, Library.GuidComments)
3664 self.UpdateComments(self._GuidComments, self.Module.GuidComments)
3665 return self._GuidList
3666
3667 def GetGuidsUsedByPcd(self):
3668 if self._GuidsUsedByPcd == None:
3669 self._GuidsUsedByPcd = sdict()
3670 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())
3671 for Library in self.DependentLibraryList:
3672 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())
3673 return self._GuidsUsedByPcd
3674 ## Get the protocol value mapping
3675 #
3676 # @retval dict The mapping between protocol cname and its value
3677 #
3678 def _GetProtocolList(self):
3679 if self._ProtocolList == None:
3680 self._ProtocolList = sdict()
3681 self._ProtocolList.update(self.Module.Protocols)
3682 for Library in self.DependentLibraryList:
3683 self._ProtocolList.update(Library.Protocols)
3684 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)
3685 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)
3686 return self._ProtocolList
3687
3688 ## Get the PPI value mapping
3689 #
3690 # @retval dict The mapping between PPI cname and its value
3691 #
3692 def _GetPpiList(self):
3693 if self._PpiList == None:
3694 self._PpiList = sdict()
3695 self._PpiList.update(self.Module.Ppis)
3696 for Library in self.DependentLibraryList:
3697 self._PpiList.update(Library.Ppis)
3698 self.UpdateComments(self._PpiComments, Library.PpiComments)
3699 self.UpdateComments(self._PpiComments, self.Module.PpiComments)
3700 return self._PpiList
3701
3702 ## Get the list of include search path
3703 #
3704 # @retval list The list path
3705 #
3706 def _GetIncludePathList(self):
3707 if self._IncludePathList == None:
3708 self._IncludePathList = []
3709 if self.AutoGenVersion < 0x00010005:
3710 for Inc in self.Module.Includes:
3711 if Inc not in self._IncludePathList:
3712 self._IncludePathList.append(Inc)
3713 # for Edk modules
3714 Inc = path.join(Inc, self.Arch.capitalize())
3715 if os.path.exists(Inc) and Inc not in self._IncludePathList:
3716 self._IncludePathList.append(Inc)
3717 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3718 self._IncludePathList.append(self.DebugDir)
3719 else:
3720 self._IncludePathList.append(self.MetaFile.Dir)
3721 self._IncludePathList.append(self.DebugDir)
3722
3723 for Package in self.Module.Packages:
3724 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)
3725 if PackageDir not in self._IncludePathList:
3726 self._IncludePathList.append(PackageDir)
3727 IncludesList = Package.Includes
3728 if Package._PrivateIncludes:
3729 if not self.MetaFile.Path.startswith(PackageDir):
3730 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))
3731 for Inc in IncludesList:
3732 if Inc not in self._IncludePathList:
3733 self._IncludePathList.append(str(Inc))
3734 return self._IncludePathList
3735
3736 def _GetIncludePathLength(self):
3737 self._IncludePathLength = 0
3738 if self._IncludePathList:
3739 for inc in self._IncludePathList:
3740 self._IncludePathLength += len(' ' + inc)
3741 return self._IncludePathLength
3742
3743 ## Get HII EX PCDs which maybe used by VFR
3744 #
3745 # efivarstore used by VFR may relate with HII EX PCDs
3746 # Get the variable name and GUID from efivarstore and HII EX PCD
3747 # List the HII EX PCDs in As Built INF if both name and GUID match.
3748 #
3749 # @retval list HII EX PCDs
3750 #
3751 def _GetPcdsMaybeUsedByVfr(self):
3752 if not self.SourceFileList:
3753 return []
3754
3755 NameGuids = []
3756 for SrcFile in self.SourceFileList:
3757 if SrcFile.Ext.lower() != '.vfr':
3758 continue
3759 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')
3760 if not os.path.exists(Vfri):
3761 continue
3762 VfriFile = open(Vfri, 'r')
3763 Content = VfriFile.read()
3764 VfriFile.close()
3765 Pos = Content.find('efivarstore')
3766 while Pos != -1:
3767 #
3768 # Make sure 'efivarstore' is the start of efivarstore statement
3769 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3770 #
3771 Index = Pos - 1
3772 while Index >= 0 and Content[Index] in ' \t\r\n':
3773 Index -= 1
3774 if Index >= 0 and Content[Index] != ';':
3775 Pos = Content.find('efivarstore', Pos + len('efivarstore'))
3776 continue
3777 #
3778 # 'efivarstore' must be followed by name and guid
3779 #
3780 Name = gEfiVarStoreNamePattern.search(Content, Pos)
3781 if not Name:
3782 break
3783 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)
3784 if not Guid:
3785 break
3786 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')
3787 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))
3788 Pos = Content.find('efivarstore', Name.end())
3789 if not NameGuids:
3790 return []
3791 HiiExPcds = []
3792 for Pcd in self.PlatformInfo.Platform.Pcds.values():
3793 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:
3794 continue
3795 for SkuName in Pcd.SkuInfoList:
3796 SkuInfo = Pcd.SkuInfoList[SkuName]
3797 Name = ConvertStringToByteArray(SkuInfo.VariableName)
3798 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)
3799 if not Value:
3800 continue
3801 Guid = GuidStructureStringToGuidString(Value)
3802 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:
3803 HiiExPcds.append(Pcd)
3804 break
3805
3806 return HiiExPcds
3807
3808 def _GenOffsetBin(self):
3809 VfrUniBaseName = {}
3810 for SourceFile in self.Module.Sources:
3811 if SourceFile.Type.upper() == ".VFR" :
3812 #
3813 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3814 #
3815 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")
3816 if SourceFile.Type.upper() == ".UNI" :
3817 #
3818 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3819 #
3820 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")
3821
3822 if len(VfrUniBaseName) == 0:
3823 return None
3824 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")
3825 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")
3826 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())
3827 if not VfrUniOffsetList:
3828 return None
3829
3830 OutputName = '%sOffset.bin' % self.Name
3831 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)
3832
3833 try:
3834 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)
3835 except:
3836 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)
3837
3838 # Use a instance of StringIO to cache data
3839 fStringIO = StringIO('')
3840
3841 for Item in VfrUniOffsetList:
3842 if (Item[0].find("Strings") != -1):
3843 #
3844 # UNI offset in image.
3845 # GUID + Offset
3846 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3847 #
3848 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3849 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]
3850 fStringIO.write(''.join(UniGuid))
3851 UniValue = pack ('Q', int (Item[1], 16))
3852 fStringIO.write (UniValue)
3853 else:
3854 #
3855 # VFR binary offset in image.
3856 # GUID + Offset
3857 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3858 #
3859 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3860 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]
3861 fStringIO.write(''.join(VfrGuid))
3862 type (Item[1])
3863 VfrValue = pack ('Q', int (Item[1], 16))
3864 fStringIO.write (VfrValue)
3865 #
3866 # write data into file.
3867 #
3868 try :
3869 fInputfile.write (fStringIO.getvalue())
3870 except:
3871 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "
3872 "file been locked or using by other applications." %UniVfrOffsetFileName,None)
3873
3874 fStringIO.close ()
3875 fInputfile.close ()
3876 return OutputName
3877
3878 ## Create AsBuilt INF file the module
3879 #
3880 def CreateAsBuiltInf(self, IsOnlyCopy = False):
3881 self.OutputFile = []
3882 if IsOnlyCopy:
3883 if GlobalData.gBinCacheDest:
3884 self.CopyModuleToCache()
3885 return
3886
3887 if self.IsAsBuiltInfCreated:
3888 return
3889
3890 # Skip the following code for EDK I inf
3891 if self.AutoGenVersion < 0x00010005:
3892 return
3893
3894 # Skip the following code for libraries
3895 if self.IsLibrary:
3896 return
3897
3898 # Skip the following code for modules with no source files
3899 if self.SourceFileList == None or self.SourceFileList == []:
3900 return
3901
3902 # Skip the following code for modules without any binary files
3903 if self.BinaryFileList <> None and self.BinaryFileList <> []:
3904 return
3905
3906 ### TODO: How to handles mixed source and binary modules
3907
3908 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3909 # Also find all packages that the DynamicEx PCDs depend on
3910 Pcds = []
3911 PatchablePcds = []
3912 Packages = []
3913 PcdCheckList = []
3914 PcdTokenSpaceList = []
3915 for Pcd in self.ModulePcdList + self.LibraryPcdList:
3916 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
3917 PatchablePcds += [Pcd]
3918 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))
3919 elif Pcd.Type in GenC.gDynamicExPcd:
3920 if Pcd not in Pcds:
3921 Pcds += [Pcd]
3922 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))
3923 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))
3924 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)
3925 GuidList = sdict()
3926 GuidList.update(self.GuidList)
3927 for TokenSpace in self.GetGuidsUsedByPcd():
3928 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3929 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3930 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:
3931 GuidList.pop(TokenSpace)
3932 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)
3933 for Package in self.DerivedPackageList:
3934 if Package in Packages:
3935 continue
3936 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)
3937 Found = False
3938 for Index in range(len(BeChecked)):
3939 for Item in CheckList[Index]:
3940 if Item in BeChecked[Index]:
3941 Packages += [Package]
3942 Found = True
3943 break
3944 if Found: break
3945
3946 VfrPcds = self._GetPcdsMaybeUsedByVfr()
3947 for Pkg in self.PlatformInfo.PackageList:
3948 if Pkg in Packages:
3949 continue
3950 for VfrPcd in VfrPcds:
3951 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or
3952 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):
3953 Packages += [Pkg]
3954 break
3955
3956 ModuleType = self.ModuleType
3957 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:
3958 ModuleType = 'DXE_DRIVER'
3959
3960 DriverType = ''
3961 if self.PcdIsDriver != '':
3962 DriverType = self.PcdIsDriver
3963
3964 Guid = self.Guid
3965 MDefs = self.Module.Defines
3966
3967 AsBuiltInfDict = {
3968 'module_name' : self.Name,
3969 'module_guid' : Guid,
3970 'module_module_type' : ModuleType,
3971 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],
3972 'pcd_is_driver_string' : [],
3973 'module_uefi_specification_version' : [],
3974 'module_pi_specification_version' : [],
3975 'module_entry_point' : self.Module.ModuleEntryPointList,
3976 'module_unload_image' : self.Module.ModuleUnloadImageList,
3977 'module_constructor' : self.Module.ConstructorList,
3978 'module_destructor' : self.Module.DestructorList,
3979 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],
3980 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],
3981 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],
3982 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],
3983 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],
3984 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],
3985 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],
3986 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],
3987 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],
3988 'module_arch' : self.Arch,
3989 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],
3990 'binary_item' : [],
3991 'patchablepcd_item' : [],
3992 'pcd_item' : [],
3993 'protocol_item' : [],
3994 'ppi_item' : [],
3995 'guid_item' : [],
3996 'flags_item' : [],
3997 'libraryclasses_item' : []
3998 }
3999
4000 if 'MODULE_UNI_FILE' in MDefs:
4001 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])
4002 if os.path.isfile(UNIFile):
4003 shutil.copy2(UNIFile, self.OutputDir)
4004
4005 if self.AutoGenVersion > int(gInfSpecVersion, 0):
4006 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion
4007 else:
4008 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion
4009
4010 if DriverType:
4011 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]
4012
4013 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:
4014 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]
4015 if 'PI_SPECIFICATION_VERSION' in self.Specification:
4016 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]
4017
4018 OutputDir = self.OutputDir.replace('\\', '/').strip('/')
4019 for Item in self.CodaTargetList:
4020 File = Item.Target.Path.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')
4021 if File not in self.OutputFile:
4022 self.OutputFile.append(File)
4023 if Item.Target.Ext.lower() == '.aml':
4024 AsBuiltInfDict['binary_item'] += ['ASL|' + File]
4025 elif Item.Target.Ext.lower() == '.acpi':
4026 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]
4027 elif Item.Target.Ext.lower() == '.efi':
4028 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']
4029 else:
4030 AsBuiltInfDict['binary_item'] += ['BIN|' + File]
4031 if self.DepexGenerated:
4032 if self.Name + '.depex' not in self.OutputFile:
4033 self.OutputFile.append(self.Name + '.depex')
4034 if self.ModuleType in ['PEIM']:
4035 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']
4036 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4037 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']
4038 if self.ModuleType in ['DXE_SMM_DRIVER']:
4039 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']
4040
4041 Bin = self._GenOffsetBin()
4042 if Bin:
4043 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]
4044 if Bin not in self.OutputFile:
4045 self.OutputFile.append(Bin)
4046
4047 for Root, Dirs, Files in os.walk(OutputDir):
4048 for File in Files:
4049 if File.lower().endswith('.pdb'):
4050 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]
4051 if File not in self.OutputFile:
4052 self.OutputFile.append(File)
4053 HeaderComments = self.Module.HeaderComments
4054 StartPos = 0
4055 for Index in range(len(HeaderComments)):
4056 if HeaderComments[Index].find('@BinaryHeader') != -1:
4057 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')
4058 StartPos = Index
4059 break
4060 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')
4061 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)
4062
4063 GenList = [
4064 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),
4065 (self.PpiList, self._PpiComments, 'ppi_item'),
4066 (GuidList, self._GuidComments, 'guid_item')
4067 ]
4068 for Item in GenList:
4069 for CName in Item[0]:
4070 Comments = ''
4071 if CName in Item[1]:
4072 Comments = '\n '.join(Item[1][CName])
4073 Entry = CName
4074 if Comments:
4075 Entry = Comments + '\n ' + CName
4076 AsBuiltInfDict[Item[2]].append(Entry)
4077 PatchList = parsePcdInfoFromMapFile(
4078 os.path.join(self.OutputDir, self.Name + '.map'),
4079 os.path.join(self.OutputDir, self.Name + '.efi')
4080 )
4081 if PatchList:
4082 for Pcd in PatchablePcds:
4083 TokenCName = Pcd.TokenCName
4084 for PcdItem in GlobalData.MixedPcd:
4085 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4086 TokenCName = PcdItem[0]
4087 break
4088 for PatchPcd in PatchList:
4089 if TokenCName == PatchPcd[0]:
4090 break
4091 else:
4092 continue
4093 PcdValue = ''
4094 if Pcd.DatumType == 'BOOLEAN':
4095 BoolValue = Pcd.DefaultValue.upper()
4096 if BoolValue == 'TRUE':
4097 Pcd.DefaultValue = '1'
4098 elif BoolValue == 'FALSE':
4099 Pcd.DefaultValue = '0'
4100
4101 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4102 HexFormat = '0x%02x'
4103 if Pcd.DatumType == 'UINT16':
4104 HexFormat = '0x%04x'
4105 elif Pcd.DatumType == 'UINT32':
4106 HexFormat = '0x%08x'
4107 elif Pcd.DatumType == 'UINT64':
4108 HexFormat = '0x%016x'
4109 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)
4110 else:
4111 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
4112 EdkLogger.error("build", AUTOGEN_ERROR,
4113 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)
4114 )
4115 ArraySize = int(Pcd.MaxDatumSize, 0)
4116 PcdValue = Pcd.DefaultValue
4117 if PcdValue[0] != '{':
4118 Unicode = False
4119 if PcdValue[0] == 'L':
4120 Unicode = True
4121 PcdValue = PcdValue.lstrip('L')
4122 PcdValue = eval(PcdValue)
4123 NewValue = '{'
4124 for Index in range(0, len(PcdValue)):
4125 if Unicode:
4126 CharVal = ord(PcdValue[Index])
4127 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \
4128 + '0x%02x' % (CharVal >> 8) + ', '
4129 else:
4130 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '
4131 Padding = '0x00, '
4132 if Unicode:
4133 Padding = Padding * 2
4134 ArraySize = ArraySize / 2
4135 if ArraySize < (len(PcdValue) + 1):
4136 EdkLogger.error("build", AUTOGEN_ERROR,
4137 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4138 )
4139 if ArraySize > len(PcdValue) + 1:
4140 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)
4141 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'
4142 elif len(PcdValue.split(',')) <= ArraySize:
4143 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))
4144 PcdValue += '}'
4145 else:
4146 EdkLogger.error("build", AUTOGEN_ERROR,
4147 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)
4148 )
4149 PcdItem = '%s.%s|%s|0x%X' % \
4150 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])
4151 PcdComments = ''
4152 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4153 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])
4154 if PcdComments:
4155 PcdItem = PcdComments + '\n ' + PcdItem
4156 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)
4157
4158 HiiPcds = []
4159 for Pcd in Pcds + VfrPcds:
4160 PcdComments = ''
4161 PcdCommentList = []
4162 HiiInfo = ''
4163 SkuId = ''
4164 TokenCName = Pcd.TokenCName
4165 for PcdItem in GlobalData.MixedPcd:
4166 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
4167 TokenCName = PcdItem[0]
4168 break
4169 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:
4170 for SkuName in Pcd.SkuInfoList:
4171 SkuInfo = Pcd.SkuInfoList[SkuName]
4172 SkuId = SkuInfo.SkuId
4173 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)
4174 break
4175 if SkuId:
4176 #
4177 # Don't generate duplicated HII PCD
4178 #
4179 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:
4180 continue
4181 else:
4182 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
4183 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:
4184 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]
4185 if HiiInfo:
4186 UsageIndex = -1
4187 UsageStr = ''
4188 for Index, Comment in enumerate(PcdCommentList):
4189 for Usage in UsageList:
4190 if Comment.find(Usage) != -1:
4191 UsageStr = Usage
4192 UsageIndex = Index
4193 break
4194 if UsageIndex != -1:
4195 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))
4196 else:
4197 PcdCommentList.append('## UNDEFINED ' + HiiInfo)
4198 PcdComments = '\n '.join(PcdCommentList)
4199 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName
4200 if PcdComments:
4201 PcdEntry = PcdComments + '\n ' + PcdEntry
4202 AsBuiltInfDict['pcd_item'] += [PcdEntry]
4203 for Item in self.BuildOption:
4204 if 'FLAGS' in self.BuildOption[Item]:
4205 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]
4206
4207 # Generated LibraryClasses section in comments.
4208 for Library in self.LibraryAutoGenList:
4209 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]
4210
4211 # Generated UserExtensions TianoCore section.
4212 # All tianocore user extensions are copied.
4213 UserExtStr = ''
4214 for TianoCore in self._GetTianoCoreUserExtensionList():
4215 UserExtStr += '\n'.join(TianoCore)
4216 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])
4217 if os.path.isfile(ExtensionFile):
4218 shutil.copy2(ExtensionFile, self.OutputDir)
4219 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr
4220
4221 # Generated depex expression section in comments.
4222 AsBuiltInfDict['depexsection_item'] = ''
4223 DepexExpresion = self._GetDepexExpresionString()
4224 if DepexExpresion:
4225 AsBuiltInfDict['depexsection_item'] = DepexExpresion
4226
4227 AsBuiltInf = TemplateString()
4228 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))
4229
4230 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)
4231
4232 self.IsAsBuiltInfCreated = True
4233 if GlobalData.gBinCacheDest:
4234 self.CopyModuleToCache()
4235
4236 def CopyModuleToCache(self):
4237 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4238 CreateDirectory (FileDir)
4239 HashFile = path.join(self.BuildDir, self.Name + '.hash')
4240 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')
4241 if os.path.exists(HashFile):
4242 shutil.copy2(HashFile, FileDir)
4243 if os.path.exists(ModuleFile):
4244 shutil.copy2(ModuleFile, FileDir)
4245 if not self.OutputFile:
4246 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]
4247 self.OutputFile = Ma.Binaries
4248 if self.OutputFile:
4249 for File in self.OutputFile:
4250 File = str(File)
4251 if not os.path.isabs(File):
4252 File = os.path.join(self.OutputDir, File)
4253 if os.path.exists(File):
4254 shutil.copy2(File, FileDir)
4255
4256 def AttemptModuleCacheCopy(self):
4257 if self.IsBinaryModule:
4258 return False
4259 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)
4260 HashFile = path.join(FileDir, self.Name + '.hash')
4261 if os.path.exists(HashFile):
4262 f = open(HashFile, 'r')
4263 CacheHash = f.read()
4264 f.close()
4265 if GlobalData.gModuleHash[self.Arch][self.Name]:
4266 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:
4267 for root, dir, files in os.walk(FileDir):
4268 for f in files:
4269 if self.Name + '.hash' in f:
4270 shutil.copy2(HashFile, self.BuildDir)
4271 else:
4272 File = path.join(root, f)
4273 shutil.copy2(File, self.OutputDir)
4274 if self.Name == "PcdPeim" or self.Name == "PcdDxe":
4275 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4276 return True
4277 return False
4278
4279 ## Create makefile for the module and its dependent libraries
4280 #
4281 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4282 # dependent libraries will be created
4283 #
4284 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):
4285 # Ignore generating makefile when it is a binary module
4286 if self.IsBinaryModule:
4287 return
4288
4289 if self.IsMakeFileCreated:
4290 return
4291 self.GenFfsList = GenFfsList
4292 if not self.IsLibrary and CreateLibraryMakeFile:
4293 for LibraryAutoGen in self.LibraryAutoGenList:
4294 LibraryAutoGen.CreateMakeFile()
4295
4296 if self.CanSkip():
4297 return
4298
4299 if len(self.CustomMakefile) == 0:
4300 Makefile = GenMake.ModuleMakefile(self)
4301 else:
4302 Makefile = GenMake.CustomMakefile(self)
4303 if Makefile.Generate():
4304 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %
4305 (self.Name, self.Arch))
4306 else:
4307 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %
4308 (self.Name, self.Arch))
4309
4310 self.CreateTimeStamp(Makefile)
4311 self.IsMakeFileCreated = True
4312
4313 def CopyBinaryFiles(self):
4314 for File in self.Module.Binaries:
4315 SrcPath = File.Path
4316 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))
4317 CopyLongFilePath(SrcPath, DstPath)
4318 ## Create autogen code for the module and its dependent libraries
4319 #
4320 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4321 # dependent libraries will be created
4322 #
4323 def CreateCodeFile(self, CreateLibraryCodeFile=True):
4324 if self.IsCodeFileCreated:
4325 return
4326
4327 # Need to generate PcdDatabase even PcdDriver is binarymodule
4328 if self.IsBinaryModule and self.PcdIsDriver != '':
4329 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())
4330 return
4331 if self.IsBinaryModule:
4332 if self.IsLibrary:
4333 self.CopyBinaryFiles()
4334 return
4335
4336 if not self.IsLibrary and CreateLibraryCodeFile:
4337 for LibraryAutoGen in self.LibraryAutoGenList:
4338 LibraryAutoGen.CreateCodeFile()
4339
4340 if self.CanSkip():
4341 return
4342
4343 AutoGenList = []
4344 IgoredAutoGenList = []
4345
4346 for File in self.AutoGenFileList:
4347 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):
4348 #Ignore Edk AutoGen.c
4349 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':
4350 continue
4351
4352 AutoGenList.append(str(File))
4353 else:
4354 IgoredAutoGenList.append(str(File))
4355
4356 # Skip the following code for EDK I inf
4357 if self.AutoGenVersion < 0x00010005:
4358 return
4359
4360 for ModuleType in self.DepexList:
4361 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4362 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":
4363 continue
4364
4365 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)
4366 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}
4367
4368 if len(Dpx.PostfixNotation) <> 0:
4369 self.DepexGenerated = True
4370
4371 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):
4372 AutoGenList.append(str(DpxFile))
4373 else:
4374 IgoredAutoGenList.append(str(DpxFile))
4375
4376 if IgoredAutoGenList == []:
4377 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %
4378 (" ".join(AutoGenList), self.Name, self.Arch))
4379 elif AutoGenList == []:
4380 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %
4381 (" ".join(IgoredAutoGenList), self.Name, self.Arch))
4382 else:
4383 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %
4384 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))
4385
4386 self.IsCodeFileCreated = True
4387 return AutoGenList
4388
4389 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4390 def _GetLibraryAutoGenList(self):
4391 if self._LibraryAutoGenList == None:
4392 self._LibraryAutoGenList = []
4393 for Library in self.DependentLibraryList:
4394 La = ModuleAutoGen(
4395 self.Workspace,
4396 Library.MetaFile,
4397 self.BuildTarget,
4398 self.ToolChain,
4399 self.Arch,
4400 self.PlatformInfo.MetaFile
4401 )
4402 if La not in self._LibraryAutoGenList:
4403 self._LibraryAutoGenList.append(La)
4404 for Lib in La.CodaTargetList:
4405 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)
4406 return self._LibraryAutoGenList
4407
4408 def GenModuleHash(self):
4409 if self.Arch not in GlobalData.gModuleHash:
4410 GlobalData.gModuleHash[self.Arch] = {}
4411 m = hashlib.md5()
4412 # Add Platform level hash
4413 m.update(GlobalData.gPlatformHash)
4414 # Add Package level hash
4415 if self.DependentPackageList:
4416 for Pkg in self.DependentPackageList:
4417 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:
4418 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])
4419
4420 # Add Library hash
4421 if self.LibraryAutoGenList:
4422 for Lib in self.LibraryAutoGenList:
4423 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:
4424 Lib.GenModuleHash()
4425 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])
4426
4427 # Add Module self
4428 f = open(str(self.MetaFile), 'r')
4429 Content = f.read()
4430 f.close()
4431 m.update(Content)
4432 # Add Module's source files
4433 if self.SourceFileList:
4434 for File in self.SourceFileList:
4435 f = open(str(File), 'r')
4436 Content = f.read()
4437 f.close()
4438 m.update(Content)
4439
4440 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")
4441 if self.Name not in GlobalData.gModuleHash[self.Arch]:
4442 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()
4443 if GlobalData.gBinCacheSource:
4444 CacheValid = self.AttemptModuleCacheCopy()
4445 if CacheValid:
4446 return False
4447 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)
4448
4449 ## Decide whether we can skip the ModuleAutoGen process
4450 def CanSkipbyHash(self):
4451 if GlobalData.gUseHashCache:
4452 return not self.GenModuleHash()
4453
4454 ## Decide whether we can skip the ModuleAutoGen process
4455 # If any source file is newer than the module than we cannot skip
4456 #
4457 def CanSkip(self):
4458 if not os.path.exists(self.GetTimeStampPath()):
4459 return False
4460 #last creation time of the module
4461 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]
4462
4463 SrcTimeStamp = self.Workspace._SrcTimeStamp
4464 if SrcTimeStamp > DstTimeStamp:
4465 return False
4466
4467 with open(self.GetTimeStampPath(),'r') as f:
4468 for source in f:
4469 source = source.rstrip('\n')
4470 if not os.path.exists(source):
4471 return False
4472 if source not in ModuleAutoGen.TimeDict :
4473 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]
4474 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:
4475 return False
4476 return True
4477
4478 def GetTimeStampPath(self):
4479 if self._TimeStampPath == None:
4480 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')
4481 return self._TimeStampPath
4482 def CreateTimeStamp(self, Makefile):
4483
4484 FileSet = set()
4485
4486 FileSet.add (self.MetaFile.Path)
4487
4488 for SourceFile in self.Module.Sources:
4489 FileSet.add (SourceFile.Path)
4490
4491 for Lib in self.DependentLibraryList:
4492 FileSet.add (Lib.MetaFile.Path)
4493
4494 for f in self.AutoGenDepSet:
4495 FileSet.add (f.Path)
4496
4497 if os.path.exists (self.GetTimeStampPath()):
4498 os.remove (self.GetTimeStampPath())
4499 with open(self.GetTimeStampPath(), 'w+') as file:
4500 for f in FileSet:
4501 print >> file, f
4502
4503 Module = property(_GetModule)
4504 Name = property(_GetBaseName)
4505 Guid = property(_GetGuid)
4506 Version = property(_GetVersion)
4507 ModuleType = property(_GetModuleType)
4508 ComponentType = property(_GetComponentType)
4509 BuildType = property(_GetBuildType)
4510 PcdIsDriver = property(_GetPcdIsDriver)
4511 AutoGenVersion = property(_GetAutoGenVersion)
4512 Macros = property(_GetMacros)
4513 Specification = property(_GetSpecification)
4514
4515 IsLibrary = property(_IsLibrary)
4516 IsBinaryModule = property(_IsBinaryModule)
4517 BuildDir = property(_GetBuildDir)
4518 OutputDir = property(_GetOutputDir)
4519 FfsOutputDir = property(_GetFfsOutputDir)
4520 DebugDir = property(_GetDebugDir)
4521 MakeFileDir = property(_GetMakeFileDir)
4522 CustomMakefile = property(_GetCustomMakefile)
4523
4524 IncludePathList = property(_GetIncludePathList)
4525 IncludePathLength = property(_GetIncludePathLength)
4526 AutoGenFileList = property(_GetAutoGenFileList)
4527 UnicodeFileList = property(_GetUnicodeFileList)
4528 VfrFileList = property(_GetVfrFileList)
4529 SourceFileList = property(_GetSourceFileList)
4530 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]
4531 Targets = property(_GetTargets)
4532 IntroTargetList = property(_GetIntroTargetList)
4533 CodaTargetList = property(_GetFinalTargetList)
4534 FileTypes = property(_GetFileTypes)
4535 BuildRules = property(_GetBuildRules)
4536 IdfFileList = property(_GetIdfFileList)
4537
4538 DependentPackageList = property(_GetDependentPackageList)
4539 DependentLibraryList = property(_GetLibraryList)
4540 LibraryAutoGenList = property(_GetLibraryAutoGenList)
4541 DerivedPackageList = property(_GetDerivedPackageList)
4542
4543 ModulePcdList = property(_GetModulePcdList)
4544 LibraryPcdList = property(_GetLibraryPcdList)
4545 GuidList = property(_GetGuidList)
4546 ProtocolList = property(_GetProtocolList)
4547 PpiList = property(_GetPpiList)
4548 DepexList = property(_GetDepexTokenList)
4549 DxsFile = property(_GetDxsFile)
4550 DepexExpressionList = property(_GetDepexExpressionTokenList)
4551 BuildOption = property(_GetModuleBuildOption)
4552 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)
4553 BuildCommand = property(_GetBuildCommand)
4554
4555 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)
4556
4557 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4558 if __name__ == '__main__':
4559 pass
4560
EFI Development Kit II mirror for PVE