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 PcdValue
= Sku
.DefaultValue
1641 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1642 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1643 UnicodePcdArray
.append(Pcd
)
1644 elif len(Sku
.VariableName
) > 0:
1645 # if found HII type PCD then insert to right of UnicodeIndex
1646 HiiPcdArray
.append(Pcd
)
1648 OtherPcdArray
.append(Pcd
)
1649 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1650 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1652 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1653 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1654 if PcdNvStoreDfBuffer
:
1655 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1656 default_skuobj
= PcdNvStoreDfBuffer
.SkuInfoList
.get("DEFAULT")
1657 vardump
= self
.VariableInfo
.dump()
1658 if vardump
and default_skuobj
:
1659 default_skuobj
.DefaultValue
= vardump
1660 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1661 PcdNvStoreDfBuffer
.SkuInfoList
.clear()
1662 PcdNvStoreDfBuffer
.SkuInfoList
['DEFAULT'] = default_skuobj
1663 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1665 PlatformPcds
= self
._PlatformPcds
.keys()
1668 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1670 for PcdKey
in PlatformPcds
:
1671 Pcd
= self
._PlatformPcds
[PcdKey
]
1672 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1673 PcdKey
in VpdPcdDict
:
1674 Pcd
= VpdPcdDict
[PcdKey
]
1675 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1676 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1677 PcdValue
= Sku
.DefaultValue
1679 PcdValue
= Pcd
.DefaultValue
1680 if Sku
.VpdOffset
!= '*':
1681 if PcdValue
.startswith("{"):
1683 elif PcdValue
.startswith("L"):
1688 VpdOffset
= int(Sku
.VpdOffset
)
1691 VpdOffset
= int(Sku
.VpdOffset
, 16)
1693 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1694 if VpdOffset
% Alignment
!= 0:
1695 if PcdValue
.startswith("{"):
1696 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1698 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1699 VpdFile
.Add(Pcd
, Sku
.VpdOffset
)
1700 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1701 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1702 NeedProcessVpdMapFile
= True
1703 if self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== '':
1704 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1705 "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.")
1709 # Fix the PCDs define in VPD PCD section that never referenced by module.
1710 # An example is PCD for signature usage.
1712 for DscPcd
in PlatformPcds
:
1713 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1714 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1715 if not (self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== ''):
1717 for VpdPcd
in VpdFile
._VpdArray
.keys():
1718 # This PCD has been referenced by module
1719 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1720 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1723 # Not found, it should be signature
1725 # just pick the a value to determine whether is unicode string type
1726 for (SkuName
,Sku
) in DscPcdEntry
.SkuInfoList
.items():
1727 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1729 # Need to iterate DEC pcd information to get the value & datumtype
1730 for eachDec
in self
.PackageList
:
1731 for DecPcd
in eachDec
.Pcds
:
1732 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1733 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1734 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1735 # Print warning message to let the developer make a determine.
1736 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1737 File
=self
.MetaFile
, \
1738 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1739 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1741 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1742 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1743 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1744 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1745 # Only fix the value while no value provided in DSC file.
1746 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1747 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1749 if DscPcdEntry
not in self
._DynamicPcdList
:
1750 self
._DynamicPcdList
.append(DscPcdEntry
)
1751 # Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]
1752 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1753 PcdValue
= Sku
.DefaultValue
1755 PcdValue
= DscPcdEntry
.DefaultValue
1756 if Sku
.VpdOffset
!= '*':
1757 if PcdValue
.startswith("{"):
1759 elif PcdValue
.startswith("L"):
1764 VpdOffset
= int(Sku
.VpdOffset
)
1767 VpdOffset
= int(Sku
.VpdOffset
, 16)
1769 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1770 if VpdOffset
% Alignment
!= 0:
1771 if PcdValue
.startswith("{"):
1772 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1774 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1775 VpdFile
.Add(DscPcdEntry
, Sku
.VpdOffset
)
1776 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1777 NeedProcessVpdMapFile
= True
1778 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1779 UnicodePcdArray
.append(DscPcdEntry
)
1780 elif len(Sku
.VariableName
) > 0:
1781 HiiPcdArray
.append(DscPcdEntry
)
1783 OtherPcdArray
.append(DscPcdEntry
)
1785 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1789 if (self
.Platform
.FlashDefinition
== None or self
.Platform
.FlashDefinition
== '') and \
1790 VpdFile
.GetCount() != 0:
1791 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1792 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1794 if VpdFile
.GetCount() != 0:
1796 self
.FixVpdOffset(VpdFile
)
1798 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1800 # Process VPD map file generated by third party BPDG tool
1801 if NeedProcessVpdMapFile
:
1802 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1803 if os
.path
.exists(VpdMapFilePath
):
1804 VpdFile
.Read(VpdMapFilePath
)
1807 for Pcd
in self
._DynamicPcdList
:
1808 # just pick the a value to determine whether is unicode string type
1810 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1811 if Sku
.VpdOffset
== "*":
1812 Sku
.VpdOffset
= VpdFile
.GetOffset(Pcd
)[i
].strip()
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 del self
._DynamicPcdList
[:]
1819 self
._DynamicPcdList
.extend(UnicodePcdArray
)
1820 self
._DynamicPcdList
.extend(HiiPcdArray
)
1821 self
._DynamicPcdList
.extend(OtherPcdArray
)
1822 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1823 for pcd
in self
._DynamicPcdList
:
1824 if len(pcd
.SkuInfoList
) == 1:
1825 for (SkuName
,SkuId
) in allskuset
:
1826 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1828 pcd
.SkuInfoList
[SkuName
] = pcd
.SkuInfoList
['DEFAULT']
1829 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1831 def FixVpdOffset(self
,VpdFile
):
1832 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1833 if not os
.path
.exists(FvPath
):
1837 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1839 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1841 if VpdFile
.Write(VpdFilePath
):
1842 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1844 for ToolDef
in self
.ToolDefinition
.values():
1845 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1846 if not ToolDef
.has_key("PATH"):
1847 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1848 BPDGToolName
= ToolDef
["PATH"]
1850 # Call third party GUID BPDG tool.
1851 if BPDGToolName
!= None:
1852 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1854 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.")
1856 ## Return the platform build data object
1857 def _GetPlatform(self
):
1858 if self
._Platform
== None:
1859 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1860 return self
._Platform
1862 ## Return platform name
1864 return self
.Platform
.PlatformName
1866 ## Return the meta file GUID
1868 return self
.Platform
.Guid
1870 ## Return the platform version
1871 def _GetVersion(self
):
1872 return self
.Platform
.Version
1874 ## Return the FDF file name
1875 def _GetFdfFile(self
):
1876 if self
._FdfFile
== None:
1877 if self
.Workspace
.FdfFile
!= "":
1878 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1881 return self
._FdfFile
1883 ## Return the build output directory platform specifies
1884 def _GetOutputDir(self
):
1885 return self
.Platform
.OutputDirectory
1887 ## Return the directory to store all intermediate and final files built
1888 def _GetBuildDir(self
):
1889 if self
._BuildDir
== None:
1890 if os
.path
.isabs(self
.OutputDir
):
1891 self
._BuildDir
= path
.join(
1892 path
.abspath(self
.OutputDir
),
1893 self
.BuildTarget
+ "_" + self
.ToolChain
,
1896 self
._BuildDir
= path
.join(
1899 self
.BuildTarget
+ "_" + self
.ToolChain
,
1901 GlobalData
.gBuildDirectory
= self
._BuildDir
1902 return self
._BuildDir
1904 ## Return directory of platform makefile
1906 # @retval string Makefile directory
1908 def _GetMakeFileDir(self
):
1909 if self
._MakeFileDir
== None:
1910 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1911 return self
._MakeFileDir
1913 ## Return build command string
1915 # @retval string Build command string
1917 def _GetBuildCommand(self
):
1918 if self
._BuildCommand
== None:
1919 self
._BuildCommand
= []
1920 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1921 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1922 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1923 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1925 self
._BuildCommand
+= SplitOption(NewOption
)
1926 return self
._BuildCommand
1928 ## Get tool chain definition
1930 # Get each tool defition for given tool chain from tools_def.txt and platform
1932 def _GetToolDefinition(self
):
1933 if self
._ToolDefinitions
== None:
1934 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1935 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1936 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1937 ExtraData
="[%s]" % self
.MetaFile
)
1938 self
._ToolDefinitions
= {}
1940 for Def
in ToolDefinition
:
1941 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1942 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1945 Value
= ToolDefinition
[Def
]
1946 # don't record the DLL
1948 DllPathList
.add(Value
)
1951 if Tool
not in self
._ToolDefinitions
:
1952 self
._ToolDefinitions
[Tool
] = {}
1953 self
._ToolDefinitions
[Tool
][Attr
] = Value
1957 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1958 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1959 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1960 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1962 for Tool
in self
._ToolDefinitions
:
1963 for Attr
in self
._ToolDefinitions
[Tool
]:
1964 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1965 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1966 # check if override is indicated
1967 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1968 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1971 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1973 Value
= self
.BuildOption
[Tool
][Attr
]
1976 # Don't put MAKE definition in the file
1980 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1982 # Don't put MAKE definition in the file
1987 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1990 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1991 for DllPath
in DllPathList
:
1992 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1993 os
.environ
["MAKE_FLAGS"] = MakeFlags
1995 return self
._ToolDefinitions
1997 ## Return the paths of tools
1998 def _GetToolDefFile(self
):
1999 if self
._ToolDefFile
== None:
2000 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
2001 return self
._ToolDefFile
2003 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
2004 def _GetToolChainFamily(self
):
2005 if self
._ToolChainFamily
== None:
2006 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
2007 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
2008 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
2009 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
2010 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2012 self
._ToolChainFamily
= "MSFT"
2014 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
2015 return self
._ToolChainFamily
2017 def _GetBuildRuleFamily(self
):
2018 if self
._BuildRuleFamily
== None:
2019 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
2020 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
2021 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
2022 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
2023 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2025 self
._BuildRuleFamily
= "MSFT"
2027 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
2028 return self
._BuildRuleFamily
2030 ## Return the build options specific for all modules in this platform
2031 def _GetBuildOptions(self
):
2032 if self
._BuildOption
== None:
2033 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
2034 return self
._BuildOption
2036 ## Return the build options specific for EDK modules in this platform
2037 def _GetEdkBuildOptions(self
):
2038 if self
._EdkBuildOption
== None:
2039 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
2040 return self
._EdkBuildOption
2042 ## Return the build options specific for EDKII modules in this platform
2043 def _GetEdkIIBuildOptions(self
):
2044 if self
._EdkIIBuildOption
== None:
2045 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
2046 return self
._EdkIIBuildOption
2048 ## Parse build_rule.txt in Conf Directory.
2050 # @retval BuildRule object
2052 def _GetBuildRule(self
):
2053 if self
._BuildRule
== None:
2054 BuildRuleFile
= None
2055 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2056 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2057 if BuildRuleFile
in [None, '']:
2058 BuildRuleFile
= gDefaultBuildRuleFile
2059 self
._BuildRule
= BuildRule(BuildRuleFile
)
2060 if self
._BuildRule
._FileVersion
== "":
2061 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2063 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2064 # If Build Rule's version is less than the version number required by the tools, halting the build.
2065 EdkLogger
.error("build", AUTOGEN_ERROR
,
2066 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])"\
2067 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2069 return self
._BuildRule
2071 ## Summarize the packages used by modules in this platform
2072 def _GetPackageList(self
):
2073 if self
._PackageList
== None:
2074 self
._PackageList
= set()
2075 for La
in self
.LibraryAutoGenList
:
2076 self
._PackageList
.update(La
.DependentPackageList
)
2077 for Ma
in self
.ModuleAutoGenList
:
2078 self
._PackageList
.update(Ma
.DependentPackageList
)
2079 #Collect package set information from INF of FDF
2081 for ModuleFile
in self
._AsBuildModuleList
:
2082 if ModuleFile
in self
.Platform
.Modules
:
2084 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2085 PkgSet
.update(ModuleData
.Packages
)
2086 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2087 return self
._PackageList
2089 def _GetNonDynamicPcdDict(self
):
2090 if self
._NonDynamicPcdDict
:
2091 return self
._NonDynamicPcdDict
2092 for Pcd
in self
.NonDynamicPcdList
:
2093 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2094 return self
._NonDynamicPcdDict
2096 ## Get list of non-dynamic PCDs
2097 def _GetNonDynamicPcdList(self
):
2098 if self
._NonDynamicPcdList
== None:
2099 self
.CollectPlatformDynamicPcds()
2100 return self
._NonDynamicPcdList
2102 ## Get list of dynamic PCDs
2103 def _GetDynamicPcdList(self
):
2104 if self
._DynamicPcdList
== None:
2105 self
.CollectPlatformDynamicPcds()
2106 return self
._DynamicPcdList
2108 ## Generate Token Number for all PCD
2109 def _GetPcdTokenNumbers(self
):
2110 if self
._PcdTokenNumber
== None:
2111 self
._PcdTokenNumber
= sdict()
2114 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2118 # TokenNumber 0 ~ 10
2120 # TokeNumber 11 ~ 20
2122 for Pcd
in self
.DynamicPcdList
:
2123 if Pcd
.Phase
== "PEI":
2124 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2125 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2126 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2129 for Pcd
in self
.DynamicPcdList
:
2130 if Pcd
.Phase
== "PEI":
2131 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2132 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2133 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2136 for Pcd
in self
.DynamicPcdList
:
2137 if Pcd
.Phase
== "DXE":
2138 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2139 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2140 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2143 for Pcd
in self
.DynamicPcdList
:
2144 if Pcd
.Phase
== "DXE":
2145 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2146 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2147 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2150 for Pcd
in self
.NonDynamicPcdList
:
2151 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2153 return self
._PcdTokenNumber
2155 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2156 def _GetAutoGenObjectList(self
):
2157 self
._ModuleAutoGenList
= []
2158 self
._LibraryAutoGenList
= []
2159 for ModuleFile
in self
.Platform
.Modules
:
2168 if Ma
not in self
._ModuleAutoGenList
:
2169 self
._ModuleAutoGenList
.append(Ma
)
2170 for La
in Ma
.LibraryAutoGenList
:
2171 if La
not in self
._LibraryAutoGenList
:
2172 self
._LibraryAutoGenList
.append(La
)
2173 if Ma
not in La
._ReferenceModules
:
2174 La
._ReferenceModules
.append(Ma
)
2176 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2177 def _GetModuleAutoGenList(self
):
2178 if self
._ModuleAutoGenList
== None:
2179 self
._GetAutoGenObjectList
()
2180 return self
._ModuleAutoGenList
2182 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2183 def _GetLibraryAutoGenList(self
):
2184 if self
._LibraryAutoGenList
== None:
2185 self
._GetAutoGenObjectList
()
2186 return self
._LibraryAutoGenList
2188 ## Test if a module is supported by the platform
2190 # An error will be raised directly if the module or its arch is not supported
2191 # by the platform or current configuration
2193 def ValidModule(self
, Module
):
2194 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2195 or Module
in self
._AsBuildModuleList
2197 ## Resolve the library classes in a module to library instances
2199 # This method will not only resolve library classes but also sort the library
2200 # instances according to the dependency-ship.
2202 # @param Module The module from which the library classes will be resolved
2204 # @retval library_list List of library instances sorted
2206 def ApplyLibraryInstance(self
, Module
):
2207 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2208 if str(Module
) not in self
.Platform
.Modules
:
2211 ModuleType
= Module
.ModuleType
2213 # for overridding library instances with module specific setting
2214 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2216 # add forced library instances (specified under LibraryClasses sections)
2218 # If a module has a MODULE_TYPE of USER_DEFINED,
2219 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2221 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2222 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2223 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2224 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2226 # add forced library instances (specified in module overrides)
2227 for LibraryClass
in PlatformModule
.LibraryClasses
:
2228 if LibraryClass
.startswith("NULL"):
2229 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2232 LibraryConsumerList
= [Module
]
2234 ConsumedByList
= sdict()
2235 LibraryInstance
= sdict()
2237 EdkLogger
.verbose("")
2238 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2239 while len(LibraryConsumerList
) > 0:
2240 M
= LibraryConsumerList
.pop()
2241 for LibraryClassName
in M
.LibraryClasses
:
2242 if LibraryClassName
not in LibraryInstance
:
2243 # override library instance for this module
2244 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2245 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2247 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2248 if LibraryPath
== None or LibraryPath
== "":
2249 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2250 if LibraryPath
== None or LibraryPath
== "":
2251 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2252 "Instance of library class [%s] is not found" % LibraryClassName
,
2254 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2256 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2257 # for those forced library instance (NULL library), add a fake library class
2258 if LibraryClassName
.startswith("NULL"):
2259 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2260 elif LibraryModule
.LibraryClass
== None \
2261 or len(LibraryModule
.LibraryClass
) == 0 \
2262 or (ModuleType
!= 'USER_DEFINED'
2263 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2264 # only USER_DEFINED can link against any library instance despite of its SupModList
2265 EdkLogger
.error("build", OPTION_MISSING
,
2266 "Module type [%s] is not supported by library instance [%s]" \
2267 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2268 ExtraData
="consumed by [%s]" % str(Module
))
2270 LibraryInstance
[LibraryClassName
] = LibraryModule
2271 LibraryConsumerList
.append(LibraryModule
)
2272 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2274 LibraryModule
= LibraryInstance
[LibraryClassName
]
2276 if LibraryModule
== None:
2279 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2280 Constructor
.append(LibraryModule
)
2282 if LibraryModule
not in ConsumedByList
:
2283 ConsumedByList
[LibraryModule
] = []
2284 # don't add current module itself to consumer list
2286 if M
in ConsumedByList
[LibraryModule
]:
2288 ConsumedByList
[LibraryModule
].append(M
)
2290 # Initialize the sorted output list to the empty set
2292 SortedLibraryList
= []
2294 # Q <- Set of all nodes with no incoming edges
2296 LibraryList
= [] #LibraryInstance.values()
2298 for LibraryClassName
in LibraryInstance
:
2299 M
= LibraryInstance
[LibraryClassName
]
2300 LibraryList
.append(M
)
2301 if ConsumedByList
[M
] == []:
2305 # start the DAG algorithm
2309 while Q
== [] and EdgeRemoved
:
2311 # for each node Item with a Constructor
2312 for Item
in LibraryList
:
2313 if Item
not in Constructor
:
2315 # for each Node without a constructor with an edge e from Item to Node
2316 for Node
in ConsumedByList
[Item
]:
2317 if Node
in Constructor
:
2319 # remove edge e from the graph if Node has no constructor
2320 ConsumedByList
[Item
].remove(Node
)
2322 if ConsumedByList
[Item
] == []:
2323 # insert Item into Q
2328 # DAG is done if there's no more incoming edge for all nodes
2332 # remove node from Q
2335 SortedLibraryList
.append(Node
)
2337 # for each node Item with an edge e from Node to Item do
2338 for Item
in LibraryList
:
2339 if Node
not in ConsumedByList
[Item
]:
2341 # remove edge e from the graph
2342 ConsumedByList
[Item
].remove(Node
)
2344 if ConsumedByList
[Item
] != []:
2346 # insert Item into Q, if Item has no other incoming edges
2350 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2352 for Item
in LibraryList
:
2353 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2354 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2355 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2356 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2357 if Item
not in SortedLibraryList
:
2358 SortedLibraryList
.append(Item
)
2361 # Build the list of constructor and destructir names
2362 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2364 SortedLibraryList
.reverse()
2365 return SortedLibraryList
2368 ## Override PCD setting (type, value, ...)
2370 # @param ToPcd The PCD to be overrided
2371 # @param FromPcd The PCD overrideing from
2373 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2375 # in case there's PCDs coming from FDF file, which have no type given.
2376 # at this point, ToPcd.Type has the type found from dependent
2379 TokenCName
= ToPcd
.TokenCName
2380 for PcdItem
in GlobalData
.MixedPcd
:
2381 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2382 TokenCName
= PcdItem
[0]
2385 if GlobalData
.BuildOptionPcd
:
2386 for pcd
in GlobalData
.BuildOptionPcd
:
2387 if (FromPcd
.TokenSpaceGuidCName
, FromPcd
.TokenCName
) == (pcd
[0], pcd
[1]):
2388 FromPcd
.DefaultValue
= pcd
[2]
2390 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2391 ToPcd
.Type
= FromPcd
.Type
2392 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2393 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2394 if ToPcd
.Type
.strip() == "DynamicEx":
2395 ToPcd
.Type
= FromPcd
.Type
2396 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2397 and ToPcd
.Type
!= FromPcd
.Type
:
2398 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2399 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2400 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2401 ToPcd
.Type
, Module
, FromPcd
.Type
),
2404 if FromPcd
.MaxDatumSize
not in [None, '']:
2405 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2406 if FromPcd
.DefaultValue
not in [None, '']:
2407 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2408 if FromPcd
.TokenValue
not in [None, '']:
2409 ToPcd
.TokenValue
= FromPcd
.TokenValue
2410 if FromPcd
.MaxDatumSize
not in [None, '']:
2411 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2412 if FromPcd
.DatumType
not in [None, '']:
2413 ToPcd
.DatumType
= FromPcd
.DatumType
2414 if FromPcd
.SkuInfoList
not in [None, '', []]:
2415 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2417 # check the validation of datum
2418 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2420 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2421 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2422 ToPcd
.validateranges
= FromPcd
.validateranges
2423 ToPcd
.validlists
= FromPcd
.validlists
2424 ToPcd
.expressions
= FromPcd
.expressions
2426 if ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2427 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2428 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2429 Value
= ToPcd
.DefaultValue
2430 if Value
in [None, '']:
2431 ToPcd
.MaxDatumSize
= '1'
2432 elif Value
[0] == 'L':
2433 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2434 elif Value
[0] == '{':
2435 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2437 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2439 # apply default SKU for dynamic PCDS if specified one is not available
2440 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2441 and ToPcd
.SkuInfoList
in [None, {}, '']:
2442 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2443 SkuName
= self
.Platform
.SkuName
2446 ToPcd
.SkuInfoList
= {
2447 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2450 ## Apply PCD setting defined platform to a module
2452 # @param Module The module from which the PCD setting will be overrided
2454 # @retval PCD_list The list PCDs with settings from platform
2456 def ApplyPcdSetting(self
, Module
, Pcds
):
2457 # for each PCD in module
2458 for Name
, Guid
in Pcds
:
2459 PcdInModule
= Pcds
[Name
, Guid
]
2460 # find out the PCD setting in platform
2461 if (Name
, Guid
) in self
.Platform
.Pcds
:
2462 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2464 PcdInPlatform
= None
2465 # then override the settings if any
2466 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2467 # resolve the VariableGuid value
2468 for SkuId
in PcdInModule
.SkuInfoList
:
2469 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2470 if Sku
.VariableGuid
== '': continue
2471 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2472 if Sku
.VariableGuidValue
== None:
2473 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2476 RESOURCE_NOT_AVAILABLE
,
2477 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2478 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2479 % (Guid
, Name
, str(Module
)),
2483 # override PCD settings with module specific setting
2484 if Module
in self
.Platform
.Modules
:
2485 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2486 for Key
in PlatformModule
.Pcds
:
2491 elif Key
in GlobalData
.MixedPcd
:
2492 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2494 ToPcd
= Pcds
[PcdItem
]
2498 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2499 return Pcds
.values()
2501 ## Resolve library names to library modules
2503 # (for Edk.x modules)
2505 # @param Module The module from which the library names will be resolved
2507 # @retval library_list The list of library modules
2509 def ResolveLibraryReference(self
, Module
):
2510 EdkLogger
.verbose("")
2511 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2512 LibraryConsumerList
= [Module
]
2514 # "CompilerStub" is a must for Edk modules
2515 if Module
.Libraries
:
2516 Module
.Libraries
.append("CompilerStub")
2518 while len(LibraryConsumerList
) > 0:
2519 M
= LibraryConsumerList
.pop()
2520 for LibraryName
in M
.Libraries
:
2521 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2523 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2524 if LibraryName
.upper() == Key
.upper():
2525 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2528 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2529 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2532 if Library
not in LibraryList
:
2533 LibraryList
.append(Library
)
2534 LibraryConsumerList
.append(Library
)
2535 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2538 ## Calculate the priority value of the build option
2540 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2542 # @retval Value Priority value based on the priority list.
2544 def CalculatePriorityValue(self
, Key
):
2545 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2546 PriorityValue
= 0x11111
2548 PriorityValue
&= 0x01111
2549 if ToolChain
== "*":
2550 PriorityValue
&= 0x10111
2552 PriorityValue
&= 0x11011
2553 if CommandType
== "*":
2554 PriorityValue
&= 0x11101
2556 PriorityValue
&= 0x11110
2558 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2561 ## Expand * in build option key
2563 # @param Options Options to be expanded
2565 # @retval options Options expanded
2567 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2574 # Construct a list contain the build options which need override.
2578 # Key[0] -- tool family
2579 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2581 if (Key
[0] == self
.BuildRuleFamily
and
2582 (ModuleStyle
== None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2583 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2584 if Target
== self
.BuildTarget
or Target
== "*":
2585 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2586 if Arch
== self
.Arch
or Arch
== "*":
2587 if Options
[Key
].startswith("="):
2588 if OverrideList
.get(Key
[1]) != None:
2589 OverrideList
.pop(Key
[1])
2590 OverrideList
[Key
[1]] = Options
[Key
]
2593 # Use the highest priority value.
2595 if (len(OverrideList
) >= 2):
2596 KeyList
= OverrideList
.keys()
2597 for Index
in range(len(KeyList
)):
2598 NowKey
= KeyList
[Index
]
2599 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2600 for Index1
in range(len(KeyList
) - Index
- 1):
2601 NextKey
= KeyList
[Index1
+ Index
+ 1]
2603 # Compare two Key, if one is included by another, choose the higher priority one
2605 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2606 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2607 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2608 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2609 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2610 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2611 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2612 if Options
.get((self
.BuildRuleFamily
, NextKey
)) != None:
2613 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2615 if Options
.get((self
.BuildRuleFamily
, NowKey
)) != None:
2616 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2619 if ModuleStyle
!= None and len (Key
) > 2:
2620 # Check Module style is EDK or EDKII.
2621 # Only append build option for the matched style module.
2622 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2624 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2627 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2628 # if tool chain family doesn't match, skip it
2629 if Tool
in self
.ToolDefinition
and Family
!= "":
2630 FamilyIsNull
= False
2631 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2632 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2634 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2637 # expand any wildcard
2638 if Target
== "*" or Target
== self
.BuildTarget
:
2639 if Tag
== "*" or Tag
== self
.ToolChain
:
2640 if Arch
== "*" or Arch
== self
.Arch
:
2641 if Tool
not in BuildOptions
:
2642 BuildOptions
[Tool
] = {}
2643 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2644 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2646 # append options for the same tool except PATH
2648 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2650 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2651 # Build Option Family has been checked, which need't to be checked again for family.
2652 if FamilyMatch
or FamilyIsNull
:
2656 if ModuleStyle
!= None and len (Key
) > 2:
2657 # Check Module style is EDK or EDKII.
2658 # Only append build option for the matched style module.
2659 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2661 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2664 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2665 # if tool chain family doesn't match, skip it
2666 if Tool
not in self
.ToolDefinition
or Family
== "":
2668 # option has been added before
2669 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2672 # expand any wildcard
2673 if Target
== "*" or Target
== self
.BuildTarget
:
2674 if Tag
== "*" or Tag
== self
.ToolChain
:
2675 if Arch
== "*" or Arch
== self
.Arch
:
2676 if Tool
not in BuildOptions
:
2677 BuildOptions
[Tool
] = {}
2678 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2679 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2681 # append options for the same tool except PATH
2683 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2685 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2688 ## Append build options in platform to a module
2690 # @param Module The module to which the build options will be appened
2692 # @retval options The options appended with build options in platform
2694 def ApplyBuildOption(self
, Module
):
2695 # Get the different options for the different style module
2696 if Module
.AutoGenVersion
< 0x00010005:
2697 PlatformOptions
= self
.EdkBuildOption
2698 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2700 PlatformOptions
= self
.EdkIIBuildOption
2701 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2702 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2703 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2704 if Module
in self
.Platform
.Modules
:
2705 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2706 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2708 PlatformModuleOptions
= {}
2710 BuildRuleOrder
= None
2711 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2712 for Tool
in Options
:
2713 for Attr
in Options
[Tool
]:
2714 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2715 BuildRuleOrder
= Options
[Tool
][Attr
]
2717 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2718 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2719 self
.ToolDefinition
.keys())
2721 for Tool
in AllTools
:
2722 if Tool
not in BuildOptions
:
2723 BuildOptions
[Tool
] = {}
2725 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2726 if Tool
not in Options
:
2728 for Attr
in Options
[Tool
]:
2729 Value
= Options
[Tool
][Attr
]
2731 # Do not generate it in Makefile
2733 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2735 if Attr
not in BuildOptions
[Tool
]:
2736 BuildOptions
[Tool
][Attr
] = ""
2737 # check if override is indicated
2738 if Value
.startswith('='):
2739 ToolPath
= Value
[1:]
2740 ToolPath
= mws
.handleWsMacro(ToolPath
)
2741 BuildOptions
[Tool
][Attr
] = ToolPath
2743 Value
= mws
.handleWsMacro(Value
)
2745 BuildOptions
[Tool
][Attr
] += " " + Value
2747 BuildOptions
[Tool
][Attr
] = Value
2748 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
!= None:
2750 # Override UNI flag only for EDK module.
2752 if 'BUILD' not in BuildOptions
:
2753 BuildOptions
['BUILD'] = {}
2754 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2755 return BuildOptions
, BuildRuleOrder
2757 Platform
= property(_GetPlatform
)
2758 Name
= property(_GetName
)
2759 Guid
= property(_GetGuid
)
2760 Version
= property(_GetVersion
)
2762 OutputDir
= property(_GetOutputDir
)
2763 BuildDir
= property(_GetBuildDir
)
2764 MakeFileDir
= property(_GetMakeFileDir
)
2765 FdfFile
= property(_GetFdfFile
)
2767 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2768 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2769 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2770 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2771 PackageList
= property(_GetPackageList
)
2773 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2774 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2775 ToolChainFamily
= property(_GetToolChainFamily
)
2776 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2777 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2778 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2779 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2781 BuildCommand
= property(_GetBuildCommand
)
2782 BuildRule
= property(_GetBuildRule
)
2783 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2784 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2785 GenFdsCommand
= property(_GenFdsCommand
)
2787 ## ModuleAutoGen class
2789 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2790 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2791 # to the [depex] section in module's inf file.
2793 class ModuleAutoGen(AutoGen
):
2794 ## Cache the timestamps of metafiles of every module in a class variable
2798 ## The real constructor of ModuleAutoGen
2800 # This method is not supposed to be called by users of ModuleAutoGen. It's
2801 # only used by factory method __new__() to do real initialization work for an
2802 # object of ModuleAutoGen
2804 # @param Workspace EdkIIWorkspaceBuild object
2805 # @param ModuleFile The path of module file
2806 # @param Target Build target (DEBUG, RELEASE)
2807 # @param Toolchain Name of tool chain
2808 # @param Arch The arch the module supports
2809 # @param PlatformFile Platform meta-file
2811 def _Init(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2812 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2813 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2815 self
.Workspace
= Workspace
2816 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2818 self
.MetaFile
= ModuleFile
2819 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2820 # check if this module is employed by active platform
2821 if not self
.PlatformInfo
.ValidModule(self
.MetaFile
):
2822 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2823 % (self
.MetaFile
, Arch
))
2826 self
.SourceDir
= self
.MetaFile
.SubDir
2827 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2829 self
.SourceOverrideDir
= None
2830 # use overrided path defined in DSC file
2831 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2832 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2834 self
.ToolChain
= Toolchain
2835 self
.BuildTarget
= Target
2837 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2838 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2840 self
.IsMakeFileCreated
= False
2841 self
.IsCodeFileCreated
= False
2842 self
.IsAsBuiltInfCreated
= False
2843 self
.DepexGenerated
= False
2845 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2846 self
.BuildRuleOrder
= None
2852 self
._Version
= None
2853 self
._ModuleType
= None
2854 self
._ComponentType
= None
2855 self
._PcdIsDriver
= None
2856 self
._AutoGenVersion
= None
2857 self
._LibraryFlag
= None
2858 self
._CustomMakefile
= None
2861 self
._BuildDir
= None
2862 self
._OutputDir
= None
2863 self
._FfsOutputDir
= None
2864 self
._DebugDir
= None
2865 self
._MakeFileDir
= None
2867 self
._IncludePathList
= None
2868 self
._IncludePathLength
= 0
2869 self
._AutoGenFileList
= None
2870 self
._UnicodeFileList
= None
2871 self
._VfrFileList
= None
2872 self
._IdfFileList
= None
2873 self
._SourceFileList
= None
2874 self
._ObjectFileList
= None
2875 self
._BinaryFileList
= None
2877 self
._DependentPackageList
= None
2878 self
._DependentLibraryList
= None
2879 self
._LibraryAutoGenList
= None
2880 self
._DerivedPackageList
= None
2881 self
._ModulePcdList
= None
2882 self
._LibraryPcdList
= None
2883 self
._PcdComments
= sdict()
2884 self
._GuidList
= None
2885 self
._GuidsUsedByPcd
= None
2886 self
._GuidComments
= sdict()
2887 self
._ProtocolList
= None
2888 self
._ProtocolComments
= sdict()
2889 self
._PpiList
= None
2890 self
._PpiComments
= sdict()
2891 self
._DepexList
= None
2892 self
._DepexExpressionList
= None
2893 self
._BuildOption
= None
2894 self
._BuildOptionIncPathList
= None
2895 self
._BuildTargets
= None
2896 self
._IntroBuildTargetList
= None
2897 self
._FinalBuildTargetList
= None
2898 self
._FileTypes
= None
2899 self
._BuildRules
= None
2901 self
._TimeStampPath
= None
2903 self
.AutoGenDepSet
= set()
2906 ## The Modules referenced to this Library
2907 # Only Library has this attribute
2908 self
._ReferenceModules
= []
2910 ## Store the FixedAtBuild Pcds
2912 self
._FixedAtBuildPcds
= []
2917 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2919 # Get FixedAtBuild Pcds of this Module
2920 def _GetFixedAtBuildPcds(self
):
2921 if self
._FixedAtBuildPcds
:
2922 return self
._FixedAtBuildPcds
2923 for Pcd
in self
.ModulePcdList
:
2924 if Pcd
.Type
!= "FixedAtBuild":
2926 if Pcd
not in self
._FixedAtBuildPcds
:
2927 self
._FixedAtBuildPcds
.append(Pcd
)
2929 return self
._FixedAtBuildPcds
2931 def _GetUniqueBaseName(self
):
2932 BaseName
= self
.Name
2933 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2934 if Module
.MetaFile
== self
.MetaFile
:
2936 if Module
.Name
== self
.Name
:
2937 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2938 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2939 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2940 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2943 # Macros could be used in build_rule.txt (also Makefile)
2944 def _GetMacros(self
):
2945 if self
._Macro
== None:
2946 self
._Macro
= sdict()
2947 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2948 self
._Macro
["MODULE_NAME" ] = self
.Name
2949 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2950 self
._Macro
["MODULE_GUID" ] = self
.Guid
2951 self
._Macro
["MODULE_VERSION" ] = self
.Version
2952 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2953 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2954 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2955 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2956 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2958 self
._Macro
["BASE_NAME" ] = self
.Name
2960 self
._Macro
["ARCH" ] = self
.Arch
2961 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2962 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2963 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2964 self
._Macro
["TARGET" ] = self
.BuildTarget
2966 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2967 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2968 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2969 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2970 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2971 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2972 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2973 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2974 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2975 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2976 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2977 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2978 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2979 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2980 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2983 ## Return the module build data object
2984 def _GetModule(self
):
2985 if self
._Module
== None:
2986 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2989 ## Return the module name
2990 def _GetBaseName(self
):
2991 return self
.Module
.BaseName
2993 ## Return the module DxsFile if exist
2994 def _GetDxsFile(self
):
2995 return self
.Module
.DxsFile
2997 ## Return the module SourceOverridePath
2998 def _GetSourceOverridePath(self
):
2999 return self
.Module
.SourceOverridePath
3001 ## Return the module meta-file GUID
3004 # To build same module more than once, the module path with FILE_GUID overridden has
3005 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3006 # in DSC. The overridden GUID can be retrieved from file name
3008 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
3010 # Length of GUID is 36
3012 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
3013 return self
.Module
.Guid
3015 ## Return the module version
3016 def _GetVersion(self
):
3017 return self
.Module
.Version
3019 ## Return the module type
3020 def _GetModuleType(self
):
3021 return self
.Module
.ModuleType
3023 ## Return the component type (for Edk.x style of module)
3024 def _GetComponentType(self
):
3025 return self
.Module
.ComponentType
3027 ## Return the build type
3028 def _GetBuildType(self
):
3029 return self
.Module
.BuildType
3031 ## Return the PCD_IS_DRIVER setting
3032 def _GetPcdIsDriver(self
):
3033 return self
.Module
.PcdIsDriver
3035 ## Return the autogen version, i.e. module meta-file version
3036 def _GetAutoGenVersion(self
):
3037 return self
.Module
.AutoGenVersion
3039 ## Check if the module is library or not
3040 def _IsLibrary(self
):
3041 if self
._LibraryFlag
== None:
3042 if self
.Module
.LibraryClass
!= None and self
.Module
.LibraryClass
!= []:
3043 self
._LibraryFlag
= True
3045 self
._LibraryFlag
= False
3046 return self
._LibraryFlag
3048 ## Check if the module is binary module or not
3049 def _IsBinaryModule(self
):
3050 return self
.Module
.IsBinaryModule
3052 ## Return the directory to store intermediate files of the module
3053 def _GetBuildDir(self
):
3054 if self
._BuildDir
== None:
3055 self
._BuildDir
= path
.join(
3056 self
.PlatformInfo
.BuildDir
,
3059 self
.MetaFile
.BaseName
3061 CreateDirectory(self
._BuildDir
)
3062 return self
._BuildDir
3064 ## Return the directory to store the intermediate object files of the mdoule
3065 def _GetOutputDir(self
):
3066 if self
._OutputDir
== None:
3067 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3068 CreateDirectory(self
._OutputDir
)
3069 return self
._OutputDir
3071 ## Return the directory to store ffs file
3072 def _GetFfsOutputDir(self
):
3073 if self
._FfsOutputDir
== None:
3074 if GlobalData
.gFdfParser
!= None:
3075 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3077 self
._FfsOutputDir
= ''
3078 return self
._FfsOutputDir
3080 ## Return the directory to store auto-gened source files of the mdoule
3081 def _GetDebugDir(self
):
3082 if self
._DebugDir
== None:
3083 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3084 CreateDirectory(self
._DebugDir
)
3085 return self
._DebugDir
3087 ## Return the path of custom file
3088 def _GetCustomMakefile(self
):
3089 if self
._CustomMakefile
== None:
3090 self
._CustomMakefile
= {}
3091 for Type
in self
.Module
.CustomMakefile
:
3092 if Type
in gMakeTypeMap
:
3093 MakeType
= gMakeTypeMap
[Type
]
3096 if self
.SourceOverrideDir
!= None:
3097 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3098 if not os
.path
.exists(File
):
3099 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3101 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3102 self
._CustomMakefile
[MakeType
] = File
3103 return self
._CustomMakefile
3105 ## Return the directory of the makefile
3107 # @retval string The directory string of module's makefile
3109 def _GetMakeFileDir(self
):
3110 return self
.BuildDir
3112 ## Return build command string
3114 # @retval string Build command string
3116 def _GetBuildCommand(self
):
3117 return self
.PlatformInfo
.BuildCommand
3119 ## Get object list of all packages the module and its dependent libraries belong to
3121 # @retval list The list of package object
3123 def _GetDerivedPackageList(self
):
3125 for M
in [self
.Module
] + self
.DependentLibraryList
:
3126 for Package
in M
.Packages
:
3127 if Package
in PackageList
:
3129 PackageList
.append(Package
)
3132 ## Get the depex string
3134 # @return : a string contain all depex expresion.
3135 def _GetDepexExpresionString(self
):
3138 ## DPX_SOURCE IN Define section.
3139 if self
.Module
.DxsFile
:
3141 for M
in [self
.Module
] + self
.DependentLibraryList
:
3142 Filename
= M
.MetaFile
.Path
3143 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3144 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3145 for DepexExpresion
in DepexExpresionList
:
3146 for key
in DepexExpresion
.keys():
3147 Arch
, ModuleType
= key
3148 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3149 # the type of build module is USER_DEFINED.
3150 # All different DEPEX section tags would be copied into the As Built INF file
3151 # and there would be separate DEPEX section tags
3152 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3153 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3154 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3156 if Arch
.upper() == TAB_ARCH_COMMON
or \
3157 (Arch
.upper() == self
.Arch
.upper() and \
3158 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3159 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3161 #the type of build module is USER_DEFINED.
3162 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3163 for Depex
in DepexList
:
3164 for key
in Depex
.keys():
3165 DepexStr
+= '[Depex.%s.%s]\n' % key
3166 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3169 return '[Depex.%s]\n' % self
.Arch
3172 #the type of build module not is USER_DEFINED.
3174 for Depex
in DepexList
:
3179 for D
in Depex
.values():
3180 DepexStr
+= ' '.join([val
for val
in D
])
3181 Index
= DepexStr
.find('END')
3182 if Index
> -1 and Index
== len(DepexStr
) - 3:
3183 DepexStr
= DepexStr
[:-3]
3184 DepexStr
= DepexStr
.strip()
3187 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3189 return '[Depex.%s]\n' % self
.Arch
3190 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3192 ## Merge dependency expression
3194 # @retval list The token list of the dependency expression after parsed
3196 def _GetDepexTokenList(self
):
3197 if self
._DepexList
== None:
3198 self
._DepexList
= {}
3199 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3200 return self
._DepexList
3202 self
._DepexList
[self
.ModuleType
] = []
3204 for ModuleType
in self
._DepexList
:
3205 DepexList
= self
._DepexList
[ModuleType
]
3207 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3209 for M
in [self
.Module
] + self
.DependentLibraryList
:
3211 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3213 DepexList
.append('AND')
3214 DepexList
.append('(')
3216 if DepexList
[-1] == 'END': # no need of a END at this time
3218 DepexList
.append(')')
3221 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3222 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3224 if len(DepexList
) > 0:
3225 EdkLogger
.verbose('')
3226 return self
._DepexList
3228 ## Merge dependency expression
3230 # @retval list The token list of the dependency expression after parsed
3232 def _GetDepexExpressionTokenList(self
):
3233 if self
._DepexExpressionList
== None:
3234 self
._DepexExpressionList
= {}
3235 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3236 return self
._DepexExpressionList
3238 self
._DepexExpressionList
[self
.ModuleType
] = ''
3240 for ModuleType
in self
._DepexExpressionList
:
3241 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3243 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3245 for M
in [self
.Module
] + self
.DependentLibraryList
:
3247 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3248 if DepexExpressionList
!= '':
3249 DepexExpressionList
+= ' AND '
3250 DepexExpressionList
+= '('
3251 DepexExpressionList
+= D
3252 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3253 DepexExpressionList
+= ')'
3256 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3257 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3259 if len(DepexExpressionList
) > 0:
3260 EdkLogger
.verbose('')
3261 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3262 return self
._DepexExpressionList
3264 # Get the tiano core user extension, it is contain dependent library.
3265 # @retval: a list contain tiano core userextension.
3267 def _GetTianoCoreUserExtensionList(self
):
3268 TianoCoreUserExtentionList
= []
3269 for M
in [self
.Module
] + self
.DependentLibraryList
:
3270 Filename
= M
.MetaFile
.Path
3271 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3272 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3273 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3274 for Section
in TianoCoreUserExtent
.keys():
3275 ItemList
= Section
.split(TAB_SPLIT
)
3277 if len(ItemList
) == 4:
3279 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3281 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3282 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3283 TianoCoreList
.append('\n')
3284 TianoCoreUserExtentionList
.append(TianoCoreList
)
3286 return TianoCoreUserExtentionList
3288 ## Return the list of specification version required for the module
3290 # @retval list The list of specification defined in module file
3292 def _GetSpecification(self
):
3293 return self
.Module
.Specification
3295 ## Tool option for the module build
3297 # @param PlatformInfo The object of PlatformBuildInfo
3298 # @retval dict The dict containing valid options
3300 def _GetModuleBuildOption(self
):
3301 if self
._BuildOption
== None:
3302 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3303 if self
.BuildRuleOrder
:
3304 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3305 return self
._BuildOption
3307 ## Get include path list from tool option for the module build
3309 # @retval list The include path list
3311 def _GetBuildOptionIncPathList(self
):
3312 if self
._BuildOptionIncPathList
== None:
3314 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3315 # is the former use /I , the Latter used -I to specify include directories
3317 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3318 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3319 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3320 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3323 # New ToolChainFamily, don't known whether there is option to specify include directories
3325 self
._BuildOptionIncPathList
= []
3326 return self
._BuildOptionIncPathList
3328 BuildOptionIncPathList
= []
3329 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3332 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3336 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3337 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in gBuildOptIncludePattern
.findall(FlagOption
)]
3340 # RVCT may specify a list of directory seperated by commas
3343 for Path
in gBuildOptIncludePattern
.findall(FlagOption
):
3344 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3345 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3348 # EDK II modules must not reference header files outside of the packages they depend on or
3349 # within the module's directory tree. Report error if violation.
3351 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3352 for Path
in IncPathList
:
3353 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3354 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3355 EdkLogger
.error("build",
3358 File
=str(self
.MetaFile
))
3361 BuildOptionIncPathList
+= IncPathList
3363 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3365 return self
._BuildOptionIncPathList
3367 ## Return a list of files which can be built from source
3369 # What kind of files can be built is determined by build rules in
3370 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3372 def _GetSourceFileList(self
):
3373 if self
._SourceFileList
== None:
3374 self
._SourceFileList
= []
3375 for F
in self
.Module
.Sources
:
3377 if F
.TagName
not in ("", "*", self
.ToolChain
):
3378 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3379 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3381 # match tool chain family or build rule family
3382 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3385 "The file [%s] must be built by tools of [%s], " \
3386 "but current toolchain family is [%s], buildrule family is [%s]" \
3387 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3390 # add the file path into search path list for file including
3391 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3392 self
.IncludePathList
.insert(0, F
.Dir
)
3393 self
._SourceFileList
.append(F
)
3395 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3397 for F
in self
._SourceFileList
:
3398 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3399 return self
._SourceFileList
3401 def _MatchBuildRuleOrder(self
, FileList
):
3403 self
._GetModuleBuildOption
()
3404 for SingleFile
in FileList
:
3405 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3406 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3407 if key
in Order_Dict
:
3408 Order_Dict
[key
].append(SingleFile
.Ext
)
3410 Order_Dict
[key
] = [SingleFile
.Ext
]
3413 for F
in Order_Dict
:
3414 if len(Order_Dict
[F
]) > 1:
3415 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3416 for Ext
in Order_Dict
[F
][1:]:
3417 RemoveList
.append(F
+ Ext
)
3419 for item
in RemoveList
:
3420 FileList
.remove(item
)
3424 ## Return the list of unicode files
3425 def _GetUnicodeFileList(self
):
3426 if self
._UnicodeFileList
== None:
3427 if TAB_UNICODE_FILE
in self
.FileTypes
:
3428 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3430 self
._UnicodeFileList
= []
3431 return self
._UnicodeFileList
3433 ## Return the list of vfr files
3434 def _GetVfrFileList(self
):
3435 if self
._VfrFileList
== None:
3436 if TAB_VFR_FILE
in self
.FileTypes
:
3437 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3439 self
._VfrFileList
= []
3440 return self
._VfrFileList
3442 ## Return the list of Image Definition files
3443 def _GetIdfFileList(self
):
3444 if self
._IdfFileList
== None:
3445 if TAB_IMAGE_FILE
in self
.FileTypes
:
3446 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3448 self
._IdfFileList
= []
3449 return self
._IdfFileList
3451 ## Return a list of files which can be built from binary
3453 # "Build" binary files are just to copy them to build directory.
3455 # @retval list The list of files which can be built later
3457 def _GetBinaryFiles(self
):
3458 if self
._BinaryFileList
== None:
3459 self
._BinaryFileList
= []
3460 for F
in self
.Module
.Binaries
:
3461 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3463 self
._BinaryFileList
.append(F
)
3464 self
._ApplyBuildRule
(F
, F
.Type
)
3465 return self
._BinaryFileList
3467 def _GetBuildRules(self
):
3468 if self
._BuildRules
== None:
3470 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3471 for Type
in BuildRuleDatabase
.FileTypeList
:
3472 #first try getting build rule by BuildRuleFamily
3473 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3475 # build type is always module type, but ...
3476 if self
.ModuleType
!= self
.BuildType
:
3477 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3478 #second try getting build rule by ToolChainFamily
3480 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3482 # build type is always module type, but ...
3483 if self
.ModuleType
!= self
.BuildType
:
3484 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3487 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3488 BuildRules
[Type
] = RuleObject
3489 for Ext
in RuleObject
.SourceFileExtList
:
3490 BuildRules
[Ext
] = RuleObject
3491 self
._BuildRules
= BuildRules
3492 return self
._BuildRules
3494 def _ApplyBuildRule(self
, File
, FileType
):
3495 if self
._BuildTargets
== None:
3496 self
._IntroBuildTargetList
= set()
3497 self
._FinalBuildTargetList
= set()
3498 self
._BuildTargets
= {}
3499 self
._FileTypes
= {}
3501 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3502 if not os
.path
.exists(SubDirectory
):
3503 CreateDirectory(SubDirectory
)
3509 # Make sure to get build rule order value
3511 self
._GetModuleBuildOption
()
3513 while Index
< len(SourceList
):
3514 Source
= SourceList
[Index
]
3518 CreateDirectory(Source
.Dir
)
3520 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
!= None and File
in self
._BinaryFileList
:
3521 # Skip all files that are not binary libraries
3522 if not self
.IsLibrary
:
3524 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3525 elif FileType
in self
.BuildRules
:
3526 RuleObject
= self
.BuildRules
[FileType
]
3527 elif Source
.Ext
in self
.BuildRules
:
3528 RuleObject
= self
.BuildRules
[Source
.Ext
]
3530 # stop at no more rules
3532 self
._FinalBuildTargetList
.add(LastTarget
)
3535 FileType
= RuleObject
.SourceFileType
3536 if FileType
not in self
._FileTypes
:
3537 self
._FileTypes
[FileType
] = set()
3538 self
._FileTypes
[FileType
].add(Source
)
3540 # stop at STATIC_LIBRARY for library
3541 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3543 self
._FinalBuildTargetList
.add(LastTarget
)
3546 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3549 self
._FinalBuildTargetList
.add(LastTarget
)
3551 elif not Target
.Outputs
:
3552 # Only do build for target with outputs
3553 self
._FinalBuildTargetList
.add(Target
)
3555 if FileType
not in self
._BuildTargets
:
3556 self
._BuildTargets
[FileType
] = set()
3557 self
._BuildTargets
[FileType
].add(Target
)
3559 if not Source
.IsBinary
and Source
== File
:
3560 self
._IntroBuildTargetList
.add(Target
)
3562 # to avoid cyclic rule
3563 if FileType
in RuleChain
:
3566 RuleChain
.append(FileType
)
3567 SourceList
.extend(Target
.Outputs
)
3569 FileType
= TAB_UNKNOWN_FILE
3571 def _GetTargets(self
):
3572 if self
._BuildTargets
== None:
3573 self
._IntroBuildTargetList
= set()
3574 self
._FinalBuildTargetList
= set()
3575 self
._BuildTargets
= {}
3576 self
._FileTypes
= {}
3578 #TRICK: call _GetSourceFileList to apply build rule for source files
3579 if self
.SourceFileList
:
3582 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3583 if self
.BinaryFileList
:
3586 return self
._BuildTargets
3588 def _GetIntroTargetList(self
):
3590 return self
._IntroBuildTargetList
3592 def _GetFinalTargetList(self
):
3594 return self
._FinalBuildTargetList
3596 def _GetFileTypes(self
):
3598 return self
._FileTypes
3600 ## Get the list of package object the module depends on
3602 # @retval list The package object list
3604 def _GetDependentPackageList(self
):
3605 return self
.Module
.Packages
3607 ## Return the list of auto-generated code file
3609 # @retval list The list of auto-generated file
3611 def _GetAutoGenFileList(self
):
3612 UniStringAutoGenC
= True
3613 IdfStringAutoGenC
= True
3614 UniStringBinBuffer
= StringIO()
3615 IdfGenBinBuffer
= StringIO()
3616 if self
.BuildType
== 'UEFI_HII':
3617 UniStringAutoGenC
= False
3618 IdfStringAutoGenC
= False
3619 if self
._AutoGenFileList
== None:
3620 self
._AutoGenFileList
= {}
3621 AutoGenC
= TemplateString()
3622 AutoGenH
= TemplateString()
3623 StringH
= TemplateString()
3624 StringIdf
= TemplateString()
3625 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3627 # AutoGen.c is generated if there are library classes in inf, or there are object files
3629 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3630 or TAB_OBJECT_FILE
in self
.FileTypes
):
3631 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3632 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3633 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3634 if str(AutoGenH
) != "":
3635 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3636 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3637 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3638 if str(StringH
) != "":
3639 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3640 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3641 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3642 if UniStringBinBuffer
!= None and UniStringBinBuffer
.getvalue() != "":
3643 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3644 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3645 AutoFile
.IsBinary
= True
3646 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3647 if UniStringBinBuffer
!= None:
3648 UniStringBinBuffer
.close()
3649 if str(StringIdf
) != "":
3650 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3651 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3652 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3653 if IdfGenBinBuffer
!= None and IdfGenBinBuffer
.getvalue() != "":
3654 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3655 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3656 AutoFile
.IsBinary
= True
3657 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3658 if IdfGenBinBuffer
!= None:
3659 IdfGenBinBuffer
.close()
3660 return self
._AutoGenFileList
3662 ## Return the list of library modules explicitly or implicityly used by this module
3663 def _GetLibraryList(self
):
3664 if self
._DependentLibraryList
== None:
3665 # only merge library classes and PCD for non-library module
3667 self
._DependentLibraryList
= []
3669 if self
.AutoGenVersion
< 0x00010005:
3670 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3672 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3673 return self
._DependentLibraryList
3676 def UpdateComments(Recver
, Src
):
3678 if Key
not in Recver
:
3680 Recver
[Key
].extend(Src
[Key
])
3681 ## Get the list of PCDs from current module
3683 # @retval list The list of PCD
3685 def _GetModulePcdList(self
):
3686 if self
._ModulePcdList
== None:
3687 # apply PCD settings from platform
3688 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3689 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3690 return self
._ModulePcdList
3692 ## Get the list of PCDs from dependent libraries
3694 # @retval list The list of PCD
3696 def _GetLibraryPcdList(self
):
3697 if self
._LibraryPcdList
== None:
3699 if not self
.IsLibrary
:
3700 # get PCDs from dependent libraries
3701 for Library
in self
.DependentLibraryList
:
3702 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3703 for Key
in Library
.Pcds
:
3704 # skip duplicated PCDs
3705 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3707 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3708 # apply PCD settings from platform
3709 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3711 self
._LibraryPcdList
= []
3712 return self
._LibraryPcdList
3714 ## Get the GUID value mapping
3716 # @retval dict The mapping between GUID cname and its value
3718 def _GetGuidList(self
):
3719 if self
._GuidList
== None:
3720 self
._GuidList
= sdict()
3721 self
._GuidList
.update(self
.Module
.Guids
)
3722 for Library
in self
.DependentLibraryList
:
3723 self
._GuidList
.update(Library
.Guids
)
3724 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3725 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3726 return self
._GuidList
3728 def GetGuidsUsedByPcd(self
):
3729 if self
._GuidsUsedByPcd
== None:
3730 self
._GuidsUsedByPcd
= sdict()
3731 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3732 for Library
in self
.DependentLibraryList
:
3733 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3734 return self
._GuidsUsedByPcd
3735 ## Get the protocol value mapping
3737 # @retval dict The mapping between protocol cname and its value
3739 def _GetProtocolList(self
):
3740 if self
._ProtocolList
== None:
3741 self
._ProtocolList
= sdict()
3742 self
._ProtocolList
.update(self
.Module
.Protocols
)
3743 for Library
in self
.DependentLibraryList
:
3744 self
._ProtocolList
.update(Library
.Protocols
)
3745 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3746 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3747 return self
._ProtocolList
3749 ## Get the PPI value mapping
3751 # @retval dict The mapping between PPI cname and its value
3753 def _GetPpiList(self
):
3754 if self
._PpiList
== None:
3755 self
._PpiList
= sdict()
3756 self
._PpiList
.update(self
.Module
.Ppis
)
3757 for Library
in self
.DependentLibraryList
:
3758 self
._PpiList
.update(Library
.Ppis
)
3759 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3760 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3761 return self
._PpiList
3763 ## Get the list of include search path
3765 # @retval list The list path
3767 def _GetIncludePathList(self
):
3768 if self
._IncludePathList
== None:
3769 self
._IncludePathList
= []
3770 if self
.AutoGenVersion
< 0x00010005:
3771 for Inc
in self
.Module
.Includes
:
3772 if Inc
not in self
._IncludePathList
:
3773 self
._IncludePathList
.append(Inc
)
3775 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3776 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3777 self
._IncludePathList
.append(Inc
)
3778 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3779 self
._IncludePathList
.append(self
.DebugDir
)
3781 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3782 self
._IncludePathList
.append(self
.DebugDir
)
3784 for Package
in self
.Module
.Packages
:
3785 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3786 if PackageDir
not in self
._IncludePathList
:
3787 self
._IncludePathList
.append(PackageDir
)
3788 IncludesList
= Package
.Includes
3789 if Package
._PrivateIncludes
:
3790 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3791 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3792 for Inc
in IncludesList
:
3793 if Inc
not in self
._IncludePathList
:
3794 self
._IncludePathList
.append(str(Inc
))
3795 return self
._IncludePathList
3797 def _GetIncludePathLength(self
):
3798 self
._IncludePathLength
= 0
3799 if self
._IncludePathList
:
3800 for inc
in self
._IncludePathList
:
3801 self
._IncludePathLength
+= len(' ' + inc
)
3802 return self
._IncludePathLength
3804 ## Get HII EX PCDs which maybe used by VFR
3806 # efivarstore used by VFR may relate with HII EX PCDs
3807 # Get the variable name and GUID from efivarstore and HII EX PCD
3808 # List the HII EX PCDs in As Built INF if both name and GUID match.
3810 # @retval list HII EX PCDs
3812 def _GetPcdsMaybeUsedByVfr(self
):
3813 if not self
.SourceFileList
:
3817 for SrcFile
in self
.SourceFileList
:
3818 if SrcFile
.Ext
.lower() != '.vfr':
3820 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3821 if not os
.path
.exists(Vfri
):
3823 VfriFile
= open(Vfri
, 'r')
3824 Content
= VfriFile
.read()
3826 Pos
= Content
.find('efivarstore')
3829 # Make sure 'efivarstore' is the start of efivarstore statement
3830 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3833 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3835 if Index
>= 0 and Content
[Index
] != ';':
3836 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3839 # 'efivarstore' must be followed by name and guid
3841 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3844 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3847 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3848 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3849 Pos
= Content
.find('efivarstore', Name
.end())
3853 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3854 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3856 for SkuName
in Pcd
.SkuInfoList
:
3857 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3858 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3859 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3862 Guid
= GuidStructureStringToGuidString(Value
)
3863 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3864 HiiExPcds
.append(Pcd
)
3869 def _GenOffsetBin(self
):
3871 for SourceFile
in self
.Module
.Sources
:
3872 if SourceFile
.Type
.upper() == ".VFR" :
3874 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3876 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3877 if SourceFile
.Type
.upper() == ".UNI" :
3879 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3881 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3883 if len(VfrUniBaseName
) == 0:
3885 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3886 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3887 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3888 if not VfrUniOffsetList
:
3891 OutputName
= '%sOffset.bin' % self
.Name
3892 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3895 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3897 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3899 # Use a instance of StringIO to cache data
3900 fStringIO
= StringIO('')
3902 for Item
in VfrUniOffsetList
:
3903 if (Item
[0].find("Strings") != -1):
3905 # UNI offset in image.
3907 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3909 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3910 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3911 fStringIO
.write(''.join(UniGuid
))
3912 UniValue
= pack ('Q', int (Item
[1], 16))
3913 fStringIO
.write (UniValue
)
3916 # VFR binary offset in image.
3918 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3920 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3921 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3922 fStringIO
.write(''.join(VfrGuid
))
3924 VfrValue
= pack ('Q', int (Item
[1], 16))
3925 fStringIO
.write (VfrValue
)
3927 # write data into file.
3930 fInputfile
.write (fStringIO
.getvalue())
3932 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3933 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3939 ## Create AsBuilt INF file the module
3941 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3942 self
.OutputFile
= []
3944 if GlobalData
.gBinCacheDest
:
3945 self
.CopyModuleToCache()
3948 if self
.IsAsBuiltInfCreated
:
3951 # Skip the following code for EDK I inf
3952 if self
.AutoGenVersion
< 0x00010005:
3955 # Skip the following code for libraries
3959 # Skip the following code for modules with no source files
3960 if self
.SourceFileList
== None or self
.SourceFileList
== []:
3963 # Skip the following code for modules without any binary files
3964 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3967 ### TODO: How to handles mixed source and binary modules
3969 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3970 # Also find all packages that the DynamicEx PCDs depend on
3975 PcdTokenSpaceList
= []
3976 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3977 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3978 PatchablePcds
+= [Pcd
]
3979 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3980 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3983 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3984 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3985 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3987 GuidList
.update(self
.GuidList
)
3988 for TokenSpace
in self
.GetGuidsUsedByPcd():
3989 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3990 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3991 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3992 GuidList
.pop(TokenSpace
)
3993 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3994 for Package
in self
.DerivedPackageList
:
3995 if Package
in Packages
:
3997 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3999 for Index
in range(len(BeChecked
)):
4000 for Item
in CheckList
[Index
]:
4001 if Item
in BeChecked
[Index
]:
4002 Packages
+= [Package
]
4007 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
4008 for Pkg
in self
.PlatformInfo
.PackageList
:
4011 for VfrPcd
in VfrPcds
:
4012 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
4013 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
4017 ModuleType
= self
.ModuleType
4018 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
4019 ModuleType
= 'DXE_DRIVER'
4022 if self
.PcdIsDriver
!= '':
4023 DriverType
= self
.PcdIsDriver
4026 MDefs
= self
.Module
.Defines
4029 'module_name' : self
.Name
,
4030 'module_guid' : Guid
,
4031 'module_module_type' : ModuleType
,
4032 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
4033 'pcd_is_driver_string' : [],
4034 'module_uefi_specification_version' : [],
4035 'module_pi_specification_version' : [],
4036 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
4037 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
4038 'module_constructor' : self
.Module
.ConstructorList
,
4039 'module_destructor' : self
.Module
.DestructorList
,
4040 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4041 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4042 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4043 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4044 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4045 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4046 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4047 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4048 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4049 'module_arch' : self
.Arch
,
4050 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4052 'patchablepcd_item' : [],
4054 'protocol_item' : [],
4058 'libraryclasses_item' : []
4061 if 'MODULE_UNI_FILE' in MDefs
:
4062 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4063 if os
.path
.isfile(UNIFile
):
4064 shutil
.copy2(UNIFile
, self
.OutputDir
)
4066 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4067 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4069 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4072 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4074 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4075 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4076 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4077 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4079 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4080 for Item
in self
.CodaTargetList
:
4081 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4082 if File
not in self
.OutputFile
:
4083 self
.OutputFile
.append(File
)
4084 if Item
.Target
.Ext
.lower() == '.aml':
4085 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4086 elif Item
.Target
.Ext
.lower() == '.acpi':
4087 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4088 elif Item
.Target
.Ext
.lower() == '.efi':
4089 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4091 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4092 if self
.DepexGenerated
:
4093 if self
.Name
+ '.depex' not in self
.OutputFile
:
4094 self
.OutputFile
.append(self
.Name
+ '.depex')
4095 if self
.ModuleType
in ['PEIM']:
4096 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4097 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4098 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4099 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4100 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4102 Bin
= self
._GenOffsetBin
()
4104 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4105 if Bin
not in self
.OutputFile
:
4106 self
.OutputFile
.append(Bin
)
4108 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4110 if File
.lower().endswith('.pdb'):
4111 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4112 if File
not in self
.OutputFile
:
4113 self
.OutputFile
.append(File
)
4114 HeaderComments
= self
.Module
.HeaderComments
4116 for Index
in range(len(HeaderComments
)):
4117 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4118 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4121 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4122 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4125 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4126 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4127 (GuidList
, self
._GuidComments
, 'guid_item')
4129 for Item
in GenList
:
4130 for CName
in Item
[0]:
4132 if CName
in Item
[1]:
4133 Comments
= '\n '.join(Item
[1][CName
])
4136 Entry
= Comments
+ '\n ' + CName
4137 AsBuiltInfDict
[Item
[2]].append(Entry
)
4138 PatchList
= parsePcdInfoFromMapFile(
4139 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4140 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4143 for Pcd
in PatchablePcds
:
4144 TokenCName
= Pcd
.TokenCName
4145 for PcdItem
in GlobalData
.MixedPcd
:
4146 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4147 TokenCName
= PcdItem
[0]
4149 for PatchPcd
in PatchList
:
4150 if TokenCName
== PatchPcd
[0]:
4155 if Pcd
.DatumType
== 'BOOLEAN':
4156 BoolValue
= Pcd
.DefaultValue
.upper()
4157 if BoolValue
== 'TRUE':
4158 Pcd
.DefaultValue
= '1'
4159 elif BoolValue
== 'FALSE':
4160 Pcd
.DefaultValue
= '0'
4162 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4163 HexFormat
= '0x%02x'
4164 if Pcd
.DatumType
== 'UINT16':
4165 HexFormat
= '0x%04x'
4166 elif Pcd
.DatumType
== 'UINT32':
4167 HexFormat
= '0x%08x'
4168 elif Pcd
.DatumType
== 'UINT64':
4169 HexFormat
= '0x%016x'
4170 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4172 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
4173 EdkLogger
.error("build", AUTOGEN_ERROR
,
4174 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4176 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4177 PcdValue
= Pcd
.DefaultValue
4178 if PcdValue
[0] != '{':
4180 if PcdValue
[0] == 'L':
4182 PcdValue
= PcdValue
.lstrip('L')
4183 PcdValue
= eval(PcdValue
)
4185 for Index
in range(0, len(PcdValue
)):
4187 CharVal
= ord(PcdValue
[Index
])
4188 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4189 + '0x%02x' % (CharVal
>> 8) + ', '
4191 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4194 Padding
= Padding
* 2
4195 ArraySize
= ArraySize
/ 2
4196 if ArraySize
< (len(PcdValue
) + 1):
4197 EdkLogger
.error("build", AUTOGEN_ERROR
,
4198 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4200 if ArraySize
> len(PcdValue
) + 1:
4201 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4202 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4203 elif len(PcdValue
.split(',')) <= ArraySize
:
4204 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4207 EdkLogger
.error("build", AUTOGEN_ERROR
,
4208 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4210 PcdItem
= '%s.%s|%s|0x%X' % \
4211 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4213 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4214 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4216 PcdItem
= PcdComments
+ '\n ' + PcdItem
4217 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4220 for Pcd
in Pcds
+ VfrPcds
:
4225 TokenCName
= Pcd
.TokenCName
4226 for PcdItem
in GlobalData
.MixedPcd
:
4227 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4228 TokenCName
= PcdItem
[0]
4230 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4231 for SkuName
in Pcd
.SkuInfoList
:
4232 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4233 SkuId
= SkuInfo
.SkuId
4234 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4238 # Don't generate duplicated HII PCD
4240 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4243 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4244 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4245 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4249 for Index
, Comment
in enumerate(PcdCommentList
):
4250 for Usage
in UsageList
:
4251 if Comment
.find(Usage
) != -1:
4255 if UsageIndex
!= -1:
4256 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4258 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4259 PcdComments
= '\n '.join(PcdCommentList
)
4260 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4262 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4263 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4264 for Item
in self
.BuildOption
:
4265 if 'FLAGS' in self
.BuildOption
[Item
]:
4266 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4268 # Generated LibraryClasses section in comments.
4269 for Library
in self
.LibraryAutoGenList
:
4270 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4272 # Generated UserExtensions TianoCore section.
4273 # All tianocore user extensions are copied.
4275 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4276 UserExtStr
+= '\n'.join(TianoCore
)
4277 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4278 if os
.path
.isfile(ExtensionFile
):
4279 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4280 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4282 # Generated depex expression section in comments.
4283 AsBuiltInfDict
['depexsection_item'] = ''
4284 DepexExpresion
= self
._GetDepexExpresionString
()
4286 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4288 AsBuiltInf
= TemplateString()
4289 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4291 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4293 self
.IsAsBuiltInfCreated
= True
4294 if GlobalData
.gBinCacheDest
:
4295 self
.CopyModuleToCache()
4297 def CopyModuleToCache(self
):
4298 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4299 CreateDirectory (FileDir
)
4300 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4301 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4302 if os
.path
.exists(HashFile
):
4303 shutil
.copy2(HashFile
, FileDir
)
4304 if os
.path
.exists(ModuleFile
):
4305 shutil
.copy2(ModuleFile
, FileDir
)
4306 if not self
.OutputFile
:
4307 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4308 self
.OutputFile
= Ma
.Binaries
4310 for File
in self
.OutputFile
:
4312 if not os
.path
.isabs(File
):
4313 File
= os
.path
.join(self
.OutputDir
, File
)
4314 if os
.path
.exists(File
):
4315 shutil
.copy2(File
, FileDir
)
4317 def AttemptModuleCacheCopy(self
):
4318 if self
.IsBinaryModule
:
4320 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4321 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4322 if os
.path
.exists(HashFile
):
4323 f
= open(HashFile
, 'r')
4324 CacheHash
= f
.read()
4326 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4327 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4328 for root
, dir, files
in os
.walk(FileDir
):
4330 if self
.Name
+ '.hash' in f
:
4331 shutil
.copy2(HashFile
, self
.BuildDir
)
4333 File
= path
.join(root
, f
)
4334 shutil
.copy2(File
, self
.OutputDir
)
4335 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4336 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4340 ## Create makefile for the module and its dependent libraries
4342 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4343 # dependent libraries will be created
4345 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4346 # Ignore generating makefile when it is a binary module
4347 if self
.IsBinaryModule
:
4350 if self
.IsMakeFileCreated
:
4352 self
.GenFfsList
= GenFfsList
4353 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4354 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4355 LibraryAutoGen
.CreateMakeFile()
4360 if len(self
.CustomMakefile
) == 0:
4361 Makefile
= GenMake
.ModuleMakefile(self
)
4363 Makefile
= GenMake
.CustomMakefile(self
)
4364 if Makefile
.Generate():
4365 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4366 (self
.Name
, self
.Arch
))
4368 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4369 (self
.Name
, self
.Arch
))
4371 self
.CreateTimeStamp(Makefile
)
4372 self
.IsMakeFileCreated
= True
4374 def CopyBinaryFiles(self
):
4375 for File
in self
.Module
.Binaries
:
4377 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4378 CopyLongFilePath(SrcPath
, DstPath
)
4379 ## Create autogen code for the module and its dependent libraries
4381 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4382 # dependent libraries will be created
4384 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4385 if self
.IsCodeFileCreated
:
4388 # Need to generate PcdDatabase even PcdDriver is binarymodule
4389 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4390 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4392 if self
.IsBinaryModule
:
4394 self
.CopyBinaryFiles()
4397 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4398 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4399 LibraryAutoGen
.CreateCodeFile()
4405 IgoredAutoGenList
= []
4407 for File
in self
.AutoGenFileList
:
4408 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4409 #Ignore Edk AutoGen.c
4410 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4413 AutoGenList
.append(str(File
))
4415 IgoredAutoGenList
.append(str(File
))
4417 # Skip the following code for EDK I inf
4418 if self
.AutoGenVersion
< 0x00010005:
4421 for ModuleType
in self
.DepexList
:
4422 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4423 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4426 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4427 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4429 if len(Dpx
.PostfixNotation
) <> 0:
4430 self
.DepexGenerated
= True
4432 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4433 AutoGenList
.append(str(DpxFile
))
4435 IgoredAutoGenList
.append(str(DpxFile
))
4437 if IgoredAutoGenList
== []:
4438 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4439 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4440 elif AutoGenList
== []:
4441 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4442 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4444 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4445 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4447 self
.IsCodeFileCreated
= True
4450 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4451 def _GetLibraryAutoGenList(self
):
4452 if self
._LibraryAutoGenList
== None:
4453 self
._LibraryAutoGenList
= []
4454 for Library
in self
.DependentLibraryList
:
4461 self
.PlatformInfo
.MetaFile
4463 if La
not in self
._LibraryAutoGenList
:
4464 self
._LibraryAutoGenList
.append(La
)
4465 for Lib
in La
.CodaTargetList
:
4466 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4467 return self
._LibraryAutoGenList
4469 def GenModuleHash(self
):
4470 if self
.Arch
not in GlobalData
.gModuleHash
:
4471 GlobalData
.gModuleHash
[self
.Arch
] = {}
4473 # Add Platform level hash
4474 m
.update(GlobalData
.gPlatformHash
)
4475 # Add Package level hash
4476 if self
.DependentPackageList
:
4477 for Pkg
in self
.DependentPackageList
:
4478 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4479 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4482 if self
.LibraryAutoGenList
:
4483 for Lib
in self
.LibraryAutoGenList
:
4484 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4486 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4489 f
= open(str(self
.MetaFile
), 'r')
4493 # Add Module's source files
4494 if self
.SourceFileList
:
4495 for File
in self
.SourceFileList
:
4496 f
= open(str(File
), 'r')
4501 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4502 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4503 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4504 if GlobalData
.gBinCacheSource
:
4505 CacheValid
= self
.AttemptModuleCacheCopy()
4508 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4510 ## Decide whether we can skip the ModuleAutoGen process
4511 def CanSkipbyHash(self
):
4512 if GlobalData
.gUseHashCache
:
4513 return not self
.GenModuleHash()
4515 ## Decide whether we can skip the ModuleAutoGen process
4516 # If any source file is newer than the module than we cannot skip
4519 if not os
.path
.exists(self
.GetTimeStampPath()):
4521 #last creation time of the module
4522 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4524 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4525 if SrcTimeStamp
> DstTimeStamp
:
4528 with
open(self
.GetTimeStampPath(),'r') as f
:
4530 source
= source
.rstrip('\n')
4531 if not os
.path
.exists(source
):
4533 if source
not in ModuleAutoGen
.TimeDict
:
4534 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4535 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4539 def GetTimeStampPath(self
):
4540 if self
._TimeStampPath
== None:
4541 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4542 return self
._TimeStampPath
4543 def CreateTimeStamp(self
, Makefile
):
4547 FileSet
.add (self
.MetaFile
.Path
)
4549 for SourceFile
in self
.Module
.Sources
:
4550 FileSet
.add (SourceFile
.Path
)
4552 for Lib
in self
.DependentLibraryList
:
4553 FileSet
.add (Lib
.MetaFile
.Path
)
4555 for f
in self
.AutoGenDepSet
:
4556 FileSet
.add (f
.Path
)
4558 if os
.path
.exists (self
.GetTimeStampPath()):
4559 os
.remove (self
.GetTimeStampPath())
4560 with
open(self
.GetTimeStampPath(), 'w+') as file:
4564 Module
= property(_GetModule
)
4565 Name
= property(_GetBaseName
)
4566 Guid
= property(_GetGuid
)
4567 Version
= property(_GetVersion
)
4568 ModuleType
= property(_GetModuleType
)
4569 ComponentType
= property(_GetComponentType
)
4570 BuildType
= property(_GetBuildType
)
4571 PcdIsDriver
= property(_GetPcdIsDriver
)
4572 AutoGenVersion
= property(_GetAutoGenVersion
)
4573 Macros
= property(_GetMacros
)
4574 Specification
= property(_GetSpecification
)
4576 IsLibrary
= property(_IsLibrary
)
4577 IsBinaryModule
= property(_IsBinaryModule
)
4578 BuildDir
= property(_GetBuildDir
)
4579 OutputDir
= property(_GetOutputDir
)
4580 FfsOutputDir
= property(_GetFfsOutputDir
)
4581 DebugDir
= property(_GetDebugDir
)
4582 MakeFileDir
= property(_GetMakeFileDir
)
4583 CustomMakefile
= property(_GetCustomMakefile
)
4585 IncludePathList
= property(_GetIncludePathList
)
4586 IncludePathLength
= property(_GetIncludePathLength
)
4587 AutoGenFileList
= property(_GetAutoGenFileList
)
4588 UnicodeFileList
= property(_GetUnicodeFileList
)
4589 VfrFileList
= property(_GetVfrFileList
)
4590 SourceFileList
= property(_GetSourceFileList
)
4591 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4592 Targets
= property(_GetTargets
)
4593 IntroTargetList
= property(_GetIntroTargetList
)
4594 CodaTargetList
= property(_GetFinalTargetList
)
4595 FileTypes
= property(_GetFileTypes
)
4596 BuildRules
= property(_GetBuildRules
)
4597 IdfFileList
= property(_GetIdfFileList
)
4599 DependentPackageList
= property(_GetDependentPackageList
)
4600 DependentLibraryList
= property(_GetLibraryList
)
4601 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4602 DerivedPackageList
= property(_GetDerivedPackageList
)
4604 ModulePcdList
= property(_GetModulePcdList
)
4605 LibraryPcdList
= property(_GetLibraryPcdList
)
4606 GuidList
= property(_GetGuidList
)
4607 ProtocolList
= property(_GetProtocolList
)
4608 PpiList
= property(_GetPpiList
)
4609 DepexList
= property(_GetDepexTokenList
)
4610 DxsFile
= property(_GetDxsFile
)
4611 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4612 BuildOption
= property(_GetModuleBuildOption
)
4613 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4614 BuildCommand
= property(_GetBuildCommand
)
4616 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4618 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4619 if __name__
== '__main__':