2 # Generate AutoGen.h, AutoGen.c and *.depex files
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # Copyright (c) 2018, Hewlett Packard Enterprise Development, L.P.<BR>
7 # This program and the accompanying materials
8 # are licensed and made available under the terms and conditions of the BSD License
9 # which accompanies this distribution. The full text of the license may be found at
10 # http://opensource.org/licenses/bsd-license.php
12 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 from __future__
import print_function
19 from __future__
import absolute_import
20 import Common
.LongFilePathOs
as os
22 import os
.path
as path
28 from . import GenDepex
29 from io
import BytesIO
31 from .StrGather
import *
32 from .BuildEngine
import BuildRule
34 from Common
.LongFilePathSupport
import CopyLongFilePath
35 from Common
.BuildToolError
import *
36 from Common
.DataType
import *
37 from Common
.Misc
import *
38 from Common
.StringUtils
import *
39 import Common
.GlobalData
as GlobalData
40 from GenFds
.FdfParser
import *
41 from CommonDataClass
.CommonClass
import SkuInfoClass
42 from GenPatchPcdTable
.GenPatchPcdTable
import parsePcdInfoFromMapFile
43 import Common
.VpdInfoFile
as VpdInfoFile
44 from .GenPcdDb
import CreatePcdDatabaseCode
45 from Workspace
.MetaFileCommentParser
import UsageList
46 from Workspace
.WorkspaceCommon
import GetModuleLibInstances
47 from Common
.MultipleWorkspace
import MultipleWorkspace
as mws
48 from . import InfSectionParser
51 from .GenVar
import VariableMgr
, var_info
52 from collections
import OrderedDict
53 from collections
import defaultdict
54 from Workspace
.WorkspaceCommon
import OrderedListDict
56 from Common
.caching
import cached_property
, cached_class_function
58 ## Regular expression for splitting Dependency Expression string into tokens
59 gDepexTokenPattern
= re
.compile("(\(|\)|\w+| \S+\.inf)")
61 ## Regular expression for match: PCD(xxxx.yyy)
62 gPCDAsGuidPattern
= re
.compile(r
"^PCD\(.+\..+\)$")
65 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
66 # is the former use /I , the Latter used -I to specify include directories
68 gBuildOptIncludePatternMsft
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
69 gBuildOptIncludePatternOther
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
72 # Match name = variable
74 gEfiVarStoreNamePattern
= re
.compile("\s*name\s*=\s*(\w+)")
76 # The format of guid in efivarstore statement likes following and must be correct:
77 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
79 gEfiVarStoreGuidPattern
= re
.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
81 ## Mapping Makefile type
82 gMakeTypeMap
= {TAB_COMPILER_MSFT
:"nmake", "GCC":"gmake"}
85 ## Build rule configuration file
86 gDefaultBuildRuleFile
= 'build_rule.txt'
88 ## Tools definition configuration file
89 gDefaultToolsDefFile
= 'tools_def.txt'
91 ## Build rule default version
92 AutoGenReqBuildRuleVerNum
= "0.1"
94 ## default file name for AutoGen
95 gAutoGenCodeFileName
= "AutoGen.c"
96 gAutoGenHeaderFileName
= "AutoGen.h"
97 gAutoGenStringFileName
= "%(module_name)sStrDefs.h"
98 gAutoGenStringFormFileName
= "%(module_name)sStrDefs.hpk"
99 gAutoGenDepexFileName
= "%(module_name)s.depex"
100 gAutoGenImageDefFileName
= "%(module_name)sImgDefs.h"
101 gAutoGenIdfFileName
= "%(module_name)sIdf.hpk"
102 gInfSpecVersion
= "0x00010017"
105 # Template string to generic AsBuilt INF
107 gAsBuiltInfHeaderString
= TemplateString("""${header_comments}
110 # FILE auto-generated
113 INF_VERSION = ${module_inf_version}
114 BASE_NAME = ${module_name}
115 FILE_GUID = ${module_guid}
116 MODULE_TYPE = ${module_module_type}${BEGIN}
117 VERSION_STRING = ${module_version_string}${END}${BEGIN}
118 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
119 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
120 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
121 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
122 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
123 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
124 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
125 SHADOW = ${module_shadow}${END}${BEGIN}
126 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
127 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
128 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
129 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
130 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
131 SPEC = ${module_spec}${END}${BEGIN}
132 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
133 MODULE_UNI_FILE = ${module_uni_file}${END}
135 [Packages.${module_arch}]${BEGIN}
136 ${package_item}${END}
138 [Binaries.${module_arch}]${BEGIN}
141 [PatchPcd.${module_arch}]${BEGIN}
145 [Protocols.${module_arch}]${BEGIN}
149 [Ppis.${module_arch}]${BEGIN}
153 [Guids.${module_arch}]${BEGIN}
157 [PcdEx.${module_arch}]${BEGIN}
161 [LibraryClasses.${module_arch}]
162 ## @LIB_INSTANCES${BEGIN}
163 # ${libraryclasses_item}${END}
167 ${userextension_tianocore_item}
171 [BuildOptions.${module_arch}]
173 ## ${flags_item}${END}
176 ## Base class for AutoGen
178 # This class just implements the cache mechanism of AutoGen objects.
180 class AutoGen(object):
181 # database to maintain the objects in each child class
182 __ObjectCache
= {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object
186 # @param Class class object of real AutoGen class
187 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
188 # @param Workspace Workspace directory or WorkspaceAutoGen object
189 # @param MetaFile The path of meta file
190 # @param Target Build target
191 # @param Toolchain Tool chain name
192 # @param Arch Target arch
193 # @param *args The specific class related parameters
194 # @param **kwargs The specific class related dict parameters
196 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
197 # check if the object has been created
198 Key
= (Target
, Toolchain
, Arch
, MetaFile
)
199 if Key
in cls
.__ObjectCache
:
200 # if it exists, just return it directly
201 return cls
.__ObjectCache
[Key
]
202 # it didnt exist. create it, cache it, then return it
203 RetVal
= cls
.__ObjectCache
[Key
] = super(AutoGen
, cls
).__new
__(cls
)
206 def __init__ (self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
207 super(AutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
211 # The file path of platform file will be used to represent hash value of this object
213 # @retval int Hash value of the file path of platform file
216 return hash(self
.MetaFile
)
220 # The file path of platform file will be used to represent this object
222 # @retval string String of platform file path
225 return str(self
.MetaFile
)
228 def __eq__(self
, Other
):
229 return Other
and self
.MetaFile
== Other
231 ## Workspace AutoGen class
233 # This class is used mainly to control the whole platform build for different
234 # architecture. This class will generate top level makefile.
236 class WorkspaceAutoGen(AutoGen
):
237 # call super().__init__ then call the worker function with different parameter count
238 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
239 if not hasattr(self
, "_Init"):
240 super(WorkspaceAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
241 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
244 ## Initialize WorkspaceAutoGen
246 # @param WorkspaceDir Root directory of workspace
247 # @param ActivePlatform Meta-file of active platform
248 # @param Target Build target
249 # @param Toolchain Tool chain name
250 # @param ArchList List of architecture of current build
251 # @param MetaFileDb Database containing meta-files
252 # @param BuildConfig Configuration of build
253 # @param ToolDefinition Tool chain definitions
254 # @param FlashDefinitionFile File of flash definition
255 # @param Fds FD list to be generated
256 # @param Fvs FV list to be generated
257 # @param Caps Capsule list to be generated
258 # @param SkuId SKU id from command line
260 def _InitWorker(self
, WorkspaceDir
, ActivePlatform
, Target
, Toolchain
, ArchList
, MetaFileDb
,
261 BuildConfig
, ToolDefinition
, FlashDefinitionFile
='', Fds
=None, Fvs
=None, Caps
=None, SkuId
='', UniFlag
=None,
262 Progress
=None, BuildModule
=None):
263 self
.BuildDatabase
= MetaFileDb
264 self
.MetaFile
= ActivePlatform
265 self
.WorkspaceDir
= WorkspaceDir
266 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, TAB_ARCH_COMMON
, Target
, Toolchain
]
267 GlobalData
.gActivePlatform
= self
.Platform
268 self
.BuildTarget
= Target
269 self
.ToolChain
= Toolchain
270 self
.ArchList
= ArchList
272 self
.UniFlag
= UniFlag
274 self
.TargetTxt
= BuildConfig
275 self
.ToolDef
= ToolDefinition
276 self
.FdfFile
= FlashDefinitionFile
277 self
.FdTargetList
= Fds
if Fds
else []
278 self
.FvTargetList
= Fvs
if Fvs
else []
279 self
.CapTargetList
= Caps
if Caps
else []
280 self
.AutoGenObjectList
= []
283 # there's many relative directory operations, so ...
284 os
.chdir(self
.WorkspaceDir
)
289 if not self
.ArchList
:
290 ArchList
= set(self
.Platform
.SupArchList
)
292 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
294 EdkLogger
.error("build", PARAMETER_INVALID
,
295 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
296 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
297 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
298 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
299 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
300 self
.ArchList
= tuple(ArchList
)
302 # Validate build target
303 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
304 EdkLogger
.error("build", PARAMETER_INVALID
,
305 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
306 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
309 # parse FDF file to get PCDs in it, if any
311 self
.FdfFile
= self
.Platform
.FlashDefinition
315 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
316 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
317 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
319 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
321 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
324 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
326 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
329 Progress
.Start("\nProcessing meta-data")
333 # Mark now build in AutoGen Phase
335 GlobalData
.gAutoGenPhase
= True
336 Fdf
= FdfParser(self
.FdfFile
.Path
)
338 GlobalData
.gFdfParser
= Fdf
339 GlobalData
.gAutoGenPhase
= False
340 PcdSet
= Fdf
.Profile
.PcdDict
341 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
342 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
343 for FdRegion
in FdDict
.RegionList
:
344 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
345 if int(FdRegion
.Offset
) % 8 != 0:
346 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
347 ModuleList
= Fdf
.Profile
.InfList
348 self
.FdfProfile
= Fdf
.Profile
349 for fvname
in self
.FvTargetList
:
350 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
351 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
352 "No such an FV in FDF file: %s" % fvname
)
354 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
355 # but the path (self.MetaFile.Path) is the real path
356 for key
in self
.FdfProfile
.InfDict
:
358 MetaFile_cache
= defaultdict(set)
359 for Arch
in self
.ArchList
:
360 Current_Platform_cache
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
361 for Pkey
in Current_Platform_cache
.Modules
:
362 MetaFile_cache
[Arch
].add(Current_Platform_cache
.Modules
[Pkey
].MetaFile
)
363 for Inf
in self
.FdfProfile
.InfDict
[key
]:
364 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
365 for Arch
in self
.ArchList
:
366 if ModuleFile
in MetaFile_cache
[Arch
]:
369 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
370 if not ModuleData
.IsBinaryModule
:
371 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
374 for Arch
in self
.ArchList
:
376 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
378 for Pkey
in Platform
.Modules
:
379 MetaFileList
.add(Platform
.Modules
[Pkey
].MetaFile
)
380 for Inf
in self
.FdfProfile
.InfDict
[key
]:
381 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
382 if ModuleFile
in MetaFileList
:
384 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
385 if not ModuleData
.IsBinaryModule
:
386 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
391 self
.FdfProfile
= None
392 if self
.FdTargetList
:
393 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
394 self
.FdTargetList
= []
395 if self
.FvTargetList
:
396 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
397 self
.FvTargetList
= []
398 if self
.CapTargetList
:
399 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
400 self
.CapTargetList
= []
402 # apply SKU and inject PCDs from Flash Definition file
403 for Arch
in self
.ArchList
:
404 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
405 PlatformPcds
= Platform
.Pcds
406 self
._GuidDict
= Platform
._GuidDict
407 SourcePcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set(),TAB_PCDS_DYNAMIC
:set(),TAB_PCDS_FIXED_AT_BUILD
:set()}
408 BinaryPcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set()}
409 SourcePcdDict_Keys
= SourcePcdDict
.keys()
410 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
412 # generate the SourcePcdDict and BinaryPcdDict
413 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
414 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
415 if BuildData
.Arch
!= Arch
:
417 if BuildData
.MetaFile
.Ext
== '.inf':
418 for key
in BuildData
.Pcds
:
419 if BuildData
.Pcds
[key
].Pending
:
420 if key
in Platform
.Pcds
:
421 PcdInPlatform
= Platform
.Pcds
[key
]
422 if PcdInPlatform
.Type
:
423 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
424 BuildData
.Pcds
[key
].Pending
= False
426 if BuildData
.MetaFile
in Platform
.Modules
:
427 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
428 if key
in PlatformModule
.Pcds
:
429 PcdInPlatform
= PlatformModule
.Pcds
[key
]
430 if PcdInPlatform
.Type
:
431 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
432 BuildData
.Pcds
[key
].Pending
= False
434 #Pcd used in Library, Pcd Type from reference module if Pcd Type is Pending
435 if BuildData
.Pcds
[key
].Pending
:
436 MGen
= ModuleAutoGen(self
, BuildData
.MetaFile
, Target
, Toolchain
, Arch
, self
.MetaFile
)
437 if MGen
and MGen
.IsLibrary
:
438 if MGen
in PGen
.LibraryAutoGenList
:
439 ReferenceModules
= MGen
.ReferenceModules
440 for ReferenceModule
in ReferenceModules
:
441 if ReferenceModule
.MetaFile
in Platform
.Modules
:
442 RefPlatformModule
= Platform
.Modules
[str(ReferenceModule
.MetaFile
)]
443 if key
in RefPlatformModule
.Pcds
:
444 PcdInReferenceModule
= RefPlatformModule
.Pcds
[key
]
445 if PcdInReferenceModule
.Type
:
446 BuildData
.Pcds
[key
].Type
= PcdInReferenceModule
.Type
447 BuildData
.Pcds
[key
].Pending
= False
450 if TAB_PCDS_DYNAMIC_EX
in BuildData
.Pcds
[key
].Type
:
451 if BuildData
.IsBinaryModule
:
452 BinaryPcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
454 SourcePcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
456 elif TAB_PCDS_PATCHABLE_IN_MODULE
in BuildData
.Pcds
[key
].Type
:
457 if BuildData
.MetaFile
.Ext
== '.inf':
458 if BuildData
.IsBinaryModule
:
459 BinaryPcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
461 SourcePcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
463 elif TAB_PCDS_DYNAMIC
in BuildData
.Pcds
[key
].Type
:
464 SourcePcdDict
[TAB_PCDS_DYNAMIC
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
465 elif TAB_PCDS_FIXED_AT_BUILD
in BuildData
.Pcds
[key
].Type
:
466 SourcePcdDict
[TAB_PCDS_FIXED_AT_BUILD
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
470 # A PCD can only use one type for all source modules
472 for i
in SourcePcdDict_Keys
:
473 for j
in SourcePcdDict_Keys
:
475 Intersections
= SourcePcdDict
[i
].intersection(SourcePcdDict
[j
])
476 if len(Intersections
) > 0:
480 "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
),
481 ExtraData
='\n\t'.join(str(P
[1]+'.'+P
[0]) for P
in Intersections
)
485 # intersection the BinaryPCD for Mixed PCD
487 for i
in BinaryPcdDict_Keys
:
488 for j
in BinaryPcdDict_Keys
:
490 Intersections
= BinaryPcdDict
[i
].intersection(BinaryPcdDict
[j
])
491 for item
in Intersections
:
492 NewPcd1
= (item
[0] + '_' + i
, item
[1])
493 NewPcd2
= (item
[0] + '_' + j
, item
[1])
494 if item
not in GlobalData
.MixedPcd
:
495 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
497 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
498 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
499 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
500 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
503 # intersection the SourcePCD and BinaryPCD for Mixed PCD
505 for i
in SourcePcdDict_Keys
:
506 for j
in BinaryPcdDict_Keys
:
508 Intersections
= SourcePcdDict
[i
].intersection(BinaryPcdDict
[j
])
509 for item
in Intersections
:
510 NewPcd1
= (item
[0] + '_' + i
, item
[1])
511 NewPcd2
= (item
[0] + '_' + j
, item
[1])
512 if item
not in GlobalData
.MixedPcd
:
513 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
515 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
516 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
517 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
518 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
520 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
521 if BuildData
.Arch
!= Arch
:
523 for key
in BuildData
.Pcds
:
524 for SinglePcd
in GlobalData
.MixedPcd
:
525 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
526 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
527 Pcd_Type
= item
[0].split('_')[-1]
528 if (Pcd_Type
== BuildData
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and BuildData
.Pcds
[key
].Type
in PCD_DYNAMIC_EX_TYPE_SET
) or \
529 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in PCD_DYNAMIC_TYPE_SET
):
530 Value
= BuildData
.Pcds
[key
]
531 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
533 newkey
= (Value
.TokenCName
, key
[1])
535 newkey
= (Value
.TokenCName
, key
[1], key
[2])
536 del BuildData
.Pcds
[key
]
537 BuildData
.Pcds
[newkey
] = Value
541 # handle the mixed pcd in FDF file
543 if key
in GlobalData
.MixedPcd
:
546 for item
in GlobalData
.MixedPcd
[key
]:
549 #Collect package set information from INF of FDF
551 for Inf
in ModuleList
:
552 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
553 if ModuleFile
in Platform
.Modules
:
555 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
556 PkgSet
.update(ModuleData
.Packages
)
557 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
562 DecPcds
.add((Pcd
[0], Pcd
[1]))
563 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
565 Platform
.SkuName
= self
.SkuId
566 for Name
, Guid
,Fileds
in PcdSet
:
567 if (Name
, Guid
) not in DecPcds
:
571 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
572 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
, Fileds
][0],
573 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
, Fileds
][1]
576 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
577 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
578 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
579 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
581 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
585 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
586 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
, Fileds
][0],
587 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
, Fileds
][1]
590 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
592 # Explicitly collect platform's dynamic PCDs
594 Pa
.CollectPlatformDynamicPcds()
595 Pa
.CollectFixedAtBuildPcds()
596 self
.AutoGenObjectList
.append(Pa
)
599 # Generate Package level hash value
601 GlobalData
.gPackageHash
[Arch
] = {}
602 if GlobalData
.gUseHashCache
:
604 self
._GenPkgLevelHash
(Pkg
)
607 # Check PCDs token value conflict in each DEC file.
609 self
._CheckAllPcdsTokenValueConflict
()
612 # Check PCD type and definition between DSC and DEC
614 self
._CheckPcdDefineAndType
()
617 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
619 content
= 'gCommandLineDefines: '
620 content
+= str(GlobalData
.gCommandLineDefines
)
621 content
+= os
.linesep
622 content
+= 'BuildOptionPcd: '
623 content
+= str(GlobalData
.BuildOptionPcd
)
624 content
+= os
.linesep
625 content
+= 'Active Platform: '
626 content
+= str(self
.Platform
)
627 content
+= os
.linesep
629 content
+= 'Flash Image Definition: '
630 content
+= str(self
.FdfFile
)
631 content
+= os
.linesep
632 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
635 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
637 PcdTokenNumber
= 'PcdTokenNumber: '
638 if Pa
.PcdTokenNumber
:
639 if Pa
.DynamicPcdList
:
640 for Pcd
in Pa
.DynamicPcdList
:
641 PcdTokenNumber
+= os
.linesep
642 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
643 PcdTokenNumber
+= ' : '
644 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
645 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
648 # Get set of workspace metafiles
650 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
653 # Retrieve latest modified time of all metafiles
656 for f
in AllWorkSpaceMetaFiles
:
657 if os
.stat(f
)[8] > SrcTimeStamp
:
658 SrcTimeStamp
= os
.stat(f
)[8]
659 self
._SrcTimeStamp
= SrcTimeStamp
661 if GlobalData
.gUseHashCache
:
663 for files
in AllWorkSpaceMetaFiles
:
664 if files
.endswith('.dec'):
670 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
671 GlobalData
.gPlatformHash
= m
.hexdigest()
674 # Write metafile list to build directory
676 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
677 if os
.path
.exists (AutoGenFilePath
):
678 os
.remove(AutoGenFilePath
)
679 if not os
.path
.exists(self
.BuildDir
):
680 os
.makedirs(self
.BuildDir
)
681 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
682 for f
in AllWorkSpaceMetaFiles
:
686 def _GenPkgLevelHash(self
, Pkg
):
687 if Pkg
.PackageName
in GlobalData
.gPackageHash
[Pkg
.Arch
]:
690 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
691 CreateDirectory(PkgDir
)
692 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
694 # Get .dec file's hash value
695 f
= open(Pkg
.MetaFile
.Path
, 'r')
699 # Get include files hash value
701 for inc
in sorted(Pkg
.Includes
, key
=lambda x
: str(x
)):
702 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
703 for File
in sorted(Files
):
704 File_Path
= os
.path
.join(Root
, File
)
705 f
= open(File_Path
, 'r')
709 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
710 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
712 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
713 AllWorkSpaceMetaFiles
= set()
718 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
719 for f
in GlobalData
.gFdfParser
.GetAllIncludedFile():
720 AllWorkSpaceMetaFiles
.add (f
.FileName
)
724 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
727 # add build_rule.txt & tools_def.txt
729 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
730 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
732 # add BuildOption metafile
734 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
736 # add PcdToken Number file for Dynamic/DynamicEx Pcd
738 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
740 for Arch
in self
.ArchList
:
744 for Package
in PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
).PackageList
:
745 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
750 for filePath
in self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]._RawData
.IncludedFiles
:
751 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
753 return AllWorkSpaceMetaFiles
755 def _CheckPcdDefineAndType(self
):
756 PcdTypeSet
= {TAB_PCDS_FIXED_AT_BUILD
,
757 TAB_PCDS_PATCHABLE_IN_MODULE
,
758 TAB_PCDS_FEATURE_FLAG
,
762 # This dict store PCDs which are not used by any modules with specified arches
763 UnusedPcd
= OrderedDict()
764 for Pa
in self
.AutoGenObjectList
:
765 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
766 for Pcd
in Pa
.Platform
.Pcds
:
767 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
769 # If no PCD type, this PCD comes from FDF
773 # Try to remove Hii and Vpd suffix
774 if PcdType
.startswith(TAB_PCDS_DYNAMIC_EX
):
775 PcdType
= TAB_PCDS_DYNAMIC_EX
776 elif PcdType
.startswith(TAB_PCDS_DYNAMIC
):
777 PcdType
= TAB_PCDS_DYNAMIC
779 for Package
in Pa
.PackageList
:
780 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
781 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
783 for Type
in PcdTypeSet
:
784 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
788 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
789 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
794 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
796 for Pcd
in UnusedPcd
:
799 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
800 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
801 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
806 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
808 ## Return the directory to store FV files
811 return path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
)
813 ## Return the directory to store all intermediate and final files built
816 return self
.AutoGenObjectList
[0].BuildDir
818 ## Return the build output directory platform specifies
821 return self
.Platform
.OutputDirectory
823 ## Return platform name
826 return self
.Platform
.PlatformName
828 ## Return meta-file GUID
831 return self
.Platform
.Guid
833 ## Return platform version
836 return self
.Platform
.Version
838 ## Return paths of tools
840 def ToolDefinition(self
):
841 return self
.AutoGenObjectList
[0].ToolDefinition
843 ## Return directory of platform makefile
845 # @retval string Makefile directory
848 def MakeFileDir(self
):
851 ## Return build command string
853 # @retval string Build command string
856 def BuildCommand(self
):
857 # BuildCommand should be all the same. So just get one from platform AutoGen
858 return self
.AutoGenObjectList
[0].BuildCommand
860 ## Check the PCDs token value conflict in each DEC file.
862 # Will cause build break and raise error message while two PCDs conflict.
866 def _CheckAllPcdsTokenValueConflict(self
):
867 for Pa
in self
.AutoGenObjectList
:
868 for Package
in Pa
.PackageList
:
869 PcdList
= Package
.Pcds
.values()
870 PcdList
.sort(key
=lambda x
: int(x
.TokenValue
, 0))
872 while (Count
< len(PcdList
) - 1) :
873 Item
= PcdList
[Count
]
874 ItemNext
= PcdList
[Count
+ 1]
876 # Make sure in the same token space the TokenValue should be unique
878 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
879 SameTokenValuePcdList
= []
880 SameTokenValuePcdList
.append(Item
)
881 SameTokenValuePcdList
.append(ItemNext
)
882 RemainPcdListLength
= len(PcdList
) - Count
- 2
883 for ValueSameCount
in range(RemainPcdListLength
):
884 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
885 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
889 # Sort same token value PCD list with TokenGuid and TokenCName
891 SameTokenValuePcdList
.sort(key
=lambda x
: "%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
))
892 SameTokenValuePcdListCount
= 0
893 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
895 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
896 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
898 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
899 for PcdItem
in GlobalData
.MixedPcd
:
900 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
901 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
907 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
908 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
911 SameTokenValuePcdListCount
+= 1
912 Count
+= SameTokenValuePcdListCount
915 PcdList
= Package
.Pcds
.values()
916 PcdList
.sort(key
=lambda x
: "%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
))
918 while (Count
< len(PcdList
) - 1) :
919 Item
= PcdList
[Count
]
920 ItemNext
= PcdList
[Count
+ 1]
922 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
924 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
928 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
929 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
933 ## Generate fds command
935 def GenFdsCommand(self
):
936 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
939 def GenFdsCommandDict(self
):
940 return GenMake
.TopLevelMakefile(self
)._TemplateDict
942 ## Create makefile for the platform and modules in it
944 # @param CreateDepsMakeFile Flag indicating if the makefile for
945 # modules will be created as well
947 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
948 if not CreateDepsMakeFile
:
950 for Pa
in self
.AutoGenObjectList
:
951 Pa
.CreateMakeFile(True)
953 ## Create autogen code for platform and modules
955 # Since there's no autogen code for platform, this method will do nothing
956 # if CreateModuleCodeFile is set to False.
958 # @param CreateDepsCodeFile Flag indicating if creating module's
959 # autogen code file or not
961 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
962 if not CreateDepsCodeFile
:
964 for Pa
in self
.AutoGenObjectList
:
965 Pa
.CreateCodeFile(True)
967 ## Create AsBuilt INF file the platform
969 def CreateAsBuiltInf(self
):
973 ## AutoGen class for platform
975 # PlatformAutoGen class will process the original information in platform
976 # file in order to generate makefile for platform.
978 class PlatformAutoGen(AutoGen
):
979 # call super().__init__ then call the worker function with different parameter count
980 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
981 if not hasattr(self
, "_Init"):
982 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
983 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
986 # Used to store all PCDs for both PEI and DXE phase, in order to generate
987 # correct PCD database
990 _NonDynaPcdList_
= []
994 # The priority list while override build option
996 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
997 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
998 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
999 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1000 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1001 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1002 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1003 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1004 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1005 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1006 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1007 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1008 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1009 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1010 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1011 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1013 ## Initialize PlatformAutoGen
1016 # @param Workspace WorkspaceAutoGen object
1017 # @param PlatformFile Platform file (DSC file)
1018 # @param Target Build target (DEBUG, RELEASE)
1019 # @param Toolchain Name of tool chain
1020 # @param Arch arch of the platform supports
1022 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1023 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1024 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1026 self
.MetaFile
= PlatformFile
1027 self
.Workspace
= Workspace
1028 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1029 self
.ToolChain
= Toolchain
1030 self
.BuildTarget
= Target
1032 self
.SourceDir
= PlatformFile
.SubDir
1033 self
.SourceOverrideDir
= None
1034 self
.FdTargetList
= self
.Workspace
.FdTargetList
1035 self
.FvTargetList
= self
.Workspace
.FvTargetList
1036 self
.AllPcdList
= []
1037 # get the original module/package/platform objects
1038 self
.BuildDatabase
= Workspace
.BuildDatabase
1039 self
.DscBuildDataObj
= Workspace
.Platform
1041 # flag indicating if the makefile/C-code file has been created or not
1042 self
.IsMakeFileCreated
= False
1044 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1045 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1047 self
._AsBuildInfList
= []
1048 self
._AsBuildModuleList
= []
1050 self
.VariableInfo
= None
1052 if GlobalData
.gFdfParser
is not None:
1053 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1054 for Inf
in self
._AsBuildInfList
:
1055 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1056 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1057 if not M
.IsBinaryModule
:
1059 self
._AsBuildModuleList
.append(InfClass
)
1060 # get library/modules for build
1061 self
.LibraryBuildDirectoryList
= []
1062 self
.ModuleBuildDirectoryList
= []
1066 @cached_class_function
1068 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1070 ## Create autogen code for platform and modules
1072 # Since there's no autogen code for platform, this method will do nothing
1073 # if CreateModuleCodeFile is set to False.
1075 # @param CreateModuleCodeFile Flag indicating if creating module's
1076 # autogen code file or not
1078 @cached_class_function
1079 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1080 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1081 if not CreateModuleCodeFile
:
1084 for Ma
in self
.ModuleAutoGenList
:
1085 Ma
.CreateCodeFile(True)
1087 ## Generate Fds Command
1089 def GenFdsCommand(self
):
1090 return self
.Workspace
.GenFdsCommand
1092 ## Create makefile for the platform and modules in it
1094 # @param CreateModuleMakeFile Flag indicating if the makefile for
1095 # modules will be created as well
1097 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1098 if CreateModuleMakeFile
:
1099 for Ma
in self
._MaList
:
1100 key
= (Ma
.MetaFile
.File
, self
.Arch
)
1101 if key
in FfsCommand
:
1102 Ma
.CreateMakeFile(True, FfsCommand
[key
])
1104 Ma
.CreateMakeFile(True)
1106 # no need to create makefile for the platform more than once
1107 if self
.IsMakeFileCreated
:
1110 # create library/module build dirs for platform
1111 Makefile
= GenMake
.PlatformMakefile(self
)
1112 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1113 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1115 self
.IsMakeFileCreated
= True
1117 ## Deal with Shared FixedAtBuild Pcds
1119 def CollectFixedAtBuildPcds(self
):
1120 for LibAuto
in self
.LibraryAutoGenList
:
1121 FixedAtBuildPcds
= {}
1122 ShareFixedAtBuildPcdsSameValue
= {}
1123 for Module
in LibAuto
.ReferenceModules
:
1124 for Pcd
in set(Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
):
1125 DefaultValue
= Pcd
.DefaultValue
1126 # Cover the case: DSC component override the Pcd value and the Pcd only used in one Lib
1127 if Pcd
in Module
.LibraryPcdList
:
1128 Index
= Module
.LibraryPcdList
.index(Pcd
)
1129 DefaultValue
= Module
.LibraryPcdList
[Index
].DefaultValue
1130 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1131 if key
not in FixedAtBuildPcds
:
1132 ShareFixedAtBuildPcdsSameValue
[key
] = True
1133 FixedAtBuildPcds
[key
] = DefaultValue
1135 if FixedAtBuildPcds
[key
] != DefaultValue
:
1136 ShareFixedAtBuildPcdsSameValue
[key
] = False
1137 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1138 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1139 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1142 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1143 if DscPcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
1145 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1146 LibAuto
.ConstPcd
[key
] = FixedAtBuildPcds
[key
]
1148 def CollectVariables(self
, DynamicPcdSet
):
1151 if self
.Workspace
.FdfFile
:
1152 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1153 for FdRegion
in FdDict
.RegionList
:
1154 for item
in FdRegion
.RegionDataList
:
1155 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1156 VpdRegionSize
= FdRegion
.Size
1157 VpdRegionBase
= FdRegion
.Offset
1160 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(), self
.DscBuildDataObj
.SkuIds
)
1161 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1162 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1164 for Pcd
in DynamicPcdSet
:
1165 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1166 for SkuName
in Pcd
.SkuInfoList
:
1167 Sku
= Pcd
.SkuInfoList
[SkuName
]
1169 if SkuId
is None or SkuId
== '':
1171 if len(Sku
.VariableName
) > 0:
1172 if Sku
.VariableAttribute
and 'NV' not in Sku
.VariableAttribute
:
1174 VariableGuidStructure
= Sku
.VariableGuidValue
1175 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1176 for StorageName
in Sku
.DefaultStoreDict
:
1177 VariableInfo
.append_variable(var_info(Index
, pcdname
, StorageName
, SkuName
, StringToArray(Sku
.VariableName
), VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
, Sku
.DefaultStoreDict
[StorageName
] if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
else StringToArray(Sku
.DefaultStoreDict
[StorageName
]), Pcd
.DatumType
, Pcd
.CustomAttribute
['DscPosition'], Pcd
.CustomAttribute
.get('IsStru',False)))
1181 def UpdateNVStoreMaxSize(self
, OrgVpdFile
):
1182 if self
.VariableInfo
:
1183 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1184 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1186 if PcdNvStoreDfBuffer
:
1187 if os
.path
.exists(VpdMapFilePath
):
1188 OrgVpdFile
.Read(VpdMapFilePath
)
1189 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1190 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1192 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1194 NvStoreOffset
= int(NvStoreOffset
, 16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1195 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get(TAB_DEFAULT
)
1196 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1197 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1199 if var_data
and default_skuobj
:
1200 default_skuobj
.DefaultValue
= var_data
1201 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1202 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1203 PcdNvStoreDfBuffer
[0].SkuInfoList
[TAB_DEFAULT
] = default_skuobj
1204 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1208 ## Collect dynamic PCDs
1210 # Gather dynamic PCDs list from each module and their settings from platform
1211 # This interface should be invoked explicitly when platform action is created.
1213 def CollectPlatformDynamicPcds(self
):
1214 for key
in self
.Platform
.Pcds
:
1215 for SinglePcd
in GlobalData
.MixedPcd
:
1216 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1217 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1218 Pcd_Type
= item
[0].split('_')[-1]
1219 if (Pcd_Type
== self
.Platform
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and self
.Platform
.Pcds
[key
].Type
in PCD_DYNAMIC_EX_TYPE_SET
) or \
1220 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in PCD_DYNAMIC_TYPE_SET
):
1221 Value
= self
.Platform
.Pcds
[key
]
1222 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1224 newkey
= (Value
.TokenCName
, key
[1])
1226 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1227 del self
.Platform
.Pcds
[key
]
1228 self
.Platform
.Pcds
[newkey
] = Value
1232 # for gathering error information
1233 NoDatumTypePcdList
= set()
1235 for InfName
in self
._AsBuildInfList
:
1236 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1237 FdfModuleList
.append(os
.path
.normpath(InfName
))
1238 for M
in self
._MaList
:
1239 # F is the Module for which M is the module autogen
1240 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1241 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1242 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1243 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, M
.MetaFile
))
1245 # Check the PCD from Binary INF or Source INF
1246 if M
.IsBinaryModule
== True:
1247 PcdFromModule
.IsFromBinaryInf
= True
1249 # Check the PCD from DSC or not
1250 PcdFromModule
.IsFromDsc
= (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
1252 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
or PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1253 if M
.MetaFile
.Path
not in FdfModuleList
:
1254 # If one of the Source built modules listed in the DSC is not listed
1255 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1256 # access method (it is only listed in the DEC file that declares the
1257 # PCD as PcdsDynamic), then build tool will report warning message
1258 # notify the PI that they are attempting to build a module that must
1259 # be included in a flash image in order to be functional. These Dynamic
1260 # PCD will not be added into the Database unless it is used by other
1261 # modules that are included in the FDF file.
1262 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
and \
1263 PcdFromModule
.IsFromBinaryInf
== False:
1264 # Print warning message to let the developer make a determine.
1266 # If one of the Source built modules listed in the DSC is not listed in
1267 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1268 # access method (it is only listed in the DEC file that declares the
1269 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1270 # PCD to the Platform's PCD Database.
1271 if PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1274 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1275 # it should be stored in Pcd PEI database, If a dynamic only
1276 # used by DXE module, it should be stored in DXE PCD database.
1277 # The default Phase is DXE
1279 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1280 PcdFromModule
.Phase
= "PEI"
1281 if PcdFromModule
not in self
._DynaPcdList
_:
1282 self
._DynaPcdList
_.append(PcdFromModule
)
1283 elif PcdFromModule
.Phase
== 'PEI':
1284 # overwrite any the same PCD existing, if Phase is PEI
1285 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1286 self
._DynaPcdList
_[Index
] = PcdFromModule
1287 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1288 self
._NonDynaPcdList
_.append(PcdFromModule
)
1289 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1290 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1291 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1292 #The PCD from Binary INF will override the same one from source INF
1293 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1294 PcdFromModule
.Pending
= False
1295 self
._NonDynaPcdList
_.append (PcdFromModule
)
1296 DscModuleSet
= {os
.path
.normpath(ModuleInf
.Path
) for ModuleInf
in self
.Platform
.Modules
}
1297 # add the PCD from modules that listed in FDF but not in DSC to Database
1298 for InfName
in FdfModuleList
:
1299 if InfName
not in DscModuleSet
:
1300 InfClass
= PathClass(InfName
)
1301 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1302 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1303 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1304 # For binary module, if in current arch, we need to list the PCDs into database.
1305 if not M
.IsBinaryModule
:
1307 # Override the module PCD setting by platform setting
1308 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1309 for PcdFromModule
in ModulePcdList
:
1310 PcdFromModule
.IsFromBinaryInf
= True
1311 PcdFromModule
.IsFromDsc
= False
1312 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1313 if PcdFromModule
.Type
not in PCD_DYNAMIC_EX_TYPE_SET
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1314 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1316 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1317 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1318 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1319 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1320 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1321 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1322 PcdFromModule
.Phase
= "PEI"
1323 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1324 self
._DynaPcdList
_.append(PcdFromModule
)
1325 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1326 self
._NonDynaPcdList
_.append(PcdFromModule
)
1327 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1328 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1329 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1330 # module & DXE module at a same time.
1331 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1332 # INF file as DynamicEx.
1333 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1334 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1335 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1336 for PcdFromModule
in self
._NonDynaPcdList
_:
1337 # If a PCD is not listed in the DSC file, but binary INF files used by
1338 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1339 # section, AND all source INF files used by this platform the build
1340 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1341 # section, then the tools must NOT add the PCD to the Platform's PCD
1342 # Database; the build must assign the access method for this PCD as
1343 # PcdsPatchableInModule.
1344 if PcdFromModule
not in self
._DynaPcdList
_:
1346 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1347 if PcdFromModule
.IsFromDsc
== False and \
1348 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1349 PcdFromModule
.IsFromBinaryInf
== True and \
1350 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1351 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1352 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1354 # print out error information and break the build, if error found
1355 if len(NoDatumTypePcdList
) > 0:
1356 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1357 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1359 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1360 % NoDatumTypePcdListString
)
1361 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1362 self
._DynamicPcdList
= self
._DynaPcdList
_
1364 # Sort dynamic PCD list to:
1365 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1366 # try to be put header of dynamicd List
1367 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1369 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1371 UnicodePcdArray
= set()
1373 OtherPcdArray
= set()
1375 VpdFile
= VpdInfoFile
.VpdInfoFile()
1376 NeedProcessVpdMapFile
= False
1378 for pcd
in self
.Platform
.Pcds
:
1379 if pcd
not in self
._PlatformPcds
:
1380 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1382 for item
in self
._PlatformPcds
:
1383 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1384 self
._PlatformPcds
[item
].DatumType
= TAB_VOID
1386 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1387 for Pcd
in self
._DynamicPcdList
:
1388 # just pick the a value to determine whether is unicode string type
1389 Sku
= Pcd
.SkuInfoList
.values()[0]
1390 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1392 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1393 Pcd
.DatumType
= TAB_VOID
1395 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1396 # if found HII type PCD then insert to right of UnicodeIndex
1397 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1398 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1400 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1401 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer", "gEfiMdeModulePkgTokenSpaceGuid"))
1402 if PcdNvStoreDfBuffer
:
1403 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1404 vardump
= self
.VariableInfo
.dump()
1407 #According to PCD_DATABASE_INIT in edk2\MdeModulePkg\Include\Guid\PcdDataBaseSignatureGuid.h,
1408 #the max size for string PCD should not exceed USHRT_MAX 65535(0xffff).
1409 #typedef UINT16 SIZE_INFO;
1410 #//SIZE_INFO SizeTable[];
1411 if len(vardump
.split(",")) > 0xffff:
1412 EdkLogger
.error("build", RESOURCE_OVERFLOW
, 'The current length of PCD %s value is %d, it exceeds to the max size of String PCD.' %(".".join([PcdNvStoreDfBuffer
.TokenSpaceGuidCName
,PcdNvStoreDfBuffer
.TokenCName
]) ,len(vardump
.split(","))))
1413 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1414 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1415 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1416 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1418 #If the end user define [DefaultStores] and [XXX.Menufacturing] in DSC, but forget to configure PcdNvStoreDefaultValueBuffer to PcdsDynamicVpd
1419 if [Pcd
for Pcd
in self
._DynamicPcdList
if Pcd
.UserDefinedDefaultStoresFlag
]:
1420 EdkLogger
.warn("build", "PcdNvStoreDefaultValueBuffer should be defined as PcdsDynamicExVpd in dsc file since the DefaultStores is enabled for this platform.\n%s" %self
.Platform
.MetaFile
.Path
)
1421 PlatformPcds
= sorted(self
._PlatformPcds
.keys())
1423 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1426 for PcdKey
in PlatformPcds
:
1427 Pcd
= self
._PlatformPcds
[PcdKey
]
1428 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1429 PcdKey
in VpdPcdDict
:
1430 Pcd
= VpdPcdDict
[PcdKey
]
1432 DefaultSku
= Pcd
.SkuInfoList
.get(TAB_DEFAULT
)
1434 PcdValue
= DefaultSku
.DefaultValue
1435 if PcdValue
not in SkuValueMap
:
1436 SkuValueMap
[PcdValue
] = []
1437 VpdFile
.Add(Pcd
, TAB_DEFAULT
, DefaultSku
.VpdOffset
)
1438 SkuValueMap
[PcdValue
].append(DefaultSku
)
1440 for (SkuName
, Sku
) in Pcd
.SkuInfoList
.items():
1441 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1442 PcdValue
= Sku
.DefaultValue
1444 PcdValue
= Pcd
.DefaultValue
1445 if Sku
.VpdOffset
!= TAB_STAR
:
1446 if PcdValue
.startswith("{"):
1448 elif PcdValue
.startswith("L"):
1453 VpdOffset
= int(Sku
.VpdOffset
)
1456 VpdOffset
= int(Sku
.VpdOffset
, 16)
1458 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1459 if VpdOffset
% Alignment
!= 0:
1460 if PcdValue
.startswith("{"):
1461 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1463 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1464 if PcdValue
not in SkuValueMap
:
1465 SkuValueMap
[PcdValue
] = []
1466 VpdFile
.Add(Pcd
, SkuName
, Sku
.VpdOffset
)
1467 SkuValueMap
[PcdValue
].append(Sku
)
1468 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1469 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== TAB_STAR
:
1470 NeedProcessVpdMapFile
= True
1471 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1472 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1473 "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.")
1475 VpdSkuMap
[PcdKey
] = SkuValueMap
1477 # Fix the PCDs define in VPD PCD section that never referenced by module.
1478 # An example is PCD for signature usage.
1480 for DscPcd
in PlatformPcds
:
1481 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1482 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1483 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1485 for VpdPcd
in VpdFile
._VpdArray
:
1486 # This PCD has been referenced by module
1487 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1488 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1491 # Not found, it should be signature
1493 # just pick the a value to determine whether is unicode string type
1495 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1496 DefaultSku
= DscPcdEntry
.SkuInfoList
.get(TAB_DEFAULT
)
1498 defaultindex
= SkuObjList
.index((TAB_DEFAULT
, DefaultSku
))
1499 SkuObjList
[0], SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
], SkuObjList
[0]
1500 for (SkuName
, Sku
) in SkuObjList
:
1501 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1503 # Need to iterate DEC pcd information to get the value & datumtype
1504 for eachDec
in self
.PackageList
:
1505 for DecPcd
in eachDec
.Pcds
:
1506 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1507 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1508 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1509 # Print warning message to let the developer make a determine.
1510 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1511 File
=self
.MetaFile
, \
1512 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1513 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1515 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1516 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1517 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1518 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1519 # Only fix the value while no value provided in DSC file.
1520 if not Sku
.DefaultValue
:
1521 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1523 if DscPcdEntry
not in self
._DynamicPcdList
:
1524 self
._DynamicPcdList
.append(DscPcdEntry
)
1525 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1526 PcdValue
= Sku
.DefaultValue
1528 PcdValue
= DscPcdEntry
.DefaultValue
1529 if Sku
.VpdOffset
!= TAB_STAR
:
1530 if PcdValue
.startswith("{"):
1532 elif PcdValue
.startswith("L"):
1537 VpdOffset
= int(Sku
.VpdOffset
)
1540 VpdOffset
= int(Sku
.VpdOffset
, 16)
1542 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1543 if VpdOffset
% Alignment
!= 0:
1544 if PcdValue
.startswith("{"):
1545 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1547 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1548 if PcdValue
not in SkuValueMap
:
1549 SkuValueMap
[PcdValue
] = []
1550 VpdFile
.Add(DscPcdEntry
, SkuName
, Sku
.VpdOffset
)
1551 SkuValueMap
[PcdValue
].append(Sku
)
1552 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== TAB_STAR
:
1553 NeedProcessVpdMapFile
= True
1554 if DscPcdEntry
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1555 UnicodePcdArray
.add(DscPcdEntry
)
1556 elif len(Sku
.VariableName
) > 0:
1557 HiiPcdArray
.add(DscPcdEntry
)
1559 OtherPcdArray
.add(DscPcdEntry
)
1561 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1562 VpdSkuMap
[DscPcd
] = SkuValueMap
1563 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1564 VpdFile
.GetCount() != 0:
1565 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1566 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1568 if VpdFile
.GetCount() != 0:
1570 self
.FixVpdOffset(VpdFile
)
1572 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1573 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1574 if PcdNvStoreDfBuffer
:
1575 PcdName
,PcdGuid
= PcdNvStoreDfBuffer
[0].TokenCName
, PcdNvStoreDfBuffer
[0].TokenSpaceGuidCName
1576 if (PcdName
,PcdGuid
) in VpdSkuMap
:
1577 DefaultSku
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get(TAB_DEFAULT
)
1578 VpdSkuMap
[(PcdName
,PcdGuid
)] = {DefaultSku
.DefaultValue
:[DefaultSku
]}
1580 # Process VPD map file generated by third party BPDG tool
1581 if NeedProcessVpdMapFile
:
1582 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1583 if os
.path
.exists(VpdMapFilePath
):
1584 VpdFile
.Read(VpdMapFilePath
)
1586 # Fixup TAB_STAR offset
1587 for pcd
in VpdSkuMap
:
1588 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1590 # just pick the a value to determine whether is unicode string type
1592 for pcdvalue
in VpdSkuMap
[pcd
]:
1593 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1594 for item
in vpdinfo
:
1595 if item
[2] == pcdvalue
:
1596 sku
.VpdOffset
= item
[1]
1598 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1600 # Delete the DynamicPcdList At the last time enter into this function
1601 for Pcd
in self
._DynamicPcdList
:
1602 # just pick the a value to determine whether is unicode string type
1603 Sku
= Pcd
.SkuInfoList
.values()[0]
1604 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1606 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1607 Pcd
.DatumType
= TAB_VOID
1609 PcdValue
= Sku
.DefaultValue
1610 if Pcd
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1611 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1612 UnicodePcdArray
.add(Pcd
)
1613 elif len(Sku
.VariableName
) > 0:
1614 # if found HII type PCD then insert to right of UnicodeIndex
1615 HiiPcdArray
.add(Pcd
)
1617 OtherPcdArray
.add(Pcd
)
1618 del self
._DynamicPcdList
[:]
1619 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1620 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1621 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1622 allskuset
= [(SkuName
, Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
, Sku
) in pcd
.SkuInfoList
.items()]
1623 for pcd
in self
._DynamicPcdList
:
1624 if len(pcd
.SkuInfoList
) == 1:
1625 for (SkuName
, SkuId
) in allskuset
:
1626 if type(SkuId
) in (str, unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1628 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
[TAB_DEFAULT
])
1629 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1630 pcd
.SkuInfoList
[SkuName
].SkuIdName
= SkuName
1631 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1633 def FixVpdOffset(self
, VpdFile
):
1634 FvPath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
)
1635 if not os
.path
.exists(FvPath
):
1639 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1641 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1643 if VpdFile
.Write(VpdFilePath
):
1644 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1646 for ToolDef
in self
.ToolDefinition
.values():
1647 if TAB_GUID
in ToolDef
and ToolDef
[TAB_GUID
] == self
.Platform
.VpdToolGuid
:
1648 if "PATH" not in ToolDef
:
1649 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1650 BPDGToolName
= ToolDef
["PATH"]
1652 # Call third party GUID BPDG tool.
1653 if BPDGToolName
is not None:
1654 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1656 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.")
1658 ## Return the platform build data object
1661 return self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1663 ## Return platform name
1666 return self
.Platform
.PlatformName
1668 ## Return the meta file GUID
1671 return self
.Platform
.Guid
1673 ## Return the platform version
1676 return self
.Platform
.Version
1678 ## Return the FDF file name
1681 if self
.Workspace
.FdfFile
:
1682 RetVal
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1687 ## Return the build output directory platform specifies
1689 def OutputDir(self
):
1690 return self
.Platform
.OutputDirectory
1692 ## Return the directory to store all intermediate and final files built
1695 if os
.path
.isabs(self
.OutputDir
):
1696 GlobalData
.gBuildDirectory
= RetVal
= path
.join(
1697 path
.abspath(self
.OutputDir
),
1698 self
.BuildTarget
+ "_" + self
.ToolChain
,
1701 GlobalData
.gBuildDirectory
= RetVal
= path
.join(
1704 self
.BuildTarget
+ "_" + self
.ToolChain
,
1708 ## Return directory of platform makefile
1710 # @retval string Makefile directory
1713 def MakeFileDir(self
):
1714 return path
.join(self
.BuildDir
, self
.Arch
)
1716 ## Return build command string
1718 # @retval string Build command string
1721 def BuildCommand(self
):
1723 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1724 RetVal
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1725 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1726 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1728 RetVal
+= SplitOption(NewOption
)
1729 if "MAKE" in self
.EdkIIBuildOption
:
1730 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1731 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1732 if Flags
.startswith('='):
1733 RetVal
= [RetVal
[0]] + [Flags
[1:]]
1735 RetVal
.append(Flags
)
1738 ## Get tool chain definition
1740 # Get each tool defition for given tool chain from tools_def.txt and platform
1743 def ToolDefinition(self
):
1744 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1745 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1746 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1747 ExtraData
="[%s]" % self
.MetaFile
)
1750 for Def
in ToolDefinition
:
1751 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1752 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1755 Value
= ToolDefinition
[Def
]
1756 # don't record the DLL
1758 DllPathList
.add(Value
)
1761 if Tool
not in RetVal
:
1763 RetVal
[Tool
][Attr
] = Value
1766 if GlobalData
.gOptions
.SilentMode
and "MAKE" in RetVal
:
1767 if "FLAGS" not in RetVal
["MAKE"]:
1768 RetVal
["MAKE"]["FLAGS"] = ""
1769 RetVal
["MAKE"]["FLAGS"] += " -s"
1772 for Attr
in RetVal
[Tool
]:
1773 Value
= RetVal
[Tool
][Attr
]
1774 if Tool
in self
._BuildOptionWithToolDef
(RetVal
) and Attr
in self
._BuildOptionWithToolDef
(RetVal
)[Tool
]:
1775 # check if override is indicated
1776 if self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
].startswith('='):
1777 Value
= self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
][1:]
1780 Value
+= " " + self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
]
1782 Value
= self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
]
1785 # Don't put MAKE definition in the file
1787 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1789 # Don't put MAKE definition in the file
1794 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1797 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1798 for DllPath
in DllPathList
:
1799 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1800 os
.environ
["MAKE_FLAGS"] = MakeFlags
1804 ## Return the paths of tools
1806 def ToolDefinitionFile(self
):
1807 return os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1809 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1811 def ToolChainFamily(self
):
1812 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1813 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1814 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1815 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1816 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1818 RetVal
= TAB_COMPILER_MSFT
1820 RetVal
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1824 def BuildRuleFamily(self
):
1825 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1826 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1827 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1828 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1829 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1831 return TAB_COMPILER_MSFT
1833 return ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1835 ## Return the build options specific for all modules in this platform
1837 def BuildOption(self
):
1838 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1840 def _BuildOptionWithToolDef(self
, ToolDef
):
1841 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, ToolDef
=ToolDef
)
1843 ## Return the build options specific for EDK modules in this platform
1845 def EdkBuildOption(self
):
1846 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1848 ## Return the build options specific for EDKII modules in this platform
1850 def EdkIIBuildOption(self
):
1851 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1853 ## Parse build_rule.txt in Conf Directory.
1855 # @retval BuildRule object
1858 def BuildRule(self
):
1859 BuildRuleFile
= None
1860 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
1861 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
1862 if not BuildRuleFile
:
1863 BuildRuleFile
= gDefaultBuildRuleFile
1864 RetVal
= BuildRule(BuildRuleFile
)
1865 if RetVal
._FileVersion
== "":
1866 RetVal
._FileVersion
= AutoGenReqBuildRuleVerNum
1868 if RetVal
._FileVersion
< AutoGenReqBuildRuleVerNum
:
1869 # If Build Rule's version is less than the version number required by the tools, halting the build.
1870 EdkLogger
.error("build", AUTOGEN_ERROR
,
1871 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])"\
1872 % (RetVal
._FileVersion
, AutoGenReqBuildRuleVerNum
))
1875 ## Summarize the packages used by modules in this platform
1877 def PackageList(self
):
1879 for La
in self
.LibraryAutoGenList
:
1880 RetVal
.update(La
.DependentPackageList
)
1881 for Ma
in self
.ModuleAutoGenList
:
1882 RetVal
.update(Ma
.DependentPackageList
)
1883 #Collect package set information from INF of FDF
1884 for ModuleFile
in self
._AsBuildModuleList
:
1885 if ModuleFile
in self
.Platform
.Modules
:
1887 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1888 RetVal
.update(ModuleData
.Packages
)
1892 def NonDynamicPcdDict(self
):
1893 return {(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):Pcd
for Pcd
in self
.NonDynamicPcdList
}
1895 ## Get list of non-dynamic PCDs
1897 def NonDynamicPcdList(self
):
1898 if not self
._NonDynamicPcdList
:
1899 self
.CollectPlatformDynamicPcds()
1900 return self
._NonDynamicPcdList
1902 ## Get list of dynamic PCDs
1904 def DynamicPcdList(self
):
1905 if not self
._DynamicPcdList
:
1906 self
.CollectPlatformDynamicPcds()
1907 return self
._DynamicPcdList
1909 ## Generate Token Number for all PCD
1911 def PcdTokenNumber(self
):
1912 RetVal
= OrderedDict()
1915 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
1919 # TokenNumber 0 ~ 10
1921 # TokeNumber 11 ~ 20
1923 for Pcd
in self
.DynamicPcdList
:
1924 if Pcd
.Phase
== "PEI" and Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1925 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1926 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1929 for Pcd
in self
.DynamicPcdList
:
1930 if Pcd
.Phase
== "PEI" and Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1931 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1932 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1935 for Pcd
in self
.DynamicPcdList
:
1936 if Pcd
.Phase
== "DXE" and Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1937 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1938 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1941 for Pcd
in self
.DynamicPcdList
:
1942 if Pcd
.Phase
== "DXE" and Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1943 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1944 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1947 for Pcd
in self
.NonDynamicPcdList
:
1948 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1954 for ModuleFile
in self
.Platform
.Modules
:
1963 self
.Platform
.Modules
[ModuleFile
].M
= Ma
1964 return [x
.M
for x
in self
.Platform
.Modules
.values()]
1966 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
1968 def ModuleAutoGenList(self
):
1970 for Ma
in self
._MaList
:
1971 if Ma
not in RetVal
:
1975 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
1977 def LibraryAutoGenList(self
):
1979 for Ma
in self
._MaList
:
1980 for La
in Ma
.LibraryAutoGenList
:
1981 if La
not in RetVal
:
1983 if Ma
not in La
.ReferenceModules
:
1984 La
.ReferenceModules
.append(Ma
)
1987 ## Test if a module is supported by the platform
1989 # An error will be raised directly if the module or its arch is not supported
1990 # by the platform or current configuration
1992 def ValidModule(self
, Module
):
1993 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
1994 or Module
in self
._AsBuildModuleList
1996 ## Resolve the library classes in a module to library instances
1998 # This method will not only resolve library classes but also sort the library
1999 # instances according to the dependency-ship.
2001 # @param Module The module from which the library classes will be resolved
2003 # @retval library_list List of library instances sorted
2005 def ApplyLibraryInstance(self
, Module
):
2006 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2007 if str(Module
) not in self
.Platform
.Modules
:
2010 return GetModuleLibInstances(Module
,
2019 ## Override PCD setting (type, value, ...)
2021 # @param ToPcd The PCD to be overrided
2022 # @param FromPcd The PCD overrideing from
2024 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
="", Msg
="", Library
=""):
2026 # in case there's PCDs coming from FDF file, which have no type given.
2027 # at this point, ToPcd.Type has the type found from dependent
2030 TokenCName
= ToPcd
.TokenCName
2031 for PcdItem
in GlobalData
.MixedPcd
:
2032 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2033 TokenCName
= PcdItem
[0]
2035 if FromPcd
is not None:
2036 if ToPcd
.Pending
and FromPcd
.Type
:
2037 ToPcd
.Type
= FromPcd
.Type
2038 elif ToPcd
.Type
and FromPcd
.Type\
2039 and ToPcd
.Type
!= FromPcd
.Type
and ToPcd
.Type
in FromPcd
.Type
:
2040 if ToPcd
.Type
.strip() == TAB_PCDS_DYNAMIC_EX
:
2041 ToPcd
.Type
= FromPcd
.Type
2042 elif ToPcd
.Type
and FromPcd
.Type \
2043 and ToPcd
.Type
!= FromPcd
.Type
:
2045 Module
= str(Module
) + " 's library file (" + str(Library
) + ")"
2046 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2047 ExtraData
="%s.%s is used as [%s] in module %s, but as [%s] in %s."\
2048 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2049 ToPcd
.Type
, Module
, FromPcd
.Type
, Msg
),
2052 if FromPcd
.MaxDatumSize
:
2053 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2054 ToPcd
.MaxSizeUserSet
= FromPcd
.MaxDatumSize
2055 if FromPcd
.DefaultValue
:
2056 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2057 if FromPcd
.TokenValue
:
2058 ToPcd
.TokenValue
= FromPcd
.TokenValue
2059 if FromPcd
.DatumType
:
2060 ToPcd
.DatumType
= FromPcd
.DatumType
2061 if FromPcd
.SkuInfoList
:
2062 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2063 if FromPcd
.UserDefinedDefaultStoresFlag
:
2064 ToPcd
.UserDefinedDefaultStoresFlag
= FromPcd
.UserDefinedDefaultStoresFlag
2065 # Add Flexible PCD format parse
2066 if ToPcd
.DefaultValue
:
2068 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
.Workspace
._GuidDict
)(True)
2069 except BadExpression
as Value
:
2070 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2073 # check the validation of datum
2074 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2076 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2077 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2078 ToPcd
.validateranges
= FromPcd
.validateranges
2079 ToPcd
.validlists
= FromPcd
.validlists
2080 ToPcd
.expressions
= FromPcd
.expressions
2081 ToPcd
.CustomAttribute
= FromPcd
.CustomAttribute
2083 if FromPcd
is not None and ToPcd
.DatumType
== TAB_VOID
and not ToPcd
.MaxDatumSize
:
2084 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2085 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2086 Value
= ToPcd
.DefaultValue
2088 ToPcd
.MaxDatumSize
= '1'
2089 elif Value
[0] == 'L':
2090 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2091 elif Value
[0] == '{':
2092 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2094 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2096 # apply default SKU for dynamic PCDS if specified one is not available
2097 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_SET
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
) \
2098 and not ToPcd
.SkuInfoList
:
2099 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2100 SkuName
= self
.Platform
.SkuName
2102 SkuName
= TAB_DEFAULT
2103 ToPcd
.SkuInfoList
= {
2104 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2107 ## Apply PCD setting defined platform to a module
2109 # @param Module The module from which the PCD setting will be overrided
2111 # @retval PCD_list The list PCDs with settings from platform
2113 def ApplyPcdSetting(self
, Module
, Pcds
, Library
=""):
2114 # for each PCD in module
2115 for Name
, Guid
in Pcds
:
2116 PcdInModule
= Pcds
[Name
, Guid
]
2117 # find out the PCD setting in platform
2118 if (Name
, Guid
) in self
.Platform
.Pcds
:
2119 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2121 PcdInPlatform
= None
2122 # then override the settings if any
2123 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
, Msg
="DSC PCD sections", Library
=Library
)
2124 # resolve the VariableGuid value
2125 for SkuId
in PcdInModule
.SkuInfoList
:
2126 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2127 if Sku
.VariableGuid
== '': continue
2128 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2129 if Sku
.VariableGuidValue
is None:
2130 PackageList
= "\n\t".join(str(P
) for P
in self
.PackageList
)
2133 RESOURCE_NOT_AVAILABLE
,
2134 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2135 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2136 % (Guid
, Name
, str(Module
)),
2140 # override PCD settings with module specific setting
2141 if Module
in self
.Platform
.Modules
:
2142 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2143 for Key
in PlatformModule
.Pcds
:
2144 if GlobalData
.BuildOptionPcd
:
2145 for pcd
in GlobalData
.BuildOptionPcd
:
2146 (TokenSpaceGuidCName
, TokenCName
, FieldName
, pcdvalue
, _
) = pcd
2147 if (TokenCName
, TokenSpaceGuidCName
) == Key
and FieldName
=="":
2148 PlatformModule
.Pcds
[Key
].DefaultValue
= pcdvalue
2149 PlatformModule
.Pcds
[Key
].PcdValueFromComm
= pcdvalue
2155 elif Key
in GlobalData
.MixedPcd
:
2156 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2158 ToPcd
= Pcds
[PcdItem
]
2162 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
, Msg
="DSC Components Module scoped PCD section", Library
=Library
)
2163 # use PCD value to calculate the MaxDatumSize when it is not specified
2164 for Name
, Guid
in Pcds
:
2165 Pcd
= Pcds
[Name
, Guid
]
2166 if Pcd
.DatumType
== TAB_VOID
and not Pcd
.MaxDatumSize
:
2167 Pcd
.MaxSizeUserSet
= None
2168 Value
= Pcd
.DefaultValue
2170 Pcd
.MaxDatumSize
= '1'
2171 elif Value
[0] == 'L':
2172 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2173 elif Value
[0] == '{':
2174 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2176 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2177 return Pcds
.values()
2179 ## Resolve library names to library modules
2181 # (for Edk.x modules)
2183 # @param Module The module from which the library names will be resolved
2185 # @retval library_list The list of library modules
2187 def ResolveLibraryReference(self
, Module
):
2188 EdkLogger
.verbose("")
2189 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2190 LibraryConsumerList
= [Module
]
2192 # "CompilerStub" is a must for Edk modules
2193 if Module
.Libraries
:
2194 Module
.Libraries
.append("CompilerStub")
2196 while len(LibraryConsumerList
) > 0:
2197 M
= LibraryConsumerList
.pop()
2198 for LibraryName
in M
.Libraries
:
2199 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2201 for Key
in self
.Platform
.LibraryClasses
.data
:
2202 if LibraryName
.upper() == Key
.upper():
2203 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2206 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2207 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2210 if Library
not in LibraryList
:
2211 LibraryList
.append(Library
)
2212 LibraryConsumerList
.append(Library
)
2213 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2216 ## Calculate the priority value of the build option
2218 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2220 # @retval Value Priority value based on the priority list.
2222 def CalculatePriorityValue(self
, Key
):
2223 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2224 PriorityValue
= 0x11111
2225 if Target
== TAB_STAR
:
2226 PriorityValue
&= 0x01111
2227 if ToolChain
== TAB_STAR
:
2228 PriorityValue
&= 0x10111
2229 if Arch
== TAB_STAR
:
2230 PriorityValue
&= 0x11011
2231 if CommandType
== TAB_STAR
:
2232 PriorityValue
&= 0x11101
2233 if Attr
== TAB_STAR
:
2234 PriorityValue
&= 0x11110
2236 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2239 ## Expand * in build option key
2241 # @param Options Options to be expanded
2242 # @param ToolDef Use specified ToolDef instead of full version.
2243 # This is needed during initialization to prevent
2244 # infinite recursion betweeh BuildOptions,
2245 # ToolDefinition, and this function.
2247 # @retval options Options expanded
2249 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None, ToolDef
=None):
2251 ToolDef
= self
.ToolDefinition
2258 # Construct a list contain the build options which need override.
2262 # Key[0] -- tool family
2263 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2265 if (Key
[0] == self
.BuildRuleFamily
and
2266 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2267 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2268 if (Target
== self
.BuildTarget
or Target
== TAB_STAR
) and\
2269 (ToolChain
== self
.ToolChain
or ToolChain
== TAB_STAR
) and\
2270 (Arch
== self
.Arch
or Arch
== TAB_STAR
) and\
2271 Options
[Key
].startswith("="):
2273 if OverrideList
.get(Key
[1]) is not None:
2274 OverrideList
.pop(Key
[1])
2275 OverrideList
[Key
[1]] = Options
[Key
]
2278 # Use the highest priority value.
2280 if (len(OverrideList
) >= 2):
2281 KeyList
= OverrideList
.keys()
2282 for Index
in range(len(KeyList
)):
2283 NowKey
= KeyList
[Index
]
2284 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2285 for Index1
in range(len(KeyList
) - Index
- 1):
2286 NextKey
= KeyList
[Index1
+ Index
+ 1]
2288 # Compare two Key, if one is included by another, choose the higher priority one
2290 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2291 if (Target1
== Target2
or Target1
== TAB_STAR
or Target2
== TAB_STAR
) and\
2292 (ToolChain1
== ToolChain2
or ToolChain1
== TAB_STAR
or ToolChain2
== TAB_STAR
) and\
2293 (Arch1
== Arch2
or Arch1
== TAB_STAR
or Arch2
== TAB_STAR
) and\
2294 (CommandType1
== CommandType2
or CommandType1
== TAB_STAR
or CommandType2
== TAB_STAR
) and\
2295 (Attr1
== Attr2
or Attr1
== TAB_STAR
or Attr2
== TAB_STAR
):
2297 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2298 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2299 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2301 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2302 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2305 if ModuleStyle
is not None and len (Key
) > 2:
2306 # Check Module style is EDK or EDKII.
2307 # Only append build option for the matched style module.
2308 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2310 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2313 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2314 # if tool chain family doesn't match, skip it
2315 if Tool
in ToolDef
and Family
!= "":
2316 FamilyIsNull
= False
2317 if ToolDef
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2318 if Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2320 elif Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2323 # expand any wildcard
2324 if Target
== TAB_STAR
or Target
== self
.BuildTarget
:
2325 if Tag
== TAB_STAR
or Tag
== self
.ToolChain
:
2326 if Arch
== TAB_STAR
or Arch
== self
.Arch
:
2327 if Tool
not in BuildOptions
:
2328 BuildOptions
[Tool
] = {}
2329 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2330 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2332 # append options for the same tool except PATH
2334 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2336 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2337 # Build Option Family has been checked, which need't to be checked again for family.
2338 if FamilyMatch
or FamilyIsNull
:
2342 if ModuleStyle
is not None and len (Key
) > 2:
2343 # Check Module style is EDK or EDKII.
2344 # Only append build option for the matched style module.
2345 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2347 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2350 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2351 # if tool chain family doesn't match, skip it
2352 if Tool
not in ToolDef
or Family
== "":
2354 # option has been added before
2355 if Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2358 # expand any wildcard
2359 if Target
== TAB_STAR
or Target
== self
.BuildTarget
:
2360 if Tag
== TAB_STAR
or Tag
== self
.ToolChain
:
2361 if Arch
== TAB_STAR
or Arch
== self
.Arch
:
2362 if Tool
not in BuildOptions
:
2363 BuildOptions
[Tool
] = {}
2364 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2365 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2367 # append options for the same tool except PATH
2369 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2371 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2374 ## Append build options in platform to a module
2376 # @param Module The module to which the build options will be appened
2378 # @retval options The options appended with build options in platform
2380 def ApplyBuildOption(self
, Module
):
2381 # Get the different options for the different style module
2382 if Module
.AutoGenVersion
< 0x00010005:
2383 PlatformOptions
= self
.EdkBuildOption
2384 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2386 PlatformOptions
= self
.EdkIIBuildOption
2387 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2388 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2389 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2390 if Module
in self
.Platform
.Modules
:
2391 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2392 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2394 PlatformModuleOptions
= {}
2396 BuildRuleOrder
= None
2397 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2398 for Tool
in Options
:
2399 for Attr
in Options
[Tool
]:
2400 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2401 BuildRuleOrder
= Options
[Tool
][Attr
]
2403 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2404 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2405 self
.ToolDefinition
.keys())
2406 BuildOptions
= defaultdict(lambda: defaultdict(str))
2407 for Tool
in AllTools
:
2408 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2409 if Tool
not in Options
:
2411 for Attr
in Options
[Tool
]:
2413 # Do not generate it in Makefile
2415 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2417 Value
= Options
[Tool
][Attr
]
2418 # check if override is indicated
2419 if Value
.startswith('='):
2420 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
[1:])
2423 BuildOptions
[Tool
][Attr
] += " " + mws
.handleWsMacro(Value
)
2425 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
)
2427 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2429 # Override UNI flag only for EDK module.
2431 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2432 return BuildOptions
, BuildRuleOrder
2435 # extend lists contained in a dictionary with lists stored in another dictionary
2436 # if CopyToDict is not derived from DefaultDict(list) then this may raise exception
2438 def ExtendCopyDictionaryLists(CopyToDict
, CopyFromDict
):
2439 for Key
in CopyFromDict
:
2440 CopyToDict
[Key
].extend(CopyFromDict
[Key
])
2442 # Create a directory specified by a set of path elements and return the full path
2443 def _MakeDir(PathList
):
2444 RetVal
= path
.join(*PathList
)
2445 CreateDirectory(RetVal
)
2448 ## ModuleAutoGen class
2450 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2451 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2452 # to the [depex] section in module's inf file.
2454 class ModuleAutoGen(AutoGen
):
2455 # call super().__init__ then call the worker function with different parameter count
2456 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2457 if not hasattr(self
, "_Init"):
2458 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2459 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2462 ## Cache the timestamps of metafiles of every module in a class attribute
2466 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2467 # check if this module is employed by active platform
2468 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2469 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2472 return super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2474 ## Initialize ModuleAutoGen
2476 # @param Workspace EdkIIWorkspaceBuild object
2477 # @param ModuleFile The path of module file
2478 # @param Target Build target (DEBUG, RELEASE)
2479 # @param Toolchain Name of tool chain
2480 # @param Arch The arch the module supports
2481 # @param PlatformFile Platform meta-file
2483 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2484 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2485 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2487 self
.Workspace
= Workspace
2488 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2489 self
.MetaFile
= ModuleFile
2490 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2492 self
.SourceDir
= self
.MetaFile
.SubDir
2493 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2495 self
.SourceOverrideDir
= None
2496 # use overrided path defined in DSC file
2497 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2498 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2500 self
.ToolChain
= Toolchain
2501 self
.BuildTarget
= Target
2503 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2504 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2506 self
.IsCodeFileCreated
= False
2507 self
.IsAsBuiltInfCreated
= False
2508 self
.DepexGenerated
= False
2510 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2511 self
.BuildRuleOrder
= None
2514 self
._PcdComments
= OrderedListDict()
2515 self
._GuidComments
= OrderedListDict()
2516 self
._ProtocolComments
= OrderedListDict()
2517 self
._PpiComments
= OrderedListDict()
2518 self
._BuildTargets
= None
2519 self
._IntroBuildTargetList
= None
2520 self
._FinalBuildTargetList
= None
2521 self
._FileTypes
= None
2523 self
.AutoGenDepSet
= set()
2524 self
.ReferenceModules
= []
2529 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2531 # Get FixedAtBuild Pcds of this Module
2533 def FixedAtBuildPcds(self
):
2535 for Pcd
in self
.ModulePcdList
:
2536 if Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
2538 if Pcd
not in RetVal
:
2543 def FixedVoidTypePcds(self
):
2545 for Pcd
in self
.FixedAtBuildPcds
:
2546 if Pcd
.DatumType
== TAB_VOID
:
2547 if '{}.{}'.format(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) not in RetVal
:
2548 RetVal
['{}.{}'.format(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
)] = Pcd
.DefaultValue
2552 def UniqueBaseName(self
):
2553 BaseName
= self
.Name
2554 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2555 if Module
.MetaFile
== self
.MetaFile
:
2557 if Module
.Name
== self
.Name
:
2558 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2559 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2560 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2561 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2564 # Macros could be used in build_rule.txt (also Makefile)
2567 return OrderedDict((
2568 ("WORKSPACE" ,self
.WorkspaceDir
),
2569 ("MODULE_NAME" ,self
.Name
),
2570 ("MODULE_NAME_GUID" ,self
.UniqueBaseName
),
2571 ("MODULE_GUID" ,self
.Guid
),
2572 ("MODULE_VERSION" ,self
.Version
),
2573 ("MODULE_TYPE" ,self
.ModuleType
),
2574 ("MODULE_FILE" ,str(self
.MetaFile
)),
2575 ("MODULE_FILE_BASE_NAME" ,self
.MetaFile
.BaseName
),
2576 ("MODULE_RELATIVE_DIR" ,self
.SourceDir
),
2577 ("MODULE_DIR" ,self
.SourceDir
),
2578 ("BASE_NAME" ,self
.Name
),
2579 ("ARCH" ,self
.Arch
),
2580 ("TOOLCHAIN" ,self
.ToolChain
),
2581 ("TOOLCHAIN_TAG" ,self
.ToolChain
),
2582 ("TOOL_CHAIN_TAG" ,self
.ToolChain
),
2583 ("TARGET" ,self
.BuildTarget
),
2584 ("BUILD_DIR" ,self
.PlatformInfo
.BuildDir
),
2585 ("BIN_DIR" ,os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)),
2586 ("LIB_DIR" ,os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)),
2587 ("MODULE_BUILD_DIR" ,self
.BuildDir
),
2588 ("OUTPUT_DIR" ,self
.OutputDir
),
2589 ("DEBUG_DIR" ,self
.DebugDir
),
2590 ("DEST_DIR_OUTPUT" ,self
.OutputDir
),
2591 ("DEST_DIR_DEBUG" ,self
.DebugDir
),
2592 ("PLATFORM_NAME" ,self
.PlatformInfo
.Name
),
2593 ("PLATFORM_GUID" ,self
.PlatformInfo
.Guid
),
2594 ("PLATFORM_VERSION" ,self
.PlatformInfo
.Version
),
2595 ("PLATFORM_RELATIVE_DIR" ,self
.PlatformInfo
.SourceDir
),
2596 ("PLATFORM_DIR" ,mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)),
2597 ("PLATFORM_OUTPUT_DIR" ,self
.PlatformInfo
.OutputDir
),
2598 ("FFS_OUTPUT_DIR" ,self
.FfsOutputDir
)
2601 ## Return the module build data object
2604 return self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2606 ## Return the module name
2609 return self
.Module
.BaseName
2611 ## Return the module DxsFile if exist
2614 return self
.Module
.DxsFile
2616 ## Return the module meta-file GUID
2620 # To build same module more than once, the module path with FILE_GUID overridden has
2621 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2622 # in DSC. The overridden GUID can be retrieved from file name
2624 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2626 # Length of GUID is 36
2628 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2629 return self
.Module
.Guid
2631 ## Return the module version
2634 return self
.Module
.Version
2636 ## Return the module type
2638 def ModuleType(self
):
2639 return self
.Module
.ModuleType
2641 ## Return the component type (for Edk.x style of module)
2643 def ComponentType(self
):
2644 return self
.Module
.ComponentType
2646 ## Return the build type
2648 def BuildType(self
):
2649 return self
.Module
.BuildType
2651 ## Return the PCD_IS_DRIVER setting
2653 def PcdIsDriver(self
):
2654 return self
.Module
.PcdIsDriver
2656 ## Return the autogen version, i.e. module meta-file version
2658 def AutoGenVersion(self
):
2659 return self
.Module
.AutoGenVersion
2661 ## Check if the module is library or not
2663 def IsLibrary(self
):
2664 return bool(self
.Module
.LibraryClass
)
2666 ## Check if the module is binary module or not
2668 def IsBinaryModule(self
):
2669 return self
.Module
.IsBinaryModule
2671 ## Return the directory to store intermediate files of the module
2675 self
.PlatformInfo
.BuildDir
,
2678 self
.MetaFile
.BaseName
2681 ## Return the directory to store the intermediate object files of the mdoule
2683 def OutputDir(self
):
2684 return _MakeDir((self
.BuildDir
, "OUTPUT"))
2686 ## Return the directory path to store ffs file
2688 def FfsOutputDir(self
):
2689 if GlobalData
.gFdfParser
:
2690 return path
.join(self
.PlatformInfo
.BuildDir
, TAB_FV_DIRECTORY
, "Ffs", self
.Guid
+ self
.Name
)
2693 ## Return the directory to store auto-gened source files of the mdoule
2696 return _MakeDir((self
.BuildDir
, "DEBUG"))
2698 ## Return the path of custom file
2700 def CustomMakefile(self
):
2702 for Type
in self
.Module
.CustomMakefile
:
2703 MakeType
= gMakeTypeMap
[Type
] if Type
in gMakeTypeMap
else 'nmake'
2704 if self
.SourceOverrideDir
is not None:
2705 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
2706 if not os
.path
.exists(File
):
2707 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
2709 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
2710 RetVal
[MakeType
] = File
2713 ## Return the directory of the makefile
2715 # @retval string The directory string of module's makefile
2718 def MakeFileDir(self
):
2719 return self
.BuildDir
2721 ## Return build command string
2723 # @retval string Build command string
2726 def BuildCommand(self
):
2727 return self
.PlatformInfo
.BuildCommand
2729 ## Get object list of all packages the module and its dependent libraries belong to
2731 # @retval list The list of package object
2734 def DerivedPackageList(self
):
2736 for M
in [self
.Module
] + self
.DependentLibraryList
:
2737 for Package
in M
.Packages
:
2738 if Package
in PackageList
:
2740 PackageList
.append(Package
)
2743 ## Get the depex string
2745 # @return : a string contain all depex expresion.
2746 def _GetDepexExpresionString(self
):
2749 ## DPX_SOURCE IN Define section.
2750 if self
.Module
.DxsFile
:
2752 for M
in [self
.Module
] + self
.DependentLibraryList
:
2753 Filename
= M
.MetaFile
.Path
2754 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
2755 DepexExpresionList
= InfObj
.GetDepexExpresionList()
2756 for DepexExpresion
in DepexExpresionList
:
2757 for key
in DepexExpresion
:
2758 Arch
, ModuleType
= key
2759 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
2760 # the type of build module is USER_DEFINED.
2761 # All different DEPEX section tags would be copied into the As Built INF file
2762 # and there would be separate DEPEX section tags
2763 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
2764 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
2765 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
2767 if Arch
.upper() == TAB_ARCH_COMMON
or \
2768 (Arch
.upper() == self
.Arch
.upper() and \
2769 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
2770 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
2772 #the type of build module is USER_DEFINED.
2773 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
2774 for Depex
in DepexList
:
2776 DepexStr
+= '[Depex.%s.%s]\n' % key
2777 DepexStr
+= '\n'.join('# '+ val
for val
in Depex
[key
])
2780 return '[Depex.%s]\n' % self
.Arch
2783 #the type of build module not is USER_DEFINED.
2785 for Depex
in DepexList
:
2790 for D
in Depex
.values():
2791 DepexStr
+= ' '.join(val
for val
in D
)
2792 Index
= DepexStr
.find('END')
2793 if Index
> -1 and Index
== len(DepexStr
) - 3:
2794 DepexStr
= DepexStr
[:-3]
2795 DepexStr
= DepexStr
.strip()
2798 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
2800 return '[Depex.%s]\n' % self
.Arch
2801 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
2803 ## Merge dependency expression
2805 # @retval list The token list of the dependency expression after parsed
2808 def DepexList(self
):
2809 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
2814 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2816 for M
in [self
.Module
] + self
.DependentLibraryList
:
2818 for D
in M
.Depex
[self
.Arch
, self
.ModuleType
]:
2820 DepexList
.append('AND')
2821 DepexList
.append('(')
2822 #replace D with value if D is FixedAtBuild PCD
2826 NewList
.append(item
)
2828 if item
not in self
._FixedPcdVoidTypeDict
:
2829 EdkLogger
.error("build", FORMAT_INVALID
, "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type in the module.".format(item
))
2831 Value
= self
._FixedPcdVoidTypeDict
[item
]
2832 if len(Value
.split(',')) != 16:
2833 EdkLogger
.error("build", FORMAT_INVALID
,
2834 "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type and 16 bytes in the module.".format(item
))
2835 NewList
.append(Value
)
2836 DepexList
.extend(NewList
)
2837 if DepexList
[-1] == 'END': # no need of a END at this time
2839 DepexList
.append(')')
2842 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
2843 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
2845 if len(DepexList
) > 0:
2846 EdkLogger
.verbose('')
2847 return {self
.ModuleType
:DepexList
}
2849 ## Merge dependency expression
2851 # @retval list The token list of the dependency expression after parsed
2854 def DepexExpressionDict(self
):
2855 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
2858 DepexExpressionString
= ''
2860 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2862 for M
in [self
.Module
] + self
.DependentLibraryList
:
2864 for D
in M
.DepexExpression
[self
.Arch
, self
.ModuleType
]:
2865 if DepexExpressionString
!= '':
2866 DepexExpressionString
+= ' AND '
2867 DepexExpressionString
+= '('
2868 DepexExpressionString
+= D
2869 DepexExpressionString
= DepexExpressionString
.rstrip('END').strip()
2870 DepexExpressionString
+= ')'
2873 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionString
))
2874 if 'BEFORE' in DepexExpressionString
or 'AFTER' in DepexExpressionString
:
2876 if len(DepexExpressionString
) > 0:
2877 EdkLogger
.verbose('')
2879 return {self
.ModuleType
:DepexExpressionString
}
2881 # Get the tiano core user extension, it is contain dependent library.
2882 # @retval: a list contain tiano core userextension.
2884 def _GetTianoCoreUserExtensionList(self
):
2885 TianoCoreUserExtentionList
= []
2886 for M
in [self
.Module
] + self
.DependentLibraryList
:
2887 Filename
= M
.MetaFile
.Path
2888 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
2889 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
2890 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
2891 for Section
in TianoCoreUserExtent
:
2892 ItemList
= Section
.split(TAB_SPLIT
)
2894 if len(ItemList
) == 4:
2896 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
2898 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
2899 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
2900 TianoCoreList
.append('\n')
2901 TianoCoreUserExtentionList
.append(TianoCoreList
)
2903 return TianoCoreUserExtentionList
2905 ## Return the list of specification version required for the module
2907 # @retval list The list of specification defined in module file
2910 def Specification(self
):
2911 return self
.Module
.Specification
2913 ## Tool option for the module build
2915 # @param PlatformInfo The object of PlatformBuildInfo
2916 # @retval dict The dict containing valid options
2919 def BuildOption(self
):
2920 RetVal
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
2921 if self
.BuildRuleOrder
:
2922 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
2925 ## Get include path list from tool option for the module build
2927 # @retval list The include path list
2930 def BuildOptionIncPathList(self
):
2932 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
2933 # is the former use /I , the Latter used -I to specify include directories
2935 if self
.PlatformInfo
.ToolChainFamily
in (TAB_COMPILER_MSFT
):
2936 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
2937 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
2938 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
2941 # New ToolChainFamily, don't known whether there is option to specify include directories
2946 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
2948 FlagOption
= self
.BuildOption
[Tool
]['FLAGS']
2952 if self
.ToolChainFamily
!= 'RVCT':
2953 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
2956 # RVCT may specify a list of directory seperated by commas
2959 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
2960 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
2961 IncPathList
.extend(NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
)
2964 # EDK II modules must not reference header files outside of the packages they depend on or
2965 # within the module's directory tree. Report error if violation.
2967 if self
.AutoGenVersion
>= 0x00010005:
2968 for Path
in IncPathList
:
2969 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
2970 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
2971 EdkLogger
.error("build",
2974 File
=str(self
.MetaFile
))
2975 RetVal
+= IncPathList
2978 ## Return a list of files which can be built from source
2980 # What kind of files can be built is determined by build rules in
2981 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
2984 def SourceFileList(self
):
2986 ToolChainTagSet
= {"", TAB_STAR
, self
.ToolChain
}
2987 ToolChainFamilySet
= {"", TAB_STAR
, self
.ToolChainFamily
, self
.BuildRuleFamily
}
2988 for F
in self
.Module
.Sources
:
2990 if F
.TagName
not in ToolChainTagSet
:
2991 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
2992 "but [%s] is currently used" % (F
.TagName
, str(F
), self
.ToolChain
))
2994 # match tool chain family or build rule family
2995 if F
.ToolChainFamily
not in ToolChainFamilySet
:
2998 "The file [%s] must be built by tools of [%s], " \
2999 "but current toolchain family is [%s], buildrule family is [%s]" \
3000 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3003 # add the file path into search path list for file including
3004 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3005 self
.IncludePathList
.insert(0, F
.Dir
)
3008 self
._MatchBuildRuleOrder
(RetVal
)
3011 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3014 def _MatchBuildRuleOrder(self
, FileList
):
3017 for SingleFile
in FileList
:
3018 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3019 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3020 if key
in Order_Dict
:
3021 Order_Dict
[key
].append(SingleFile
.Ext
)
3023 Order_Dict
[key
] = [SingleFile
.Ext
]
3026 for F
in Order_Dict
:
3027 if len(Order_Dict
[F
]) > 1:
3028 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3029 for Ext
in Order_Dict
[F
][1:]:
3030 RemoveList
.append(F
+ Ext
)
3032 for item
in RemoveList
:
3033 FileList
.remove(item
)
3037 ## Return the list of unicode files
3039 def UnicodeFileList(self
):
3040 return self
.FileTypes
.get(TAB_UNICODE_FILE
,[])
3042 ## Return the list of vfr files
3044 def VfrFileList(self
):
3045 return self
.FileTypes
.get(TAB_VFR_FILE
, [])
3047 ## Return the list of Image Definition files
3049 def IdfFileList(self
):
3050 return self
.FileTypes
.get(TAB_IMAGE_FILE
,[])
3052 ## Return a list of files which can be built from binary
3054 # "Build" binary files are just to copy them to build directory.
3056 # @retval list The list of files which can be built later
3059 def BinaryFileList(self
):
3061 for F
in self
.Module
.Binaries
:
3062 if F
.Target
not in [TAB_ARCH_COMMON
, TAB_STAR
] and F
.Target
!= self
.BuildTarget
:
3065 self
._ApplyBuildRule
(F
, F
.Type
, BinaryFileList
=RetVal
)
3069 def BuildRules(self
):
3071 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3072 for Type
in BuildRuleDatabase
.FileTypeList
:
3073 #first try getting build rule by BuildRuleFamily
3074 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3076 # build type is always module type, but ...
3077 if self
.ModuleType
!= self
.BuildType
:
3078 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3079 #second try getting build rule by ToolChainFamily
3081 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3083 # build type is always module type, but ...
3084 if self
.ModuleType
!= self
.BuildType
:
3085 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3088 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3089 RetVal
[Type
] = RuleObject
3090 for Ext
in RuleObject
.SourceFileExtList
:
3091 RetVal
[Ext
] = RuleObject
3094 def _ApplyBuildRule(self
, File
, FileType
, BinaryFileList
=None):
3095 if self
._BuildTargets
is None:
3096 self
._IntroBuildTargetList
= set()
3097 self
._FinalBuildTargetList
= set()
3098 self
._BuildTargets
= defaultdict(set)
3099 self
._FileTypes
= defaultdict(set)
3101 if not BinaryFileList
:
3102 BinaryFileList
= self
.BinaryFileList
3104 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3105 if not os
.path
.exists(SubDirectory
):
3106 CreateDirectory(SubDirectory
)
3112 # Make sure to get build rule order value
3116 while Index
< len(SourceList
):
3117 Source
= SourceList
[Index
]
3121 CreateDirectory(Source
.Dir
)
3123 if File
.IsBinary
and File
== Source
and File
in BinaryFileList
:
3124 # Skip all files that are not binary libraries
3125 if not self
.IsLibrary
:
3127 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3128 elif FileType
in self
.BuildRules
:
3129 RuleObject
= self
.BuildRules
[FileType
]
3130 elif Source
.Ext
in self
.BuildRules
:
3131 RuleObject
= self
.BuildRules
[Source
.Ext
]
3133 # stop at no more rules
3135 self
._FinalBuildTargetList
.add(LastTarget
)
3138 FileType
= RuleObject
.SourceFileType
3139 self
._FileTypes
[FileType
].add(Source
)
3141 # stop at STATIC_LIBRARY for library
3142 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3144 self
._FinalBuildTargetList
.add(LastTarget
)
3147 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3150 self
._FinalBuildTargetList
.add(LastTarget
)
3152 elif not Target
.Outputs
:
3153 # Only do build for target with outputs
3154 self
._FinalBuildTargetList
.add(Target
)
3156 self
._BuildTargets
[FileType
].add(Target
)
3158 if not Source
.IsBinary
and Source
== File
:
3159 self
._IntroBuildTargetList
.add(Target
)
3161 # to avoid cyclic rule
3162 if FileType
in RuleChain
:
3165 RuleChain
.add(FileType
)
3166 SourceList
.extend(Target
.Outputs
)
3168 FileType
= TAB_UNKNOWN_FILE
3172 if self
._BuildTargets
is None:
3173 self
._IntroBuildTargetList
= set()
3174 self
._FinalBuildTargetList
= set()
3175 self
._BuildTargets
= defaultdict(set)
3176 self
._FileTypes
= defaultdict(set)
3178 #TRICK: call SourceFileList property to apply build rule for source files
3181 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3184 return self
._BuildTargets
3187 def IntroTargetList(self
):
3189 return self
._IntroBuildTargetList
3192 def CodaTargetList(self
):
3194 return self
._FinalBuildTargetList
3197 def FileTypes(self
):
3199 return self
._FileTypes
3201 ## Get the list of package object the module depends on
3203 # @retval list The package object list
3206 def DependentPackageList(self
):
3207 return self
.Module
.Packages
3209 ## Return the list of auto-generated code file
3211 # @retval list The list of auto-generated file
3214 def AutoGenFileList(self
):
3215 AutoGenUniIdf
= self
.BuildType
!= 'UEFI_HII'
3216 UniStringBinBuffer
= BytesIO()
3217 IdfGenBinBuffer
= BytesIO()
3219 AutoGenC
= TemplateString()
3220 AutoGenH
= TemplateString()
3221 StringH
= TemplateString()
3222 StringIdf
= TemplateString()
3223 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, AutoGenUniIdf
, UniStringBinBuffer
, StringIdf
, AutoGenUniIdf
, IdfGenBinBuffer
)
3225 # AutoGen.c is generated if there are library classes in inf, or there are object files
3227 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3228 or TAB_OBJECT_FILE
in self
.FileTypes
):
3229 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3230 RetVal
[AutoFile
] = str(AutoGenC
)
3231 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3232 if str(AutoGenH
) != "":
3233 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3234 RetVal
[AutoFile
] = str(AutoGenH
)
3235 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3236 if str(StringH
) != "":
3237 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3238 RetVal
[AutoFile
] = str(StringH
)
3239 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3240 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3241 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3242 RetVal
[AutoFile
] = UniStringBinBuffer
.getvalue()
3243 AutoFile
.IsBinary
= True
3244 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3245 if UniStringBinBuffer
is not None:
3246 UniStringBinBuffer
.close()
3247 if str(StringIdf
) != "":
3248 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3249 RetVal
[AutoFile
] = str(StringIdf
)
3250 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3251 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3252 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3253 RetVal
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3254 AutoFile
.IsBinary
= True
3255 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3256 if IdfGenBinBuffer
is not None:
3257 IdfGenBinBuffer
.close()
3260 ## Return the list of library modules explicitly or implicityly used by this module
3262 def DependentLibraryList(self
):
3263 # only merge library classes and PCD for non-library module
3266 if self
.AutoGenVersion
< 0x00010005:
3267 return self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3268 return self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3270 ## Get the list of PCDs from current module
3272 # @retval list The list of PCD
3275 def ModulePcdList(self
):
3276 # apply PCD settings from platform
3277 RetVal
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3278 ExtendCopyDictionaryLists(self
._PcdComments
, self
.Module
.PcdComments
)
3281 ## Get the list of PCDs from dependent libraries
3283 # @retval list The list of PCD
3286 def LibraryPcdList(self
):
3291 # get PCDs from dependent libraries
3292 for Library
in self
.DependentLibraryList
:
3293 PcdsInLibrary
= OrderedDict()
3294 ExtendCopyDictionaryLists(self
._PcdComments
, Library
.PcdComments
)
3295 for Key
in Library
.Pcds
:
3296 # skip duplicated PCDs
3297 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3300 PcdsInLibrary
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3301 RetVal
.extend(self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, PcdsInLibrary
, Library
=Library
))
3304 ## Get the GUID value mapping
3306 # @retval dict The mapping between GUID cname and its value
3310 RetVal
= OrderedDict(self
.Module
.Guids
)
3311 for Library
in self
.DependentLibraryList
:
3312 RetVal
.update(Library
.Guids
)
3313 ExtendCopyDictionaryLists(self
._GuidComments
, Library
.GuidComments
)
3314 ExtendCopyDictionaryLists(self
._GuidComments
, self
.Module
.GuidComments
)
3318 def GetGuidsUsedByPcd(self
):
3319 RetVal
= OrderedDict(self
.Module
.GetGuidsUsedByPcd())
3320 for Library
in self
.DependentLibraryList
:
3321 RetVal
.update(Library
.GetGuidsUsedByPcd())
3323 ## Get the protocol value mapping
3325 # @retval dict The mapping between protocol cname and its value
3328 def ProtocolList(self
):
3329 RetVal
= OrderedDict(self
.Module
.Protocols
)
3330 for Library
in self
.DependentLibraryList
:
3331 RetVal
.update(Library
.Protocols
)
3332 ExtendCopyDictionaryLists(self
._ProtocolComments
, Library
.ProtocolComments
)
3333 ExtendCopyDictionaryLists(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3336 ## Get the PPI value mapping
3338 # @retval dict The mapping between PPI cname and its value
3342 RetVal
= OrderedDict(self
.Module
.Ppis
)
3343 for Library
in self
.DependentLibraryList
:
3344 RetVal
.update(Library
.Ppis
)
3345 ExtendCopyDictionaryLists(self
._PpiComments
, Library
.PpiComments
)
3346 ExtendCopyDictionaryLists(self
._PpiComments
, self
.Module
.PpiComments
)
3349 ## Get the list of include search path
3351 # @retval list The list path
3354 def IncludePathList(self
):
3356 if self
.AutoGenVersion
< 0x00010005:
3357 for Inc
in self
.Module
.Includes
:
3358 if Inc
not in RetVal
:
3361 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3362 if os
.path
.exists(Inc
) and Inc
not in RetVal
:
3364 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3365 RetVal
.append(self
.DebugDir
)
3367 RetVal
.append(self
.MetaFile
.Dir
)
3368 RetVal
.append(self
.DebugDir
)
3370 for Package
in self
.Module
.Packages
:
3371 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3372 if PackageDir
not in RetVal
:
3373 RetVal
.append(PackageDir
)
3374 IncludesList
= Package
.Includes
3375 if Package
._PrivateIncludes
:
3376 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3377 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3378 for Inc
in IncludesList
:
3379 if Inc
not in RetVal
:
3380 RetVal
.append(str(Inc
))
3384 def IncludePathLength(self
):
3385 return sum(len(inc
)+1 for inc
in self
.IncludePathList
)
3387 ## Get HII EX PCDs which maybe used by VFR
3389 # efivarstore used by VFR may relate with HII EX PCDs
3390 # Get the variable name and GUID from efivarstore and HII EX PCD
3391 # List the HII EX PCDs in As Built INF if both name and GUID match.
3393 # @retval list HII EX PCDs
3395 def _GetPcdsMaybeUsedByVfr(self
):
3396 if not self
.SourceFileList
:
3400 for SrcFile
in self
.SourceFileList
:
3401 if SrcFile
.Ext
.lower() != '.vfr':
3403 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3404 if not os
.path
.exists(Vfri
):
3406 VfriFile
= open(Vfri
, 'r')
3407 Content
= VfriFile
.read()
3409 Pos
= Content
.find('efivarstore')
3412 # Make sure 'efivarstore' is the start of efivarstore statement
3413 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3416 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3418 if Index
>= 0 and Content
[Index
] != ';':
3419 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3422 # 'efivarstore' must be followed by name and guid
3424 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3427 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3430 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3431 NameGuids
.add((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3432 Pos
= Content
.find('efivarstore', Name
.end())
3436 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3437 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3439 for SkuInfo
in Pcd
.SkuInfoList
.values():
3440 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3443 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3444 Guid
= GuidStructureStringToGuidString(Value
)
3445 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3446 HiiExPcds
.append(Pcd
)
3451 def _GenOffsetBin(self
):
3453 for SourceFile
in self
.Module
.Sources
:
3454 if SourceFile
.Type
.upper() == ".VFR" :
3456 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3458 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3459 elif SourceFile
.Type
.upper() == ".UNI" :
3461 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3463 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3465 if not VfrUniBaseName
:
3467 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3468 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3469 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3470 if not VfrUniOffsetList
:
3473 OutputName
= '%sOffset.bin' % self
.Name
3474 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3477 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3479 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
, None)
3481 # Use a instance of BytesIO to cache data
3482 fStringIO
= BytesIO('')
3484 for Item
in VfrUniOffsetList
:
3485 if (Item
[0].find("Strings") != -1):
3487 # UNI offset in image.
3489 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3491 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3492 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3493 fStringIO
.write(''.join(UniGuid
))
3494 UniValue
= pack ('Q', int (Item
[1], 16))
3495 fStringIO
.write (UniValue
)
3498 # VFR binary offset in image.
3500 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3502 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3503 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3504 fStringIO
.write(''.join(VfrGuid
))
3505 VfrValue
= pack ('Q', int (Item
[1], 16))
3506 fStringIO
.write (VfrValue
)
3508 # write data into file.
3511 fInputfile
.write (fStringIO
.getvalue())
3513 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3514 "file been locked or using by other applications." %UniVfrOffsetFileName
, None)
3520 ## Create AsBuilt INF file the module
3522 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3523 self
.OutputFile
= set()
3524 if IsOnlyCopy
and GlobalData
.gBinCacheDest
:
3525 self
.CopyModuleToCache()
3528 if self
.IsAsBuiltInfCreated
:
3531 # Skip the following code for EDK I inf
3532 if self
.AutoGenVersion
< 0x00010005:
3535 # Skip the following code for libraries
3539 # Skip the following code for modules with no source files
3540 if not self
.SourceFileList
:
3543 # Skip the following code for modules without any binary files
3544 if self
.BinaryFileList
:
3547 ### TODO: How to handles mixed source and binary modules
3549 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3550 # Also find all packages that the DynamicEx PCDs depend on
3555 PcdTokenSpaceList
= []
3556 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3557 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3558 PatchablePcds
.append(Pcd
)
3559 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_PATCHABLE_IN_MODULE
))
3560 elif Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
3563 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
))
3564 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
))
3565 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3566 GuidList
= OrderedDict(self
.GuidList
)
3567 for TokenSpace
in self
.GetGuidsUsedByPcd
:
3568 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3569 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3570 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3571 GuidList
.pop(TokenSpace
)
3572 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3573 for Package
in self
.DerivedPackageList
:
3574 if Package
in Packages
:
3576 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3578 for Index
in range(len(BeChecked
)):
3579 for Item
in CheckList
[Index
]:
3580 if Item
in BeChecked
[Index
]:
3581 Packages
.append(Package
)
3587 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3588 for Pkg
in self
.PlatformInfo
.PackageList
:
3591 for VfrPcd
in VfrPcds
:
3592 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
) in Pkg
.Pcds
or
3593 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
) in Pkg
.Pcds
):
3594 Packages
.append(Pkg
)
3597 ModuleType
= SUP_MODULE_DXE_DRIVER
if self
.ModuleType
== SUP_MODULE_UEFI_DRIVER
and self
.DepexGenerated
else self
.ModuleType
3598 DriverType
= self
.PcdIsDriver
if self
.PcdIsDriver
else ''
3600 MDefs
= self
.Module
.Defines
3603 'module_name' : self
.Name
,
3604 'module_guid' : Guid
,
3605 'module_module_type' : ModuleType
,
3606 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3607 'pcd_is_driver_string' : [],
3608 'module_uefi_specification_version' : [],
3609 'module_pi_specification_version' : [],
3610 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3611 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3612 'module_constructor' : self
.Module
.ConstructorList
,
3613 'module_destructor' : self
.Module
.DestructorList
,
3614 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
3615 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
3616 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
3617 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
3618 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
3619 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
3620 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
3621 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
3622 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
3623 'module_arch' : self
.Arch
,
3624 'package_item' : [Package
.MetaFile
.File
.replace('\\', '/') for Package
in Packages
],
3626 'patchablepcd_item' : [],
3628 'protocol_item' : [],
3632 'libraryclasses_item' : []
3635 if 'MODULE_UNI_FILE' in MDefs
:
3636 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
3637 if os
.path
.isfile(UNIFile
):
3638 shutil
.copy2(UNIFile
, self
.OutputDir
)
3640 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
3641 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
3643 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
3646 AsBuiltInfDict
['pcd_is_driver_string'].append(DriverType
)
3648 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
3649 AsBuiltInfDict
['module_uefi_specification_version'].append(self
.Specification
['UEFI_SPECIFICATION_VERSION'])
3650 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
3651 AsBuiltInfDict
['module_pi_specification_version'].append(self
.Specification
['PI_SPECIFICATION_VERSION'])
3653 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
3654 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
3655 for Item
in self
.CodaTargetList
:
3656 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
3657 self
.OutputFile
.add(File
)
3658 if os
.path
.isabs(File
):
3659 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
3660 if Item
.Target
.Ext
.lower() == '.aml':
3661 AsBuiltInfDict
['binary_item'].append('ASL|' + File
)
3662 elif Item
.Target
.Ext
.lower() == '.acpi':
3663 AsBuiltInfDict
['binary_item'].append('ACPI|' + File
)
3664 elif Item
.Target
.Ext
.lower() == '.efi':
3665 AsBuiltInfDict
['binary_item'].append('PE32|' + self
.Name
+ '.efi')
3667 AsBuiltInfDict
['binary_item'].append('BIN|' + File
)
3668 if not self
.DepexGenerated
:
3669 DepexFile
= os
.path
.join(self
.OutputDir
, self
.Name
+ '.depex')
3670 if os
.path
.exists(DepexFile
):
3671 self
.DepexGenerated
= True
3672 if self
.DepexGenerated
:
3673 self
.OutputFile
.add(self
.Name
+ '.depex')
3674 if self
.ModuleType
in [SUP_MODULE_PEIM
]:
3675 AsBuiltInfDict
['binary_item'].append('PEI_DEPEX|' + self
.Name
+ '.depex')
3676 elif self
.ModuleType
in [SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
3677 AsBuiltInfDict
['binary_item'].append('DXE_DEPEX|' + self
.Name
+ '.depex')
3678 elif self
.ModuleType
in [SUP_MODULE_DXE_SMM_DRIVER
]:
3679 AsBuiltInfDict
['binary_item'].append('SMM_DEPEX|' + self
.Name
+ '.depex')
3681 Bin
= self
._GenOffsetBin
()
3683 AsBuiltInfDict
['binary_item'].append('BIN|%s' % Bin
)
3684 self
.OutputFile
.add(Bin
)
3686 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
3688 if File
.lower().endswith('.pdb'):
3689 AsBuiltInfDict
['binary_item'].append('DISPOSABLE|' + File
)
3690 self
.OutputFile
.add(File
)
3691 HeaderComments
= self
.Module
.HeaderComments
3693 for Index
in range(len(HeaderComments
)):
3694 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
3695 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
3698 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
3699 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
3702 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
3703 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
3704 (GuidList
, self
._GuidComments
, 'guid_item')
3706 for Item
in GenList
:
3707 for CName
in Item
[0]:
3708 Comments
= '\n '.join(Item
[1][CName
]) if CName
in Item
[1] else ''
3709 Entry
= Comments
+ '\n ' + CName
if Comments
else CName
3710 AsBuiltInfDict
[Item
[2]].append(Entry
)
3711 PatchList
= parsePcdInfoFromMapFile(
3712 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
3713 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
3716 for Pcd
in PatchablePcds
:
3717 TokenCName
= Pcd
.TokenCName
3718 for PcdItem
in GlobalData
.MixedPcd
:
3719 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
3720 TokenCName
= PcdItem
[0]
3722 for PatchPcd
in PatchList
:
3723 if TokenCName
== PatchPcd
[0]:
3728 if Pcd
.DatumType
== 'BOOLEAN':
3729 BoolValue
= Pcd
.DefaultValue
.upper()
3730 if BoolValue
== 'TRUE':
3731 Pcd
.DefaultValue
= '1'
3732 elif BoolValue
== 'FALSE':
3733 Pcd
.DefaultValue
= '0'
3735 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
3736 HexFormat
= '0x%02x'
3737 if Pcd
.DatumType
== TAB_UINT16
:
3738 HexFormat
= '0x%04x'
3739 elif Pcd
.DatumType
== TAB_UINT32
:
3740 HexFormat
= '0x%08x'
3741 elif Pcd
.DatumType
== TAB_UINT64
:
3742 HexFormat
= '0x%016x'
3743 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
3745 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
3746 EdkLogger
.error("build", AUTOGEN_ERROR
,
3747 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3749 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
3750 PcdValue
= Pcd
.DefaultValue
3751 if PcdValue
[0] != '{':
3753 if PcdValue
[0] == 'L':
3755 PcdValue
= PcdValue
.lstrip('L')
3756 PcdValue
= eval(PcdValue
)
3758 for Index
in range(0, len(PcdValue
)):
3760 CharVal
= ord(PcdValue
[Index
])
3761 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
3762 + '0x%02x' % (CharVal
>> 8) + ', '
3764 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
3767 Padding
= Padding
* 2
3768 ArraySize
= ArraySize
/ 2
3769 if ArraySize
< (len(PcdValue
) + 1):
3770 if Pcd
.MaxSizeUserSet
:
3771 EdkLogger
.error("build", AUTOGEN_ERROR
,
3772 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3775 ArraySize
= len(PcdValue
) + 1
3776 if ArraySize
> len(PcdValue
) + 1:
3777 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
3778 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
3779 elif len(PcdValue
.split(',')) <= ArraySize
:
3780 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
3783 if Pcd
.MaxSizeUserSet
:
3784 EdkLogger
.error("build", AUTOGEN_ERROR
,
3785 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3788 ArraySize
= len(PcdValue
) + 1
3789 PcdItem
= '%s.%s|%s|0x%X' % \
3790 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
3792 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
3793 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
3795 PcdItem
= PcdComments
+ '\n ' + PcdItem
3796 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
3798 for Pcd
in Pcds
+ VfrPcds
:
3801 TokenCName
= Pcd
.TokenCName
3802 for PcdItem
in GlobalData
.MixedPcd
:
3803 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
3804 TokenCName
= PcdItem
[0]
3806 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
3807 for SkuName
in Pcd
.SkuInfoList
:
3808 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3809 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
3811 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
3812 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
3816 for Index
, Comment
in enumerate(PcdCommentList
):
3817 for Usage
in UsageList
:
3818 if Comment
.find(Usage
) != -1:
3822 if UsageIndex
!= -1:
3823 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
3825 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
3826 PcdComments
= '\n '.join(PcdCommentList
)
3827 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
3829 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
3830 AsBuiltInfDict
['pcd_item'].append(PcdEntry
)
3831 for Item
in self
.BuildOption
:
3832 if 'FLAGS' in self
.BuildOption
[Item
]:
3833 AsBuiltInfDict
['flags_item'].append('%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip()))
3835 # Generated LibraryClasses section in comments.
3836 for Library
in self
.LibraryAutoGenList
:
3837 AsBuiltInfDict
['libraryclasses_item'].append(Library
.MetaFile
.File
.replace('\\', '/'))
3839 # Generated UserExtensions TianoCore section.
3840 # All tianocore user extensions are copied.
3842 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
3843 UserExtStr
+= '\n'.join(TianoCore
)
3844 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
3845 if os
.path
.isfile(ExtensionFile
):
3846 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
3847 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
3849 # Generated depex expression section in comments.
3850 DepexExpresion
= self
._GetDepexExpresionString
()
3851 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
if DepexExpresion
else ''
3853 AsBuiltInf
= TemplateString()
3854 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
3856 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
3858 self
.IsAsBuiltInfCreated
= True
3859 if GlobalData
.gBinCacheDest
:
3860 self
.CopyModuleToCache()
3862 def CopyModuleToCache(self
):
3863 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
3864 CreateDirectory (FileDir
)
3865 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
3866 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
3867 if os
.path
.exists(HashFile
):
3868 shutil
.copy2(HashFile
, FileDir
)
3869 if os
.path
.exists(ModuleFile
):
3870 shutil
.copy2(ModuleFile
, FileDir
)
3871 if not self
.OutputFile
:
3872 Ma
= self
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
3873 self
.OutputFile
= Ma
.Binaries
3875 for File
in self
.OutputFile
:
3877 if not os
.path
.isabs(File
):
3878 File
= os
.path
.join(self
.OutputDir
, File
)
3879 if os
.path
.exists(File
):
3880 shutil
.copy2(File
, FileDir
)
3882 def AttemptModuleCacheCopy(self
):
3883 if self
.IsBinaryModule
:
3885 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
3886 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
3887 if os
.path
.exists(HashFile
):
3888 f
= open(HashFile
, 'r')
3889 CacheHash
= f
.read()
3891 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
3892 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
3893 for root
, dir, files
in os
.walk(FileDir
):
3895 if self
.Name
+ '.hash' in f
:
3896 shutil
.copy2(HashFile
, self
.BuildDir
)
3898 File
= path
.join(root
, f
)
3899 shutil
.copy2(File
, self
.OutputDir
)
3900 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
3901 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
3905 ## Create makefile for the module and its dependent libraries
3907 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
3908 # dependent libraries will be created
3910 @cached_class_function
3911 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
3912 # nest this function inside it's only caller.
3913 def CreateTimeStamp():
3914 FileSet
= {self
.MetaFile
.Path
}
3916 for SourceFile
in self
.Module
.Sources
:
3917 FileSet
.add (SourceFile
.Path
)
3919 for Lib
in self
.DependentLibraryList
:
3920 FileSet
.add (Lib
.MetaFile
.Path
)
3922 for f
in self
.AutoGenDepSet
:
3923 FileSet
.add (f
.Path
)
3925 if os
.path
.exists (self
.TimeStampPath
):
3926 os
.remove (self
.TimeStampPath
)
3927 with
open(self
.TimeStampPath
, 'w+') as file:
3931 # Ignore generating makefile when it is a binary module
3932 if self
.IsBinaryModule
:
3935 self
.GenFfsList
= GenFfsList
3936 if not self
.IsLibrary
and CreateLibraryMakeFile
:
3937 for LibraryAutoGen
in self
.LibraryAutoGenList
:
3938 LibraryAutoGen
.CreateMakeFile()
3943 if len(self
.CustomMakefile
) == 0:
3944 Makefile
= GenMake
.ModuleMakefile(self
)
3946 Makefile
= GenMake
.CustomMakefile(self
)
3947 if Makefile
.Generate():
3948 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
3949 (self
.Name
, self
.Arch
))
3951 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
3952 (self
.Name
, self
.Arch
))
3956 def CopyBinaryFiles(self
):
3957 for File
in self
.Module
.Binaries
:
3959 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
3960 CopyLongFilePath(SrcPath
, DstPath
)
3961 ## Create autogen code for the module and its dependent libraries
3963 # @param CreateLibraryCodeFile Flag indicating if or not the code of
3964 # dependent libraries will be created
3966 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
3967 if self
.IsCodeFileCreated
:
3970 # Need to generate PcdDatabase even PcdDriver is binarymodule
3971 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
3972 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
3974 if self
.IsBinaryModule
:
3976 self
.CopyBinaryFiles()
3979 if not self
.IsLibrary
and CreateLibraryCodeFile
:
3980 for LibraryAutoGen
in self
.LibraryAutoGenList
:
3981 LibraryAutoGen
.CreateCodeFile()
3987 IgoredAutoGenList
= []
3989 for File
in self
.AutoGenFileList
:
3990 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
3991 #Ignore Edk AutoGen.c
3992 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
3995 AutoGenList
.append(str(File
))
3997 IgoredAutoGenList
.append(str(File
))
3999 # Skip the following code for EDK I inf
4000 if self
.AutoGenVersion
< 0x00010005:
4003 for ModuleType
in self
.DepexList
:
4004 # Ignore empty [depex] section or [depex] section for SUP_MODULE_USER_DEFINED module
4005 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== SUP_MODULE_USER_DEFINED
:
4008 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4009 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4011 if len(Dpx
.PostfixNotation
) != 0:
4012 self
.DepexGenerated
= True
4014 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4015 AutoGenList
.append(str(DpxFile
))
4017 IgoredAutoGenList
.append(str(DpxFile
))
4019 if IgoredAutoGenList
== []:
4020 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4021 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4022 elif AutoGenList
== []:
4023 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4024 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4026 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4027 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4029 self
.IsCodeFileCreated
= True
4032 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4034 def LibraryAutoGenList(self
):
4036 for Library
in self
.DependentLibraryList
:
4043 self
.PlatformInfo
.MetaFile
4045 if La
not in RetVal
:
4047 for Lib
in La
.CodaTargetList
:
4048 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4051 def GenModuleHash(self
):
4052 if self
.Arch
not in GlobalData
.gModuleHash
:
4053 GlobalData
.gModuleHash
[self
.Arch
] = {}
4055 # Add Platform level hash
4056 m
.update(GlobalData
.gPlatformHash
)
4057 # Add Package level hash
4058 if self
.DependentPackageList
:
4059 for Pkg
in sorted(self
.DependentPackageList
, key
=lambda x
: x
.PackageName
):
4060 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4061 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4064 if self
.LibraryAutoGenList
:
4065 for Lib
in sorted(self
.LibraryAutoGenList
, key
=lambda x
: x
.Name
):
4066 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4068 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4071 f
= open(str(self
.MetaFile
), 'r')
4075 # Add Module's source files
4076 if self
.SourceFileList
:
4077 for File
in sorted(self
.SourceFileList
, key
=lambda x
: str(x
)):
4078 f
= open(str(File
), 'r')
4083 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4084 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4085 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4086 if GlobalData
.gBinCacheSource
:
4087 if self
.AttemptModuleCacheCopy():
4089 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4091 ## Decide whether we can skip the ModuleAutoGen process
4092 def CanSkipbyHash(self
):
4093 if GlobalData
.gUseHashCache
:
4094 return not self
.GenModuleHash()
4097 ## Decide whether we can skip the ModuleAutoGen process
4098 # If any source file is newer than the module than we cannot skip
4101 if self
.MakeFileDir
in GlobalData
.gSikpAutoGenCache
:
4103 if not os
.path
.exists(self
.TimeStampPath
):
4105 #last creation time of the module
4106 DstTimeStamp
= os
.stat(self
.TimeStampPath
)[8]
4108 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4109 if SrcTimeStamp
> DstTimeStamp
:
4112 with
open(self
.TimeStampPath
,'r') as f
:
4114 source
= source
.rstrip('\n')
4115 if not os
.path
.exists(source
):
4117 if source
not in ModuleAutoGen
.TimeDict
:
4118 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4119 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4121 GlobalData
.gSikpAutoGenCache
.add(self
.MakeFileDir
)
4125 def TimeStampPath(self
):
4126 return os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')