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
= []
1265 if GlobalData
.gFdfParser
!= None:
1266 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1267 for Inf
in self
._AsBuildInfList
:
1268 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1269 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1270 if not M
.IsSupportedArch
:
1272 self
._AsBuildModuleList
.append(InfClass
)
1273 # get library/modules for build
1274 self
.LibraryBuildDirectoryList
= []
1275 self
.ModuleBuildDirectoryList
= []
1279 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1281 ## Create autogen code for platform and modules
1283 # Since there's no autogen code for platform, this method will do nothing
1284 # if CreateModuleCodeFile is set to False.
1286 # @param CreateModuleCodeFile Flag indicating if creating module's
1287 # autogen code file or not
1289 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1290 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1291 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1294 for Ma
in self
.ModuleAutoGenList
:
1295 Ma
.CreateCodeFile(True)
1297 # don't do this twice
1298 self
.IsCodeFileCreated
= True
1300 ## Generate Fds Command
1301 def _GenFdsCommand(self
):
1302 return self
.Workspace
.GenFdsCommand
1304 ## Create makefile for the platform and mdoules in it
1306 # @param CreateModuleMakeFile Flag indicating if the makefile for
1307 # modules will be created as well
1309 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1310 if CreateModuleMakeFile
:
1311 for ModuleFile
in self
.Platform
.Modules
:
1312 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1313 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1314 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1315 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1317 Ma
.CreateMakeFile(True)
1318 #Ma.CreateAsBuiltInf()
1320 # no need to create makefile for the platform more than once
1321 if self
.IsMakeFileCreated
:
1324 # create library/module build dirs for platform
1325 Makefile
= GenMake
.PlatformMakefile(self
)
1326 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1327 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1329 self
.IsMakeFileCreated
= True
1331 ## Deal with Shared FixedAtBuild Pcds
1333 def CollectFixedAtBuildPcds(self
):
1334 for LibAuto
in self
.LibraryAutoGenList
:
1335 FixedAtBuildPcds
= {}
1336 ShareFixedAtBuildPcdsSameValue
= {}
1337 for Module
in LibAuto
._ReferenceModules
:
1338 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1339 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1340 if key
not in FixedAtBuildPcds
:
1341 ShareFixedAtBuildPcdsSameValue
[key
] = True
1342 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1344 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1345 ShareFixedAtBuildPcdsSameValue
[key
] = False
1346 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1347 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1348 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1351 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1352 if DscPcd
.Type
!= "FixedAtBuild":
1354 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1355 LibAuto
.ConstPcd
[key
] = Pcd
.DefaultValue
1357 def CollectVariables(self
, DynamicPcdSet
):
1358 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1360 for Pcd
in DynamicPcdSet
:
1361 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1362 for SkuName
in Pcd
.SkuInfoList
:
1363 Sku
= Pcd
.SkuInfoList
[SkuName
]
1365 if SkuId
== None or SkuId
== '':
1367 if len(Sku
.VariableName
) > 0:
1368 VariableGuidStructure
= Sku
.VariableGuidValue
1369 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1370 if Pcd
.Phase
== "DXE":
1371 for StorageName
in Sku
.DefaultStoreDict
:
1372 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableAttribute
, Pcd
.DefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1375 ## Collect dynamic PCDs
1377 # Gather dynamic PCDs list from each module and their settings from platform
1378 # This interface should be invoked explicitly when platform action is created.
1380 def CollectPlatformDynamicPcds(self
):
1381 # Override the platform Pcd's value by build option
1382 if GlobalData
.BuildOptionPcd
:
1383 for key
in self
.Platform
.Pcds
:
1384 PlatformPcd
= self
.Platform
.Pcds
[key
]
1385 for PcdItem
in GlobalData
.BuildOptionPcd
:
1386 if (PlatformPcd
.TokenSpaceGuidCName
, PlatformPcd
.TokenCName
) == (PcdItem
[0], PcdItem
[1]):
1387 PlatformPcd
.DefaultValue
= PcdItem
[2]
1388 if PlatformPcd
.SkuInfoList
:
1389 Sku
= PlatformPcd
.SkuInfoList
[PlatformPcd
.SkuInfoList
.keys()[0]]
1390 Sku
.DefaultValue
= PcdItem
[2]
1393 for key
in self
.Platform
.Pcds
:
1394 for SinglePcd
in GlobalData
.MixedPcd
:
1395 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1396 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1397 Pcd_Type
= item
[0].split('_')[-1]
1398 if (Pcd_Type
== self
.Platform
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
1399 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1400 Value
= self
.Platform
.Pcds
[key
]
1401 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1403 newkey
= (Value
.TokenCName
, key
[1])
1405 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1406 del self
.Platform
.Pcds
[key
]
1407 self
.Platform
.Pcds
[newkey
] = Value
1415 # for gathering error information
1416 NoDatumTypePcdList
= set()
1418 self
._GuidValue
= {}
1420 for InfName
in self
._AsBuildInfList
:
1421 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1422 FdfModuleList
.append(os
.path
.normpath(InfName
))
1423 for F
in self
.Platform
.Modules
.keys():
1424 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1425 #GuidValue.update(M.Guids)
1427 self
.Platform
.Modules
[F
].M
= M
1429 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1430 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1431 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1432 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1434 # Check the PCD from Binary INF or Source INF
1435 if M
.IsBinaryModule
== True:
1436 PcdFromModule
.IsFromBinaryInf
= True
1438 # Check the PCD from DSC or not
1439 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1440 PcdFromModule
.IsFromDsc
= True
1442 PcdFromModule
.IsFromDsc
= False
1443 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1444 if F
.Path
not in FdfModuleList
:
1445 # If one of the Source built modules listed in the DSC is not listed
1446 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1447 # access method (it is only listed in the DEC file that declares the
1448 # PCD as PcdsDynamic), then build tool will report warning message
1449 # notify the PI that they are attempting to build a module that must
1450 # be included in a flash image in order to be functional. These Dynamic
1451 # PCD will not be added into the Database unless it is used by other
1452 # modules that are included in the FDF file.
1453 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1454 PcdFromModule
.IsFromBinaryInf
== False:
1455 # Print warning message to let the developer make a determine.
1456 if PcdFromModule
not in PcdNotInDb
:
1457 PcdNotInDb
.append(PcdFromModule
)
1459 # If one of the Source built modules listed in the DSC is not listed in
1460 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1461 # access method (it is only listed in the DEC file that declares the
1462 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1463 # PCD to the Platform's PCD Database.
1464 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1465 if PcdFromModule
not in PcdNotInDb
:
1466 PcdNotInDb
.append(PcdFromModule
)
1469 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1470 # it should be stored in Pcd PEI database, If a dynamic only
1471 # used by DXE module, it should be stored in DXE PCD database.
1472 # The default Phase is DXE
1474 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1475 PcdFromModule
.Phase
= "PEI"
1476 if PcdFromModule
not in self
._DynaPcdList
_:
1477 self
._DynaPcdList
_.append(PcdFromModule
)
1478 elif PcdFromModule
.Phase
== 'PEI':
1479 # overwrite any the same PCD existing, if Phase is PEI
1480 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1481 self
._DynaPcdList
_[Index
] = PcdFromModule
1482 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1483 self
._NonDynaPcdList
_.append(PcdFromModule
)
1484 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1485 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1486 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1487 #The PCD from Binary INF will override the same one from source INF
1488 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1489 PcdFromModule
.Pending
= False
1490 self
._NonDynaPcdList
_.append (PcdFromModule
)
1491 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1493 for ModuleInf
in self
.Platform
.Modules
.keys():
1494 DscModuleList
.append (os
.path
.normpath(ModuleInf
.Path
))
1495 # add the PCD from modules that listed in FDF but not in DSC to Database
1496 for InfName
in FdfModuleList
:
1497 if InfName
not in DscModuleList
:
1498 InfClass
= PathClass(InfName
)
1499 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1500 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1501 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1502 # For binary module, if in current arch, we need to list the PCDs into database.
1503 if not M
.IsSupportedArch
:
1505 # Override the module PCD setting by platform setting
1506 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1507 for PcdFromModule
in ModulePcdList
:
1508 PcdFromModule
.IsFromBinaryInf
= True
1509 PcdFromModule
.IsFromDsc
= False
1510 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1511 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1512 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1514 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1515 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1516 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1517 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1518 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1519 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1520 PcdFromModule
.Phase
= "PEI"
1521 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1522 self
._DynaPcdList
_.append(PcdFromModule
)
1523 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1524 self
._NonDynaPcdList
_.append(PcdFromModule
)
1525 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1526 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1527 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1528 # module & DXE module at a same time.
1529 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1530 # INF file as DynamicEx.
1531 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1532 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1533 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1534 for PcdFromModule
in self
._NonDynaPcdList
_:
1535 # If a PCD is not listed in the DSC file, but binary INF files used by
1536 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1537 # section, AND all source INF files used by this platform the build
1538 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1539 # section, then the tools must NOT add the PCD to the Platform's PCD
1540 # Database; the build must assign the access method for this PCD as
1541 # PcdsPatchableInModule.
1542 if PcdFromModule
not in self
._DynaPcdList
_:
1544 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1545 if PcdFromModule
.IsFromDsc
== False and \
1546 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1547 PcdFromModule
.IsFromBinaryInf
== True and \
1548 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1549 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1550 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1552 # print out error information and break the build, if error found
1553 if len(NoDatumTypePcdList
) > 0:
1554 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1555 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1557 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1558 % NoDatumTypePcdListString
)
1559 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1560 self
._DynamicPcdList
= self
._DynaPcdList
_
1562 # Sort dynamic PCD list to:
1563 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1564 # try to be put header of dynamicd List
1565 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1567 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1569 UnicodePcdArray
= []
1573 VpdFile
= VpdInfoFile
.VpdInfoFile()
1574 NeedProcessVpdMapFile
= False
1576 for pcd
in self
.Platform
.Pcds
.keys():
1577 if pcd
not in self
._PlatformPcds
.keys():
1578 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1580 for item
in self
._PlatformPcds
:
1581 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1582 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1584 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1585 for Pcd
in self
._DynamicPcdList
:
1586 # just pick the a value to determine whether is unicode string type
1587 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1588 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1590 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1591 Pcd
.DatumType
= "VOID*"
1593 PcdValue
= Sku
.DefaultValue
1594 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1595 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1596 UnicodePcdArray
.append(Pcd
)
1597 elif len(Sku
.VariableName
) > 0:
1598 # if found HII type PCD then insert to right of UnicodeIndex
1599 HiiPcdArray
.append(Pcd
)
1601 OtherPcdArray
.append(Pcd
)
1602 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1603 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1605 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1606 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1607 if PcdNvStoreDfBuffer
:
1608 var_info
= self
.CollectVariables(self
._DynamicPcdList
)
1609 default_skuobj
= PcdNvStoreDfBuffer
.SkuInfoList
.get("DEFAULT")
1610 default_skuobj
.DefaultValue
= var_info
.dump()
1612 PcdNvStoreDfBuffer
.SkuInfoList
.clear()
1613 PcdNvStoreDfBuffer
.SkuInfoList
['DEFAULT'] = default_skuobj
1614 PcdNvStoreDfBuffer
.MaxDatumSize
= len(default_skuobj
.DefaultValue
.split(","))
1616 PlatformPcds
= self
._PlatformPcds
.keys()
1619 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1621 for PcdKey
in PlatformPcds
:
1622 Pcd
= self
._PlatformPcds
[PcdKey
]
1623 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1624 PcdKey
in VpdPcdDict
:
1625 Pcd
= VpdPcdDict
[PcdKey
]
1626 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1627 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1628 PcdValue
= Sku
.DefaultValue
1630 PcdValue
= Pcd
.DefaultValue
1631 if Sku
.VpdOffset
!= '*':
1632 if PcdValue
.startswith("{"):
1634 elif PcdValue
.startswith("L"):
1639 VpdOffset
= int(Sku
.VpdOffset
)
1642 VpdOffset
= int(Sku
.VpdOffset
, 16)
1644 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1645 if VpdOffset
% Alignment
!= 0:
1646 if PcdValue
.startswith("{"):
1647 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1649 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1650 VpdFile
.Add(Pcd
, Sku
.VpdOffset
)
1651 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1652 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1653 NeedProcessVpdMapFile
= True
1654 if self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== '':
1655 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1656 "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1660 # Fix the PCDs define in VPD PCD section that never referenced by module.
1661 # An example is PCD for signature usage.
1663 for DscPcd
in PlatformPcds
:
1664 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1665 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1666 if not (self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== ''):
1668 for VpdPcd
in VpdFile
._VpdArray
.keys():
1669 # This PCD has been referenced by module
1670 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1671 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1674 # Not found, it should be signature
1676 # just pick the a value to determine whether is unicode string type
1677 for (SkuName
,Sku
) in DscPcdEntry
.SkuInfoList
.items():
1678 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1680 # Need to iterate DEC pcd information to get the value & datumtype
1681 for eachDec
in self
.PackageList
:
1682 for DecPcd
in eachDec
.Pcds
:
1683 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1684 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1685 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1686 # Print warning message to let the developer make a determine.
1687 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1688 File
=self
.MetaFile
, \
1689 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1690 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1692 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1693 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1694 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1695 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1696 # Only fix the value while no value provided in DSC file.
1697 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1698 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1700 if DscPcdEntry
not in self
._DynamicPcdList
:
1701 self
._DynamicPcdList
.append(DscPcdEntry
)
1702 # Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]
1703 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1704 PcdValue
= Sku
.DefaultValue
1706 PcdValue
= DscPcdEntry
.DefaultValue
1707 if Sku
.VpdOffset
!= '*':
1708 if PcdValue
.startswith("{"):
1710 elif PcdValue
.startswith("L"):
1715 VpdOffset
= int(Sku
.VpdOffset
)
1718 VpdOffset
= int(Sku
.VpdOffset
, 16)
1720 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1721 if VpdOffset
% Alignment
!= 0:
1722 if PcdValue
.startswith("{"):
1723 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1725 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1726 VpdFile
.Add(DscPcdEntry
, Sku
.VpdOffset
)
1727 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1728 NeedProcessVpdMapFile
= True
1729 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1730 UnicodePcdArray
.append(DscPcdEntry
)
1731 elif len(Sku
.VariableName
) > 0:
1732 HiiPcdArray
.append(DscPcdEntry
)
1734 OtherPcdArray
.append(DscPcdEntry
)
1736 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1740 if (self
.Platform
.FlashDefinition
== None or self
.Platform
.FlashDefinition
== '') and \
1741 VpdFile
.GetCount() != 0:
1742 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1743 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1745 if VpdFile
.GetCount() != 0:
1746 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1747 if not os
.path
.exists(FvPath
):
1751 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1753 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1755 if VpdFile
.Write(VpdFilePath
):
1756 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1758 for ToolDef
in self
.ToolDefinition
.values():
1759 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1760 if not ToolDef
.has_key("PATH"):
1761 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1762 BPDGToolName
= ToolDef
["PATH"]
1764 # Call third party GUID BPDG tool.
1765 if BPDGToolName
!= None:
1766 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1768 EdkLogger
.error("Build", FILE_NOT_FOUND
, "Fail to find third-party BPDG tool to process VPD PCDs. BPDG Guid tool need to be defined in tools_def.txt and VPD_TOOL_GUID need to be provided in DSC file.")
1770 # Process VPD map file generated by third party BPDG tool
1771 if NeedProcessVpdMapFile
:
1772 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1773 if os
.path
.exists(VpdMapFilePath
):
1774 VpdFile
.Read(VpdMapFilePath
)
1777 for Pcd
in self
._DynamicPcdList
:
1778 # just pick the a value to determine whether is unicode string type
1780 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1781 if Sku
.VpdOffset
== "*":
1782 Sku
.VpdOffset
= VpdFile
.GetOffset(Pcd
)[i
].strip()
1785 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1787 # Delete the DynamicPcdList At the last time enter into this function
1788 del self
._DynamicPcdList
[:]
1789 self
._DynamicPcdList
.extend(UnicodePcdArray
)
1790 self
._DynamicPcdList
.extend(HiiPcdArray
)
1791 self
._DynamicPcdList
.extend(OtherPcdArray
)
1792 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1794 ## Return the platform build data object
1795 def _GetPlatform(self
):
1796 if self
._Platform
== None:
1797 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1798 return self
._Platform
1800 ## Return platform name
1802 return self
.Platform
.PlatformName
1804 ## Return the meta file GUID
1806 return self
.Platform
.Guid
1808 ## Return the platform version
1809 def _GetVersion(self
):
1810 return self
.Platform
.Version
1812 ## Return the FDF file name
1813 def _GetFdfFile(self
):
1814 if self
._FdfFile
== None:
1815 if self
.Workspace
.FdfFile
!= "":
1816 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1819 return self
._FdfFile
1821 ## Return the build output directory platform specifies
1822 def _GetOutputDir(self
):
1823 return self
.Platform
.OutputDirectory
1825 ## Return the directory to store all intermediate and final files built
1826 def _GetBuildDir(self
):
1827 if self
._BuildDir
== None:
1828 if os
.path
.isabs(self
.OutputDir
):
1829 self
._BuildDir
= path
.join(
1830 path
.abspath(self
.OutputDir
),
1831 self
.BuildTarget
+ "_" + self
.ToolChain
,
1834 self
._BuildDir
= path
.join(
1837 self
.BuildTarget
+ "_" + self
.ToolChain
,
1839 GlobalData
.gBuildDirectory
= self
._BuildDir
1840 return self
._BuildDir
1842 ## Return directory of platform makefile
1844 # @retval string Makefile directory
1846 def _GetMakeFileDir(self
):
1847 if self
._MakeFileDir
== None:
1848 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1849 return self
._MakeFileDir
1851 ## Return build command string
1853 # @retval string Build command string
1855 def _GetBuildCommand(self
):
1856 if self
._BuildCommand
== None:
1857 self
._BuildCommand
= []
1858 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1859 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1860 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1861 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1863 self
._BuildCommand
+= SplitOption(NewOption
)
1864 return self
._BuildCommand
1866 ## Get tool chain definition
1868 # Get each tool defition for given tool chain from tools_def.txt and platform
1870 def _GetToolDefinition(self
):
1871 if self
._ToolDefinitions
== None:
1872 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1873 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1874 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1875 ExtraData
="[%s]" % self
.MetaFile
)
1876 self
._ToolDefinitions
= {}
1878 for Def
in ToolDefinition
:
1879 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1880 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1883 Value
= ToolDefinition
[Def
]
1884 # don't record the DLL
1886 DllPathList
.add(Value
)
1889 if Tool
not in self
._ToolDefinitions
:
1890 self
._ToolDefinitions
[Tool
] = {}
1891 self
._ToolDefinitions
[Tool
][Attr
] = Value
1895 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1896 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1897 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1898 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1900 for Tool
in self
._ToolDefinitions
:
1901 for Attr
in self
._ToolDefinitions
[Tool
]:
1902 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1903 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1904 # check if override is indicated
1905 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1906 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1909 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1911 Value
= self
.BuildOption
[Tool
][Attr
]
1914 # Don't put MAKE definition in the file
1918 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1920 # Don't put MAKE definition in the file
1925 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1928 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1929 for DllPath
in DllPathList
:
1930 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1931 os
.environ
["MAKE_FLAGS"] = MakeFlags
1933 return self
._ToolDefinitions
1935 ## Return the paths of tools
1936 def _GetToolDefFile(self
):
1937 if self
._ToolDefFile
== None:
1938 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1939 return self
._ToolDefFile
1941 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1942 def _GetToolChainFamily(self
):
1943 if self
._ToolChainFamily
== None:
1944 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1945 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1946 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1947 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1948 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1950 self
._ToolChainFamily
= "MSFT"
1952 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1953 return self
._ToolChainFamily
1955 def _GetBuildRuleFamily(self
):
1956 if self
._BuildRuleFamily
== None:
1957 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1958 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1959 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1960 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1961 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1963 self
._BuildRuleFamily
= "MSFT"
1965 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1966 return self
._BuildRuleFamily
1968 ## Return the build options specific for all modules in this platform
1969 def _GetBuildOptions(self
):
1970 if self
._BuildOption
== None:
1971 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1972 return self
._BuildOption
1974 ## Return the build options specific for EDK modules in this platform
1975 def _GetEdkBuildOptions(self
):
1976 if self
._EdkBuildOption
== None:
1977 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1978 return self
._EdkBuildOption
1980 ## Return the build options specific for EDKII modules in this platform
1981 def _GetEdkIIBuildOptions(self
):
1982 if self
._EdkIIBuildOption
== None:
1983 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1984 return self
._EdkIIBuildOption
1986 ## Parse build_rule.txt in Conf Directory.
1988 # @retval BuildRule object
1990 def _GetBuildRule(self
):
1991 if self
._BuildRule
== None:
1992 BuildRuleFile
= None
1993 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
1994 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
1995 if BuildRuleFile
in [None, '']:
1996 BuildRuleFile
= gDefaultBuildRuleFile
1997 self
._BuildRule
= BuildRule(BuildRuleFile
)
1998 if self
._BuildRule
._FileVersion
== "":
1999 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2001 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2002 # If Build Rule's version is less than the version number required by the tools, halting the build.
2003 EdkLogger
.error("build", AUTOGEN_ERROR
,
2004 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])"\
2005 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2007 return self
._BuildRule
2009 ## Summarize the packages used by modules in this platform
2010 def _GetPackageList(self
):
2011 if self
._PackageList
== None:
2012 self
._PackageList
= set()
2013 for La
in self
.LibraryAutoGenList
:
2014 self
._PackageList
.update(La
.DependentPackageList
)
2015 for Ma
in self
.ModuleAutoGenList
:
2016 self
._PackageList
.update(Ma
.DependentPackageList
)
2017 #Collect package set information from INF of FDF
2019 for ModuleFile
in self
._AsBuildModuleList
:
2020 if ModuleFile
in self
.Platform
.Modules
:
2022 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2023 PkgSet
.update(ModuleData
.Packages
)
2024 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2025 return self
._PackageList
2027 def _GetNonDynamicPcdDict(self
):
2028 if self
._NonDynamicPcdDict
:
2029 return self
._NonDynamicPcdDict
2030 for Pcd
in self
.NonDynamicPcdList
:
2031 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2032 return self
._NonDynamicPcdDict
2034 ## Get list of non-dynamic PCDs
2035 def _GetNonDynamicPcdList(self
):
2036 if self
._NonDynamicPcdList
== None:
2037 self
.CollectPlatformDynamicPcds()
2038 return self
._NonDynamicPcdList
2040 ## Get list of dynamic PCDs
2041 def _GetDynamicPcdList(self
):
2042 if self
._DynamicPcdList
== None:
2043 self
.CollectPlatformDynamicPcds()
2044 return self
._DynamicPcdList
2046 ## Generate Token Number for all PCD
2047 def _GetPcdTokenNumbers(self
):
2048 if self
._PcdTokenNumber
== None:
2049 self
._PcdTokenNumber
= sdict()
2052 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2056 # TokenNumber 0 ~ 10
2058 # TokeNumber 11 ~ 20
2060 for Pcd
in self
.DynamicPcdList
:
2061 if Pcd
.Phase
== "PEI":
2062 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2063 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2064 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2067 for Pcd
in self
.DynamicPcdList
:
2068 if Pcd
.Phase
== "PEI":
2069 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2070 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2071 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2074 for Pcd
in self
.DynamicPcdList
:
2075 if Pcd
.Phase
== "DXE":
2076 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2077 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2078 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2081 for Pcd
in self
.DynamicPcdList
:
2082 if Pcd
.Phase
== "DXE":
2083 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2084 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2085 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2088 for Pcd
in self
.NonDynamicPcdList
:
2089 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2091 return self
._PcdTokenNumber
2093 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2094 def _GetAutoGenObjectList(self
):
2095 self
._ModuleAutoGenList
= []
2096 self
._LibraryAutoGenList
= []
2097 for ModuleFile
in self
.Platform
.Modules
:
2106 if Ma
not in self
._ModuleAutoGenList
:
2107 self
._ModuleAutoGenList
.append(Ma
)
2108 for La
in Ma
.LibraryAutoGenList
:
2109 if La
not in self
._LibraryAutoGenList
:
2110 self
._LibraryAutoGenList
.append(La
)
2111 if Ma
not in La
._ReferenceModules
:
2112 La
._ReferenceModules
.append(Ma
)
2114 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2115 def _GetModuleAutoGenList(self
):
2116 if self
._ModuleAutoGenList
== None:
2117 self
._GetAutoGenObjectList
()
2118 return self
._ModuleAutoGenList
2120 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2121 def _GetLibraryAutoGenList(self
):
2122 if self
._LibraryAutoGenList
== None:
2123 self
._GetAutoGenObjectList
()
2124 return self
._LibraryAutoGenList
2126 ## Test if a module is supported by the platform
2128 # An error will be raised directly if the module or its arch is not supported
2129 # by the platform or current configuration
2131 def ValidModule(self
, Module
):
2132 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2133 or Module
in self
._AsBuildModuleList
2135 ## Resolve the library classes in a module to library instances
2137 # This method will not only resolve library classes but also sort the library
2138 # instances according to the dependency-ship.
2140 # @param Module The module from which the library classes will be resolved
2142 # @retval library_list List of library instances sorted
2144 def ApplyLibraryInstance(self
, Module
):
2145 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2146 if str(Module
) not in self
.Platform
.Modules
:
2149 ModuleType
= Module
.ModuleType
2151 # for overridding library instances with module specific setting
2152 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2154 # add forced library instances (specified under LibraryClasses sections)
2156 # If a module has a MODULE_TYPE of USER_DEFINED,
2157 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2159 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2160 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2161 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2162 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2164 # add forced library instances (specified in module overrides)
2165 for LibraryClass
in PlatformModule
.LibraryClasses
:
2166 if LibraryClass
.startswith("NULL"):
2167 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2170 LibraryConsumerList
= [Module
]
2172 ConsumedByList
= sdict()
2173 LibraryInstance
= sdict()
2175 EdkLogger
.verbose("")
2176 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2177 while len(LibraryConsumerList
) > 0:
2178 M
= LibraryConsumerList
.pop()
2179 for LibraryClassName
in M
.LibraryClasses
:
2180 if LibraryClassName
not in LibraryInstance
:
2181 # override library instance for this module
2182 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2183 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2185 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2186 if LibraryPath
== None or LibraryPath
== "":
2187 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2188 if LibraryPath
== None or LibraryPath
== "":
2189 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2190 "Instance of library class [%s] is not found" % LibraryClassName
,
2192 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2194 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2195 # for those forced library instance (NULL library), add a fake library class
2196 if LibraryClassName
.startswith("NULL"):
2197 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2198 elif LibraryModule
.LibraryClass
== None \
2199 or len(LibraryModule
.LibraryClass
) == 0 \
2200 or (ModuleType
!= 'USER_DEFINED'
2201 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2202 # only USER_DEFINED can link against any library instance despite of its SupModList
2203 EdkLogger
.error("build", OPTION_MISSING
,
2204 "Module type [%s] is not supported by library instance [%s]" \
2205 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2206 ExtraData
="consumed by [%s]" % str(Module
))
2208 LibraryInstance
[LibraryClassName
] = LibraryModule
2209 LibraryConsumerList
.append(LibraryModule
)
2210 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2212 LibraryModule
= LibraryInstance
[LibraryClassName
]
2214 if LibraryModule
== None:
2217 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2218 Constructor
.append(LibraryModule
)
2220 if LibraryModule
not in ConsumedByList
:
2221 ConsumedByList
[LibraryModule
] = []
2222 # don't add current module itself to consumer list
2224 if M
in ConsumedByList
[LibraryModule
]:
2226 ConsumedByList
[LibraryModule
].append(M
)
2228 # Initialize the sorted output list to the empty set
2230 SortedLibraryList
= []
2232 # Q <- Set of all nodes with no incoming edges
2234 LibraryList
= [] #LibraryInstance.values()
2236 for LibraryClassName
in LibraryInstance
:
2237 M
= LibraryInstance
[LibraryClassName
]
2238 LibraryList
.append(M
)
2239 if ConsumedByList
[M
] == []:
2243 # start the DAG algorithm
2247 while Q
== [] and EdgeRemoved
:
2249 # for each node Item with a Constructor
2250 for Item
in LibraryList
:
2251 if Item
not in Constructor
:
2253 # for each Node without a constructor with an edge e from Item to Node
2254 for Node
in ConsumedByList
[Item
]:
2255 if Node
in Constructor
:
2257 # remove edge e from the graph if Node has no constructor
2258 ConsumedByList
[Item
].remove(Node
)
2260 if ConsumedByList
[Item
] == []:
2261 # insert Item into Q
2266 # DAG is done if there's no more incoming edge for all nodes
2270 # remove node from Q
2273 SortedLibraryList
.append(Node
)
2275 # for each node Item with an edge e from Node to Item do
2276 for Item
in LibraryList
:
2277 if Node
not in ConsumedByList
[Item
]:
2279 # remove edge e from the graph
2280 ConsumedByList
[Item
].remove(Node
)
2282 if ConsumedByList
[Item
] != []:
2284 # insert Item into Q, if Item has no other incoming edges
2288 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2290 for Item
in LibraryList
:
2291 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2292 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2293 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2294 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2295 if Item
not in SortedLibraryList
:
2296 SortedLibraryList
.append(Item
)
2299 # Build the list of constructor and destructir names
2300 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2302 SortedLibraryList
.reverse()
2303 return SortedLibraryList
2306 ## Override PCD setting (type, value, ...)
2308 # @param ToPcd The PCD to be overrided
2309 # @param FromPcd The PCD overrideing from
2311 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2313 # in case there's PCDs coming from FDF file, which have no type given.
2314 # at this point, ToPcd.Type has the type found from dependent
2317 TokenCName
= ToPcd
.TokenCName
2318 for PcdItem
in GlobalData
.MixedPcd
:
2319 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2320 TokenCName
= PcdItem
[0]
2323 if GlobalData
.BuildOptionPcd
:
2324 for pcd
in GlobalData
.BuildOptionPcd
:
2325 if (FromPcd
.TokenSpaceGuidCName
, FromPcd
.TokenCName
) == (pcd
[0], pcd
[1]):
2326 FromPcd
.DefaultValue
= pcd
[2]
2328 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2329 ToPcd
.Type
= FromPcd
.Type
2330 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2331 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2332 if ToPcd
.Type
.strip() == "DynamicEx":
2333 ToPcd
.Type
= FromPcd
.Type
2334 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2335 and ToPcd
.Type
!= FromPcd
.Type
:
2336 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2337 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2338 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2339 ToPcd
.Type
, Module
, FromPcd
.Type
),
2342 if FromPcd
.MaxDatumSize
not in [None, '']:
2343 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2344 if FromPcd
.DefaultValue
not in [None, '']:
2345 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2346 if FromPcd
.TokenValue
not in [None, '']:
2347 ToPcd
.TokenValue
= FromPcd
.TokenValue
2348 if FromPcd
.MaxDatumSize
not in [None, '']:
2349 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2350 if FromPcd
.DatumType
not in [None, '']:
2351 ToPcd
.DatumType
= FromPcd
.DatumType
2352 if FromPcd
.SkuInfoList
not in [None, '', []]:
2353 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2355 # check the validation of datum
2356 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2358 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2359 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2360 ToPcd
.validateranges
= FromPcd
.validateranges
2361 ToPcd
.validlists
= FromPcd
.validlists
2362 ToPcd
.expressions
= FromPcd
.expressions
2364 if ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2365 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2366 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2367 Value
= ToPcd
.DefaultValue
2368 if Value
in [None, '']:
2369 ToPcd
.MaxDatumSize
= '1'
2370 elif Value
[0] == 'L':
2371 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2372 elif Value
[0] == '{':
2373 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2375 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2377 # apply default SKU for dynamic PCDS if specified one is not available
2378 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2379 and ToPcd
.SkuInfoList
in [None, {}, '']:
2380 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2381 SkuName
= self
.Platform
.SkuName
2384 ToPcd
.SkuInfoList
= {
2385 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2388 ## Apply PCD setting defined platform to a module
2390 # @param Module The module from which the PCD setting will be overrided
2392 # @retval PCD_list The list PCDs with settings from platform
2394 def ApplyPcdSetting(self
, Module
, Pcds
):
2395 # for each PCD in module
2396 for Name
, Guid
in Pcds
:
2397 PcdInModule
= Pcds
[Name
, Guid
]
2398 # find out the PCD setting in platform
2399 if (Name
, Guid
) in self
.Platform
.Pcds
:
2400 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2402 PcdInPlatform
= None
2403 # then override the settings if any
2404 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2405 # resolve the VariableGuid value
2406 for SkuId
in PcdInModule
.SkuInfoList
:
2407 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2408 if Sku
.VariableGuid
== '': continue
2409 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2410 if Sku
.VariableGuidValue
== None:
2411 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2414 RESOURCE_NOT_AVAILABLE
,
2415 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2416 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2417 % (Guid
, Name
, str(Module
)),
2421 # override PCD settings with module specific setting
2422 if Module
in self
.Platform
.Modules
:
2423 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2424 for Key
in PlatformModule
.Pcds
:
2429 elif Key
in GlobalData
.MixedPcd
:
2430 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2432 ToPcd
= Pcds
[PcdItem
]
2436 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2437 return Pcds
.values()
2439 ## Resolve library names to library modules
2441 # (for Edk.x modules)
2443 # @param Module The module from which the library names will be resolved
2445 # @retval library_list The list of library modules
2447 def ResolveLibraryReference(self
, Module
):
2448 EdkLogger
.verbose("")
2449 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2450 LibraryConsumerList
= [Module
]
2452 # "CompilerStub" is a must for Edk modules
2453 if Module
.Libraries
:
2454 Module
.Libraries
.append("CompilerStub")
2456 while len(LibraryConsumerList
) > 0:
2457 M
= LibraryConsumerList
.pop()
2458 for LibraryName
in M
.Libraries
:
2459 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2461 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2462 if LibraryName
.upper() == Key
.upper():
2463 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2466 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2467 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2470 if Library
not in LibraryList
:
2471 LibraryList
.append(Library
)
2472 LibraryConsumerList
.append(Library
)
2473 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2476 ## Calculate the priority value of the build option
2478 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2480 # @retval Value Priority value based on the priority list.
2482 def CalculatePriorityValue(self
, Key
):
2483 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2484 PriorityValue
= 0x11111
2486 PriorityValue
&= 0x01111
2487 if ToolChain
== "*":
2488 PriorityValue
&= 0x10111
2490 PriorityValue
&= 0x11011
2491 if CommandType
== "*":
2492 PriorityValue
&= 0x11101
2494 PriorityValue
&= 0x11110
2496 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2499 ## Expand * in build option key
2501 # @param Options Options to be expanded
2503 # @retval options Options expanded
2505 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2512 # Construct a list contain the build options which need override.
2516 # Key[0] -- tool family
2517 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2519 if (Key
[0] == self
.BuildRuleFamily
and
2520 (ModuleStyle
== None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2521 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2522 if Target
== self
.BuildTarget
or Target
== "*":
2523 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2524 if Arch
== self
.Arch
or Arch
== "*":
2525 if Options
[Key
].startswith("="):
2526 if OverrideList
.get(Key
[1]) != None:
2527 OverrideList
.pop(Key
[1])
2528 OverrideList
[Key
[1]] = Options
[Key
]
2531 # Use the highest priority value.
2533 if (len(OverrideList
) >= 2):
2534 KeyList
= OverrideList
.keys()
2535 for Index
in range(len(KeyList
)):
2536 NowKey
= KeyList
[Index
]
2537 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2538 for Index1
in range(len(KeyList
) - Index
- 1):
2539 NextKey
= KeyList
[Index1
+ Index
+ 1]
2541 # Compare two Key, if one is included by another, choose the higher priority one
2543 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2544 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2545 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2546 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2547 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2548 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2549 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2550 if Options
.get((self
.BuildRuleFamily
, NextKey
)) != None:
2551 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2553 if Options
.get((self
.BuildRuleFamily
, NowKey
)) != None:
2554 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2557 if ModuleStyle
!= None and len (Key
) > 2:
2558 # Check Module style is EDK or EDKII.
2559 # Only append build option for the matched style module.
2560 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2562 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2565 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2566 # if tool chain family doesn't match, skip it
2567 if Tool
in self
.ToolDefinition
and Family
!= "":
2568 FamilyIsNull
= False
2569 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2570 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2572 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2575 # expand any wildcard
2576 if Target
== "*" or Target
== self
.BuildTarget
:
2577 if Tag
== "*" or Tag
== self
.ToolChain
:
2578 if Arch
== "*" or Arch
== self
.Arch
:
2579 if Tool
not in BuildOptions
:
2580 BuildOptions
[Tool
] = {}
2581 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2582 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2584 # append options for the same tool except PATH
2586 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2588 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2589 # Build Option Family has been checked, which need't to be checked again for family.
2590 if FamilyMatch
or FamilyIsNull
:
2594 if ModuleStyle
!= None and len (Key
) > 2:
2595 # Check Module style is EDK or EDKII.
2596 # Only append build option for the matched style module.
2597 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2599 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2602 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2603 # if tool chain family doesn't match, skip it
2604 if Tool
not in self
.ToolDefinition
or Family
== "":
2606 # option has been added before
2607 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2610 # expand any wildcard
2611 if Target
== "*" or Target
== self
.BuildTarget
:
2612 if Tag
== "*" or Tag
== self
.ToolChain
:
2613 if Arch
== "*" or Arch
== self
.Arch
:
2614 if Tool
not in BuildOptions
:
2615 BuildOptions
[Tool
] = {}
2616 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2617 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2619 # append options for the same tool except PATH
2621 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2623 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2626 ## Append build options in platform to a module
2628 # @param Module The module to which the build options will be appened
2630 # @retval options The options appended with build options in platform
2632 def ApplyBuildOption(self
, Module
):
2633 # Get the different options for the different style module
2634 if Module
.AutoGenVersion
< 0x00010005:
2635 PlatformOptions
= self
.EdkBuildOption
2636 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2638 PlatformOptions
= self
.EdkIIBuildOption
2639 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2640 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2641 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2642 if Module
in self
.Platform
.Modules
:
2643 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2644 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2646 PlatformModuleOptions
= {}
2648 BuildRuleOrder
= None
2649 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2650 for Tool
in Options
:
2651 for Attr
in Options
[Tool
]:
2652 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2653 BuildRuleOrder
= Options
[Tool
][Attr
]
2655 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2656 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2657 self
.ToolDefinition
.keys())
2659 for Tool
in AllTools
:
2660 if Tool
not in BuildOptions
:
2661 BuildOptions
[Tool
] = {}
2663 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2664 if Tool
not in Options
:
2666 for Attr
in Options
[Tool
]:
2667 Value
= Options
[Tool
][Attr
]
2669 # Do not generate it in Makefile
2671 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2673 if Attr
not in BuildOptions
[Tool
]:
2674 BuildOptions
[Tool
][Attr
] = ""
2675 # check if override is indicated
2676 if Value
.startswith('='):
2677 ToolPath
= Value
[1:]
2678 ToolPath
= mws
.handleWsMacro(ToolPath
)
2679 BuildOptions
[Tool
][Attr
] = ToolPath
2681 Value
= mws
.handleWsMacro(Value
)
2683 BuildOptions
[Tool
][Attr
] += " " + Value
2685 BuildOptions
[Tool
][Attr
] = Value
2686 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
!= None:
2688 # Override UNI flag only for EDK module.
2690 if 'BUILD' not in BuildOptions
:
2691 BuildOptions
['BUILD'] = {}
2692 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2693 return BuildOptions
, BuildRuleOrder
2695 Platform
= property(_GetPlatform
)
2696 Name
= property(_GetName
)
2697 Guid
= property(_GetGuid
)
2698 Version
= property(_GetVersion
)
2700 OutputDir
= property(_GetOutputDir
)
2701 BuildDir
= property(_GetBuildDir
)
2702 MakeFileDir
= property(_GetMakeFileDir
)
2703 FdfFile
= property(_GetFdfFile
)
2705 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2706 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2707 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2708 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2709 PackageList
= property(_GetPackageList
)
2711 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2712 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2713 ToolChainFamily
= property(_GetToolChainFamily
)
2714 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2715 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2716 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2717 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2719 BuildCommand
= property(_GetBuildCommand
)
2720 BuildRule
= property(_GetBuildRule
)
2721 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2722 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2723 GenFdsCommand
= property(_GenFdsCommand
)
2725 ## ModuleAutoGen class
2727 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2728 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2729 # to the [depex] section in module's inf file.
2731 class ModuleAutoGen(AutoGen
):
2732 ## Cache the timestamps of metafiles of every module in a class variable
2736 ## The real constructor of ModuleAutoGen
2738 # This method is not supposed to be called by users of ModuleAutoGen. It's
2739 # only used by factory method __new__() to do real initialization work for an
2740 # object of ModuleAutoGen
2742 # @param Workspace EdkIIWorkspaceBuild object
2743 # @param ModuleFile The path of module file
2744 # @param Target Build target (DEBUG, RELEASE)
2745 # @param Toolchain Name of tool chain
2746 # @param Arch The arch the module supports
2747 # @param PlatformFile Platform meta-file
2749 def _Init(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2750 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2751 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2753 self
.Workspace
= Workspace
2754 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2756 self
.MetaFile
= ModuleFile
2757 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2758 # check if this module is employed by active platform
2759 if not self
.PlatformInfo
.ValidModule(self
.MetaFile
):
2760 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2761 % (self
.MetaFile
, Arch
))
2764 self
.SourceDir
= self
.MetaFile
.SubDir
2765 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2767 self
.SourceOverrideDir
= None
2768 # use overrided path defined in DSC file
2769 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2770 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2772 self
.ToolChain
= Toolchain
2773 self
.BuildTarget
= Target
2775 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2776 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2778 self
.IsMakeFileCreated
= False
2779 self
.IsCodeFileCreated
= False
2780 self
.IsAsBuiltInfCreated
= False
2781 self
.DepexGenerated
= False
2783 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2784 self
.BuildRuleOrder
= None
2790 self
._Version
= None
2791 self
._ModuleType
= None
2792 self
._ComponentType
= None
2793 self
._PcdIsDriver
= None
2794 self
._AutoGenVersion
= None
2795 self
._LibraryFlag
= None
2796 self
._CustomMakefile
= None
2799 self
._BuildDir
= None
2800 self
._OutputDir
= None
2801 self
._FfsOutputDir
= None
2802 self
._DebugDir
= None
2803 self
._MakeFileDir
= None
2805 self
._IncludePathList
= None
2806 self
._IncludePathLength
= 0
2807 self
._AutoGenFileList
= None
2808 self
._UnicodeFileList
= None
2809 self
._VfrFileList
= None
2810 self
._IdfFileList
= None
2811 self
._SourceFileList
= None
2812 self
._ObjectFileList
= None
2813 self
._BinaryFileList
= None
2815 self
._DependentPackageList
= None
2816 self
._DependentLibraryList
= None
2817 self
._LibraryAutoGenList
= None
2818 self
._DerivedPackageList
= None
2819 self
._ModulePcdList
= None
2820 self
._LibraryPcdList
= None
2821 self
._PcdComments
= sdict()
2822 self
._GuidList
= None
2823 self
._GuidsUsedByPcd
= None
2824 self
._GuidComments
= sdict()
2825 self
._ProtocolList
= None
2826 self
._ProtocolComments
= sdict()
2827 self
._PpiList
= None
2828 self
._PpiComments
= sdict()
2829 self
._DepexList
= None
2830 self
._DepexExpressionList
= None
2831 self
._BuildOption
= None
2832 self
._BuildOptionIncPathList
= None
2833 self
._BuildTargets
= None
2834 self
._IntroBuildTargetList
= None
2835 self
._FinalBuildTargetList
= None
2836 self
._FileTypes
= None
2837 self
._BuildRules
= None
2839 self
._TimeStampPath
= None
2841 self
.AutoGenDepSet
= set()
2844 ## The Modules referenced to this Library
2845 # Only Library has this attribute
2846 self
._ReferenceModules
= []
2848 ## Store the FixedAtBuild Pcds
2850 self
._FixedAtBuildPcds
= []
2855 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2857 # Get FixedAtBuild Pcds of this Module
2858 def _GetFixedAtBuildPcds(self
):
2859 if self
._FixedAtBuildPcds
:
2860 return self
._FixedAtBuildPcds
2861 for Pcd
in self
.ModulePcdList
:
2862 if Pcd
.Type
!= "FixedAtBuild":
2864 if Pcd
not in self
._FixedAtBuildPcds
:
2865 self
._FixedAtBuildPcds
.append(Pcd
)
2867 return self
._FixedAtBuildPcds
2869 def _GetUniqueBaseName(self
):
2870 BaseName
= self
.Name
2871 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2872 if Module
.MetaFile
== self
.MetaFile
:
2874 if Module
.Name
== self
.Name
:
2875 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2876 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2877 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2878 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2881 # Macros could be used in build_rule.txt (also Makefile)
2882 def _GetMacros(self
):
2883 if self
._Macro
== None:
2884 self
._Macro
= sdict()
2885 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2886 self
._Macro
["MODULE_NAME" ] = self
.Name
2887 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2888 self
._Macro
["MODULE_GUID" ] = self
.Guid
2889 self
._Macro
["MODULE_VERSION" ] = self
.Version
2890 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2891 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2892 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2893 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2894 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2896 self
._Macro
["BASE_NAME" ] = self
.Name
2898 self
._Macro
["ARCH" ] = self
.Arch
2899 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2900 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2901 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2902 self
._Macro
["TARGET" ] = self
.BuildTarget
2904 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2905 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2906 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2907 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2908 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2909 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2910 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2911 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2912 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2913 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2914 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2915 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2916 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2917 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2918 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2921 ## Return the module build data object
2922 def _GetModule(self
):
2923 if self
._Module
== None:
2924 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2927 ## Return the module name
2928 def _GetBaseName(self
):
2929 return self
.Module
.BaseName
2931 ## Return the module DxsFile if exist
2932 def _GetDxsFile(self
):
2933 return self
.Module
.DxsFile
2935 ## Return the module SourceOverridePath
2936 def _GetSourceOverridePath(self
):
2937 return self
.Module
.SourceOverridePath
2939 ## Return the module meta-file GUID
2942 # To build same module more than once, the module path with FILE_GUID overridden has
2943 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2944 # in DSC. The overridden GUID can be retrieved from file name
2946 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2948 # Length of GUID is 36
2950 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2951 return self
.Module
.Guid
2953 ## Return the module version
2954 def _GetVersion(self
):
2955 return self
.Module
.Version
2957 ## Return the module type
2958 def _GetModuleType(self
):
2959 return self
.Module
.ModuleType
2961 ## Return the component type (for Edk.x style of module)
2962 def _GetComponentType(self
):
2963 return self
.Module
.ComponentType
2965 ## Return the build type
2966 def _GetBuildType(self
):
2967 return self
.Module
.BuildType
2969 ## Return the PCD_IS_DRIVER setting
2970 def _GetPcdIsDriver(self
):
2971 return self
.Module
.PcdIsDriver
2973 ## Return the autogen version, i.e. module meta-file version
2974 def _GetAutoGenVersion(self
):
2975 return self
.Module
.AutoGenVersion
2977 ## Check if the module is library or not
2978 def _IsLibrary(self
):
2979 if self
._LibraryFlag
== None:
2980 if self
.Module
.LibraryClass
!= None and self
.Module
.LibraryClass
!= []:
2981 self
._LibraryFlag
= True
2983 self
._LibraryFlag
= False
2984 return self
._LibraryFlag
2986 ## Check if the module is binary module or not
2987 def _IsBinaryModule(self
):
2988 return self
.Module
.IsBinaryModule
2990 ## Return the directory to store intermediate files of the module
2991 def _GetBuildDir(self
):
2992 if self
._BuildDir
== None:
2993 self
._BuildDir
= path
.join(
2994 self
.PlatformInfo
.BuildDir
,
2997 self
.MetaFile
.BaseName
2999 CreateDirectory(self
._BuildDir
)
3000 return self
._BuildDir
3002 ## Return the directory to store the intermediate object files of the mdoule
3003 def _GetOutputDir(self
):
3004 if self
._OutputDir
== None:
3005 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3006 CreateDirectory(self
._OutputDir
)
3007 return self
._OutputDir
3009 ## Return the directory to store ffs file
3010 def _GetFfsOutputDir(self
):
3011 if self
._FfsOutputDir
== None:
3012 if GlobalData
.gFdfParser
!= None:
3013 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3015 self
._FfsOutputDir
= ''
3016 return self
._FfsOutputDir
3018 ## Return the directory to store auto-gened source files of the mdoule
3019 def _GetDebugDir(self
):
3020 if self
._DebugDir
== None:
3021 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3022 CreateDirectory(self
._DebugDir
)
3023 return self
._DebugDir
3025 ## Return the path of custom file
3026 def _GetCustomMakefile(self
):
3027 if self
._CustomMakefile
== None:
3028 self
._CustomMakefile
= {}
3029 for Type
in self
.Module
.CustomMakefile
:
3030 if Type
in gMakeTypeMap
:
3031 MakeType
= gMakeTypeMap
[Type
]
3034 if self
.SourceOverrideDir
!= None:
3035 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3036 if not os
.path
.exists(File
):
3037 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3039 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3040 self
._CustomMakefile
[MakeType
] = File
3041 return self
._CustomMakefile
3043 ## Return the directory of the makefile
3045 # @retval string The directory string of module's makefile
3047 def _GetMakeFileDir(self
):
3048 return self
.BuildDir
3050 ## Return build command string
3052 # @retval string Build command string
3054 def _GetBuildCommand(self
):
3055 return self
.PlatformInfo
.BuildCommand
3057 ## Get object list of all packages the module and its dependent libraries belong to
3059 # @retval list The list of package object
3061 def _GetDerivedPackageList(self
):
3063 for M
in [self
.Module
] + self
.DependentLibraryList
:
3064 for Package
in M
.Packages
:
3065 if Package
in PackageList
:
3067 PackageList
.append(Package
)
3070 ## Get the depex string
3072 # @return : a string contain all depex expresion.
3073 def _GetDepexExpresionString(self
):
3076 ## DPX_SOURCE IN Define section.
3077 if self
.Module
.DxsFile
:
3079 for M
in [self
.Module
] + self
.DependentLibraryList
:
3080 Filename
= M
.MetaFile
.Path
3081 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3082 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3083 for DepexExpresion
in DepexExpresionList
:
3084 for key
in DepexExpresion
.keys():
3085 Arch
, ModuleType
= key
3086 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3087 # the type of build module is USER_DEFINED.
3088 # All different DEPEX section tags would be copied into the As Built INF file
3089 # and there would be separate DEPEX section tags
3090 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3091 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3092 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3094 if Arch
.upper() == TAB_ARCH_COMMON
or \
3095 (Arch
.upper() == self
.Arch
.upper() and \
3096 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3097 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3099 #the type of build module is USER_DEFINED.
3100 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3101 for Depex
in DepexList
:
3102 for key
in Depex
.keys():
3103 DepexStr
+= '[Depex.%s.%s]\n' % key
3104 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3107 return '[Depex.%s]\n' % self
.Arch
3110 #the type of build module not is USER_DEFINED.
3112 for Depex
in DepexList
:
3117 for D
in Depex
.values():
3118 DepexStr
+= ' '.join([val
for val
in D
])
3119 Index
= DepexStr
.find('END')
3120 if Index
> -1 and Index
== len(DepexStr
) - 3:
3121 DepexStr
= DepexStr
[:-3]
3122 DepexStr
= DepexStr
.strip()
3125 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3127 return '[Depex.%s]\n' % self
.Arch
3128 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3130 ## Merge dependency expression
3132 # @retval list The token list of the dependency expression after parsed
3134 def _GetDepexTokenList(self
):
3135 if self
._DepexList
== None:
3136 self
._DepexList
= {}
3137 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3138 return self
._DepexList
3140 self
._DepexList
[self
.ModuleType
] = []
3142 for ModuleType
in self
._DepexList
:
3143 DepexList
= self
._DepexList
[ModuleType
]
3145 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3147 for M
in [self
.Module
] + self
.DependentLibraryList
:
3149 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3151 DepexList
.append('AND')
3152 DepexList
.append('(')
3154 if DepexList
[-1] == 'END': # no need of a END at this time
3156 DepexList
.append(')')
3159 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3160 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3162 if len(DepexList
) > 0:
3163 EdkLogger
.verbose('')
3164 return self
._DepexList
3166 ## Merge dependency expression
3168 # @retval list The token list of the dependency expression after parsed
3170 def _GetDepexExpressionTokenList(self
):
3171 if self
._DepexExpressionList
== None:
3172 self
._DepexExpressionList
= {}
3173 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3174 return self
._DepexExpressionList
3176 self
._DepexExpressionList
[self
.ModuleType
] = ''
3178 for ModuleType
in self
._DepexExpressionList
:
3179 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3181 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3183 for M
in [self
.Module
] + self
.DependentLibraryList
:
3185 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3186 if DepexExpressionList
!= '':
3187 DepexExpressionList
+= ' AND '
3188 DepexExpressionList
+= '('
3189 DepexExpressionList
+= D
3190 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3191 DepexExpressionList
+= ')'
3194 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3195 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3197 if len(DepexExpressionList
) > 0:
3198 EdkLogger
.verbose('')
3199 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3200 return self
._DepexExpressionList
3202 # Get the tiano core user extension, it is contain dependent library.
3203 # @retval: a list contain tiano core userextension.
3205 def _GetTianoCoreUserExtensionList(self
):
3206 TianoCoreUserExtentionList
= []
3207 for M
in [self
.Module
] + self
.DependentLibraryList
:
3208 Filename
= M
.MetaFile
.Path
3209 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3210 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3211 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3212 for Section
in TianoCoreUserExtent
.keys():
3213 ItemList
= Section
.split(TAB_SPLIT
)
3215 if len(ItemList
) == 4:
3217 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3219 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3220 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3221 TianoCoreList
.append('\n')
3222 TianoCoreUserExtentionList
.append(TianoCoreList
)
3224 return TianoCoreUserExtentionList
3226 ## Return the list of specification version required for the module
3228 # @retval list The list of specification defined in module file
3230 def _GetSpecification(self
):
3231 return self
.Module
.Specification
3233 ## Tool option for the module build
3235 # @param PlatformInfo The object of PlatformBuildInfo
3236 # @retval dict The dict containing valid options
3238 def _GetModuleBuildOption(self
):
3239 if self
._BuildOption
== None:
3240 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3241 if self
.BuildRuleOrder
:
3242 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3243 return self
._BuildOption
3245 ## Get include path list from tool option for the module build
3247 # @retval list The include path list
3249 def _GetBuildOptionIncPathList(self
):
3250 if self
._BuildOptionIncPathList
== None:
3252 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3253 # is the former use /I , the Latter used -I to specify include directories
3255 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3256 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3257 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3258 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3261 # New ToolChainFamily, don't known whether there is option to specify include directories
3263 self
._BuildOptionIncPathList
= []
3264 return self
._BuildOptionIncPathList
3266 BuildOptionIncPathList
= []
3267 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3270 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3274 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3275 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in gBuildOptIncludePattern
.findall(FlagOption
)]
3278 # RVCT may specify a list of directory seperated by commas
3281 for Path
in gBuildOptIncludePattern
.findall(FlagOption
):
3282 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3283 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3286 # EDK II modules must not reference header files outside of the packages they depend on or
3287 # within the module's directory tree. Report error if violation.
3289 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3290 for Path
in IncPathList
:
3291 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3292 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3293 EdkLogger
.error("build",
3296 File
=str(self
.MetaFile
))
3299 BuildOptionIncPathList
+= IncPathList
3301 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3303 return self
._BuildOptionIncPathList
3305 ## Return a list of files which can be built from source
3307 # What kind of files can be built is determined by build rules in
3308 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3310 def _GetSourceFileList(self
):
3311 if self
._SourceFileList
== None:
3312 self
._SourceFileList
= []
3313 for F
in self
.Module
.Sources
:
3315 if F
.TagName
not in ("", "*", self
.ToolChain
):
3316 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3317 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3319 # match tool chain family or build rule family
3320 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3323 "The file [%s] must be built by tools of [%s], " \
3324 "but current toolchain family is [%s], buildrule family is [%s]" \
3325 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3328 # add the file path into search path list for file including
3329 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3330 self
.IncludePathList
.insert(0, F
.Dir
)
3331 self
._SourceFileList
.append(F
)
3333 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3335 for F
in self
._SourceFileList
:
3336 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3337 return self
._SourceFileList
3339 def _MatchBuildRuleOrder(self
, FileList
):
3341 self
._GetModuleBuildOption
()
3342 for SingleFile
in FileList
:
3343 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3344 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3345 if key
in Order_Dict
:
3346 Order_Dict
[key
].append(SingleFile
.Ext
)
3348 Order_Dict
[key
] = [SingleFile
.Ext
]
3351 for F
in Order_Dict
:
3352 if len(Order_Dict
[F
]) > 1:
3353 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3354 for Ext
in Order_Dict
[F
][1:]:
3355 RemoveList
.append(F
+ Ext
)
3357 for item
in RemoveList
:
3358 FileList
.remove(item
)
3362 ## Return the list of unicode files
3363 def _GetUnicodeFileList(self
):
3364 if self
._UnicodeFileList
== None:
3365 if TAB_UNICODE_FILE
in self
.FileTypes
:
3366 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3368 self
._UnicodeFileList
= []
3369 return self
._UnicodeFileList
3371 ## Return the list of vfr files
3372 def _GetVfrFileList(self
):
3373 if self
._VfrFileList
== None:
3374 if TAB_VFR_FILE
in self
.FileTypes
:
3375 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3377 self
._VfrFileList
= []
3378 return self
._VfrFileList
3380 ## Return the list of Image Definition files
3381 def _GetIdfFileList(self
):
3382 if self
._IdfFileList
== None:
3383 if TAB_IMAGE_FILE
in self
.FileTypes
:
3384 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3386 self
._IdfFileList
= []
3387 return self
._IdfFileList
3389 ## Return a list of files which can be built from binary
3391 # "Build" binary files are just to copy them to build directory.
3393 # @retval list The list of files which can be built later
3395 def _GetBinaryFiles(self
):
3396 if self
._BinaryFileList
== None:
3397 self
._BinaryFileList
= []
3398 for F
in self
.Module
.Binaries
:
3399 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3401 self
._BinaryFileList
.append(F
)
3402 self
._ApplyBuildRule
(F
, F
.Type
)
3403 return self
._BinaryFileList
3405 def _GetBuildRules(self
):
3406 if self
._BuildRules
== None:
3408 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3409 for Type
in BuildRuleDatabase
.FileTypeList
:
3410 #first try getting build rule by BuildRuleFamily
3411 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3413 # build type is always module type, but ...
3414 if self
.ModuleType
!= self
.BuildType
:
3415 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3416 #second try getting build rule by ToolChainFamily
3418 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3420 # build type is always module type, but ...
3421 if self
.ModuleType
!= self
.BuildType
:
3422 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3425 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3426 BuildRules
[Type
] = RuleObject
3427 for Ext
in RuleObject
.SourceFileExtList
:
3428 BuildRules
[Ext
] = RuleObject
3429 self
._BuildRules
= BuildRules
3430 return self
._BuildRules
3432 def _ApplyBuildRule(self
, File
, FileType
):
3433 if self
._BuildTargets
== None:
3434 self
._IntroBuildTargetList
= set()
3435 self
._FinalBuildTargetList
= set()
3436 self
._BuildTargets
= {}
3437 self
._FileTypes
= {}
3439 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3440 if not os
.path
.exists(SubDirectory
):
3441 CreateDirectory(SubDirectory
)
3447 # Make sure to get build rule order value
3449 self
._GetModuleBuildOption
()
3451 while Index
< len(SourceList
):
3452 Source
= SourceList
[Index
]
3456 CreateDirectory(Source
.Dir
)
3458 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
!= None and File
in self
._BinaryFileList
:
3459 # Skip all files that are not binary libraries
3460 if not self
.IsLibrary
:
3462 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3463 elif FileType
in self
.BuildRules
:
3464 RuleObject
= self
.BuildRules
[FileType
]
3465 elif Source
.Ext
in self
.BuildRules
:
3466 RuleObject
= self
.BuildRules
[Source
.Ext
]
3468 # stop at no more rules
3470 self
._FinalBuildTargetList
.add(LastTarget
)
3473 FileType
= RuleObject
.SourceFileType
3474 if FileType
not in self
._FileTypes
:
3475 self
._FileTypes
[FileType
] = set()
3476 self
._FileTypes
[FileType
].add(Source
)
3478 # stop at STATIC_LIBRARY for library
3479 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3481 self
._FinalBuildTargetList
.add(LastTarget
)
3484 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3487 self
._FinalBuildTargetList
.add(LastTarget
)
3489 elif not Target
.Outputs
:
3490 # Only do build for target with outputs
3491 self
._FinalBuildTargetList
.add(Target
)
3493 if FileType
not in self
._BuildTargets
:
3494 self
._BuildTargets
[FileType
] = set()
3495 self
._BuildTargets
[FileType
].add(Target
)
3497 if not Source
.IsBinary
and Source
== File
:
3498 self
._IntroBuildTargetList
.add(Target
)
3500 # to avoid cyclic rule
3501 if FileType
in RuleChain
:
3504 RuleChain
.append(FileType
)
3505 SourceList
.extend(Target
.Outputs
)
3507 FileType
= TAB_UNKNOWN_FILE
3509 def _GetTargets(self
):
3510 if self
._BuildTargets
== None:
3511 self
._IntroBuildTargetList
= set()
3512 self
._FinalBuildTargetList
= set()
3513 self
._BuildTargets
= {}
3514 self
._FileTypes
= {}
3516 #TRICK: call _GetSourceFileList to apply build rule for source files
3517 if self
.SourceFileList
:
3520 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3521 if self
.BinaryFileList
:
3524 return self
._BuildTargets
3526 def _GetIntroTargetList(self
):
3528 return self
._IntroBuildTargetList
3530 def _GetFinalTargetList(self
):
3532 return self
._FinalBuildTargetList
3534 def _GetFileTypes(self
):
3536 return self
._FileTypes
3538 ## Get the list of package object the module depends on
3540 # @retval list The package object list
3542 def _GetDependentPackageList(self
):
3543 return self
.Module
.Packages
3545 ## Return the list of auto-generated code file
3547 # @retval list The list of auto-generated file
3549 def _GetAutoGenFileList(self
):
3550 UniStringAutoGenC
= True
3551 IdfStringAutoGenC
= True
3552 UniStringBinBuffer
= StringIO()
3553 IdfGenBinBuffer
= StringIO()
3554 if self
.BuildType
== 'UEFI_HII':
3555 UniStringAutoGenC
= False
3556 IdfStringAutoGenC
= False
3557 if self
._AutoGenFileList
== None:
3558 self
._AutoGenFileList
= {}
3559 AutoGenC
= TemplateString()
3560 AutoGenH
= TemplateString()
3561 StringH
= TemplateString()
3562 StringIdf
= TemplateString()
3563 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3565 # AutoGen.c is generated if there are library classes in inf, or there are object files
3567 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3568 or TAB_OBJECT_FILE
in self
.FileTypes
):
3569 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3570 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3571 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3572 if str(AutoGenH
) != "":
3573 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3574 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3575 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3576 if str(StringH
) != "":
3577 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3578 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3579 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3580 if UniStringBinBuffer
!= None and UniStringBinBuffer
.getvalue() != "":
3581 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3582 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3583 AutoFile
.IsBinary
= True
3584 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3585 if UniStringBinBuffer
!= None:
3586 UniStringBinBuffer
.close()
3587 if str(StringIdf
) != "":
3588 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3589 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3590 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3591 if IdfGenBinBuffer
!= None and IdfGenBinBuffer
.getvalue() != "":
3592 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3593 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3594 AutoFile
.IsBinary
= True
3595 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3596 if IdfGenBinBuffer
!= None:
3597 IdfGenBinBuffer
.close()
3598 return self
._AutoGenFileList
3600 ## Return the list of library modules explicitly or implicityly used by this module
3601 def _GetLibraryList(self
):
3602 if self
._DependentLibraryList
== None:
3603 # only merge library classes and PCD for non-library module
3605 self
._DependentLibraryList
= []
3607 if self
.AutoGenVersion
< 0x00010005:
3608 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3610 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3611 return self
._DependentLibraryList
3614 def UpdateComments(Recver
, Src
):
3616 if Key
not in Recver
:
3618 Recver
[Key
].extend(Src
[Key
])
3619 ## Get the list of PCDs from current module
3621 # @retval list The list of PCD
3623 def _GetModulePcdList(self
):
3624 if self
._ModulePcdList
== None:
3625 # apply PCD settings from platform
3626 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3627 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3628 return self
._ModulePcdList
3630 ## Get the list of PCDs from dependent libraries
3632 # @retval list The list of PCD
3634 def _GetLibraryPcdList(self
):
3635 if self
._LibraryPcdList
== None:
3637 if not self
.IsLibrary
:
3638 # get PCDs from dependent libraries
3639 for Library
in self
.DependentLibraryList
:
3640 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3641 for Key
in Library
.Pcds
:
3642 # skip duplicated PCDs
3643 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3645 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3646 # apply PCD settings from platform
3647 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3649 self
._LibraryPcdList
= []
3650 return self
._LibraryPcdList
3652 ## Get the GUID value mapping
3654 # @retval dict The mapping between GUID cname and its value
3656 def _GetGuidList(self
):
3657 if self
._GuidList
== None:
3658 self
._GuidList
= sdict()
3659 self
._GuidList
.update(self
.Module
.Guids
)
3660 for Library
in self
.DependentLibraryList
:
3661 self
._GuidList
.update(Library
.Guids
)
3662 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3663 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3664 return self
._GuidList
3666 def GetGuidsUsedByPcd(self
):
3667 if self
._GuidsUsedByPcd
== None:
3668 self
._GuidsUsedByPcd
= sdict()
3669 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3670 for Library
in self
.DependentLibraryList
:
3671 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3672 return self
._GuidsUsedByPcd
3673 ## Get the protocol value mapping
3675 # @retval dict The mapping between protocol cname and its value
3677 def _GetProtocolList(self
):
3678 if self
._ProtocolList
== None:
3679 self
._ProtocolList
= sdict()
3680 self
._ProtocolList
.update(self
.Module
.Protocols
)
3681 for Library
in self
.DependentLibraryList
:
3682 self
._ProtocolList
.update(Library
.Protocols
)
3683 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3684 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3685 return self
._ProtocolList
3687 ## Get the PPI value mapping
3689 # @retval dict The mapping between PPI cname and its value
3691 def _GetPpiList(self
):
3692 if self
._PpiList
== None:
3693 self
._PpiList
= sdict()
3694 self
._PpiList
.update(self
.Module
.Ppis
)
3695 for Library
in self
.DependentLibraryList
:
3696 self
._PpiList
.update(Library
.Ppis
)
3697 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3698 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3699 return self
._PpiList
3701 ## Get the list of include search path
3703 # @retval list The list path
3705 def _GetIncludePathList(self
):
3706 if self
._IncludePathList
== None:
3707 self
._IncludePathList
= []
3708 if self
.AutoGenVersion
< 0x00010005:
3709 for Inc
in self
.Module
.Includes
:
3710 if Inc
not in self
._IncludePathList
:
3711 self
._IncludePathList
.append(Inc
)
3713 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3714 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3715 self
._IncludePathList
.append(Inc
)
3716 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3717 self
._IncludePathList
.append(self
.DebugDir
)
3719 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3720 self
._IncludePathList
.append(self
.DebugDir
)
3722 for Package
in self
.Module
.Packages
:
3723 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3724 if PackageDir
not in self
._IncludePathList
:
3725 self
._IncludePathList
.append(PackageDir
)
3726 IncludesList
= Package
.Includes
3727 if Package
._PrivateIncludes
:
3728 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3729 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3730 for Inc
in IncludesList
:
3731 if Inc
not in self
._IncludePathList
:
3732 self
._IncludePathList
.append(str(Inc
))
3733 return self
._IncludePathList
3735 def _GetIncludePathLength(self
):
3736 self
._IncludePathLength
= 0
3737 if self
._IncludePathList
:
3738 for inc
in self
._IncludePathList
:
3739 self
._IncludePathLength
+= len(' ' + inc
)
3740 return self
._IncludePathLength
3742 ## Get HII EX PCDs which maybe used by VFR
3744 # efivarstore used by VFR may relate with HII EX PCDs
3745 # Get the variable name and GUID from efivarstore and HII EX PCD
3746 # List the HII EX PCDs in As Built INF if both name and GUID match.
3748 # @retval list HII EX PCDs
3750 def _GetPcdsMaybeUsedByVfr(self
):
3751 if not self
.SourceFileList
:
3755 for SrcFile
in self
.SourceFileList
:
3756 if SrcFile
.Ext
.lower() != '.vfr':
3758 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3759 if not os
.path
.exists(Vfri
):
3761 VfriFile
= open(Vfri
, 'r')
3762 Content
= VfriFile
.read()
3764 Pos
= Content
.find('efivarstore')
3767 # Make sure 'efivarstore' is the start of efivarstore statement
3768 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3771 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3773 if Index
>= 0 and Content
[Index
] != ';':
3774 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3777 # 'efivarstore' must be followed by name and guid
3779 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3782 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3785 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3786 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3787 Pos
= Content
.find('efivarstore', Name
.end())
3791 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3792 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3794 for SkuName
in Pcd
.SkuInfoList
:
3795 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3796 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3797 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3800 Guid
= GuidStructureStringToGuidString(Value
)
3801 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3802 HiiExPcds
.append(Pcd
)
3807 def _GenOffsetBin(self
):
3809 for SourceFile
in self
.Module
.Sources
:
3810 if SourceFile
.Type
.upper() == ".VFR" :
3812 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3814 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3815 if SourceFile
.Type
.upper() == ".UNI" :
3817 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3819 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3821 if len(VfrUniBaseName
) == 0:
3823 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3824 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3825 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3826 if not VfrUniOffsetList
:
3829 OutputName
= '%sOffset.bin' % self
.Name
3830 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3833 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3835 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3837 # Use a instance of StringIO to cache data
3838 fStringIO
= StringIO('')
3840 for Item
in VfrUniOffsetList
:
3841 if (Item
[0].find("Strings") != -1):
3843 # UNI offset in image.
3845 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3847 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3848 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3849 fStringIO
.write(''.join(UniGuid
))
3850 UniValue
= pack ('Q', int (Item
[1], 16))
3851 fStringIO
.write (UniValue
)
3854 # VFR binary offset in image.
3856 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3858 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3859 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3860 fStringIO
.write(''.join(VfrGuid
))
3862 VfrValue
= pack ('Q', int (Item
[1], 16))
3863 fStringIO
.write (VfrValue
)
3865 # write data into file.
3868 fInputfile
.write (fStringIO
.getvalue())
3870 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3871 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3877 ## Create AsBuilt INF file the module
3879 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3880 self
.OutputFile
= []
3882 if GlobalData
.gBinCacheDest
:
3883 self
.CopyModuleToCache()
3886 if self
.IsAsBuiltInfCreated
:
3889 # Skip the following code for EDK I inf
3890 if self
.AutoGenVersion
< 0x00010005:
3893 # Skip the following code for libraries
3897 # Skip the following code for modules with no source files
3898 if self
.SourceFileList
== None or self
.SourceFileList
== []:
3901 # Skip the following code for modules without any binary files
3902 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3905 ### TODO: How to handles mixed source and binary modules
3907 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3908 # Also find all packages that the DynamicEx PCDs depend on
3913 PcdTokenSpaceList
= []
3914 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3915 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3916 PatchablePcds
+= [Pcd
]
3917 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3918 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3921 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3922 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3923 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3925 GuidList
.update(self
.GuidList
)
3926 for TokenSpace
in self
.GetGuidsUsedByPcd():
3927 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3928 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3929 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3930 GuidList
.pop(TokenSpace
)
3931 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3932 for Package
in self
.DerivedPackageList
:
3933 if Package
in Packages
:
3935 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3937 for Index
in range(len(BeChecked
)):
3938 for Item
in CheckList
[Index
]:
3939 if Item
in BeChecked
[Index
]:
3940 Packages
+= [Package
]
3945 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3946 for Pkg
in self
.PlatformInfo
.PackageList
:
3949 for VfrPcd
in VfrPcds
:
3950 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
3951 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
3955 ModuleType
= self
.ModuleType
3956 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
3957 ModuleType
= 'DXE_DRIVER'
3960 if self
.PcdIsDriver
!= '':
3961 DriverType
= self
.PcdIsDriver
3964 MDefs
= self
.Module
.Defines
3967 'module_name' : self
.Name
,
3968 'module_guid' : Guid
,
3969 'module_module_type' : ModuleType
,
3970 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3971 'pcd_is_driver_string' : [],
3972 'module_uefi_specification_version' : [],
3973 'module_pi_specification_version' : [],
3974 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3975 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3976 'module_constructor' : self
.Module
.ConstructorList
,
3977 'module_destructor' : self
.Module
.DestructorList
,
3978 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
3979 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
3980 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
3981 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
3982 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
3983 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
3984 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
3985 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
3986 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
3987 'module_arch' : self
.Arch
,
3988 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
3990 'patchablepcd_item' : [],
3992 'protocol_item' : [],
3996 'libraryclasses_item' : []
3999 if 'MODULE_UNI_FILE' in MDefs
:
4000 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4001 if os
.path
.isfile(UNIFile
):
4002 shutil
.copy2(UNIFile
, self
.OutputDir
)
4004 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4005 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4007 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4010 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4012 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4013 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4014 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4015 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4017 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4018 for Item
in self
.CodaTargetList
:
4019 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4020 if File
not in self
.OutputFile
:
4021 self
.OutputFile
.append(File
)
4022 if Item
.Target
.Ext
.lower() == '.aml':
4023 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4024 elif Item
.Target
.Ext
.lower() == '.acpi':
4025 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4026 elif Item
.Target
.Ext
.lower() == '.efi':
4027 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4029 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4030 if self
.DepexGenerated
:
4031 if self
.Name
+ '.depex' not in self
.OutputFile
:
4032 self
.OutputFile
.append(self
.Name
+ '.depex')
4033 if self
.ModuleType
in ['PEIM']:
4034 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4035 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4036 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4037 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4038 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4040 Bin
= self
._GenOffsetBin
()
4042 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4043 if Bin
not in self
.OutputFile
:
4044 self
.OutputFile
.append(Bin
)
4046 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4048 if File
.lower().endswith('.pdb'):
4049 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4050 if File
not in self
.OutputFile
:
4051 self
.OutputFile
.append(File
)
4052 HeaderComments
= self
.Module
.HeaderComments
4054 for Index
in range(len(HeaderComments
)):
4055 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4056 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4059 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4060 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4063 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4064 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4065 (GuidList
, self
._GuidComments
, 'guid_item')
4067 for Item
in GenList
:
4068 for CName
in Item
[0]:
4070 if CName
in Item
[1]:
4071 Comments
= '\n '.join(Item
[1][CName
])
4074 Entry
= Comments
+ '\n ' + CName
4075 AsBuiltInfDict
[Item
[2]].append(Entry
)
4076 PatchList
= parsePcdInfoFromMapFile(
4077 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4078 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4081 for Pcd
in PatchablePcds
:
4082 TokenCName
= Pcd
.TokenCName
4083 for PcdItem
in GlobalData
.MixedPcd
:
4084 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4085 TokenCName
= PcdItem
[0]
4087 for PatchPcd
in PatchList
:
4088 if TokenCName
== PatchPcd
[0]:
4093 if Pcd
.DatumType
== 'BOOLEAN':
4094 BoolValue
= Pcd
.DefaultValue
.upper()
4095 if BoolValue
== 'TRUE':
4096 Pcd
.DefaultValue
= '1'
4097 elif BoolValue
== 'FALSE':
4098 Pcd
.DefaultValue
= '0'
4100 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4101 HexFormat
= '0x%02x'
4102 if Pcd
.DatumType
== 'UINT16':
4103 HexFormat
= '0x%04x'
4104 elif Pcd
.DatumType
== 'UINT32':
4105 HexFormat
= '0x%08x'
4106 elif Pcd
.DatumType
== 'UINT64':
4107 HexFormat
= '0x%016x'
4108 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4110 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
4111 EdkLogger
.error("build", AUTOGEN_ERROR
,
4112 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4114 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4115 PcdValue
= Pcd
.DefaultValue
4116 if PcdValue
[0] != '{':
4118 if PcdValue
[0] == 'L':
4120 PcdValue
= PcdValue
.lstrip('L')
4121 PcdValue
= eval(PcdValue
)
4123 for Index
in range(0, len(PcdValue
)):
4125 CharVal
= ord(PcdValue
[Index
])
4126 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4127 + '0x%02x' % (CharVal
>> 8) + ', '
4129 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4132 Padding
= Padding
* 2
4133 ArraySize
= ArraySize
/ 2
4134 if ArraySize
< (len(PcdValue
) + 1):
4135 EdkLogger
.error("build", AUTOGEN_ERROR
,
4136 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4138 if ArraySize
> len(PcdValue
) + 1:
4139 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4140 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4141 elif len(PcdValue
.split(',')) <= ArraySize
:
4142 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4145 EdkLogger
.error("build", AUTOGEN_ERROR
,
4146 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4148 PcdItem
= '%s.%s|%s|0x%X' % \
4149 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4151 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4152 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4154 PcdItem
= PcdComments
+ '\n ' + PcdItem
4155 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4158 for Pcd
in Pcds
+ VfrPcds
:
4163 TokenCName
= Pcd
.TokenCName
4164 for PcdItem
in GlobalData
.MixedPcd
:
4165 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4166 TokenCName
= PcdItem
[0]
4168 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4169 for SkuName
in Pcd
.SkuInfoList
:
4170 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4171 SkuId
= SkuInfo
.SkuId
4172 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4176 # Don't generate duplicated HII PCD
4178 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4181 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4182 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4183 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4187 for Index
, Comment
in enumerate(PcdCommentList
):
4188 for Usage
in UsageList
:
4189 if Comment
.find(Usage
) != -1:
4193 if UsageIndex
!= -1:
4194 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4196 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4197 PcdComments
= '\n '.join(PcdCommentList
)
4198 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4200 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4201 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4202 for Item
in self
.BuildOption
:
4203 if 'FLAGS' in self
.BuildOption
[Item
]:
4204 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4206 # Generated LibraryClasses section in comments.
4207 for Library
in self
.LibraryAutoGenList
:
4208 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4210 # Generated UserExtensions TianoCore section.
4211 # All tianocore user extensions are copied.
4213 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4214 UserExtStr
+= '\n'.join(TianoCore
)
4215 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4216 if os
.path
.isfile(ExtensionFile
):
4217 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4218 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4220 # Generated depex expression section in comments.
4221 AsBuiltInfDict
['depexsection_item'] = ''
4222 DepexExpresion
= self
._GetDepexExpresionString
()
4224 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4226 AsBuiltInf
= TemplateString()
4227 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4229 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4231 self
.IsAsBuiltInfCreated
= True
4232 if GlobalData
.gBinCacheDest
:
4233 self
.CopyModuleToCache()
4235 def CopyModuleToCache(self
):
4236 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4237 CreateDirectory (FileDir
)
4238 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4239 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4240 if os
.path
.exists(HashFile
):
4241 shutil
.copy2(HashFile
, FileDir
)
4242 if os
.path
.exists(ModuleFile
):
4243 shutil
.copy2(ModuleFile
, FileDir
)
4244 if not self
.OutputFile
:
4245 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4246 self
.OutputFile
= Ma
.Binaries
4248 for File
in self
.OutputFile
:
4250 if not os
.path
.isabs(File
):
4251 File
= os
.path
.join(self
.OutputDir
, File
)
4252 if os
.path
.exists(File
):
4253 shutil
.copy2(File
, FileDir
)
4255 def AttemptModuleCacheCopy(self
):
4256 if self
.IsBinaryModule
:
4258 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4259 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4260 if os
.path
.exists(HashFile
):
4261 f
= open(HashFile
, 'r')
4262 CacheHash
= f
.read()
4264 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4265 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4266 for root
, dir, files
in os
.walk(FileDir
):
4268 if self
.Name
+ '.hash' in f
:
4269 shutil
.copy2(HashFile
, self
.BuildDir
)
4271 File
= path
.join(root
, f
)
4272 shutil
.copy2(File
, self
.OutputDir
)
4273 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4274 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4278 ## Create makefile for the module and its dependent libraries
4280 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4281 # dependent libraries will be created
4283 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4284 # Ignore generating makefile when it is a binary module
4285 if self
.IsBinaryModule
:
4288 if self
.IsMakeFileCreated
:
4290 self
.GenFfsList
= GenFfsList
4291 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4292 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4293 LibraryAutoGen
.CreateMakeFile()
4298 if len(self
.CustomMakefile
) == 0:
4299 Makefile
= GenMake
.ModuleMakefile(self
)
4301 Makefile
= GenMake
.CustomMakefile(self
)
4302 if Makefile
.Generate():
4303 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4304 (self
.Name
, self
.Arch
))
4306 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4307 (self
.Name
, self
.Arch
))
4309 self
.CreateTimeStamp(Makefile
)
4310 self
.IsMakeFileCreated
= True
4312 def CopyBinaryFiles(self
):
4313 for File
in self
.Module
.Binaries
:
4315 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4316 CopyLongFilePath(SrcPath
, DstPath
)
4317 ## Create autogen code for the module and its dependent libraries
4319 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4320 # dependent libraries will be created
4322 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4323 if self
.IsCodeFileCreated
:
4326 # Need to generate PcdDatabase even PcdDriver is binarymodule
4327 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4328 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4330 if self
.IsBinaryModule
:
4332 self
.CopyBinaryFiles()
4335 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4336 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4337 LibraryAutoGen
.CreateCodeFile()
4343 IgoredAutoGenList
= []
4345 for File
in self
.AutoGenFileList
:
4346 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4347 #Ignore Edk AutoGen.c
4348 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4351 AutoGenList
.append(str(File
))
4353 IgoredAutoGenList
.append(str(File
))
4355 # Skip the following code for EDK I inf
4356 if self
.AutoGenVersion
< 0x00010005:
4359 for ModuleType
in self
.DepexList
:
4360 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4361 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4364 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4365 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4367 if len(Dpx
.PostfixNotation
) <> 0:
4368 self
.DepexGenerated
= True
4370 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4371 AutoGenList
.append(str(DpxFile
))
4373 IgoredAutoGenList
.append(str(DpxFile
))
4375 if IgoredAutoGenList
== []:
4376 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4377 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4378 elif AutoGenList
== []:
4379 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4380 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4382 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4383 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4385 self
.IsCodeFileCreated
= True
4388 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4389 def _GetLibraryAutoGenList(self
):
4390 if self
._LibraryAutoGenList
== None:
4391 self
._LibraryAutoGenList
= []
4392 for Library
in self
.DependentLibraryList
:
4399 self
.PlatformInfo
.MetaFile
4401 if La
not in self
._LibraryAutoGenList
:
4402 self
._LibraryAutoGenList
.append(La
)
4403 for Lib
in La
.CodaTargetList
:
4404 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4405 return self
._LibraryAutoGenList
4407 def GenModuleHash(self
):
4408 if self
.Arch
not in GlobalData
.gModuleHash
:
4409 GlobalData
.gModuleHash
[self
.Arch
] = {}
4411 # Add Platform level hash
4412 m
.update(GlobalData
.gPlatformHash
)
4413 # Add Package level hash
4414 if self
.DependentPackageList
:
4415 for Pkg
in self
.DependentPackageList
:
4416 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4417 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4420 if self
.LibraryAutoGenList
:
4421 for Lib
in self
.LibraryAutoGenList
:
4422 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4424 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4427 f
= open(str(self
.MetaFile
), 'r')
4431 # Add Module's source files
4432 if self
.SourceFileList
:
4433 for File
in self
.SourceFileList
:
4434 f
= open(str(File
), 'r')
4439 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4440 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4441 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4442 if GlobalData
.gBinCacheSource
:
4443 CacheValid
= self
.AttemptModuleCacheCopy()
4446 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4448 ## Decide whether we can skip the ModuleAutoGen process
4449 def CanSkipbyHash(self
):
4450 if GlobalData
.gUseHashCache
:
4451 return not self
.GenModuleHash()
4453 ## Decide whether we can skip the ModuleAutoGen process
4454 # If any source file is newer than the module than we cannot skip
4457 if not os
.path
.exists(self
.GetTimeStampPath()):
4459 #last creation time of the module
4460 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4462 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4463 if SrcTimeStamp
> DstTimeStamp
:
4466 with
open(self
.GetTimeStampPath(),'r') as f
:
4468 source
= source
.rstrip('\n')
4469 if not os
.path
.exists(source
):
4471 if source
not in ModuleAutoGen
.TimeDict
:
4472 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4473 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4477 def GetTimeStampPath(self
):
4478 if self
._TimeStampPath
== None:
4479 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4480 return self
._TimeStampPath
4481 def CreateTimeStamp(self
, Makefile
):
4485 FileSet
.add (self
.MetaFile
.Path
)
4487 for SourceFile
in self
.Module
.Sources
:
4488 FileSet
.add (SourceFile
.Path
)
4490 for Lib
in self
.DependentLibraryList
:
4491 FileSet
.add (Lib
.MetaFile
.Path
)
4493 for f
in self
.AutoGenDepSet
:
4494 FileSet
.add (f
.Path
)
4496 if os
.path
.exists (self
.GetTimeStampPath()):
4497 os
.remove (self
.GetTimeStampPath())
4498 with
open(self
.GetTimeStampPath(), 'w+') as file:
4502 Module
= property(_GetModule
)
4503 Name
= property(_GetBaseName
)
4504 Guid
= property(_GetGuid
)
4505 Version
= property(_GetVersion
)
4506 ModuleType
= property(_GetModuleType
)
4507 ComponentType
= property(_GetComponentType
)
4508 BuildType
= property(_GetBuildType
)
4509 PcdIsDriver
= property(_GetPcdIsDriver
)
4510 AutoGenVersion
= property(_GetAutoGenVersion
)
4511 Macros
= property(_GetMacros
)
4512 Specification
= property(_GetSpecification
)
4514 IsLibrary
= property(_IsLibrary
)
4515 IsBinaryModule
= property(_IsBinaryModule
)
4516 BuildDir
= property(_GetBuildDir
)
4517 OutputDir
= property(_GetOutputDir
)
4518 FfsOutputDir
= property(_GetFfsOutputDir
)
4519 DebugDir
= property(_GetDebugDir
)
4520 MakeFileDir
= property(_GetMakeFileDir
)
4521 CustomMakefile
= property(_GetCustomMakefile
)
4523 IncludePathList
= property(_GetIncludePathList
)
4524 IncludePathLength
= property(_GetIncludePathLength
)
4525 AutoGenFileList
= property(_GetAutoGenFileList
)
4526 UnicodeFileList
= property(_GetUnicodeFileList
)
4527 VfrFileList
= property(_GetVfrFileList
)
4528 SourceFileList
= property(_GetSourceFileList
)
4529 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4530 Targets
= property(_GetTargets
)
4531 IntroTargetList
= property(_GetIntroTargetList
)
4532 CodaTargetList
= property(_GetFinalTargetList
)
4533 FileTypes
= property(_GetFileTypes
)
4534 BuildRules
= property(_GetBuildRules
)
4535 IdfFileList
= property(_GetIdfFileList
)
4537 DependentPackageList
= property(_GetDependentPackageList
)
4538 DependentLibraryList
= property(_GetLibraryList
)
4539 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4540 DerivedPackageList
= property(_GetDerivedPackageList
)
4542 ModulePcdList
= property(_GetModulePcdList
)
4543 LibraryPcdList
= property(_GetLibraryPcdList
)
4544 GuidList
= property(_GetGuidList
)
4545 ProtocolList
= property(_GetProtocolList
)
4546 PpiList
= property(_GetPpiList
)
4547 DepexList
= property(_GetDepexTokenList
)
4548 DxsFile
= property(_GetDxsFile
)
4549 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4550 BuildOption
= property(_GetModuleBuildOption
)
4551 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4552 BuildCommand
= property(_GetBuildCommand
)
4554 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4556 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4557 if __name__
== '__main__':