2 # Generate AutoGen.h, AutoGen.c and *.depex files
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
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.
16 import Common
.LongFilePathOs
as os
18 import os
.path
as path
25 from StringIO
import StringIO
27 from StrGather
import *
28 from BuildEngine
import BuildRule
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
47 from GenVar
import VariableMgr
,var_info
49 ## Regular expression for splitting Dependency Expression string into tokens
50 gDepexTokenPattern
= re
.compile("(\(|\)|\w+| \S+\.inf)")
53 # Match name = variable
55 gEfiVarStoreNamePattern
= re
.compile("\s*name\s*=\s*(\w+)")
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}}
60 gEfiVarStoreGuidPattern
= re
.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
62 ## Mapping Makefile type
63 gMakeTypeMap
= {"MSFT":"nmake", "GCC":"gmake"}
66 ## Build rule configuration file
67 gDefaultBuildRuleFile
= 'build_rule.txt'
69 ## Tools definition configuration file
70 gDefaultToolsDefFile
= 'tools_def.txt'
72 ## Build rule default version
73 AutoGenReqBuildRuleVerNum
= "0.1"
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"
86 # Template string to generic AsBuilt INF
88 gAsBuiltInfHeaderString
= TemplateString("""${header_comments}
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}
116 [Packages.${module_arch}]${BEGIN}
117 ${package_item}${END}
119 [Binaries.${module_arch}]${BEGIN}
122 [PatchPcd.${module_arch}]${BEGIN}
126 [Protocols.${module_arch}]${BEGIN}
130 [Ppis.${module_arch}]${BEGIN}
134 [Guids.${module_arch}]${BEGIN}
138 [PcdEx.${module_arch}]${BEGIN}
142 [LibraryClasses.${module_arch}]
143 ## @LIB_INSTANCES${BEGIN}
144 # ${libraryclasses_item}${END}
148 ${userextension_tianocore_item}
152 [BuildOptions.${module_arch}]
154 ## ${flags_item}${END}
157 ## Base class for AutoGen
159 # This class just implements the cache mechanism of AutoGen objects.
161 class AutoGen(object):
162 # database to maintain the objects of xxxAutoGen
163 _CACHE_
= {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}
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
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
):
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
192 AutoGenObject
= Class
._CACHE
_[Key
][Arch
][MetaFile
]
198 # The file path of platform file will be used to represent hash value of this object
200 # @retval int Hash value of the file path of platform file
203 return hash(self
.MetaFile
)
207 # The file path of platform file will be used to represent this object
209 # @retval string String of platform file path
212 return str(self
.MetaFile
)
215 def __eq__(self
, Other
):
216 return Other
and self
.MetaFile
== Other
218 ## Workspace AutoGen class
220 # This class is used mainly to control the whole platform build for different
221 # architecture. This class will generate top level makefile.
223 class WorkspaceAutoGen(AutoGen
):
224 ## Real constructor of WorkspaceAutoGen
226 # This method behaves the same as __init__ except that it needs explicit invoke
227 # (in super class's __new__ method)
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
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):
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
261 self
.UniFlag
= UniFlag
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
272 self
._MakeFileDir
= None
273 self
._BuildCommand
= None
275 # there's many relative directory operations, so ...
276 os
.chdir(self
.WorkspaceDir
)
281 if not self
.ArchList
:
282 ArchList
= set(self
.Platform
.SupArchList
)
284 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
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
)
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
)))
301 # parse FDF file to get PCDs in it, if any
303 self
.FdfFile
= self
.Platform
.FlashDefinition
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
))
311 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
313 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
316 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
318 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
321 # Progress.Start("\nProcessing meta-data")
325 # Mark now build in AutoGen Phase
327 GlobalData
.gAutoGenPhase
= True
328 Fdf
= FdfParser(self
.FdfFile
.Path
)
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
)
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
:
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
]:
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
)
368 for Arch
in self
.ArchList
:
370 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
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
:
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
)
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
= []
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
]
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:
407 (pcdname
, pcdvalue
) = pcd
.split('=')
409 EdkLogger
.error('build', AUTOGEN_ERROR
, "No Value specified for the PCD %s." % (pcdname
))
411 (TokenSpaceGuidCName
, TokenCName
) = pcdname
.split('.')
415 TokenSpaceGuidCName
= ''
416 HasTokenSpace
= False
417 TokenSpaceGuidCNameList
= []
421 for package
in PGen
.PackageList
:
422 for key
in package
.Pcds
:
423 PcdItem
= package
.Pcds
[key
]
425 if (PcdItem
.TokenCName
, PcdItem
.TokenSpaceGuidCName
) == (TokenCName
, TokenSpaceGuidCName
):
426 PcdDatumType
= PcdItem
.DatumType
427 NewValue
= BuildOptionPcdValueFormat(TokenSpaceGuidCName
, TokenCName
, PcdDatumType
, pcdvalue
)
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
)
442 "The Pcd %s is found under multiple different TokenSpaceGuid: %s and %s." % (TokenCName
, PcdItem
.TokenSpaceGuidCName
, TokenSpaceGuidCNameList
[0])
445 GlobalData
.BuildOptionPcd
[i
] = (TokenSpaceGuidCName
, TokenCName
, NewValue
)
449 EdkLogger
.error('build', AUTOGEN_ERROR
, "The Pcd %s.%s is not found in the DEC file." % (TokenSpaceGuidCName
, TokenCName
))
451 EdkLogger
.error('build', AUTOGEN_ERROR
, "The Pcd %s is not found in the DEC file." % (TokenCName
))
453 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
454 if BuildData
.Arch
!= Arch
:
456 if BuildData
.MetaFile
.Ext
== '.dec':
458 for key
in BuildData
.Pcds
:
459 PcdItem
= BuildData
.Pcds
[key
]
460 if (TokenSpaceGuidCName
, TokenCName
) == (PcdItem
.TokenSpaceGuidCName
, PcdItem
.TokenCName
):
461 PcdItem
.DefaultValue
= NewValue
463 if (TokenCName
, TokenSpaceGuidCName
) in PcdSet
:
464 PcdSet
[(TokenCName
, TokenSpaceGuidCName
)] = NewValue
466 SourcePcdDict
= {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}
467 BinaryPcdDict
= {'DynamicEx':[], 'PatchableInModule':[]}
468 SourcePcdDict_Keys
= SourcePcdDict
.keys()
469 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
471 # generate the SourcePcdDict and BinaryPcdDict
472 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
473 if BuildData
.Arch
!= Arch
:
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
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
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
))
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
))
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
))
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
))
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
))
516 # A PCD can only use one type for all source modules
518 for i
in SourcePcdDict_Keys
:
519 for j
in SourcePcdDict_Keys
:
521 IntersectionList
= list(set(SourcePcdDict
[i
]).intersection(set(SourcePcdDict
[j
])))
522 if len(IntersectionList
) > 0:
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
])
533 # intersection the BinaryPCD for Mixed PCD
535 for i
in BinaryPcdDict_Keys
:
536 for j
in BinaryPcdDict_Keys
:
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
]
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
)
553 # intersection the SourcePCD and BinaryPCD for Mixed PCD
555 for i
in SourcePcdDict_Keys
:
556 for j
in BinaryPcdDict_Keys
:
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
]
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
)
572 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
573 if BuildData
.Arch
!= Arch
:
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
585 newkey
= (Value
.TokenCName
, key
[1])
587 newkey
= (Value
.TokenCName
, key
[1], key
[2])
588 del BuildData
.Pcds
[key
]
589 BuildData
.Pcds
[newkey
] = Value
597 # handle the mixed pcd in FDF file
599 if key
in GlobalData
.MixedPcd
:
602 for item
in GlobalData
.MixedPcd
[key
]:
605 #Collect package set information from INF of FDF
607 for Inf
in ModuleList
:
608 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
609 if ModuleFile
in Platform
.Modules
:
611 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
612 PkgSet
.update(ModuleData
.Packages
)
613 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
616 DecPcds
[Pcd
[0], Pcd
[1]] = Pkg
.Pcds
[Pcd
]
617 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
619 Platform
.SkuName
= self
.SkuId
620 for Name
, Guid
in PcdSet
:
621 if (Name
, Guid
) not in DecPcds
:
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]
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
])
636 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
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]
645 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
647 # Explicitly collect platform's dynamic PCDs
649 Pa
.CollectPlatformDynamicPcds()
650 Pa
.CollectFixedAtBuildPcds()
651 self
.AutoGenObjectList
.append(Pa
)
654 # Generate Package level hash value
656 GlobalData
.gPackageHash
[Arch
] = {}
657 if GlobalData
.gUseHashCache
:
659 self
._GenPkgLevelHash
(Pkg
)
662 # Check PCDs token value conflict in each DEC file.
664 self
._CheckAllPcdsTokenValueConflict
()
667 # Check PCD type and definition between DSC and DEC
669 self
._CheckPcdDefineAndType
()
672 # self._CheckDuplicateInFV(Fdf)
675 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
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
687 content
+= 'Flash Image Definition: '
688 content
+= str(self
.FdfFile
)
689 content
+= os
.linesep
690 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
693 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
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)
706 # Get set of workspace metafiles
708 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
711 # Retrieve latest modified time of all metafiles
714 for f
in AllWorkSpaceMetaFiles
:
715 if os
.stat(f
)[8] > SrcTimeStamp
:
716 SrcTimeStamp
= os
.stat(f
)[8]
717 self
._SrcTimeStamp
= SrcTimeStamp
719 if GlobalData
.gUseHashCache
:
721 for files
in AllWorkSpaceMetaFiles
:
722 if files
.endswith('.dec'):
728 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
729 GlobalData
.gPlatformHash
= m
.hexdigest()
732 # Write metafile list to build directory
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
:
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')
749 # Get .dec file's hash value
750 f
= open(Pkg
.MetaFile
.Path
, 'r')
754 # Get include files hash value
756 for inc
in Pkg
.Includes
:
757 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
759 File_Path
= os
.path
.join(Root
, File
)
760 f
= open(File_Path
, 'r')
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()
768 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
769 AllWorkSpaceMetaFiles
= set()
774 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
776 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
778 AllWorkSpaceMetaFiles
.add (f
.FileName
)
782 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
785 # add build_rule.txt & tools_def.txt
787 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
788 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
790 # add BuildOption metafile
792 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
794 # add PcdToken Number file for Dynamic/DynamicEx Pcd
796 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
798 for Arch
in self
.ArchList
:
799 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
800 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
805 for Package
in PGen
.PackageList
:
806 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
811 for filePath
in Platform
._RawData
.IncludedFiles
:
812 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
814 return AllWorkSpaceMetaFiles
816 ## _CheckDuplicateInFV() method
818 # Check whether there is duplicate modules/files exist in FV section.
819 # The check base on the file GUID;
821 def _CheckDuplicateInFV(self
, Fdf
):
822 for Fv
in Fdf
.Profile
.FvDict
:
824 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
825 if FfsFile
.InfFileName
and FfsFile
.NameGuid
== None:
830 for Pa
in self
.AutoGenObjectList
:
833 for Module
in Pa
.ModuleAutoGenList
:
834 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
836 if not Module
.Guid
.upper() in _GuidDict
.keys():
837 _GuidDict
[Module
.Guid
.upper()] = FfsFile
840 EdkLogger
.error("build",
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
)
849 # Some INF files not have entity in DSC file.
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
))
857 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
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.
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
866 EdkLogger
.error("build",
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
)
876 if FfsFile
.NameGuid
!= None:
877 _CheckPCDAsGuidPattern
= re
.compile("^PCD\(.+\..+\)$")
880 # If the NameGuid reference a PCD name.
881 # The style must match: PCD(xxxx.yyy)
883 if _CheckPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
885 # Replace the PCD value.
887 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
889 for Pa
in self
.AutoGenObjectList
:
891 for PcdItem
in Pa
.AllPcdList
:
892 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
894 # First convert from CFormatGuid to GUID string
896 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
898 if not _PcdGuidString
:
900 # Then try Byte array.
902 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
904 if not _PcdGuidString
:
906 # Not Byte array or CFormat GUID, raise error.
908 EdkLogger
.error("build",
910 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
911 ExtraData
=self
.FdfFile
)
913 if not _PcdGuidString
.upper() in _GuidDict
.keys():
914 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
918 EdkLogger
.error("build",
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
)
927 if not FfsFile
.NameGuid
.upper() in _GuidDict
.keys():
928 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
931 # Two raw file GUID conflict.
933 EdkLogger
.error("build",
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
)
943 def _CheckPcdDefineAndType(self
):
945 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
946 "Dynamic", #"DynamicHii", "DynamicVpd",
947 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
950 # This dict store PCDs which are not used by any modules with specified arches
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
957 # If no PCD type, this PCD comes from FDF
961 # Try to remove Hii and Vpd suffix
962 if PcdType
.startswith("DynamicEx"):
963 PcdType
= "DynamicEx"
964 elif PcdType
.startswith("Dynamic"):
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
:
971 for Type
in PcdTypeList
:
972 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
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
),
982 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
984 for Pcd
in UnusedPcd
:
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
])),
994 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
996 ## Return the directory to store FV files
998 if self
._FvDir
== None:
999 self
._FvDir
= path
.join(self
.BuildDir
, 'FV')
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
1007 ## Return the build output directory platform specifies
1008 def _GetOutputDir(self
):
1009 return self
.Platform
.OutputDirectory
1011 ## Return platform name
1013 return self
.Platform
.PlatformName
1015 ## Return meta-file GUID
1017 return self
.Platform
.Guid
1019 ## Return platform version
1020 def _GetVersion(self
):
1021 return self
.Platform
.Version
1023 ## Return paths of tools
1024 def _GetToolDefinition(self
):
1025 return self
.AutoGenObjectList
[0].ToolDefinition
1027 ## Return directory of platform makefile
1029 # @retval string Makefile directory
1031 def _GetMakeFileDir(self
):
1032 if self
._MakeFileDir
== None:
1033 self
._MakeFileDir
= self
.BuildDir
1034 return self
._MakeFileDir
1036 ## Return build command string
1038 # @retval string Build command string
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
1046 ## Check the PCDs token value conflict in each DEC file.
1048 # Will cause build break and raise error message while two PCDs conflict.
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)))
1058 while (Count
< len(PcdList
) - 1) :
1059 Item
= PcdList
[Count
]
1060 ItemNext
= PcdList
[Count
+ 1]
1062 # Make sure in the same token space the TokenValue should be unique
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
])
1075 # Sort same token value PCD list with TokenGuid and TokenCName
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):
1081 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1082 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
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
]:
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
),
1097 SameTokenValuePcdListCount
+= 1
1098 Count
+= SameTokenValuePcdListCount
1101 PcdList
= Package
.Pcds
.values()
1102 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1104 while (Count
< len(PcdList
) - 1) :
1105 Item
= PcdList
[Count
]
1106 ItemNext
= PcdList
[Count
+ 1]
1108 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1110 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
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
),
1119 ## Generate fds command
1120 def _GenFdsCommand(self
):
1121 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1123 ## Create makefile for the platform and modules in it
1125 # @param CreateDepsMakeFile Flag indicating if the makefile for
1126 # modules will be created as well
1128 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1129 if CreateDepsMakeFile
:
1130 for Pa
in self
.AutoGenObjectList
:
1131 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1133 ## Create autogen code for platform and modules
1135 # Since there's no autogen code for platform, this method will do nothing
1136 # if CreateModuleCodeFile is set to False.
1138 # @param CreateDepsCodeFile Flag indicating if creating module's
1139 # autogen code file or not
1141 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1142 if not CreateDepsCodeFile
:
1144 for Pa
in self
.AutoGenObjectList
:
1145 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1147 ## Create AsBuilt INF file the platform
1149 def CreateAsBuiltInf(self
):
1152 Name
= property(_GetName
)
1153 Guid
= property(_GetGuid
)
1154 Version
= property(_GetVersion
)
1155 OutputDir
= property(_GetOutputDir
)
1157 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1159 BuildDir
= property(_GetBuildDir
)
1160 FvDir
= property(_GetFvDir
)
1161 MakeFileDir
= property(_GetMakeFileDir
)
1162 BuildCommand
= property(_GetBuildCommand
)
1163 GenFdsCommand
= property(_GenFdsCommand
)
1165 ## AutoGen class for platform
1167 # PlatformAutoGen class will process the original information in platform
1168 # file in order to generate makefile for platform.
1170 class PlatformAutoGen(AutoGen
):
1172 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1173 # correct PCD database
1176 _NonDynaPcdList_
= []
1180 # The priority list while override build option
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)
1199 ## The real constructor of PlatformAutoGen
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
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
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
)
1215 self
.MetaFile
= PlatformFile
1216 self
.Workspace
= Workspace
1217 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1218 self
.ToolChain
= Toolchain
1219 self
.BuildTarget
= Target
1221 self
.SourceDir
= PlatformFile
.SubDir
1222 self
.SourceOverrideDir
= None
1223 self
.FdTargetList
= self
.Workspace
.FdTargetList
1224 self
.FvTargetList
= self
.Workspace
.FvTargetList
1225 self
.AllPcdList
= []
1226 # get the original module/package/platform objects
1227 self
.BuildDatabase
= Workspace
.BuildDatabase
1228 self
.DscBuildDataObj
= Workspace
.Platform
1230 # flag indicating if the makefile/C-code file has been created or not
1231 self
.IsMakeFileCreated
= False
1232 self
.IsCodeFileCreated
= False
1234 self
._Platform
= None
1237 self
._Version
= None
1239 self
._BuildRule
= None
1240 self
._SourceDir
= None
1241 self
._BuildDir
= None
1242 self
._OutputDir
= None
1244 self
._MakeFileDir
= None
1245 self
._FdfFile
= None
1247 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1248 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1249 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1250 self
._NonDynamicPcdDict
= {}
1252 self
._ToolDefinitions
= None
1253 self
._ToolDefFile
= None # toolcode : tool path
1254 self
._ToolChainFamily
= None
1255 self
._BuildRuleFamily
= None
1256 self
._BuildOption
= None # toolcode : option
1257 self
._EdkBuildOption
= None # edktoolcode : option
1258 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1259 self
._PackageList
= None
1260 self
._ModuleAutoGenList
= None
1261 self
._LibraryAutoGenList
= None
1262 self
._BuildCommand
= None
1263 self
._AsBuildInfList
= []
1264 self
._AsBuildModuleList
= []
1266 self
.VariableInfo
= None
1268 if GlobalData
.gFdfParser
!= None:
1269 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1270 for Inf
in self
._AsBuildInfList
:
1271 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1272 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1273 if not M
.IsSupportedArch
:
1275 self
._AsBuildModuleList
.append(InfClass
)
1276 # get library/modules for build
1277 self
.LibraryBuildDirectoryList
= []
1278 self
.ModuleBuildDirectoryList
= []
1283 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1285 ## Create autogen code for platform and modules
1287 # Since there's no autogen code for platform, this method will do nothing
1288 # if CreateModuleCodeFile is set to False.
1290 # @param CreateModuleCodeFile Flag indicating if creating module's
1291 # autogen code file or not
1293 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1294 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1295 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1298 for Ma
in self
.ModuleAutoGenList
:
1299 Ma
.CreateCodeFile(True)
1301 # don't do this twice
1302 self
.IsCodeFileCreated
= True
1304 ## Generate Fds Command
1305 def _GenFdsCommand(self
):
1306 return self
.Workspace
.GenFdsCommand
1308 ## Create makefile for the platform and mdoules in it
1310 # @param CreateModuleMakeFile Flag indicating if the makefile for
1311 # modules will be created as well
1313 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1314 if CreateModuleMakeFile
:
1315 for ModuleFile
in self
.Platform
.Modules
:
1316 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1317 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1318 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1319 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1321 Ma
.CreateMakeFile(True)
1322 #Ma.CreateAsBuiltInf()
1324 # no need to create makefile for the platform more than once
1325 if self
.IsMakeFileCreated
:
1328 # create library/module build dirs for platform
1329 Makefile
= GenMake
.PlatformMakefile(self
)
1330 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1331 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1333 self
.IsMakeFileCreated
= True
1335 ## Deal with Shared FixedAtBuild Pcds
1337 def CollectFixedAtBuildPcds(self
):
1338 for LibAuto
in self
.LibraryAutoGenList
:
1339 FixedAtBuildPcds
= {}
1340 ShareFixedAtBuildPcdsSameValue
= {}
1341 for Module
in LibAuto
._ReferenceModules
:
1342 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1343 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1344 if key
not in FixedAtBuildPcds
:
1345 ShareFixedAtBuildPcdsSameValue
[key
] = True
1346 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1348 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1349 ShareFixedAtBuildPcdsSameValue
[key
] = False
1350 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1351 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1352 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1355 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1356 if DscPcd
.Type
!= "FixedAtBuild":
1358 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1359 LibAuto
.ConstPcd
[key
] = Pcd
.DefaultValue
1361 def CollectVariables(self
, DynamicPcdSet
):
1365 if self
.Workspace
.FdfFile
:
1366 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1367 for FdRegion
in FdDict
.RegionList
:
1368 for item
in FdRegion
.RegionDataList
:
1369 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1370 VpdRegionSize
= FdRegion
.Size
1371 VpdRegionBase
= FdRegion
.Offset
1375 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1376 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1377 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1379 for Pcd
in DynamicPcdSet
:
1380 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1381 for SkuName
in Pcd
.SkuInfoList
:
1382 Sku
= Pcd
.SkuInfoList
[SkuName
]
1384 if SkuId
== None or SkuId
== '':
1386 if len(Sku
.VariableName
) > 0:
1387 VariableGuidStructure
= Sku
.VariableGuidValue
1388 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1389 if Pcd
.Phase
== "DXE":
1390 for StorageName
in Sku
.DefaultStoreDict
:
1391 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1395 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1396 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1397 # VpdFile = VpdInfoFile.VpdInfoFile()
1398 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1400 if PcdNvStoreDfBuffer
:
1401 if os
.path
.exists(VpdMapFilePath
):
1402 OrgVpdFile
.Read(VpdMapFilePath
)
1403 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1404 NvStoreOffset
= PcdItems
[0].strip() if PcdItems
else 0
1406 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1408 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1409 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
1410 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1411 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get("DEFAULT")
1413 if var_data
and default_skuobj
:
1414 default_skuobj
.DefaultValue
= var_data
1415 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1416 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1417 PcdNvStoreDfBuffer
[0].SkuInfoList
['DEFAULT'] = default_skuobj
1418 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1422 ## Collect dynamic PCDs
1424 # Gather dynamic PCDs list from each module and their settings from platform
1425 # This interface should be invoked explicitly when platform action is created.
1427 def CollectPlatformDynamicPcds(self
):
1428 # Override the platform Pcd's value by build option
1429 if GlobalData
.BuildOptionPcd
:
1430 for key
in self
.Platform
.Pcds
:
1431 PlatformPcd
= self
.Platform
.Pcds
[key
]
1432 for PcdItem
in GlobalData
.BuildOptionPcd
:
1433 if (PlatformPcd
.TokenSpaceGuidCName
, PlatformPcd
.TokenCName
) == (PcdItem
[0], PcdItem
[1]):
1434 PlatformPcd
.DefaultValue
= PcdItem
[2]
1435 if PlatformPcd
.SkuInfoList
:
1436 Sku
= PlatformPcd
.SkuInfoList
[PlatformPcd
.SkuInfoList
.keys()[0]]
1437 Sku
.DefaultValue
= PcdItem
[2]
1440 for key
in self
.Platform
.Pcds
:
1441 for SinglePcd
in GlobalData
.MixedPcd
:
1442 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1443 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1444 Pcd_Type
= item
[0].split('_')[-1]
1445 if (Pcd_Type
== self
.Platform
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
1446 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1447 Value
= self
.Platform
.Pcds
[key
]
1448 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1450 newkey
= (Value
.TokenCName
, key
[1])
1452 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1453 del self
.Platform
.Pcds
[key
]
1454 self
.Platform
.Pcds
[newkey
] = Value
1462 # for gathering error information
1463 NoDatumTypePcdList
= set()
1465 self
._GuidValue
= {}
1467 for InfName
in self
._AsBuildInfList
:
1468 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1469 FdfModuleList
.append(os
.path
.normpath(InfName
))
1470 for F
in self
.Platform
.Modules
.keys():
1471 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1472 #GuidValue.update(M.Guids)
1474 self
.Platform
.Modules
[F
].M
= M
1476 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1477 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1478 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1479 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1481 # Check the PCD from Binary INF or Source INF
1482 if M
.IsBinaryModule
== True:
1483 PcdFromModule
.IsFromBinaryInf
= True
1485 # Check the PCD from DSC or not
1486 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1487 PcdFromModule
.IsFromDsc
= True
1489 PcdFromModule
.IsFromDsc
= False
1490 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1491 if F
.Path
not in FdfModuleList
:
1492 # If one of the Source built modules listed in the DSC is not listed
1493 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1494 # access method (it is only listed in the DEC file that declares the
1495 # PCD as PcdsDynamic), then build tool will report warning message
1496 # notify the PI that they are attempting to build a module that must
1497 # be included in a flash image in order to be functional. These Dynamic
1498 # PCD will not be added into the Database unless it is used by other
1499 # modules that are included in the FDF file.
1500 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1501 PcdFromModule
.IsFromBinaryInf
== False:
1502 # Print warning message to let the developer make a determine.
1503 if PcdFromModule
not in PcdNotInDb
:
1504 PcdNotInDb
.append(PcdFromModule
)
1506 # If one of the Source built modules listed in the DSC is not listed in
1507 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1508 # access method (it is only listed in the DEC file that declares the
1509 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1510 # PCD to the Platform's PCD Database.
1511 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1512 if PcdFromModule
not in PcdNotInDb
:
1513 PcdNotInDb
.append(PcdFromModule
)
1516 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1517 # it should be stored in Pcd PEI database, If a dynamic only
1518 # used by DXE module, it should be stored in DXE PCD database.
1519 # The default Phase is DXE
1521 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1522 PcdFromModule
.Phase
= "PEI"
1523 if PcdFromModule
not in self
._DynaPcdList
_:
1524 self
._DynaPcdList
_.append(PcdFromModule
)
1525 elif PcdFromModule
.Phase
== 'PEI':
1526 # overwrite any the same PCD existing, if Phase is PEI
1527 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1528 self
._DynaPcdList
_[Index
] = PcdFromModule
1529 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1530 self
._NonDynaPcdList
_.append(PcdFromModule
)
1531 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1532 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1533 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1534 #The PCD from Binary INF will override the same one from source INF
1535 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1536 PcdFromModule
.Pending
= False
1537 self
._NonDynaPcdList
_.append (PcdFromModule
)
1538 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1540 for ModuleInf
in self
.Platform
.Modules
.keys():
1541 DscModuleList
.append (os
.path
.normpath(ModuleInf
.Path
))
1542 # add the PCD from modules that listed in FDF but not in DSC to Database
1543 for InfName
in FdfModuleList
:
1544 if InfName
not in DscModuleList
:
1545 InfClass
= PathClass(InfName
)
1546 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1547 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1548 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1549 # For binary module, if in current arch, we need to list the PCDs into database.
1550 if not M
.IsSupportedArch
:
1552 # Override the module PCD setting by platform setting
1553 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1554 for PcdFromModule
in ModulePcdList
:
1555 PcdFromModule
.IsFromBinaryInf
= True
1556 PcdFromModule
.IsFromDsc
= False
1557 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1558 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1559 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1561 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1562 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1563 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1564 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1565 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1566 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1567 PcdFromModule
.Phase
= "PEI"
1568 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1569 self
._DynaPcdList
_.append(PcdFromModule
)
1570 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1571 self
._NonDynaPcdList
_.append(PcdFromModule
)
1572 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1573 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1574 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1575 # module & DXE module at a same time.
1576 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1577 # INF file as DynamicEx.
1578 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1579 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1580 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1581 for PcdFromModule
in self
._NonDynaPcdList
_:
1582 # If a PCD is not listed in the DSC file, but binary INF files used by
1583 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1584 # section, AND all source INF files used by this platform the build
1585 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1586 # section, then the tools must NOT add the PCD to the Platform's PCD
1587 # Database; the build must assign the access method for this PCD as
1588 # PcdsPatchableInModule.
1589 if PcdFromModule
not in self
._DynaPcdList
_:
1591 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1592 if PcdFromModule
.IsFromDsc
== False and \
1593 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1594 PcdFromModule
.IsFromBinaryInf
== True and \
1595 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1596 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1597 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1599 # print out error information and break the build, if error found
1600 if len(NoDatumTypePcdList
) > 0:
1601 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1602 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1604 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1605 % NoDatumTypePcdListString
)
1606 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1607 self
._DynamicPcdList
= self
._DynaPcdList
_
1609 # Sort dynamic PCD list to:
1610 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1611 # try to be put header of dynamicd List
1612 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1614 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1616 UnicodePcdArray
= []
1620 VpdFile
= VpdInfoFile
.VpdInfoFile()
1621 NeedProcessVpdMapFile
= False
1623 for pcd
in self
.Platform
.Pcds
.keys():
1624 if pcd
not in self
._PlatformPcds
.keys():
1625 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1627 for item
in self
._PlatformPcds
:
1628 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1629 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1631 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1632 for Pcd
in self
._DynamicPcdList
:
1633 # just pick the a value to determine whether is unicode string type
1634 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1635 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1637 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1638 Pcd
.DatumType
= "VOID*"
1640 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1641 # if found HII type PCD then insert to right of UnicodeIndex
1642 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1643 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1645 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1646 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1647 if PcdNvStoreDfBuffer
:
1648 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1649 vardump
= self
.VariableInfo
.dump()
1651 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1652 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1653 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1654 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1656 PlatformPcds
= self
._PlatformPcds
.keys()
1659 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1662 for PcdKey
in PlatformPcds
:
1663 Pcd
= self
._PlatformPcds
[PcdKey
]
1664 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1665 PcdKey
in VpdPcdDict
:
1666 Pcd
= VpdPcdDict
[PcdKey
]
1668 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1669 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1670 PcdValue
= Sku
.DefaultValue
1672 PcdValue
= Pcd
.DefaultValue
1673 if Sku
.VpdOffset
!= '*':
1674 if PcdValue
.startswith("{"):
1676 elif PcdValue
.startswith("L"):
1681 VpdOffset
= int(Sku
.VpdOffset
)
1684 VpdOffset
= int(Sku
.VpdOffset
, 16)
1686 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1687 if VpdOffset
% Alignment
!= 0:
1688 if PcdValue
.startswith("{"):
1689 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1691 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1692 if PcdValue
not in SkuValueMap
:
1693 SkuValueMap
[PcdValue
] = []
1694 VpdFile
.Add(Pcd
, Sku
.VpdOffset
)
1695 SkuValueMap
[PcdValue
].append(Sku
)
1696 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1697 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1698 NeedProcessVpdMapFile
= True
1699 if self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== '':
1700 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1701 "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1703 VpdSkuMap
[PcdKey
] = SkuValueMap
1705 # Fix the PCDs define in VPD PCD section that never referenced by module.
1706 # An example is PCD for signature usage.
1708 for DscPcd
in PlatformPcds
:
1709 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1710 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1711 if not (self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== ''):
1713 for VpdPcd
in VpdFile
._VpdArray
.keys():
1714 # This PCD has been referenced by module
1715 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1716 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1719 # Not found, it should be signature
1721 # just pick the a value to determine whether is unicode string type
1723 for (SkuName
,Sku
) in DscPcdEntry
.SkuInfoList
.items():
1724 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1726 # Need to iterate DEC pcd information to get the value & datumtype
1727 for eachDec
in self
.PackageList
:
1728 for DecPcd
in eachDec
.Pcds
:
1729 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1730 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1731 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1732 # Print warning message to let the developer make a determine.
1733 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1734 File
=self
.MetaFile
, \
1735 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1736 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1738 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1739 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1740 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1741 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1742 # Only fix the value while no value provided in DSC file.
1743 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1744 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1746 if DscPcdEntry
not in self
._DynamicPcdList
:
1747 self
._DynamicPcdList
.append(DscPcdEntry
)
1748 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1749 PcdValue
= Sku
.DefaultValue
1751 PcdValue
= DscPcdEntry
.DefaultValue
1752 if Sku
.VpdOffset
!= '*':
1753 if PcdValue
.startswith("{"):
1755 elif PcdValue
.startswith("L"):
1760 VpdOffset
= int(Sku
.VpdOffset
)
1763 VpdOffset
= int(Sku
.VpdOffset
, 16)
1765 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1766 if VpdOffset
% Alignment
!= 0:
1767 if PcdValue
.startswith("{"):
1768 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1770 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1771 if PcdValue
not in SkuValueMap
:
1772 SkuValueMap
[PcdValue
] = []
1773 VpdFile
.Add(DscPcdEntry
, Sku
.VpdOffset
)
1774 SkuValueMap
[PcdValue
].append(Sku
)
1775 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1776 NeedProcessVpdMapFile
= True
1777 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1778 UnicodePcdArray
.append(DscPcdEntry
)
1779 elif len(Sku
.VariableName
) > 0:
1780 HiiPcdArray
.append(DscPcdEntry
)
1782 OtherPcdArray
.append(DscPcdEntry
)
1784 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1785 VpdSkuMap
[DscPcd
] = SkuValueMap
1786 if (self
.Platform
.FlashDefinition
== None or self
.Platform
.FlashDefinition
== '') and \
1787 VpdFile
.GetCount() != 0:
1788 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1789 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1791 if VpdFile
.GetCount() != 0:
1793 self
.FixVpdOffset(VpdFile
)
1795 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1797 # Process VPD map file generated by third party BPDG tool
1798 if NeedProcessVpdMapFile
:
1799 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1800 if os
.path
.exists(VpdMapFilePath
):
1801 VpdFile
.Read(VpdMapFilePath
)
1804 for pcd
in VpdSkuMap
:
1805 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1807 # just pick the a value to determine whether is unicode string type
1809 for pcdvalue
in VpdSkuMap
[pcd
]:
1810 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1811 for item
in vpdinfo
:
1812 if item
[2] == pcdvalue
:
1813 sku
.VpdOffset
= item
[1]
1815 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1817 # Delete the DynamicPcdList At the last time enter into this function
1818 for Pcd
in self
._DynamicPcdList
:
1819 # just pick the a value to determine whether is unicode string type
1820 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1821 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1823 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1824 Pcd
.DatumType
= "VOID*"
1826 PcdValue
= Sku
.DefaultValue
1827 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1828 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1829 UnicodePcdArray
.append(Pcd
)
1830 elif len(Sku
.VariableName
) > 0:
1831 # if found HII type PCD then insert to right of UnicodeIndex
1832 HiiPcdArray
.append(Pcd
)
1834 OtherPcdArray
.append(Pcd
)
1835 del self
._DynamicPcdList
[:]
1836 self
._DynamicPcdList
.extend(UnicodePcdArray
)
1837 self
._DynamicPcdList
.extend(HiiPcdArray
)
1838 self
._DynamicPcdList
.extend(OtherPcdArray
)
1839 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1840 for pcd
in self
._DynamicPcdList
:
1841 if len(pcd
.SkuInfoList
) == 1:
1842 for (SkuName
,SkuId
) in allskuset
:
1843 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1845 pcd
.SkuInfoList
[SkuName
] = pcd
.SkuInfoList
['DEFAULT']
1846 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1848 def FixVpdOffset(self
,VpdFile
):
1849 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1850 if not os
.path
.exists(FvPath
):
1854 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1856 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1858 if VpdFile
.Write(VpdFilePath
):
1859 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1861 for ToolDef
in self
.ToolDefinition
.values():
1862 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1863 if not ToolDef
.has_key("PATH"):
1864 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1865 BPDGToolName
= ToolDef
["PATH"]
1867 # Call third party GUID BPDG tool.
1868 if BPDGToolName
!= None:
1869 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1871 EdkLogger
.error("Build", FILE_NOT_FOUND
, "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1873 ## Return the platform build data object
1874 def _GetPlatform(self
):
1875 if self
._Platform
== None:
1876 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1877 return self
._Platform
1879 ## Return platform name
1881 return self
.Platform
.PlatformName
1883 ## Return the meta file GUID
1885 return self
.Platform
.Guid
1887 ## Return the platform version
1888 def _GetVersion(self
):
1889 return self
.Platform
.Version
1891 ## Return the FDF file name
1892 def _GetFdfFile(self
):
1893 if self
._FdfFile
== None:
1894 if self
.Workspace
.FdfFile
!= "":
1895 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1898 return self
._FdfFile
1900 ## Return the build output directory platform specifies
1901 def _GetOutputDir(self
):
1902 return self
.Platform
.OutputDirectory
1904 ## Return the directory to store all intermediate and final files built
1905 def _GetBuildDir(self
):
1906 if self
._BuildDir
== None:
1907 if os
.path
.isabs(self
.OutputDir
):
1908 self
._BuildDir
= path
.join(
1909 path
.abspath(self
.OutputDir
),
1910 self
.BuildTarget
+ "_" + self
.ToolChain
,
1913 self
._BuildDir
= path
.join(
1916 self
.BuildTarget
+ "_" + self
.ToolChain
,
1918 GlobalData
.gBuildDirectory
= self
._BuildDir
1919 return self
._BuildDir
1921 ## Return directory of platform makefile
1923 # @retval string Makefile directory
1925 def _GetMakeFileDir(self
):
1926 if self
._MakeFileDir
== None:
1927 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1928 return self
._MakeFileDir
1930 ## Return build command string
1932 # @retval string Build command string
1934 def _GetBuildCommand(self
):
1935 if self
._BuildCommand
== None:
1936 self
._BuildCommand
= []
1937 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1938 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1939 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1940 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1942 self
._BuildCommand
+= SplitOption(NewOption
)
1943 return self
._BuildCommand
1945 ## Get tool chain definition
1947 # Get each tool defition for given tool chain from tools_def.txt and platform
1949 def _GetToolDefinition(self
):
1950 if self
._ToolDefinitions
== None:
1951 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1952 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1953 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1954 ExtraData
="[%s]" % self
.MetaFile
)
1955 self
._ToolDefinitions
= {}
1957 for Def
in ToolDefinition
:
1958 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1959 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1962 Value
= ToolDefinition
[Def
]
1963 # don't record the DLL
1965 DllPathList
.add(Value
)
1968 if Tool
not in self
._ToolDefinitions
:
1969 self
._ToolDefinitions
[Tool
] = {}
1970 self
._ToolDefinitions
[Tool
][Attr
] = Value
1974 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1975 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1976 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1977 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1979 for Tool
in self
._ToolDefinitions
:
1980 for Attr
in self
._ToolDefinitions
[Tool
]:
1981 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1982 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1983 # check if override is indicated
1984 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1985 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1988 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1990 Value
= self
.BuildOption
[Tool
][Attr
]
1993 # Don't put MAKE definition in the file
1997 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1999 # Don't put MAKE definition in the file
2004 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
2007 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
2008 for DllPath
in DllPathList
:
2009 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
2010 os
.environ
["MAKE_FLAGS"] = MakeFlags
2012 return self
._ToolDefinitions
2014 ## Return the paths of tools
2015 def _GetToolDefFile(self
):
2016 if self
._ToolDefFile
== None:
2017 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
2018 return self
._ToolDefFile
2020 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
2021 def _GetToolChainFamily(self
):
2022 if self
._ToolChainFamily
== None:
2023 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
2024 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
2025 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
2026 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
2027 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2029 self
._ToolChainFamily
= "MSFT"
2031 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
2032 return self
._ToolChainFamily
2034 def _GetBuildRuleFamily(self
):
2035 if self
._BuildRuleFamily
== None:
2036 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
2037 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
2038 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
2039 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
2040 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2042 self
._BuildRuleFamily
= "MSFT"
2044 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
2045 return self
._BuildRuleFamily
2047 ## Return the build options specific for all modules in this platform
2048 def _GetBuildOptions(self
):
2049 if self
._BuildOption
== None:
2050 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
2051 return self
._BuildOption
2053 ## Return the build options specific for EDK modules in this platform
2054 def _GetEdkBuildOptions(self
):
2055 if self
._EdkBuildOption
== None:
2056 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
2057 return self
._EdkBuildOption
2059 ## Return the build options specific for EDKII modules in this platform
2060 def _GetEdkIIBuildOptions(self
):
2061 if self
._EdkIIBuildOption
== None:
2062 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
2063 return self
._EdkIIBuildOption
2065 ## Parse build_rule.txt in Conf Directory.
2067 # @retval BuildRule object
2069 def _GetBuildRule(self
):
2070 if self
._BuildRule
== None:
2071 BuildRuleFile
= None
2072 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2073 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2074 if BuildRuleFile
in [None, '']:
2075 BuildRuleFile
= gDefaultBuildRuleFile
2076 self
._BuildRule
= BuildRule(BuildRuleFile
)
2077 if self
._BuildRule
._FileVersion
== "":
2078 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2080 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2081 # If Build Rule's version is less than the version number required by the tools, halting the build.
2082 EdkLogger
.error("build", AUTOGEN_ERROR
,
2083 ExtraData
="The version number [%s] of build_rule.txt is less than the version number required by the AutoGen.(the minimum required version number is [%s])"\
2084 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2086 return self
._BuildRule
2088 ## Summarize the packages used by modules in this platform
2089 def _GetPackageList(self
):
2090 if self
._PackageList
== None:
2091 self
._PackageList
= set()
2092 for La
in self
.LibraryAutoGenList
:
2093 self
._PackageList
.update(La
.DependentPackageList
)
2094 for Ma
in self
.ModuleAutoGenList
:
2095 self
._PackageList
.update(Ma
.DependentPackageList
)
2096 #Collect package set information from INF of FDF
2098 for ModuleFile
in self
._AsBuildModuleList
:
2099 if ModuleFile
in self
.Platform
.Modules
:
2101 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2102 PkgSet
.update(ModuleData
.Packages
)
2103 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2104 return self
._PackageList
2106 def _GetNonDynamicPcdDict(self
):
2107 if self
._NonDynamicPcdDict
:
2108 return self
._NonDynamicPcdDict
2109 for Pcd
in self
.NonDynamicPcdList
:
2110 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2111 return self
._NonDynamicPcdDict
2113 ## Get list of non-dynamic PCDs
2114 def _GetNonDynamicPcdList(self
):
2115 if self
._NonDynamicPcdList
== None:
2116 self
.CollectPlatformDynamicPcds()
2117 return self
._NonDynamicPcdList
2119 ## Get list of dynamic PCDs
2120 def _GetDynamicPcdList(self
):
2121 if self
._DynamicPcdList
== None:
2122 self
.CollectPlatformDynamicPcds()
2123 return self
._DynamicPcdList
2125 ## Generate Token Number for all PCD
2126 def _GetPcdTokenNumbers(self
):
2127 if self
._PcdTokenNumber
== None:
2128 self
._PcdTokenNumber
= sdict()
2131 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2135 # TokenNumber 0 ~ 10
2137 # TokeNumber 11 ~ 20
2139 for Pcd
in self
.DynamicPcdList
:
2140 if Pcd
.Phase
== "PEI":
2141 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2142 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2143 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2146 for Pcd
in self
.DynamicPcdList
:
2147 if Pcd
.Phase
== "PEI":
2148 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2149 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2150 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2153 for Pcd
in self
.DynamicPcdList
:
2154 if Pcd
.Phase
== "DXE":
2155 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2156 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2157 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2160 for Pcd
in self
.DynamicPcdList
:
2161 if Pcd
.Phase
== "DXE":
2162 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2163 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2164 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2167 for Pcd
in self
.NonDynamicPcdList
:
2168 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2170 return self
._PcdTokenNumber
2172 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2173 def _GetAutoGenObjectList(self
):
2174 self
._ModuleAutoGenList
= []
2175 self
._LibraryAutoGenList
= []
2176 for ModuleFile
in self
.Platform
.Modules
:
2185 if Ma
not in self
._ModuleAutoGenList
:
2186 self
._ModuleAutoGenList
.append(Ma
)
2187 for La
in Ma
.LibraryAutoGenList
:
2188 if La
not in self
._LibraryAutoGenList
:
2189 self
._LibraryAutoGenList
.append(La
)
2190 if Ma
not in La
._ReferenceModules
:
2191 La
._ReferenceModules
.append(Ma
)
2193 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2194 def _GetModuleAutoGenList(self
):
2195 if self
._ModuleAutoGenList
== None:
2196 self
._GetAutoGenObjectList
()
2197 return self
._ModuleAutoGenList
2199 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2200 def _GetLibraryAutoGenList(self
):
2201 if self
._LibraryAutoGenList
== None:
2202 self
._GetAutoGenObjectList
()
2203 return self
._LibraryAutoGenList
2205 ## Test if a module is supported by the platform
2207 # An error will be raised directly if the module or its arch is not supported
2208 # by the platform or current configuration
2210 def ValidModule(self
, Module
):
2211 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2212 or Module
in self
._AsBuildModuleList
2214 ## Resolve the library classes in a module to library instances
2216 # This method will not only resolve library classes but also sort the library
2217 # instances according to the dependency-ship.
2219 # @param Module The module from which the library classes will be resolved
2221 # @retval library_list List of library instances sorted
2223 def ApplyLibraryInstance(self
, Module
):
2224 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2225 if str(Module
) not in self
.Platform
.Modules
:
2228 ModuleType
= Module
.ModuleType
2230 # for overridding library instances with module specific setting
2231 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2233 # add forced library instances (specified under LibraryClasses sections)
2235 # If a module has a MODULE_TYPE of USER_DEFINED,
2236 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2238 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2239 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2240 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2241 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2243 # add forced library instances (specified in module overrides)
2244 for LibraryClass
in PlatformModule
.LibraryClasses
:
2245 if LibraryClass
.startswith("NULL"):
2246 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2249 LibraryConsumerList
= [Module
]
2251 ConsumedByList
= sdict()
2252 LibraryInstance
= sdict()
2254 EdkLogger
.verbose("")
2255 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2256 while len(LibraryConsumerList
) > 0:
2257 M
= LibraryConsumerList
.pop()
2258 for LibraryClassName
in M
.LibraryClasses
:
2259 if LibraryClassName
not in LibraryInstance
:
2260 # override library instance for this module
2261 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2262 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2264 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2265 if LibraryPath
== None or LibraryPath
== "":
2266 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2267 if LibraryPath
== None or LibraryPath
== "":
2268 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2269 "Instance of library class [%s] is not found" % LibraryClassName
,
2271 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2273 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2274 # for those forced library instance (NULL library), add a fake library class
2275 if LibraryClassName
.startswith("NULL"):
2276 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2277 elif LibraryModule
.LibraryClass
== None \
2278 or len(LibraryModule
.LibraryClass
) == 0 \
2279 or (ModuleType
!= 'USER_DEFINED'
2280 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2281 # only USER_DEFINED can link against any library instance despite of its SupModList
2282 EdkLogger
.error("build", OPTION_MISSING
,
2283 "Module type [%s] is not supported by library instance [%s]" \
2284 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2285 ExtraData
="consumed by [%s]" % str(Module
))
2287 LibraryInstance
[LibraryClassName
] = LibraryModule
2288 LibraryConsumerList
.append(LibraryModule
)
2289 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2291 LibraryModule
= LibraryInstance
[LibraryClassName
]
2293 if LibraryModule
== None:
2296 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2297 Constructor
.append(LibraryModule
)
2299 if LibraryModule
not in ConsumedByList
:
2300 ConsumedByList
[LibraryModule
] = []
2301 # don't add current module itself to consumer list
2303 if M
in ConsumedByList
[LibraryModule
]:
2305 ConsumedByList
[LibraryModule
].append(M
)
2307 # Initialize the sorted output list to the empty set
2309 SortedLibraryList
= []
2311 # Q <- Set of all nodes with no incoming edges
2313 LibraryList
= [] #LibraryInstance.values()
2315 for LibraryClassName
in LibraryInstance
:
2316 M
= LibraryInstance
[LibraryClassName
]
2317 LibraryList
.append(M
)
2318 if ConsumedByList
[M
] == []:
2322 # start the DAG algorithm
2326 while Q
== [] and EdgeRemoved
:
2328 # for each node Item with a Constructor
2329 for Item
in LibraryList
:
2330 if Item
not in Constructor
:
2332 # for each Node without a constructor with an edge e from Item to Node
2333 for Node
in ConsumedByList
[Item
]:
2334 if Node
in Constructor
:
2336 # remove edge e from the graph if Node has no constructor
2337 ConsumedByList
[Item
].remove(Node
)
2339 if ConsumedByList
[Item
] == []:
2340 # insert Item into Q
2345 # DAG is done if there's no more incoming edge for all nodes
2349 # remove node from Q
2352 SortedLibraryList
.append(Node
)
2354 # for each node Item with an edge e from Node to Item do
2355 for Item
in LibraryList
:
2356 if Node
not in ConsumedByList
[Item
]:
2358 # remove edge e from the graph
2359 ConsumedByList
[Item
].remove(Node
)
2361 if ConsumedByList
[Item
] != []:
2363 # insert Item into Q, if Item has no other incoming edges
2367 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2369 for Item
in LibraryList
:
2370 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2371 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2372 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2373 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2374 if Item
not in SortedLibraryList
:
2375 SortedLibraryList
.append(Item
)
2378 # Build the list of constructor and destructir names
2379 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2381 SortedLibraryList
.reverse()
2382 return SortedLibraryList
2385 ## Override PCD setting (type, value, ...)
2387 # @param ToPcd The PCD to be overrided
2388 # @param FromPcd The PCD overrideing from
2390 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2392 # in case there's PCDs coming from FDF file, which have no type given.
2393 # at this point, ToPcd.Type has the type found from dependent
2396 TokenCName
= ToPcd
.TokenCName
2397 for PcdItem
in GlobalData
.MixedPcd
:
2398 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2399 TokenCName
= PcdItem
[0]
2402 if GlobalData
.BuildOptionPcd
:
2403 for pcd
in GlobalData
.BuildOptionPcd
:
2404 if (FromPcd
.TokenSpaceGuidCName
, FromPcd
.TokenCName
) == (pcd
[0], pcd
[1]):
2405 FromPcd
.DefaultValue
= pcd
[2]
2407 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2408 ToPcd
.Type
= FromPcd
.Type
2409 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2410 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2411 if ToPcd
.Type
.strip() == "DynamicEx":
2412 ToPcd
.Type
= FromPcd
.Type
2413 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2414 and ToPcd
.Type
!= FromPcd
.Type
:
2415 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2416 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2417 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2418 ToPcd
.Type
, Module
, FromPcd
.Type
),
2421 if FromPcd
.MaxDatumSize
not in [None, '']:
2422 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2423 if FromPcd
.DefaultValue
not in [None, '']:
2424 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2425 if FromPcd
.TokenValue
not in [None, '']:
2426 ToPcd
.TokenValue
= FromPcd
.TokenValue
2427 if FromPcd
.MaxDatumSize
not in [None, '']:
2428 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2429 if FromPcd
.DatumType
not in [None, '']:
2430 ToPcd
.DatumType
= FromPcd
.DatumType
2431 if FromPcd
.SkuInfoList
not in [None, '', []]:
2432 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2434 # check the validation of datum
2435 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2437 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2438 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2439 ToPcd
.validateranges
= FromPcd
.validateranges
2440 ToPcd
.validlists
= FromPcd
.validlists
2441 ToPcd
.expressions
= FromPcd
.expressions
2443 if ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2444 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2445 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2446 Value
= ToPcd
.DefaultValue
2447 if Value
in [None, '']:
2448 ToPcd
.MaxDatumSize
= '1'
2449 elif Value
[0] == 'L':
2450 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2451 elif Value
[0] == '{':
2452 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2454 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2456 # apply default SKU for dynamic PCDS if specified one is not available
2457 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2458 and ToPcd
.SkuInfoList
in [None, {}, '']:
2459 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2460 SkuName
= self
.Platform
.SkuName
2463 ToPcd
.SkuInfoList
= {
2464 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2467 ## Apply PCD setting defined platform to a module
2469 # @param Module The module from which the PCD setting will be overrided
2471 # @retval PCD_list The list PCDs with settings from platform
2473 def ApplyPcdSetting(self
, Module
, Pcds
):
2474 # for each PCD in module
2475 for Name
, Guid
in Pcds
:
2476 PcdInModule
= Pcds
[Name
, Guid
]
2477 # find out the PCD setting in platform
2478 if (Name
, Guid
) in self
.Platform
.Pcds
:
2479 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2481 PcdInPlatform
= None
2482 # then override the settings if any
2483 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2484 # resolve the VariableGuid value
2485 for SkuId
in PcdInModule
.SkuInfoList
:
2486 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2487 if Sku
.VariableGuid
== '': continue
2488 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2489 if Sku
.VariableGuidValue
== None:
2490 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2493 RESOURCE_NOT_AVAILABLE
,
2494 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2495 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2496 % (Guid
, Name
, str(Module
)),
2500 # override PCD settings with module specific setting
2501 if Module
in self
.Platform
.Modules
:
2502 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2503 for Key
in PlatformModule
.Pcds
:
2508 elif Key
in GlobalData
.MixedPcd
:
2509 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2511 ToPcd
= Pcds
[PcdItem
]
2515 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2516 return Pcds
.values()
2518 ## Resolve library names to library modules
2520 # (for Edk.x modules)
2522 # @param Module The module from which the library names will be resolved
2524 # @retval library_list The list of library modules
2526 def ResolveLibraryReference(self
, Module
):
2527 EdkLogger
.verbose("")
2528 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2529 LibraryConsumerList
= [Module
]
2531 # "CompilerStub" is a must for Edk modules
2532 if Module
.Libraries
:
2533 Module
.Libraries
.append("CompilerStub")
2535 while len(LibraryConsumerList
) > 0:
2536 M
= LibraryConsumerList
.pop()
2537 for LibraryName
in M
.Libraries
:
2538 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2540 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2541 if LibraryName
.upper() == Key
.upper():
2542 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2545 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2546 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2549 if Library
not in LibraryList
:
2550 LibraryList
.append(Library
)
2551 LibraryConsumerList
.append(Library
)
2552 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2555 ## Calculate the priority value of the build option
2557 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2559 # @retval Value Priority value based on the priority list.
2561 def CalculatePriorityValue(self
, Key
):
2562 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2563 PriorityValue
= 0x11111
2565 PriorityValue
&= 0x01111
2566 if ToolChain
== "*":
2567 PriorityValue
&= 0x10111
2569 PriorityValue
&= 0x11011
2570 if CommandType
== "*":
2571 PriorityValue
&= 0x11101
2573 PriorityValue
&= 0x11110
2575 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2578 ## Expand * in build option key
2580 # @param Options Options to be expanded
2582 # @retval options Options expanded
2584 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2591 # Construct a list contain the build options which need override.
2595 # Key[0] -- tool family
2596 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2598 if (Key
[0] == self
.BuildRuleFamily
and
2599 (ModuleStyle
== None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2600 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2601 if Target
== self
.BuildTarget
or Target
== "*":
2602 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2603 if Arch
== self
.Arch
or Arch
== "*":
2604 if Options
[Key
].startswith("="):
2605 if OverrideList
.get(Key
[1]) != None:
2606 OverrideList
.pop(Key
[1])
2607 OverrideList
[Key
[1]] = Options
[Key
]
2610 # Use the highest priority value.
2612 if (len(OverrideList
) >= 2):
2613 KeyList
= OverrideList
.keys()
2614 for Index
in range(len(KeyList
)):
2615 NowKey
= KeyList
[Index
]
2616 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2617 for Index1
in range(len(KeyList
) - Index
- 1):
2618 NextKey
= KeyList
[Index1
+ Index
+ 1]
2620 # Compare two Key, if one is included by another, choose the higher priority one
2622 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2623 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2624 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2625 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2626 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2627 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2628 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2629 if Options
.get((self
.BuildRuleFamily
, NextKey
)) != None:
2630 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2632 if Options
.get((self
.BuildRuleFamily
, NowKey
)) != None:
2633 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2636 if ModuleStyle
!= None and len (Key
) > 2:
2637 # Check Module style is EDK or EDKII.
2638 # Only append build option for the matched style module.
2639 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2641 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2644 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2645 # if tool chain family doesn't match, skip it
2646 if Tool
in self
.ToolDefinition
and Family
!= "":
2647 FamilyIsNull
= False
2648 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2649 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2651 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2654 # expand any wildcard
2655 if Target
== "*" or Target
== self
.BuildTarget
:
2656 if Tag
== "*" or Tag
== self
.ToolChain
:
2657 if Arch
== "*" or Arch
== self
.Arch
:
2658 if Tool
not in BuildOptions
:
2659 BuildOptions
[Tool
] = {}
2660 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2661 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2663 # append options for the same tool except PATH
2665 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2667 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2668 # Build Option Family has been checked, which need't to be checked again for family.
2669 if FamilyMatch
or FamilyIsNull
:
2673 if ModuleStyle
!= None and len (Key
) > 2:
2674 # Check Module style is EDK or EDKII.
2675 # Only append build option for the matched style module.
2676 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2678 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2681 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2682 # if tool chain family doesn't match, skip it
2683 if Tool
not in self
.ToolDefinition
or Family
== "":
2685 # option has been added before
2686 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2689 # expand any wildcard
2690 if Target
== "*" or Target
== self
.BuildTarget
:
2691 if Tag
== "*" or Tag
== self
.ToolChain
:
2692 if Arch
== "*" or Arch
== self
.Arch
:
2693 if Tool
not in BuildOptions
:
2694 BuildOptions
[Tool
] = {}
2695 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2696 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2698 # append options for the same tool except PATH
2700 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2702 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2705 ## Append build options in platform to a module
2707 # @param Module The module to which the build options will be appened
2709 # @retval options The options appended with build options in platform
2711 def ApplyBuildOption(self
, Module
):
2712 # Get the different options for the different style module
2713 if Module
.AutoGenVersion
< 0x00010005:
2714 PlatformOptions
= self
.EdkBuildOption
2715 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2717 PlatformOptions
= self
.EdkIIBuildOption
2718 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2719 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2720 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2721 if Module
in self
.Platform
.Modules
:
2722 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2723 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2725 PlatformModuleOptions
= {}
2727 BuildRuleOrder
= None
2728 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2729 for Tool
in Options
:
2730 for Attr
in Options
[Tool
]:
2731 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2732 BuildRuleOrder
= Options
[Tool
][Attr
]
2734 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2735 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2736 self
.ToolDefinition
.keys())
2738 for Tool
in AllTools
:
2739 if Tool
not in BuildOptions
:
2740 BuildOptions
[Tool
] = {}
2742 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2743 if Tool
not in Options
:
2745 for Attr
in Options
[Tool
]:
2746 Value
= Options
[Tool
][Attr
]
2748 # Do not generate it in Makefile
2750 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2752 if Attr
not in BuildOptions
[Tool
]:
2753 BuildOptions
[Tool
][Attr
] = ""
2754 # check if override is indicated
2755 if Value
.startswith('='):
2756 ToolPath
= Value
[1:]
2757 ToolPath
= mws
.handleWsMacro(ToolPath
)
2758 BuildOptions
[Tool
][Attr
] = ToolPath
2760 Value
= mws
.handleWsMacro(Value
)
2762 BuildOptions
[Tool
][Attr
] += " " + Value
2764 BuildOptions
[Tool
][Attr
] = Value
2765 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
!= None:
2767 # Override UNI flag only for EDK module.
2769 if 'BUILD' not in BuildOptions
:
2770 BuildOptions
['BUILD'] = {}
2771 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2772 return BuildOptions
, BuildRuleOrder
2774 Platform
= property(_GetPlatform
)
2775 Name
= property(_GetName
)
2776 Guid
= property(_GetGuid
)
2777 Version
= property(_GetVersion
)
2779 OutputDir
= property(_GetOutputDir
)
2780 BuildDir
= property(_GetBuildDir
)
2781 MakeFileDir
= property(_GetMakeFileDir
)
2782 FdfFile
= property(_GetFdfFile
)
2784 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2785 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2786 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2787 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2788 PackageList
= property(_GetPackageList
)
2790 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2791 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2792 ToolChainFamily
= property(_GetToolChainFamily
)
2793 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2794 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2795 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2796 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2798 BuildCommand
= property(_GetBuildCommand
)
2799 BuildRule
= property(_GetBuildRule
)
2800 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2801 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2802 GenFdsCommand
= property(_GenFdsCommand
)
2804 ## ModuleAutoGen class
2806 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2807 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2808 # to the [depex] section in module's inf file.
2810 class ModuleAutoGen(AutoGen
):
2811 ## Cache the timestamps of metafiles of every module in a class variable
2815 ## The real constructor of ModuleAutoGen
2817 # This method is not supposed to be called by users of ModuleAutoGen. It's
2818 # only used by factory method __new__() to do real initialization work for an
2819 # object of ModuleAutoGen
2821 # @param Workspace EdkIIWorkspaceBuild object
2822 # @param ModuleFile The path of module file
2823 # @param Target Build target (DEBUG, RELEASE)
2824 # @param Toolchain Name of tool chain
2825 # @param Arch The arch the module supports
2826 # @param PlatformFile Platform meta-file
2828 def _Init(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2829 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2830 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2832 self
.Workspace
= Workspace
2833 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2835 self
.MetaFile
= ModuleFile
2836 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2837 # check if this module is employed by active platform
2838 if not self
.PlatformInfo
.ValidModule(self
.MetaFile
):
2839 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2840 % (self
.MetaFile
, Arch
))
2843 self
.SourceDir
= self
.MetaFile
.SubDir
2844 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2846 self
.SourceOverrideDir
= None
2847 # use overrided path defined in DSC file
2848 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2849 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2851 self
.ToolChain
= Toolchain
2852 self
.BuildTarget
= Target
2854 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2855 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2857 self
.IsMakeFileCreated
= False
2858 self
.IsCodeFileCreated
= False
2859 self
.IsAsBuiltInfCreated
= False
2860 self
.DepexGenerated
= False
2862 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2863 self
.BuildRuleOrder
= None
2869 self
._Version
= None
2870 self
._ModuleType
= None
2871 self
._ComponentType
= None
2872 self
._PcdIsDriver
= None
2873 self
._AutoGenVersion
= None
2874 self
._LibraryFlag
= None
2875 self
._CustomMakefile
= None
2878 self
._BuildDir
= None
2879 self
._OutputDir
= None
2880 self
._FfsOutputDir
= None
2881 self
._DebugDir
= None
2882 self
._MakeFileDir
= None
2884 self
._IncludePathList
= None
2885 self
._IncludePathLength
= 0
2886 self
._AutoGenFileList
= None
2887 self
._UnicodeFileList
= None
2888 self
._VfrFileList
= None
2889 self
._IdfFileList
= None
2890 self
._SourceFileList
= None
2891 self
._ObjectFileList
= None
2892 self
._BinaryFileList
= None
2894 self
._DependentPackageList
= None
2895 self
._DependentLibraryList
= None
2896 self
._LibraryAutoGenList
= None
2897 self
._DerivedPackageList
= None
2898 self
._ModulePcdList
= None
2899 self
._LibraryPcdList
= None
2900 self
._PcdComments
= sdict()
2901 self
._GuidList
= None
2902 self
._GuidsUsedByPcd
= None
2903 self
._GuidComments
= sdict()
2904 self
._ProtocolList
= None
2905 self
._ProtocolComments
= sdict()
2906 self
._PpiList
= None
2907 self
._PpiComments
= sdict()
2908 self
._DepexList
= None
2909 self
._DepexExpressionList
= None
2910 self
._BuildOption
= None
2911 self
._BuildOptionIncPathList
= None
2912 self
._BuildTargets
= None
2913 self
._IntroBuildTargetList
= None
2914 self
._FinalBuildTargetList
= None
2915 self
._FileTypes
= None
2916 self
._BuildRules
= None
2918 self
._TimeStampPath
= None
2920 self
.AutoGenDepSet
= set()
2923 ## The Modules referenced to this Library
2924 # Only Library has this attribute
2925 self
._ReferenceModules
= []
2927 ## Store the FixedAtBuild Pcds
2929 self
._FixedAtBuildPcds
= []
2934 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2936 # Get FixedAtBuild Pcds of this Module
2937 def _GetFixedAtBuildPcds(self
):
2938 if self
._FixedAtBuildPcds
:
2939 return self
._FixedAtBuildPcds
2940 for Pcd
in self
.ModulePcdList
:
2941 if Pcd
.Type
!= "FixedAtBuild":
2943 if Pcd
not in self
._FixedAtBuildPcds
:
2944 self
._FixedAtBuildPcds
.append(Pcd
)
2946 return self
._FixedAtBuildPcds
2948 def _GetUniqueBaseName(self
):
2949 BaseName
= self
.Name
2950 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2951 if Module
.MetaFile
== self
.MetaFile
:
2953 if Module
.Name
== self
.Name
:
2954 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2955 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2956 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2957 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2960 # Macros could be used in build_rule.txt (also Makefile)
2961 def _GetMacros(self
):
2962 if self
._Macro
== None:
2963 self
._Macro
= sdict()
2964 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2965 self
._Macro
["MODULE_NAME" ] = self
.Name
2966 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2967 self
._Macro
["MODULE_GUID" ] = self
.Guid
2968 self
._Macro
["MODULE_VERSION" ] = self
.Version
2969 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2970 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2971 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2972 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2973 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2975 self
._Macro
["BASE_NAME" ] = self
.Name
2977 self
._Macro
["ARCH" ] = self
.Arch
2978 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2979 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2980 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2981 self
._Macro
["TARGET" ] = self
.BuildTarget
2983 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2984 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2985 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2986 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2987 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2988 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2989 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2990 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2991 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2992 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2993 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2994 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2995 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2996 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2997 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
3000 ## Return the module build data object
3001 def _GetModule(self
):
3002 if self
._Module
== None:
3003 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
3006 ## Return the module name
3007 def _GetBaseName(self
):
3008 return self
.Module
.BaseName
3010 ## Return the module DxsFile if exist
3011 def _GetDxsFile(self
):
3012 return self
.Module
.DxsFile
3014 ## Return the module SourceOverridePath
3015 def _GetSourceOverridePath(self
):
3016 return self
.Module
.SourceOverridePath
3018 ## Return the module meta-file GUID
3021 # To build same module more than once, the module path with FILE_GUID overridden has
3022 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3023 # in DSC. The overridden GUID can be retrieved from file name
3025 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
3027 # Length of GUID is 36
3029 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
3030 return self
.Module
.Guid
3032 ## Return the module version
3033 def _GetVersion(self
):
3034 return self
.Module
.Version
3036 ## Return the module type
3037 def _GetModuleType(self
):
3038 return self
.Module
.ModuleType
3040 ## Return the component type (for Edk.x style of module)
3041 def _GetComponentType(self
):
3042 return self
.Module
.ComponentType
3044 ## Return the build type
3045 def _GetBuildType(self
):
3046 return self
.Module
.BuildType
3048 ## Return the PCD_IS_DRIVER setting
3049 def _GetPcdIsDriver(self
):
3050 return self
.Module
.PcdIsDriver
3052 ## Return the autogen version, i.e. module meta-file version
3053 def _GetAutoGenVersion(self
):
3054 return self
.Module
.AutoGenVersion
3056 ## Check if the module is library or not
3057 def _IsLibrary(self
):
3058 if self
._LibraryFlag
== None:
3059 if self
.Module
.LibraryClass
!= None and self
.Module
.LibraryClass
!= []:
3060 self
._LibraryFlag
= True
3062 self
._LibraryFlag
= False
3063 return self
._LibraryFlag
3065 ## Check if the module is binary module or not
3066 def _IsBinaryModule(self
):
3067 return self
.Module
.IsBinaryModule
3069 ## Return the directory to store intermediate files of the module
3070 def _GetBuildDir(self
):
3071 if self
._BuildDir
== None:
3072 self
._BuildDir
= path
.join(
3073 self
.PlatformInfo
.BuildDir
,
3076 self
.MetaFile
.BaseName
3078 CreateDirectory(self
._BuildDir
)
3079 return self
._BuildDir
3081 ## Return the directory to store the intermediate object files of the mdoule
3082 def _GetOutputDir(self
):
3083 if self
._OutputDir
== None:
3084 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3085 CreateDirectory(self
._OutputDir
)
3086 return self
._OutputDir
3088 ## Return the directory to store ffs file
3089 def _GetFfsOutputDir(self
):
3090 if self
._FfsOutputDir
== None:
3091 if GlobalData
.gFdfParser
!= None:
3092 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3094 self
._FfsOutputDir
= ''
3095 return self
._FfsOutputDir
3097 ## Return the directory to store auto-gened source files of the mdoule
3098 def _GetDebugDir(self
):
3099 if self
._DebugDir
== None:
3100 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3101 CreateDirectory(self
._DebugDir
)
3102 return self
._DebugDir
3104 ## Return the path of custom file
3105 def _GetCustomMakefile(self
):
3106 if self
._CustomMakefile
== None:
3107 self
._CustomMakefile
= {}
3108 for Type
in self
.Module
.CustomMakefile
:
3109 if Type
in gMakeTypeMap
:
3110 MakeType
= gMakeTypeMap
[Type
]
3113 if self
.SourceOverrideDir
!= None:
3114 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3115 if not os
.path
.exists(File
):
3116 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3118 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3119 self
._CustomMakefile
[MakeType
] = File
3120 return self
._CustomMakefile
3122 ## Return the directory of the makefile
3124 # @retval string The directory string of module's makefile
3126 def _GetMakeFileDir(self
):
3127 return self
.BuildDir
3129 ## Return build command string
3131 # @retval string Build command string
3133 def _GetBuildCommand(self
):
3134 return self
.PlatformInfo
.BuildCommand
3136 ## Get object list of all packages the module and its dependent libraries belong to
3138 # @retval list The list of package object
3140 def _GetDerivedPackageList(self
):
3142 for M
in [self
.Module
] + self
.DependentLibraryList
:
3143 for Package
in M
.Packages
:
3144 if Package
in PackageList
:
3146 PackageList
.append(Package
)
3149 ## Get the depex string
3151 # @return : a string contain all depex expresion.
3152 def _GetDepexExpresionString(self
):
3155 ## DPX_SOURCE IN Define section.
3156 if self
.Module
.DxsFile
:
3158 for M
in [self
.Module
] + self
.DependentLibraryList
:
3159 Filename
= M
.MetaFile
.Path
3160 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3161 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3162 for DepexExpresion
in DepexExpresionList
:
3163 for key
in DepexExpresion
.keys():
3164 Arch
, ModuleType
= key
3165 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3166 # the type of build module is USER_DEFINED.
3167 # All different DEPEX section tags would be copied into the As Built INF file
3168 # and there would be separate DEPEX section tags
3169 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3170 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3171 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3173 if Arch
.upper() == TAB_ARCH_COMMON
or \
3174 (Arch
.upper() == self
.Arch
.upper() and \
3175 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3176 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3178 #the type of build module is USER_DEFINED.
3179 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3180 for Depex
in DepexList
:
3181 for key
in Depex
.keys():
3182 DepexStr
+= '[Depex.%s.%s]\n' % key
3183 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3186 return '[Depex.%s]\n' % self
.Arch
3189 #the type of build module not is USER_DEFINED.
3191 for Depex
in DepexList
:
3196 for D
in Depex
.values():
3197 DepexStr
+= ' '.join([val
for val
in D
])
3198 Index
= DepexStr
.find('END')
3199 if Index
> -1 and Index
== len(DepexStr
) - 3:
3200 DepexStr
= DepexStr
[:-3]
3201 DepexStr
= DepexStr
.strip()
3204 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3206 return '[Depex.%s]\n' % self
.Arch
3207 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3209 ## Merge dependency expression
3211 # @retval list The token list of the dependency expression after parsed
3213 def _GetDepexTokenList(self
):
3214 if self
._DepexList
== None:
3215 self
._DepexList
= {}
3216 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3217 return self
._DepexList
3219 self
._DepexList
[self
.ModuleType
] = []
3221 for ModuleType
in self
._DepexList
:
3222 DepexList
= self
._DepexList
[ModuleType
]
3224 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3226 for M
in [self
.Module
] + self
.DependentLibraryList
:
3228 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3230 DepexList
.append('AND')
3231 DepexList
.append('(')
3233 if DepexList
[-1] == 'END': # no need of a END at this time
3235 DepexList
.append(')')
3238 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3239 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3241 if len(DepexList
) > 0:
3242 EdkLogger
.verbose('')
3243 return self
._DepexList
3245 ## Merge dependency expression
3247 # @retval list The token list of the dependency expression after parsed
3249 def _GetDepexExpressionTokenList(self
):
3250 if self
._DepexExpressionList
== None:
3251 self
._DepexExpressionList
= {}
3252 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3253 return self
._DepexExpressionList
3255 self
._DepexExpressionList
[self
.ModuleType
] = ''
3257 for ModuleType
in self
._DepexExpressionList
:
3258 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3260 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3262 for M
in [self
.Module
] + self
.DependentLibraryList
:
3264 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3265 if DepexExpressionList
!= '':
3266 DepexExpressionList
+= ' AND '
3267 DepexExpressionList
+= '('
3268 DepexExpressionList
+= D
3269 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3270 DepexExpressionList
+= ')'
3273 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3274 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3276 if len(DepexExpressionList
) > 0:
3277 EdkLogger
.verbose('')
3278 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3279 return self
._DepexExpressionList
3281 # Get the tiano core user extension, it is contain dependent library.
3282 # @retval: a list contain tiano core userextension.
3284 def _GetTianoCoreUserExtensionList(self
):
3285 TianoCoreUserExtentionList
= []
3286 for M
in [self
.Module
] + self
.DependentLibraryList
:
3287 Filename
= M
.MetaFile
.Path
3288 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3289 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3290 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3291 for Section
in TianoCoreUserExtent
.keys():
3292 ItemList
= Section
.split(TAB_SPLIT
)
3294 if len(ItemList
) == 4:
3296 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3298 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3299 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3300 TianoCoreList
.append('\n')
3301 TianoCoreUserExtentionList
.append(TianoCoreList
)
3303 return TianoCoreUserExtentionList
3305 ## Return the list of specification version required for the module
3307 # @retval list The list of specification defined in module file
3309 def _GetSpecification(self
):
3310 return self
.Module
.Specification
3312 ## Tool option for the module build
3314 # @param PlatformInfo The object of PlatformBuildInfo
3315 # @retval dict The dict containing valid options
3317 def _GetModuleBuildOption(self
):
3318 if self
._BuildOption
== None:
3319 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3320 if self
.BuildRuleOrder
:
3321 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3322 return self
._BuildOption
3324 ## Get include path list from tool option for the module build
3326 # @retval list The include path list
3328 def _GetBuildOptionIncPathList(self
):
3329 if self
._BuildOptionIncPathList
== None:
3331 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3332 # is the former use /I , the Latter used -I to specify include directories
3334 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3335 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3336 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3337 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3340 # New ToolChainFamily, don't known whether there is option to specify include directories
3342 self
._BuildOptionIncPathList
= []
3343 return self
._BuildOptionIncPathList
3345 BuildOptionIncPathList
= []
3346 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3349 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3353 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3354 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in gBuildOptIncludePattern
.findall(FlagOption
)]
3357 # RVCT may specify a list of directory seperated by commas
3360 for Path
in gBuildOptIncludePattern
.findall(FlagOption
):
3361 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3362 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3365 # EDK II modules must not reference header files outside of the packages they depend on or
3366 # within the module's directory tree. Report error if violation.
3368 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3369 for Path
in IncPathList
:
3370 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3371 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3372 EdkLogger
.error("build",
3375 File
=str(self
.MetaFile
))
3378 BuildOptionIncPathList
+= IncPathList
3380 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3382 return self
._BuildOptionIncPathList
3384 ## Return a list of files which can be built from source
3386 # What kind of files can be built is determined by build rules in
3387 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3389 def _GetSourceFileList(self
):
3390 if self
._SourceFileList
== None:
3391 self
._SourceFileList
= []
3392 for F
in self
.Module
.Sources
:
3394 if F
.TagName
not in ("", "*", self
.ToolChain
):
3395 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3396 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3398 # match tool chain family or build rule family
3399 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3402 "The file [%s] must be built by tools of [%s], " \
3403 "but current toolchain family is [%s], buildrule family is [%s]" \
3404 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3407 # add the file path into search path list for file including
3408 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3409 self
.IncludePathList
.insert(0, F
.Dir
)
3410 self
._SourceFileList
.append(F
)
3412 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3414 for F
in self
._SourceFileList
:
3415 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3416 return self
._SourceFileList
3418 def _MatchBuildRuleOrder(self
, FileList
):
3420 self
._GetModuleBuildOption
()
3421 for SingleFile
in FileList
:
3422 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3423 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3424 if key
in Order_Dict
:
3425 Order_Dict
[key
].append(SingleFile
.Ext
)
3427 Order_Dict
[key
] = [SingleFile
.Ext
]
3430 for F
in Order_Dict
:
3431 if len(Order_Dict
[F
]) > 1:
3432 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3433 for Ext
in Order_Dict
[F
][1:]:
3434 RemoveList
.append(F
+ Ext
)
3436 for item
in RemoveList
:
3437 FileList
.remove(item
)
3441 ## Return the list of unicode files
3442 def _GetUnicodeFileList(self
):
3443 if self
._UnicodeFileList
== None:
3444 if TAB_UNICODE_FILE
in self
.FileTypes
:
3445 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3447 self
._UnicodeFileList
= []
3448 return self
._UnicodeFileList
3450 ## Return the list of vfr files
3451 def _GetVfrFileList(self
):
3452 if self
._VfrFileList
== None:
3453 if TAB_VFR_FILE
in self
.FileTypes
:
3454 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3456 self
._VfrFileList
= []
3457 return self
._VfrFileList
3459 ## Return the list of Image Definition files
3460 def _GetIdfFileList(self
):
3461 if self
._IdfFileList
== None:
3462 if TAB_IMAGE_FILE
in self
.FileTypes
:
3463 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3465 self
._IdfFileList
= []
3466 return self
._IdfFileList
3468 ## Return a list of files which can be built from binary
3470 # "Build" binary files are just to copy them to build directory.
3472 # @retval list The list of files which can be built later
3474 def _GetBinaryFiles(self
):
3475 if self
._BinaryFileList
== None:
3476 self
._BinaryFileList
= []
3477 for F
in self
.Module
.Binaries
:
3478 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3480 self
._BinaryFileList
.append(F
)
3481 self
._ApplyBuildRule
(F
, F
.Type
)
3482 return self
._BinaryFileList
3484 def _GetBuildRules(self
):
3485 if self
._BuildRules
== None:
3487 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3488 for Type
in BuildRuleDatabase
.FileTypeList
:
3489 #first try getting build rule by BuildRuleFamily
3490 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3492 # build type is always module type, but ...
3493 if self
.ModuleType
!= self
.BuildType
:
3494 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3495 #second try getting build rule by ToolChainFamily
3497 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3499 # build type is always module type, but ...
3500 if self
.ModuleType
!= self
.BuildType
:
3501 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3504 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3505 BuildRules
[Type
] = RuleObject
3506 for Ext
in RuleObject
.SourceFileExtList
:
3507 BuildRules
[Ext
] = RuleObject
3508 self
._BuildRules
= BuildRules
3509 return self
._BuildRules
3511 def _ApplyBuildRule(self
, File
, FileType
):
3512 if self
._BuildTargets
== None:
3513 self
._IntroBuildTargetList
= set()
3514 self
._FinalBuildTargetList
= set()
3515 self
._BuildTargets
= {}
3516 self
._FileTypes
= {}
3518 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3519 if not os
.path
.exists(SubDirectory
):
3520 CreateDirectory(SubDirectory
)
3526 # Make sure to get build rule order value
3528 self
._GetModuleBuildOption
()
3530 while Index
< len(SourceList
):
3531 Source
= SourceList
[Index
]
3535 CreateDirectory(Source
.Dir
)
3537 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
!= None and File
in self
._BinaryFileList
:
3538 # Skip all files that are not binary libraries
3539 if not self
.IsLibrary
:
3541 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3542 elif FileType
in self
.BuildRules
:
3543 RuleObject
= self
.BuildRules
[FileType
]
3544 elif Source
.Ext
in self
.BuildRules
:
3545 RuleObject
= self
.BuildRules
[Source
.Ext
]
3547 # stop at no more rules
3549 self
._FinalBuildTargetList
.add(LastTarget
)
3552 FileType
= RuleObject
.SourceFileType
3553 if FileType
not in self
._FileTypes
:
3554 self
._FileTypes
[FileType
] = set()
3555 self
._FileTypes
[FileType
].add(Source
)
3557 # stop at STATIC_LIBRARY for library
3558 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3560 self
._FinalBuildTargetList
.add(LastTarget
)
3563 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3566 self
._FinalBuildTargetList
.add(LastTarget
)
3568 elif not Target
.Outputs
:
3569 # Only do build for target with outputs
3570 self
._FinalBuildTargetList
.add(Target
)
3572 if FileType
not in self
._BuildTargets
:
3573 self
._BuildTargets
[FileType
] = set()
3574 self
._BuildTargets
[FileType
].add(Target
)
3576 if not Source
.IsBinary
and Source
== File
:
3577 self
._IntroBuildTargetList
.add(Target
)
3579 # to avoid cyclic rule
3580 if FileType
in RuleChain
:
3583 RuleChain
.append(FileType
)
3584 SourceList
.extend(Target
.Outputs
)
3586 FileType
= TAB_UNKNOWN_FILE
3588 def _GetTargets(self
):
3589 if self
._BuildTargets
== None:
3590 self
._IntroBuildTargetList
= set()
3591 self
._FinalBuildTargetList
= set()
3592 self
._BuildTargets
= {}
3593 self
._FileTypes
= {}
3595 #TRICK: call _GetSourceFileList to apply build rule for source files
3596 if self
.SourceFileList
:
3599 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3600 if self
.BinaryFileList
:
3603 return self
._BuildTargets
3605 def _GetIntroTargetList(self
):
3607 return self
._IntroBuildTargetList
3609 def _GetFinalTargetList(self
):
3611 return self
._FinalBuildTargetList
3613 def _GetFileTypes(self
):
3615 return self
._FileTypes
3617 ## Get the list of package object the module depends on
3619 # @retval list The package object list
3621 def _GetDependentPackageList(self
):
3622 return self
.Module
.Packages
3624 ## Return the list of auto-generated code file
3626 # @retval list The list of auto-generated file
3628 def _GetAutoGenFileList(self
):
3629 UniStringAutoGenC
= True
3630 IdfStringAutoGenC
= True
3631 UniStringBinBuffer
= StringIO()
3632 IdfGenBinBuffer
= StringIO()
3633 if self
.BuildType
== 'UEFI_HII':
3634 UniStringAutoGenC
= False
3635 IdfStringAutoGenC
= False
3636 if self
._AutoGenFileList
== None:
3637 self
._AutoGenFileList
= {}
3638 AutoGenC
= TemplateString()
3639 AutoGenH
= TemplateString()
3640 StringH
= TemplateString()
3641 StringIdf
= TemplateString()
3642 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3644 # AutoGen.c is generated if there are library classes in inf, or there are object files
3646 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3647 or TAB_OBJECT_FILE
in self
.FileTypes
):
3648 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3649 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3650 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3651 if str(AutoGenH
) != "":
3652 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3653 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3654 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3655 if str(StringH
) != "":
3656 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3657 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3658 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3659 if UniStringBinBuffer
!= None and UniStringBinBuffer
.getvalue() != "":
3660 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3661 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3662 AutoFile
.IsBinary
= True
3663 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3664 if UniStringBinBuffer
!= None:
3665 UniStringBinBuffer
.close()
3666 if str(StringIdf
) != "":
3667 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3668 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3669 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3670 if IdfGenBinBuffer
!= None and IdfGenBinBuffer
.getvalue() != "":
3671 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3672 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3673 AutoFile
.IsBinary
= True
3674 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3675 if IdfGenBinBuffer
!= None:
3676 IdfGenBinBuffer
.close()
3677 return self
._AutoGenFileList
3679 ## Return the list of library modules explicitly or implicityly used by this module
3680 def _GetLibraryList(self
):
3681 if self
._DependentLibraryList
== None:
3682 # only merge library classes and PCD for non-library module
3684 self
._DependentLibraryList
= []
3686 if self
.AutoGenVersion
< 0x00010005:
3687 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3689 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3690 return self
._DependentLibraryList
3693 def UpdateComments(Recver
, Src
):
3695 if Key
not in Recver
:
3697 Recver
[Key
].extend(Src
[Key
])
3698 ## Get the list of PCDs from current module
3700 # @retval list The list of PCD
3702 def _GetModulePcdList(self
):
3703 if self
._ModulePcdList
== None:
3704 # apply PCD settings from platform
3705 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3706 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3707 return self
._ModulePcdList
3709 ## Get the list of PCDs from dependent libraries
3711 # @retval list The list of PCD
3713 def _GetLibraryPcdList(self
):
3714 if self
._LibraryPcdList
== None:
3716 if not self
.IsLibrary
:
3717 # get PCDs from dependent libraries
3718 for Library
in self
.DependentLibraryList
:
3719 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3720 for Key
in Library
.Pcds
:
3721 # skip duplicated PCDs
3722 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3724 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3725 # apply PCD settings from platform
3726 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3728 self
._LibraryPcdList
= []
3729 return self
._LibraryPcdList
3731 ## Get the GUID value mapping
3733 # @retval dict The mapping between GUID cname and its value
3735 def _GetGuidList(self
):
3736 if self
._GuidList
== None:
3737 self
._GuidList
= sdict()
3738 self
._GuidList
.update(self
.Module
.Guids
)
3739 for Library
in self
.DependentLibraryList
:
3740 self
._GuidList
.update(Library
.Guids
)
3741 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3742 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3743 return self
._GuidList
3745 def GetGuidsUsedByPcd(self
):
3746 if self
._GuidsUsedByPcd
== None:
3747 self
._GuidsUsedByPcd
= sdict()
3748 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3749 for Library
in self
.DependentLibraryList
:
3750 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3751 return self
._GuidsUsedByPcd
3752 ## Get the protocol value mapping
3754 # @retval dict The mapping between protocol cname and its value
3756 def _GetProtocolList(self
):
3757 if self
._ProtocolList
== None:
3758 self
._ProtocolList
= sdict()
3759 self
._ProtocolList
.update(self
.Module
.Protocols
)
3760 for Library
in self
.DependentLibraryList
:
3761 self
._ProtocolList
.update(Library
.Protocols
)
3762 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3763 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3764 return self
._ProtocolList
3766 ## Get the PPI value mapping
3768 # @retval dict The mapping between PPI cname and its value
3770 def _GetPpiList(self
):
3771 if self
._PpiList
== None:
3772 self
._PpiList
= sdict()
3773 self
._PpiList
.update(self
.Module
.Ppis
)
3774 for Library
in self
.DependentLibraryList
:
3775 self
._PpiList
.update(Library
.Ppis
)
3776 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3777 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3778 return self
._PpiList
3780 ## Get the list of include search path
3782 # @retval list The list path
3784 def _GetIncludePathList(self
):
3785 if self
._IncludePathList
== None:
3786 self
._IncludePathList
= []
3787 if self
.AutoGenVersion
< 0x00010005:
3788 for Inc
in self
.Module
.Includes
:
3789 if Inc
not in self
._IncludePathList
:
3790 self
._IncludePathList
.append(Inc
)
3792 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3793 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3794 self
._IncludePathList
.append(Inc
)
3795 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3796 self
._IncludePathList
.append(self
.DebugDir
)
3798 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3799 self
._IncludePathList
.append(self
.DebugDir
)
3801 for Package
in self
.Module
.Packages
:
3802 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3803 if PackageDir
not in self
._IncludePathList
:
3804 self
._IncludePathList
.append(PackageDir
)
3805 IncludesList
= Package
.Includes
3806 if Package
._PrivateIncludes
:
3807 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3808 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3809 for Inc
in IncludesList
:
3810 if Inc
not in self
._IncludePathList
:
3811 self
._IncludePathList
.append(str(Inc
))
3812 return self
._IncludePathList
3814 def _GetIncludePathLength(self
):
3815 self
._IncludePathLength
= 0
3816 if self
._IncludePathList
:
3817 for inc
in self
._IncludePathList
:
3818 self
._IncludePathLength
+= len(' ' + inc
)
3819 return self
._IncludePathLength
3821 ## Get HII EX PCDs which maybe used by VFR
3823 # efivarstore used by VFR may relate with HII EX PCDs
3824 # Get the variable name and GUID from efivarstore and HII EX PCD
3825 # List the HII EX PCDs in As Built INF if both name and GUID match.
3827 # @retval list HII EX PCDs
3829 def _GetPcdsMaybeUsedByVfr(self
):
3830 if not self
.SourceFileList
:
3834 for SrcFile
in self
.SourceFileList
:
3835 if SrcFile
.Ext
.lower() != '.vfr':
3837 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3838 if not os
.path
.exists(Vfri
):
3840 VfriFile
= open(Vfri
, 'r')
3841 Content
= VfriFile
.read()
3843 Pos
= Content
.find('efivarstore')
3846 # Make sure 'efivarstore' is the start of efivarstore statement
3847 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3850 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3852 if Index
>= 0 and Content
[Index
] != ';':
3853 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3856 # 'efivarstore' must be followed by name and guid
3858 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3861 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3864 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3865 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3866 Pos
= Content
.find('efivarstore', Name
.end())
3870 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3871 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3873 for SkuName
in Pcd
.SkuInfoList
:
3874 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3875 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3876 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3879 Guid
= GuidStructureStringToGuidString(Value
)
3880 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3881 HiiExPcds
.append(Pcd
)
3886 def _GenOffsetBin(self
):
3888 for SourceFile
in self
.Module
.Sources
:
3889 if SourceFile
.Type
.upper() == ".VFR" :
3891 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3893 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3894 if SourceFile
.Type
.upper() == ".UNI" :
3896 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3898 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3900 if len(VfrUniBaseName
) == 0:
3902 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3903 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3904 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3905 if not VfrUniOffsetList
:
3908 OutputName
= '%sOffset.bin' % self
.Name
3909 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3912 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3914 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3916 # Use a instance of StringIO to cache data
3917 fStringIO
= StringIO('')
3919 for Item
in VfrUniOffsetList
:
3920 if (Item
[0].find("Strings") != -1):
3922 # UNI offset in image.
3924 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3926 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3927 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3928 fStringIO
.write(''.join(UniGuid
))
3929 UniValue
= pack ('Q', int (Item
[1], 16))
3930 fStringIO
.write (UniValue
)
3933 # VFR binary offset in image.
3935 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3937 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3938 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3939 fStringIO
.write(''.join(VfrGuid
))
3941 VfrValue
= pack ('Q', int (Item
[1], 16))
3942 fStringIO
.write (VfrValue
)
3944 # write data into file.
3947 fInputfile
.write (fStringIO
.getvalue())
3949 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3950 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3956 ## Create AsBuilt INF file the module
3958 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3959 self
.OutputFile
= []
3961 if GlobalData
.gBinCacheDest
:
3962 self
.CopyModuleToCache()
3965 if self
.IsAsBuiltInfCreated
:
3968 # Skip the following code for EDK I inf
3969 if self
.AutoGenVersion
< 0x00010005:
3972 # Skip the following code for libraries
3976 # Skip the following code for modules with no source files
3977 if self
.SourceFileList
== None or self
.SourceFileList
== []:
3980 # Skip the following code for modules without any binary files
3981 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3984 ### TODO: How to handles mixed source and binary modules
3986 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3987 # Also find all packages that the DynamicEx PCDs depend on
3992 PcdTokenSpaceList
= []
3993 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3994 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3995 PatchablePcds
+= [Pcd
]
3996 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3997 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
4000 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
4001 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
4002 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
4004 GuidList
.update(self
.GuidList
)
4005 for TokenSpace
in self
.GetGuidsUsedByPcd():
4006 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
4007 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
4008 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
4009 GuidList
.pop(TokenSpace
)
4010 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
4011 for Package
in self
.DerivedPackageList
:
4012 if Package
in Packages
:
4014 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
4016 for Index
in range(len(BeChecked
)):
4017 for Item
in CheckList
[Index
]:
4018 if Item
in BeChecked
[Index
]:
4019 Packages
+= [Package
]
4024 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
4025 for Pkg
in self
.PlatformInfo
.PackageList
:
4028 for VfrPcd
in VfrPcds
:
4029 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
4030 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
4034 ModuleType
= self
.ModuleType
4035 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
4036 ModuleType
= 'DXE_DRIVER'
4039 if self
.PcdIsDriver
!= '':
4040 DriverType
= self
.PcdIsDriver
4043 MDefs
= self
.Module
.Defines
4046 'module_name' : self
.Name
,
4047 'module_guid' : Guid
,
4048 'module_module_type' : ModuleType
,
4049 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
4050 'pcd_is_driver_string' : [],
4051 'module_uefi_specification_version' : [],
4052 'module_pi_specification_version' : [],
4053 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
4054 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
4055 'module_constructor' : self
.Module
.ConstructorList
,
4056 'module_destructor' : self
.Module
.DestructorList
,
4057 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4058 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4059 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4060 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4061 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4062 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4063 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4064 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4065 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4066 'module_arch' : self
.Arch
,
4067 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4069 'patchablepcd_item' : [],
4071 'protocol_item' : [],
4075 'libraryclasses_item' : []
4078 if 'MODULE_UNI_FILE' in MDefs
:
4079 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4080 if os
.path
.isfile(UNIFile
):
4081 shutil
.copy2(UNIFile
, self
.OutputDir
)
4083 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4084 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4086 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4089 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4091 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4092 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4093 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4094 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4096 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4097 for Item
in self
.CodaTargetList
:
4098 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4099 if File
not in self
.OutputFile
:
4100 self
.OutputFile
.append(File
)
4101 if Item
.Target
.Ext
.lower() == '.aml':
4102 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4103 elif Item
.Target
.Ext
.lower() == '.acpi':
4104 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4105 elif Item
.Target
.Ext
.lower() == '.efi':
4106 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4108 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4109 if self
.DepexGenerated
:
4110 if self
.Name
+ '.depex' not in self
.OutputFile
:
4111 self
.OutputFile
.append(self
.Name
+ '.depex')
4112 if self
.ModuleType
in ['PEIM']:
4113 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4114 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4115 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4116 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4117 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4119 Bin
= self
._GenOffsetBin
()
4121 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4122 if Bin
not in self
.OutputFile
:
4123 self
.OutputFile
.append(Bin
)
4125 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4127 if File
.lower().endswith('.pdb'):
4128 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4129 if File
not in self
.OutputFile
:
4130 self
.OutputFile
.append(File
)
4131 HeaderComments
= self
.Module
.HeaderComments
4133 for Index
in range(len(HeaderComments
)):
4134 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4135 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4138 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4139 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4142 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4143 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4144 (GuidList
, self
._GuidComments
, 'guid_item')
4146 for Item
in GenList
:
4147 for CName
in Item
[0]:
4149 if CName
in Item
[1]:
4150 Comments
= '\n '.join(Item
[1][CName
])
4153 Entry
= Comments
+ '\n ' + CName
4154 AsBuiltInfDict
[Item
[2]].append(Entry
)
4155 PatchList
= parsePcdInfoFromMapFile(
4156 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4157 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4160 for Pcd
in PatchablePcds
:
4161 TokenCName
= Pcd
.TokenCName
4162 for PcdItem
in GlobalData
.MixedPcd
:
4163 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4164 TokenCName
= PcdItem
[0]
4166 for PatchPcd
in PatchList
:
4167 if TokenCName
== PatchPcd
[0]:
4172 if Pcd
.DatumType
== 'BOOLEAN':
4173 BoolValue
= Pcd
.DefaultValue
.upper()
4174 if BoolValue
== 'TRUE':
4175 Pcd
.DefaultValue
= '1'
4176 elif BoolValue
== 'FALSE':
4177 Pcd
.DefaultValue
= '0'
4179 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4180 HexFormat
= '0x%02x'
4181 if Pcd
.DatumType
== 'UINT16':
4182 HexFormat
= '0x%04x'
4183 elif Pcd
.DatumType
== 'UINT32':
4184 HexFormat
= '0x%08x'
4185 elif Pcd
.DatumType
== 'UINT64':
4186 HexFormat
= '0x%016x'
4187 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4189 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
4190 EdkLogger
.error("build", AUTOGEN_ERROR
,
4191 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4193 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4194 PcdValue
= Pcd
.DefaultValue
4195 if PcdValue
[0] != '{':
4197 if PcdValue
[0] == 'L':
4199 PcdValue
= PcdValue
.lstrip('L')
4200 PcdValue
= eval(PcdValue
)
4202 for Index
in range(0, len(PcdValue
)):
4204 CharVal
= ord(PcdValue
[Index
])
4205 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4206 + '0x%02x' % (CharVal
>> 8) + ', '
4208 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4211 Padding
= Padding
* 2
4212 ArraySize
= ArraySize
/ 2
4213 if ArraySize
< (len(PcdValue
) + 1):
4214 EdkLogger
.error("build", AUTOGEN_ERROR
,
4215 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4217 if ArraySize
> len(PcdValue
) + 1:
4218 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4219 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4220 elif len(PcdValue
.split(',')) <= ArraySize
:
4221 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4224 EdkLogger
.error("build", AUTOGEN_ERROR
,
4225 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4227 PcdItem
= '%s.%s|%s|0x%X' % \
4228 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4230 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4231 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4233 PcdItem
= PcdComments
+ '\n ' + PcdItem
4234 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4237 for Pcd
in Pcds
+ VfrPcds
:
4242 TokenCName
= Pcd
.TokenCName
4243 for PcdItem
in GlobalData
.MixedPcd
:
4244 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4245 TokenCName
= PcdItem
[0]
4247 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4248 for SkuName
in Pcd
.SkuInfoList
:
4249 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4250 SkuId
= SkuInfo
.SkuId
4251 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4255 # Don't generate duplicated HII PCD
4257 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4260 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4261 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4262 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4266 for Index
, Comment
in enumerate(PcdCommentList
):
4267 for Usage
in UsageList
:
4268 if Comment
.find(Usage
) != -1:
4272 if UsageIndex
!= -1:
4273 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4275 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4276 PcdComments
= '\n '.join(PcdCommentList
)
4277 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4279 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4280 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4281 for Item
in self
.BuildOption
:
4282 if 'FLAGS' in self
.BuildOption
[Item
]:
4283 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4285 # Generated LibraryClasses section in comments.
4286 for Library
in self
.LibraryAutoGenList
:
4287 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4289 # Generated UserExtensions TianoCore section.
4290 # All tianocore user extensions are copied.
4292 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4293 UserExtStr
+= '\n'.join(TianoCore
)
4294 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4295 if os
.path
.isfile(ExtensionFile
):
4296 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4297 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4299 # Generated depex expression section in comments.
4300 AsBuiltInfDict
['depexsection_item'] = ''
4301 DepexExpresion
= self
._GetDepexExpresionString
()
4303 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4305 AsBuiltInf
= TemplateString()
4306 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4308 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4310 self
.IsAsBuiltInfCreated
= True
4311 if GlobalData
.gBinCacheDest
:
4312 self
.CopyModuleToCache()
4314 def CopyModuleToCache(self
):
4315 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4316 CreateDirectory (FileDir
)
4317 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4318 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4319 if os
.path
.exists(HashFile
):
4320 shutil
.copy2(HashFile
, FileDir
)
4321 if os
.path
.exists(ModuleFile
):
4322 shutil
.copy2(ModuleFile
, FileDir
)
4323 if not self
.OutputFile
:
4324 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4325 self
.OutputFile
= Ma
.Binaries
4327 for File
in self
.OutputFile
:
4329 if not os
.path
.isabs(File
):
4330 File
= os
.path
.join(self
.OutputDir
, File
)
4331 if os
.path
.exists(File
):
4332 shutil
.copy2(File
, FileDir
)
4334 def AttemptModuleCacheCopy(self
):
4335 if self
.IsBinaryModule
:
4337 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4338 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4339 if os
.path
.exists(HashFile
):
4340 f
= open(HashFile
, 'r')
4341 CacheHash
= f
.read()
4343 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4344 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4345 for root
, dir, files
in os
.walk(FileDir
):
4347 if self
.Name
+ '.hash' in f
:
4348 shutil
.copy2(HashFile
, self
.BuildDir
)
4350 File
= path
.join(root
, f
)
4351 shutil
.copy2(File
, self
.OutputDir
)
4352 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4353 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4357 ## Create makefile for the module and its dependent libraries
4359 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4360 # dependent libraries will be created
4362 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4363 # Ignore generating makefile when it is a binary module
4364 if self
.IsBinaryModule
:
4367 if self
.IsMakeFileCreated
:
4369 self
.GenFfsList
= GenFfsList
4370 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4371 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4372 LibraryAutoGen
.CreateMakeFile()
4377 if len(self
.CustomMakefile
) == 0:
4378 Makefile
= GenMake
.ModuleMakefile(self
)
4380 Makefile
= GenMake
.CustomMakefile(self
)
4381 if Makefile
.Generate():
4382 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4383 (self
.Name
, self
.Arch
))
4385 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4386 (self
.Name
, self
.Arch
))
4388 self
.CreateTimeStamp(Makefile
)
4389 self
.IsMakeFileCreated
= True
4391 def CopyBinaryFiles(self
):
4392 for File
in self
.Module
.Binaries
:
4394 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4395 CopyLongFilePath(SrcPath
, DstPath
)
4396 ## Create autogen code for the module and its dependent libraries
4398 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4399 # dependent libraries will be created
4401 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4402 if self
.IsCodeFileCreated
:
4405 # Need to generate PcdDatabase even PcdDriver is binarymodule
4406 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4407 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4409 if self
.IsBinaryModule
:
4411 self
.CopyBinaryFiles()
4414 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4415 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4416 LibraryAutoGen
.CreateCodeFile()
4422 IgoredAutoGenList
= []
4424 for File
in self
.AutoGenFileList
:
4425 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4426 #Ignore Edk AutoGen.c
4427 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4430 AutoGenList
.append(str(File
))
4432 IgoredAutoGenList
.append(str(File
))
4434 # Skip the following code for EDK I inf
4435 if self
.AutoGenVersion
< 0x00010005:
4438 for ModuleType
in self
.DepexList
:
4439 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4440 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4443 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4444 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4446 if len(Dpx
.PostfixNotation
) <> 0:
4447 self
.DepexGenerated
= True
4449 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4450 AutoGenList
.append(str(DpxFile
))
4452 IgoredAutoGenList
.append(str(DpxFile
))
4454 if IgoredAutoGenList
== []:
4455 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4456 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4457 elif AutoGenList
== []:
4458 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4459 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4461 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4462 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4464 self
.IsCodeFileCreated
= True
4467 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4468 def _GetLibraryAutoGenList(self
):
4469 if self
._LibraryAutoGenList
== None:
4470 self
._LibraryAutoGenList
= []
4471 for Library
in self
.DependentLibraryList
:
4478 self
.PlatformInfo
.MetaFile
4480 if La
not in self
._LibraryAutoGenList
:
4481 self
._LibraryAutoGenList
.append(La
)
4482 for Lib
in La
.CodaTargetList
:
4483 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4484 return self
._LibraryAutoGenList
4486 def GenModuleHash(self
):
4487 if self
.Arch
not in GlobalData
.gModuleHash
:
4488 GlobalData
.gModuleHash
[self
.Arch
] = {}
4490 # Add Platform level hash
4491 m
.update(GlobalData
.gPlatformHash
)
4492 # Add Package level hash
4493 if self
.DependentPackageList
:
4494 for Pkg
in self
.DependentPackageList
:
4495 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4496 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4499 if self
.LibraryAutoGenList
:
4500 for Lib
in self
.LibraryAutoGenList
:
4501 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4503 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4506 f
= open(str(self
.MetaFile
), 'r')
4510 # Add Module's source files
4511 if self
.SourceFileList
:
4512 for File
in self
.SourceFileList
:
4513 f
= open(str(File
), 'r')
4518 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4519 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4520 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4521 if GlobalData
.gBinCacheSource
:
4522 CacheValid
= self
.AttemptModuleCacheCopy()
4525 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4527 ## Decide whether we can skip the ModuleAutoGen process
4528 def CanSkipbyHash(self
):
4529 if GlobalData
.gUseHashCache
:
4530 return not self
.GenModuleHash()
4532 ## Decide whether we can skip the ModuleAutoGen process
4533 # If any source file is newer than the module than we cannot skip
4536 if not os
.path
.exists(self
.GetTimeStampPath()):
4538 #last creation time of the module
4539 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4541 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4542 if SrcTimeStamp
> DstTimeStamp
:
4545 with
open(self
.GetTimeStampPath(),'r') as f
:
4547 source
= source
.rstrip('\n')
4548 if not os
.path
.exists(source
):
4550 if source
not in ModuleAutoGen
.TimeDict
:
4551 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4552 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4556 def GetTimeStampPath(self
):
4557 if self
._TimeStampPath
== None:
4558 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4559 return self
._TimeStampPath
4560 def CreateTimeStamp(self
, Makefile
):
4564 FileSet
.add (self
.MetaFile
.Path
)
4566 for SourceFile
in self
.Module
.Sources
:
4567 FileSet
.add (SourceFile
.Path
)
4569 for Lib
in self
.DependentLibraryList
:
4570 FileSet
.add (Lib
.MetaFile
.Path
)
4572 for f
in self
.AutoGenDepSet
:
4573 FileSet
.add (f
.Path
)
4575 if os
.path
.exists (self
.GetTimeStampPath()):
4576 os
.remove (self
.GetTimeStampPath())
4577 with
open(self
.GetTimeStampPath(), 'w+') as file:
4581 Module
= property(_GetModule
)
4582 Name
= property(_GetBaseName
)
4583 Guid
= property(_GetGuid
)
4584 Version
= property(_GetVersion
)
4585 ModuleType
= property(_GetModuleType
)
4586 ComponentType
= property(_GetComponentType
)
4587 BuildType
= property(_GetBuildType
)
4588 PcdIsDriver
= property(_GetPcdIsDriver
)
4589 AutoGenVersion
= property(_GetAutoGenVersion
)
4590 Macros
= property(_GetMacros
)
4591 Specification
= property(_GetSpecification
)
4593 IsLibrary
= property(_IsLibrary
)
4594 IsBinaryModule
= property(_IsBinaryModule
)
4595 BuildDir
= property(_GetBuildDir
)
4596 OutputDir
= property(_GetOutputDir
)
4597 FfsOutputDir
= property(_GetFfsOutputDir
)
4598 DebugDir
= property(_GetDebugDir
)
4599 MakeFileDir
= property(_GetMakeFileDir
)
4600 CustomMakefile
= property(_GetCustomMakefile
)
4602 IncludePathList
= property(_GetIncludePathList
)
4603 IncludePathLength
= property(_GetIncludePathLength
)
4604 AutoGenFileList
= property(_GetAutoGenFileList
)
4605 UnicodeFileList
= property(_GetUnicodeFileList
)
4606 VfrFileList
= property(_GetVfrFileList
)
4607 SourceFileList
= property(_GetSourceFileList
)
4608 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4609 Targets
= property(_GetTargets
)
4610 IntroTargetList
= property(_GetIntroTargetList
)
4611 CodaTargetList
= property(_GetFinalTargetList
)
4612 FileTypes
= property(_GetFileTypes
)
4613 BuildRules
= property(_GetBuildRules
)
4614 IdfFileList
= property(_GetIdfFileList
)
4616 DependentPackageList
= property(_GetDependentPackageList
)
4617 DependentLibraryList
= property(_GetLibraryList
)
4618 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4619 DerivedPackageList
= property(_GetDerivedPackageList
)
4621 ModulePcdList
= property(_GetModulePcdList
)
4622 LibraryPcdList
= property(_GetLibraryPcdList
)
4623 GuidList
= property(_GetGuidList
)
4624 ProtocolList
= property(_GetProtocolList
)
4625 PpiList
= property(_GetPpiList
)
4626 DepexList
= property(_GetDepexTokenList
)
4627 DxsFile
= property(_GetDxsFile
)
4628 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4629 BuildOption
= property(_GetModuleBuildOption
)
4630 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4631 BuildCommand
= property(_GetBuildCommand
)
4633 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4635 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4636 if __name__
== '__main__':