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
][0],
573 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][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
][0],
587 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][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()
938 ## Create makefile for the platform and modules in it
940 # @param CreateDepsMakeFile Flag indicating if the makefile for
941 # modules will be created as well
943 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
944 if not CreateDepsMakeFile
:
946 for Pa
in self
.AutoGenObjectList
:
947 Pa
.CreateMakeFile(True)
949 ## Create autogen code for platform and modules
951 # Since there's no autogen code for platform, this method will do nothing
952 # if CreateModuleCodeFile is set to False.
954 # @param CreateDepsCodeFile Flag indicating if creating module's
955 # autogen code file or not
957 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
958 if not CreateDepsCodeFile
:
960 for Pa
in self
.AutoGenObjectList
:
961 Pa
.CreateCodeFile(True)
963 ## Create AsBuilt INF file the platform
965 def CreateAsBuiltInf(self
):
969 ## AutoGen class for platform
971 # PlatformAutoGen class will process the original information in platform
972 # file in order to generate makefile for platform.
974 class PlatformAutoGen(AutoGen
):
975 # call super().__init__ then call the worker function with different parameter count
976 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
977 if not hasattr(self
, "_Init"):
978 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
979 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
982 # Used to store all PCDs for both PEI and DXE phase, in order to generate
983 # correct PCD database
986 _NonDynaPcdList_
= []
990 # The priority list while override build option
992 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
993 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
994 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
995 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
996 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
997 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
998 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
999 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1000 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1001 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1002 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1003 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1004 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1005 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1006 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1007 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1009 ## Initialize PlatformAutoGen
1012 # @param Workspace WorkspaceAutoGen object
1013 # @param PlatformFile Platform file (DSC file)
1014 # @param Target Build target (DEBUG, RELEASE)
1015 # @param Toolchain Name of tool chain
1016 # @param Arch arch of the platform supports
1018 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1019 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1020 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1022 self
.MetaFile
= PlatformFile
1023 self
.Workspace
= Workspace
1024 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1025 self
.ToolChain
= Toolchain
1026 self
.BuildTarget
= Target
1028 self
.SourceDir
= PlatformFile
.SubDir
1029 self
.SourceOverrideDir
= None
1030 self
.FdTargetList
= self
.Workspace
.FdTargetList
1031 self
.FvTargetList
= self
.Workspace
.FvTargetList
1032 self
.AllPcdList
= []
1033 # get the original module/package/platform objects
1034 self
.BuildDatabase
= Workspace
.BuildDatabase
1035 self
.DscBuildDataObj
= Workspace
.Platform
1037 # flag indicating if the makefile/C-code file has been created or not
1038 self
.IsMakeFileCreated
= False
1040 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1041 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1043 self
._AsBuildInfList
= []
1044 self
._AsBuildModuleList
= []
1046 self
.VariableInfo
= None
1048 if GlobalData
.gFdfParser
is not None:
1049 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1050 for Inf
in self
._AsBuildInfList
:
1051 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1052 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1053 if not M
.IsBinaryModule
:
1055 self
._AsBuildModuleList
.append(InfClass
)
1056 # get library/modules for build
1057 self
.LibraryBuildDirectoryList
= []
1058 self
.ModuleBuildDirectoryList
= []
1062 @cached_class_function
1064 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1066 ## Create autogen code for platform and modules
1068 # Since there's no autogen code for platform, this method will do nothing
1069 # if CreateModuleCodeFile is set to False.
1071 # @param CreateModuleCodeFile Flag indicating if creating module's
1072 # autogen code file or not
1074 @cached_class_function
1075 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1076 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1077 if not CreateModuleCodeFile
:
1080 for Ma
in self
.ModuleAutoGenList
:
1081 Ma
.CreateCodeFile(True)
1083 ## Generate Fds Command
1085 def GenFdsCommand(self
):
1086 return self
.Workspace
.GenFdsCommand
1088 ## Create makefile for the platform and modules in it
1090 # @param CreateModuleMakeFile Flag indicating if the makefile for
1091 # modules will be created as well
1093 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1094 if CreateModuleMakeFile
:
1095 for Ma
in self
._MaList
:
1096 key
= (Ma
.MetaFile
.File
, self
.Arch
)
1097 if key
in FfsCommand
:
1098 Ma
.CreateMakeFile(True, FfsCommand
[key
])
1100 Ma
.CreateMakeFile(True)
1102 # no need to create makefile for the platform more than once
1103 if self
.IsMakeFileCreated
:
1106 # create library/module build dirs for platform
1107 Makefile
= GenMake
.PlatformMakefile(self
)
1108 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1109 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1111 self
.IsMakeFileCreated
= True
1113 ## Deal with Shared FixedAtBuild Pcds
1115 def CollectFixedAtBuildPcds(self
):
1116 for LibAuto
in self
.LibraryAutoGenList
:
1117 FixedAtBuildPcds
= {}
1118 ShareFixedAtBuildPcdsSameValue
= {}
1119 for Module
in LibAuto
.ReferenceModules
:
1120 for Pcd
in set(Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
):
1121 DefaultValue
= Pcd
.DefaultValue
1122 # Cover the case: DSC component override the Pcd value and the Pcd only used in one Lib
1123 if Pcd
in Module
.LibraryPcdList
:
1124 Index
= Module
.LibraryPcdList
.index(Pcd
)
1125 DefaultValue
= Module
.LibraryPcdList
[Index
].DefaultValue
1126 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1127 if key
not in FixedAtBuildPcds
:
1128 ShareFixedAtBuildPcdsSameValue
[key
] = True
1129 FixedAtBuildPcds
[key
] = DefaultValue
1131 if FixedAtBuildPcds
[key
] != DefaultValue
:
1132 ShareFixedAtBuildPcdsSameValue
[key
] = False
1133 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1134 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1135 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1138 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)]
1139 if DscPcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
1141 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1142 LibAuto
.ConstPcd
[key
] = FixedAtBuildPcds
[key
]
1144 def CollectVariables(self
, DynamicPcdSet
):
1147 if self
.Workspace
.FdfFile
:
1148 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1149 for FdRegion
in FdDict
.RegionList
:
1150 for item
in FdRegion
.RegionDataList
:
1151 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1152 VpdRegionSize
= FdRegion
.Size
1153 VpdRegionBase
= FdRegion
.Offset
1156 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(), self
.DscBuildDataObj
._GetSkuIds
())
1157 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1158 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1160 for Pcd
in DynamicPcdSet
:
1161 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1162 for SkuName
in Pcd
.SkuInfoList
:
1163 Sku
= Pcd
.SkuInfoList
[SkuName
]
1165 if SkuId
is None or SkuId
== '':
1167 if len(Sku
.VariableName
) > 0:
1168 VariableGuidStructure
= Sku
.VariableGuidValue
1169 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1170 for StorageName
in Sku
.DefaultStoreDict
:
1171 VariableInfo
.append_variable(var_info(Index
, pcdname
, StorageName
, SkuName
, StringToArray(Sku
.VariableName
), VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
, Sku
.DefaultStoreDict
[StorageName
], Pcd
.DatumType
))
1175 def UpdateNVStoreMaxSize(self
, OrgVpdFile
):
1176 if self
.VariableInfo
:
1177 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1178 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1180 if PcdNvStoreDfBuffer
:
1181 if os
.path
.exists(VpdMapFilePath
):
1182 OrgVpdFile
.Read(VpdMapFilePath
)
1183 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1184 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1186 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1188 NvStoreOffset
= int(NvStoreOffset
, 16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1189 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get(TAB_DEFAULT
)
1190 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1191 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1193 if var_data
and default_skuobj
:
1194 default_skuobj
.DefaultValue
= var_data
1195 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1196 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1197 PcdNvStoreDfBuffer
[0].SkuInfoList
[TAB_DEFAULT
] = default_skuobj
1198 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1202 ## Collect dynamic PCDs
1204 # Gather dynamic PCDs list from each module and their settings from platform
1205 # This interface should be invoked explicitly when platform action is created.
1207 def CollectPlatformDynamicPcds(self
):
1208 for key
in self
.Platform
.Pcds
:
1209 for SinglePcd
in GlobalData
.MixedPcd
:
1210 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1211 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1212 Pcd_Type
= item
[0].split('_')[-1]
1213 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 \
1214 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in PCD_DYNAMIC_TYPE_SET
):
1215 Value
= self
.Platform
.Pcds
[key
]
1216 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1218 newkey
= (Value
.TokenCName
, key
[1])
1220 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1221 del self
.Platform
.Pcds
[key
]
1222 self
.Platform
.Pcds
[newkey
] = Value
1226 # for gathering error information
1227 NoDatumTypePcdList
= set()
1229 for InfName
in self
._AsBuildInfList
:
1230 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1231 FdfModuleList
.append(os
.path
.normpath(InfName
))
1232 for M
in self
._MaList
:
1233 # F is the Module for which M is the module autogen
1234 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1235 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1236 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1237 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, M
.MetaFile
))
1239 # Check the PCD from Binary INF or Source INF
1240 if M
.IsBinaryModule
== True:
1241 PcdFromModule
.IsFromBinaryInf
= True
1243 # Check the PCD from DSC or not
1244 PcdFromModule
.IsFromDsc
= (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
1246 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
or PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1247 if M
.MetaFile
.Path
not in FdfModuleList
:
1248 # If one of the Source built modules listed in the DSC is not listed
1249 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1250 # access method (it is only listed in the DEC file that declares the
1251 # PCD as PcdsDynamic), then build tool will report warning message
1252 # notify the PI that they are attempting to build a module that must
1253 # be included in a flash image in order to be functional. These Dynamic
1254 # PCD will not be added into the Database unless it is used by other
1255 # modules that are included in the FDF file.
1256 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
and \
1257 PcdFromModule
.IsFromBinaryInf
== False:
1258 # Print warning message to let the developer make a determine.
1260 # If one of the Source built modules listed in the DSC is not listed in
1261 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1262 # access method (it is only listed in the DEC file that declares the
1263 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1264 # PCD to the Platform's PCD Database.
1265 if PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1268 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1269 # it should be stored in Pcd PEI database, If a dynamic only
1270 # used by DXE module, it should be stored in DXE PCD database.
1271 # The default Phase is DXE
1273 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1274 PcdFromModule
.Phase
= "PEI"
1275 if PcdFromModule
not in self
._DynaPcdList
_:
1276 self
._DynaPcdList
_.append(PcdFromModule
)
1277 elif PcdFromModule
.Phase
== 'PEI':
1278 # overwrite any the same PCD existing, if Phase is PEI
1279 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1280 self
._DynaPcdList
_[Index
] = PcdFromModule
1281 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1282 self
._NonDynaPcdList
_.append(PcdFromModule
)
1283 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1284 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1285 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1286 #The PCD from Binary INF will override the same one from source INF
1287 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1288 PcdFromModule
.Pending
= False
1289 self
._NonDynaPcdList
_.append (PcdFromModule
)
1290 DscModuleSet
= {os
.path
.normpath(ModuleInf
.Path
) for ModuleInf
in self
.Platform
.Modules
}
1291 # add the PCD from modules that listed in FDF but not in DSC to Database
1292 for InfName
in FdfModuleList
:
1293 if InfName
not in DscModuleSet
:
1294 InfClass
= PathClass(InfName
)
1295 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1296 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1297 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1298 # For binary module, if in current arch, we need to list the PCDs into database.
1299 if not M
.IsBinaryModule
:
1301 # Override the module PCD setting by platform setting
1302 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1303 for PcdFromModule
in ModulePcdList
:
1304 PcdFromModule
.IsFromBinaryInf
= True
1305 PcdFromModule
.IsFromDsc
= False
1306 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1307 if PcdFromModule
.Type
not in PCD_DYNAMIC_EX_TYPE_SET
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1308 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1310 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1311 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1312 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1313 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1314 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1315 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1316 PcdFromModule
.Phase
= "PEI"
1317 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1318 self
._DynaPcdList
_.append(PcdFromModule
)
1319 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1320 self
._NonDynaPcdList
_.append(PcdFromModule
)
1321 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1322 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1323 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1324 # module & DXE module at a same time.
1325 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1326 # INF file as DynamicEx.
1327 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1328 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1329 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1330 for PcdFromModule
in self
._NonDynaPcdList
_:
1331 # If a PCD is not listed in the DSC file, but binary INF files used by
1332 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1333 # section, AND all source INF files used by this platform the build
1334 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1335 # section, then the tools must NOT add the PCD to the Platform's PCD
1336 # Database; the build must assign the access method for this PCD as
1337 # PcdsPatchableInModule.
1338 if PcdFromModule
not in self
._DynaPcdList
_:
1340 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1341 if PcdFromModule
.IsFromDsc
== False and \
1342 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1343 PcdFromModule
.IsFromBinaryInf
== True and \
1344 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1345 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1346 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1348 # print out error information and break the build, if error found
1349 if len(NoDatumTypePcdList
) > 0:
1350 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1351 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1353 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1354 % NoDatumTypePcdListString
)
1355 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1356 self
._DynamicPcdList
= self
._DynaPcdList
_
1358 # Sort dynamic PCD list to:
1359 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1360 # try to be put header of dynamicd List
1361 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1363 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1365 UnicodePcdArray
= set()
1367 OtherPcdArray
= set()
1369 VpdFile
= VpdInfoFile
.VpdInfoFile()
1370 NeedProcessVpdMapFile
= False
1372 for pcd
in self
.Platform
.Pcds
:
1373 if pcd
not in self
._PlatformPcds
:
1374 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1376 for item
in self
._PlatformPcds
:
1377 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1378 self
._PlatformPcds
[item
].DatumType
= TAB_VOID
1380 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1381 for Pcd
in self
._DynamicPcdList
:
1382 # just pick the a value to determine whether is unicode string type
1383 Sku
= Pcd
.SkuInfoList
.values()[0]
1384 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1386 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1387 Pcd
.DatumType
= TAB_VOID
1389 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1390 # if found HII type PCD then insert to right of UnicodeIndex
1391 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1392 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1394 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1395 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer", "gEfiMdeModulePkgTokenSpaceGuid"))
1396 if PcdNvStoreDfBuffer
:
1397 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1398 vardump
= self
.VariableInfo
.dump()
1400 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1401 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1402 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1403 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1405 #If the end user define [DefaultStores] and [XXX.Menufacturing] in DSC, but forget to configure PcdNvStoreDefaultValueBuffer to PcdsDynamicVpd
1406 if [Pcd
for Pcd
in self
._DynamicPcdList
if Pcd
.UserDefinedDefaultStoresFlag
]:
1407 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
)
1408 PlatformPcds
= sorted(self
._PlatformPcds
.keys())
1410 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1413 for PcdKey
in PlatformPcds
:
1414 Pcd
= self
._PlatformPcds
[PcdKey
]
1415 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1416 PcdKey
in VpdPcdDict
:
1417 Pcd
= VpdPcdDict
[PcdKey
]
1419 DefaultSku
= Pcd
.SkuInfoList
.get(TAB_DEFAULT
)
1421 PcdValue
= DefaultSku
.DefaultValue
1422 if PcdValue
not in SkuValueMap
:
1423 SkuValueMap
[PcdValue
] = []
1424 VpdFile
.Add(Pcd
, TAB_DEFAULT
, DefaultSku
.VpdOffset
)
1425 SkuValueMap
[PcdValue
].append(DefaultSku
)
1427 for (SkuName
, Sku
) in Pcd
.SkuInfoList
.items():
1428 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1429 PcdValue
= Sku
.DefaultValue
1431 PcdValue
= Pcd
.DefaultValue
1432 if Sku
.VpdOffset
!= '*':
1433 if PcdValue
.startswith("{"):
1435 elif PcdValue
.startswith("L"):
1440 VpdOffset
= int(Sku
.VpdOffset
)
1443 VpdOffset
= int(Sku
.VpdOffset
, 16)
1445 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1446 if VpdOffset
% Alignment
!= 0:
1447 if PcdValue
.startswith("{"):
1448 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1450 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1451 if PcdValue
not in SkuValueMap
:
1452 SkuValueMap
[PcdValue
] = []
1453 VpdFile
.Add(Pcd
, SkuName
, Sku
.VpdOffset
)
1454 SkuValueMap
[PcdValue
].append(Sku
)
1455 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1456 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1457 NeedProcessVpdMapFile
= True
1458 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1459 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1460 "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.")
1462 VpdSkuMap
[PcdKey
] = SkuValueMap
1464 # Fix the PCDs define in VPD PCD section that never referenced by module.
1465 # An example is PCD for signature usage.
1467 for DscPcd
in PlatformPcds
:
1468 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1469 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1470 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1472 for VpdPcd
in VpdFile
._VpdArray
:
1473 # This PCD has been referenced by module
1474 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1475 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1478 # Not found, it should be signature
1480 # just pick the a value to determine whether is unicode string type
1482 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1483 DefaultSku
= DscPcdEntry
.SkuInfoList
.get(TAB_DEFAULT
)
1485 defaultindex
= SkuObjList
.index((TAB_DEFAULT
, DefaultSku
))
1486 SkuObjList
[0], SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
], SkuObjList
[0]
1487 for (SkuName
, Sku
) in SkuObjList
:
1488 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1490 # Need to iterate DEC pcd information to get the value & datumtype
1491 for eachDec
in self
.PackageList
:
1492 for DecPcd
in eachDec
.Pcds
:
1493 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1494 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1495 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1496 # Print warning message to let the developer make a determine.
1497 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1498 File
=self
.MetaFile
, \
1499 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1500 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1502 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1503 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1504 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1505 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1506 # Only fix the value while no value provided in DSC file.
1507 if not Sku
.DefaultValue
:
1508 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1510 if DscPcdEntry
not in self
._DynamicPcdList
:
1511 self
._DynamicPcdList
.append(DscPcdEntry
)
1512 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1513 PcdValue
= Sku
.DefaultValue
1515 PcdValue
= DscPcdEntry
.DefaultValue
1516 if Sku
.VpdOffset
!= '*':
1517 if PcdValue
.startswith("{"):
1519 elif PcdValue
.startswith("L"):
1524 VpdOffset
= int(Sku
.VpdOffset
)
1527 VpdOffset
= int(Sku
.VpdOffset
, 16)
1529 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1530 if VpdOffset
% Alignment
!= 0:
1531 if PcdValue
.startswith("{"):
1532 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1534 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1535 if PcdValue
not in SkuValueMap
:
1536 SkuValueMap
[PcdValue
] = []
1537 VpdFile
.Add(DscPcdEntry
, SkuName
, Sku
.VpdOffset
)
1538 SkuValueMap
[PcdValue
].append(Sku
)
1539 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1540 NeedProcessVpdMapFile
= True
1541 if DscPcdEntry
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1542 UnicodePcdArray
.add(DscPcdEntry
)
1543 elif len(Sku
.VariableName
) > 0:
1544 HiiPcdArray
.add(DscPcdEntry
)
1546 OtherPcdArray
.add(DscPcdEntry
)
1548 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1549 VpdSkuMap
[DscPcd
] = SkuValueMap
1550 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1551 VpdFile
.GetCount() != 0:
1552 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1553 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1555 if VpdFile
.GetCount() != 0:
1557 self
.FixVpdOffset(VpdFile
)
1559 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1561 # Process VPD map file generated by third party BPDG tool
1562 if NeedProcessVpdMapFile
:
1563 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1564 if os
.path
.exists(VpdMapFilePath
):
1565 VpdFile
.Read(VpdMapFilePath
)
1568 for pcd
in VpdSkuMap
:
1569 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1571 # just pick the a value to determine whether is unicode string type
1573 for pcdvalue
in VpdSkuMap
[pcd
]:
1574 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1575 for item
in vpdinfo
:
1576 if item
[2] == pcdvalue
:
1577 sku
.VpdOffset
= item
[1]
1579 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1581 # Delete the DynamicPcdList At the last time enter into this function
1582 for Pcd
in self
._DynamicPcdList
:
1583 # just pick the a value to determine whether is unicode string type
1584 Sku
= Pcd
.SkuInfoList
.values()[0]
1585 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1587 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1588 Pcd
.DatumType
= TAB_VOID
1590 PcdValue
= Sku
.DefaultValue
1591 if Pcd
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1592 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1593 UnicodePcdArray
.add(Pcd
)
1594 elif len(Sku
.VariableName
) > 0:
1595 # if found HII type PCD then insert to right of UnicodeIndex
1596 HiiPcdArray
.add(Pcd
)
1598 OtherPcdArray
.add(Pcd
)
1599 del self
._DynamicPcdList
[:]
1600 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1601 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1602 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1603 allskuset
= [(SkuName
, Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
, Sku
) in pcd
.SkuInfoList
.items()]
1604 for pcd
in self
._DynamicPcdList
:
1605 if len(pcd
.SkuInfoList
) == 1:
1606 for (SkuName
, SkuId
) in allskuset
:
1607 if type(SkuId
) in (str, unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1609 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
[TAB_DEFAULT
])
1610 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1611 pcd
.SkuInfoList
[SkuName
].SkuIdName
= SkuName
1612 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1614 def FixVpdOffset(self
, VpdFile
):
1615 FvPath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
)
1616 if not os
.path
.exists(FvPath
):
1620 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1622 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1624 if VpdFile
.Write(VpdFilePath
):
1625 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1627 for ToolDef
in self
.ToolDefinition
.values():
1628 if TAB_GUID
in ToolDef
and ToolDef
[TAB_GUID
] == self
.Platform
.VpdToolGuid
:
1629 if "PATH" not in ToolDef
:
1630 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1631 BPDGToolName
= ToolDef
["PATH"]
1633 # Call third party GUID BPDG tool.
1634 if BPDGToolName
is not None:
1635 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1637 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.")
1639 ## Return the platform build data object
1642 return self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1644 ## Return platform name
1647 return self
.Platform
.PlatformName
1649 ## Return the meta file GUID
1652 return self
.Platform
.Guid
1654 ## Return the platform version
1657 return self
.Platform
.Version
1659 ## Return the FDF file name
1662 if self
.Workspace
.FdfFile
:
1663 RetVal
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1668 ## Return the build output directory platform specifies
1670 def OutputDir(self
):
1671 return self
.Platform
.OutputDirectory
1673 ## Return the directory to store all intermediate and final files built
1676 if os
.path
.isabs(self
.OutputDir
):
1677 GlobalData
.gBuildDirectory
= RetVal
= path
.join(
1678 path
.abspath(self
.OutputDir
),
1679 self
.BuildTarget
+ "_" + self
.ToolChain
,
1682 GlobalData
.gBuildDirectory
= RetVal
= path
.join(
1685 self
.BuildTarget
+ "_" + self
.ToolChain
,
1689 ## Return directory of platform makefile
1691 # @retval string Makefile directory
1694 def MakeFileDir(self
):
1695 return path
.join(self
.BuildDir
, self
.Arch
)
1697 ## Return build command string
1699 # @retval string Build command string
1702 def BuildCommand(self
):
1704 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1705 RetVal
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1706 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1707 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1709 RetVal
+= SplitOption(NewOption
)
1710 if "MAKE" in self
.EdkIIBuildOption
:
1711 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1712 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1713 if Flags
.startswith('='):
1714 RetVal
= [RetVal
[0]] + [Flags
[1:]]
1716 RetVal
.append(Flags
)
1719 ## Get tool chain definition
1721 # Get each tool defition for given tool chain from tools_def.txt and platform
1724 def ToolDefinition(self
):
1725 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1726 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1727 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1728 ExtraData
="[%s]" % self
.MetaFile
)
1731 for Def
in ToolDefinition
:
1732 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1733 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1736 Value
= ToolDefinition
[Def
]
1737 # don't record the DLL
1739 DllPathList
.add(Value
)
1742 if Tool
not in RetVal
:
1744 RetVal
[Tool
][Attr
] = Value
1747 if GlobalData
.gOptions
.SilentMode
and "MAKE" in RetVal
:
1748 if "FLAGS" not in RetVal
["MAKE"]:
1749 RetVal
["MAKE"]["FLAGS"] = ""
1750 RetVal
["MAKE"]["FLAGS"] += " -s"
1753 for Attr
in RetVal
[Tool
]:
1754 Value
= RetVal
[Tool
][Attr
]
1755 if Tool
in self
._BuildOptionWithToolDef
(RetVal
) and Attr
in self
._BuildOptionWithToolDef
(RetVal
)[Tool
]:
1756 # check if override is indicated
1757 if self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
].startswith('='):
1758 Value
= self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
][1:]
1761 Value
+= " " + self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
]
1763 Value
= self
._BuildOptionWithToolDef
(RetVal
)[Tool
][Attr
]
1766 # Don't put MAKE definition in the file
1768 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1770 # Don't put MAKE definition in the file
1775 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1778 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1779 for DllPath
in DllPathList
:
1780 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1781 os
.environ
["MAKE_FLAGS"] = MakeFlags
1785 ## Return the paths of tools
1787 def ToolDefinitionFile(self
):
1788 return os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1790 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1792 def ToolChainFamily(self
):
1793 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1794 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1795 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1796 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1797 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1799 RetVal
= TAB_COMPILER_MSFT
1801 RetVal
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1805 def BuildRuleFamily(self
):
1806 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1807 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1808 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1809 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1810 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1812 return TAB_COMPILER_MSFT
1814 return ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1816 ## Return the build options specific for all modules in this platform
1818 def BuildOption(self
):
1819 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1821 def _BuildOptionWithToolDef(self
, ToolDef
):
1822 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, ToolDef
=ToolDef
)
1824 ## Return the build options specific for EDK modules in this platform
1826 def EdkBuildOption(self
):
1827 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1829 ## Return the build options specific for EDKII modules in this platform
1831 def EdkIIBuildOption(self
):
1832 return self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1834 ## Parse build_rule.txt in Conf Directory.
1836 # @retval BuildRule object
1839 def BuildRule(self
):
1840 BuildRuleFile
= None
1841 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
1842 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
1843 if not BuildRuleFile
:
1844 BuildRuleFile
= gDefaultBuildRuleFile
1845 RetVal
= BuildRule(BuildRuleFile
)
1846 if RetVal
._FileVersion
== "":
1847 RetVal
._FileVersion
= AutoGenReqBuildRuleVerNum
1849 if RetVal
._FileVersion
< AutoGenReqBuildRuleVerNum
:
1850 # If Build Rule's version is less than the version number required by the tools, halting the build.
1851 EdkLogger
.error("build", AUTOGEN_ERROR
,
1852 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])"\
1853 % (RetVal
._FileVersion
, AutoGenReqBuildRuleVerNum
))
1856 ## Summarize the packages used by modules in this platform
1858 def PackageList(self
):
1860 for La
in self
.LibraryAutoGenList
:
1861 RetVal
.update(La
.DependentPackageList
)
1862 for Ma
in self
.ModuleAutoGenList
:
1863 RetVal
.update(Ma
.DependentPackageList
)
1864 #Collect package set information from INF of FDF
1865 for ModuleFile
in self
._AsBuildModuleList
:
1866 if ModuleFile
in self
.Platform
.Modules
:
1868 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1869 RetVal
.update(ModuleData
.Packages
)
1873 def NonDynamicPcdDict(self
):
1874 return {(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
):Pcd
for Pcd
in self
.NonDynamicPcdList
}
1876 ## Get list of non-dynamic PCDs
1878 def NonDynamicPcdList(self
):
1879 self
.CollectPlatformDynamicPcds()
1880 return self
._NonDynamicPcdList
1882 ## Get list of dynamic PCDs
1884 def DynamicPcdList(self
):
1885 self
.CollectPlatformDynamicPcds()
1886 return self
._DynamicPcdList
1888 ## Generate Token Number for all PCD
1890 def PcdTokenNumber(self
):
1891 RetVal
= OrderedDict()
1894 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
1898 # TokenNumber 0 ~ 10
1900 # TokeNumber 11 ~ 20
1902 for Pcd
in self
.DynamicPcdList
:
1903 if Pcd
.Phase
== "PEI" and Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1904 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1905 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1908 for Pcd
in self
.DynamicPcdList
:
1909 if Pcd
.Phase
== "PEI" and Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1910 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1911 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1914 for Pcd
in self
.DynamicPcdList
:
1915 if Pcd
.Phase
== "DXE" and Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1916 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1917 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1920 for Pcd
in self
.DynamicPcdList
:
1921 if Pcd
.Phase
== "DXE" and Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1922 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
1923 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1926 for Pcd
in self
.NonDynamicPcdList
:
1927 RetVal
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
1933 for ModuleFile
in self
.Platform
.Modules
:
1942 self
.Platform
.Modules
[ModuleFile
].M
= Ma
1943 return [x
.M
for x
in self
.Platform
.Modules
.values()]
1945 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
1947 def ModuleAutoGenList(self
):
1949 for Ma
in self
._MaList
:
1950 if Ma
not in RetVal
:
1954 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
1956 def LibraryAutoGenList(self
):
1958 for Ma
in self
._MaList
:
1959 for La
in Ma
.LibraryAutoGenList
:
1960 if La
not in RetVal
:
1962 if Ma
not in La
.ReferenceModules
:
1963 La
.ReferenceModules
.append(Ma
)
1966 ## Test if a module is supported by the platform
1968 # An error will be raised directly if the module or its arch is not supported
1969 # by the platform or current configuration
1971 def ValidModule(self
, Module
):
1972 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
1973 or Module
in self
._AsBuildModuleList
1975 ## Resolve the library classes in a module to library instances
1977 # This method will not only resolve library classes but also sort the library
1978 # instances according to the dependency-ship.
1980 # @param Module The module from which the library classes will be resolved
1982 # @retval library_list List of library instances sorted
1984 def ApplyLibraryInstance(self
, Module
):
1985 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
1986 if str(Module
) not in self
.Platform
.Modules
:
1989 return GetModuleLibInstances(Module
,
1998 ## Override PCD setting (type, value, ...)
2000 # @param ToPcd The PCD to be overrided
2001 # @param FromPcd The PCD overrideing from
2003 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
="", Msg
="", Library
=""):
2005 # in case there's PCDs coming from FDF file, which have no type given.
2006 # at this point, ToPcd.Type has the type found from dependent
2009 TokenCName
= ToPcd
.TokenCName
2010 for PcdItem
in GlobalData
.MixedPcd
:
2011 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2012 TokenCName
= PcdItem
[0]
2014 if FromPcd
is not None:
2015 if ToPcd
.Pending
and FromPcd
.Type
:
2016 ToPcd
.Type
= FromPcd
.Type
2017 elif ToPcd
.Type
and FromPcd
.Type\
2018 and ToPcd
.Type
!= FromPcd
.Type
and ToPcd
.Type
in FromPcd
.Type
:
2019 if ToPcd
.Type
.strip() == TAB_PCDS_DYNAMIC_EX
:
2020 ToPcd
.Type
= FromPcd
.Type
2021 elif ToPcd
.Type
and FromPcd
.Type \
2022 and ToPcd
.Type
!= FromPcd
.Type
:
2024 Module
= str(Module
) + " 's library file (" + str(Library
) + ")"
2025 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2026 ExtraData
="%s.%s is used as [%s] in module %s, but as [%s] in %s."\
2027 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2028 ToPcd
.Type
, Module
, FromPcd
.Type
, Msg
),
2031 if FromPcd
.MaxDatumSize
:
2032 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2033 ToPcd
.MaxSizeUserSet
= FromPcd
.MaxDatumSize
2034 if FromPcd
.DefaultValue
:
2035 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2036 if FromPcd
.TokenValue
:
2037 ToPcd
.TokenValue
= FromPcd
.TokenValue
2038 if FromPcd
.DatumType
:
2039 ToPcd
.DatumType
= FromPcd
.DatumType
2040 if FromPcd
.SkuInfoList
:
2041 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2042 if FromPcd
.UserDefinedDefaultStoresFlag
:
2043 ToPcd
.UserDefinedDefaultStoresFlag
= FromPcd
.UserDefinedDefaultStoresFlag
2044 # Add Flexible PCD format parse
2045 if ToPcd
.DefaultValue
:
2047 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
.Workspace
._GuidDict
)(True)
2048 except BadExpression
as Value
:
2049 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2052 # check the validation of datum
2053 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2055 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2056 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2057 ToPcd
.validateranges
= FromPcd
.validateranges
2058 ToPcd
.validlists
= FromPcd
.validlists
2059 ToPcd
.expressions
= FromPcd
.expressions
2061 if FromPcd
is not None and ToPcd
.DatumType
== TAB_VOID
and not ToPcd
.MaxDatumSize
:
2062 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2063 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2064 Value
= ToPcd
.DefaultValue
2066 ToPcd
.MaxDatumSize
= '1'
2067 elif Value
[0] == 'L':
2068 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2069 elif Value
[0] == '{':
2070 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2072 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2074 # apply default SKU for dynamic PCDS if specified one is not available
2075 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_SET
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
) \
2076 and not ToPcd
.SkuInfoList
:
2077 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2078 SkuName
= self
.Platform
.SkuName
2080 SkuName
= TAB_DEFAULT
2081 ToPcd
.SkuInfoList
= {
2082 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2085 ## Apply PCD setting defined platform to a module
2087 # @param Module The module from which the PCD setting will be overrided
2089 # @retval PCD_list The list PCDs with settings from platform
2091 def ApplyPcdSetting(self
, Module
, Pcds
, Library
=""):
2092 # for each PCD in module
2093 for Name
, Guid
in Pcds
:
2094 PcdInModule
= Pcds
[Name
, Guid
]
2095 # find out the PCD setting in platform
2096 if (Name
, Guid
) in self
.Platform
.Pcds
:
2097 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2099 PcdInPlatform
= None
2100 # then override the settings if any
2101 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
, Msg
="DSC PCD sections", Library
=Library
)
2102 # resolve the VariableGuid value
2103 for SkuId
in PcdInModule
.SkuInfoList
:
2104 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2105 if Sku
.VariableGuid
== '': continue
2106 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2107 if Sku
.VariableGuidValue
is None:
2108 PackageList
= "\n\t".join(str(P
) for P
in self
.PackageList
)
2111 RESOURCE_NOT_AVAILABLE
,
2112 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2113 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2114 % (Guid
, Name
, str(Module
)),
2118 # override PCD settings with module specific setting
2119 if Module
in self
.Platform
.Modules
:
2120 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2121 for Key
in PlatformModule
.Pcds
:
2126 elif Key
in GlobalData
.MixedPcd
:
2127 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2129 ToPcd
= Pcds
[PcdItem
]
2133 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
, Msg
="DSC Components Module scoped PCD section", Library
=Library
)
2134 # use PCD value to calculate the MaxDatumSize when it is not specified
2135 for Name
, Guid
in Pcds
:
2136 Pcd
= Pcds
[Name
, Guid
]
2137 if Pcd
.DatumType
== TAB_VOID
and not Pcd
.MaxDatumSize
:
2138 Pcd
.MaxSizeUserSet
= None
2139 Value
= Pcd
.DefaultValue
2141 Pcd
.MaxDatumSize
= '1'
2142 elif Value
[0] == 'L':
2143 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2144 elif Value
[0] == '{':
2145 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2147 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2148 return Pcds
.values()
2150 ## Resolve library names to library modules
2152 # (for Edk.x modules)
2154 # @param Module The module from which the library names will be resolved
2156 # @retval library_list The list of library modules
2158 def ResolveLibraryReference(self
, Module
):
2159 EdkLogger
.verbose("")
2160 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2161 LibraryConsumerList
= [Module
]
2163 # "CompilerStub" is a must for Edk modules
2164 if Module
.Libraries
:
2165 Module
.Libraries
.append("CompilerStub")
2167 while len(LibraryConsumerList
) > 0:
2168 M
= LibraryConsumerList
.pop()
2169 for LibraryName
in M
.Libraries
:
2170 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2172 for Key
in self
.Platform
.LibraryClasses
.data
:
2173 if LibraryName
.upper() == Key
.upper():
2174 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2177 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2178 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2181 if Library
not in LibraryList
:
2182 LibraryList
.append(Library
)
2183 LibraryConsumerList
.append(Library
)
2184 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2187 ## Calculate the priority value of the build option
2189 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2191 # @retval Value Priority value based on the priority list.
2193 def CalculatePriorityValue(self
, Key
):
2194 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2195 PriorityValue
= 0x11111
2197 PriorityValue
&= 0x01111
2198 if ToolChain
== "*":
2199 PriorityValue
&= 0x10111
2201 PriorityValue
&= 0x11011
2202 if CommandType
== "*":
2203 PriorityValue
&= 0x11101
2205 PriorityValue
&= 0x11110
2207 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2210 ## Expand * in build option key
2212 # @param Options Options to be expanded
2213 # @param ToolDef Use specified ToolDef instead of full version.
2214 # This is needed during initialization to prevent
2215 # infinite recursion betweeh BuildOptions,
2216 # ToolDefinition, and this function.
2218 # @retval options Options expanded
2220 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None, ToolDef
=None):
2222 ToolDef
= self
.ToolDefinition
2229 # Construct a list contain the build options which need override.
2233 # Key[0] -- tool family
2234 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2236 if (Key
[0] == self
.BuildRuleFamily
and
2237 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2238 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2239 if (Target
== self
.BuildTarget
or Target
== "*") and\
2240 (ToolChain
== self
.ToolChain
or ToolChain
== "*") and\
2241 (Arch
== self
.Arch
or Arch
== "*") and\
2242 Options
[Key
].startswith("="):
2244 if OverrideList
.get(Key
[1]) is not None:
2245 OverrideList
.pop(Key
[1])
2246 OverrideList
[Key
[1]] = Options
[Key
]
2249 # Use the highest priority value.
2251 if (len(OverrideList
) >= 2):
2252 KeyList
= OverrideList
.keys()
2253 for Index
in range(len(KeyList
)):
2254 NowKey
= KeyList
[Index
]
2255 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2256 for Index1
in range(len(KeyList
) - Index
- 1):
2257 NextKey
= KeyList
[Index1
+ Index
+ 1]
2259 # Compare two Key, if one is included by another, choose the higher priority one
2261 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2262 if (Target1
== Target2
or Target1
== "*" or Target2
== "*") and\
2263 (ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*") and\
2264 (Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*") and\
2265 (CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*") and\
2266 (Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*"):
2268 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2269 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2270 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2272 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2273 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2276 if ModuleStyle
is not None and len (Key
) > 2:
2277 # Check Module style is EDK or EDKII.
2278 # Only append build option for the matched style module.
2279 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2281 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2284 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2285 # if tool chain family doesn't match, skip it
2286 if Tool
in ToolDef
and Family
!= "":
2287 FamilyIsNull
= False
2288 if ToolDef
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2289 if Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2291 elif Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2294 # expand any wildcard
2295 if Target
== "*" or Target
== self
.BuildTarget
:
2296 if Tag
== "*" or Tag
== self
.ToolChain
:
2297 if Arch
== "*" or Arch
== self
.Arch
:
2298 if Tool
not in BuildOptions
:
2299 BuildOptions
[Tool
] = {}
2300 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2301 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2303 # append options for the same tool except PATH
2305 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2307 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2308 # Build Option Family has been checked, which need't to be checked again for family.
2309 if FamilyMatch
or FamilyIsNull
:
2313 if ModuleStyle
is not None and len (Key
) > 2:
2314 # Check Module style is EDK or EDKII.
2315 # Only append build option for the matched style module.
2316 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2318 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2321 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2322 # if tool chain family doesn't match, skip it
2323 if Tool
not in ToolDef
or Family
== "":
2325 # option has been added before
2326 if Family
!= ToolDef
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2329 # expand any wildcard
2330 if Target
== "*" or Target
== self
.BuildTarget
:
2331 if Tag
== "*" or Tag
== self
.ToolChain
:
2332 if Arch
== "*" or Arch
== self
.Arch
:
2333 if Tool
not in BuildOptions
:
2334 BuildOptions
[Tool
] = {}
2335 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2336 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2338 # append options for the same tool except PATH
2340 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2342 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2345 ## Append build options in platform to a module
2347 # @param Module The module to which the build options will be appened
2349 # @retval options The options appended with build options in platform
2351 def ApplyBuildOption(self
, Module
):
2352 # Get the different options for the different style module
2353 if Module
.AutoGenVersion
< 0x00010005:
2354 PlatformOptions
= self
.EdkBuildOption
2355 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2357 PlatformOptions
= self
.EdkIIBuildOption
2358 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2359 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2360 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2361 if Module
in self
.Platform
.Modules
:
2362 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2363 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2365 PlatformModuleOptions
= {}
2367 BuildRuleOrder
= None
2368 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2369 for Tool
in Options
:
2370 for Attr
in Options
[Tool
]:
2371 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2372 BuildRuleOrder
= Options
[Tool
][Attr
]
2374 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2375 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2376 self
.ToolDefinition
.keys())
2377 BuildOptions
= defaultdict(lambda: defaultdict(str))
2378 for Tool
in AllTools
:
2379 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2380 if Tool
not in Options
:
2382 for Attr
in Options
[Tool
]:
2384 # Do not generate it in Makefile
2386 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2388 Value
= Options
[Tool
][Attr
]
2389 # check if override is indicated
2390 if Value
.startswith('='):
2391 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
[1:])
2394 BuildOptions
[Tool
][Attr
] += " " + mws
.handleWsMacro(Value
)
2396 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
)
2398 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2400 # Override UNI flag only for EDK module.
2402 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2403 return BuildOptions
, BuildRuleOrder
2406 # extend lists contained in a dictionary with lists stored in another dictionary
2407 # if CopyToDict is not derived from DefaultDict(list) then this may raise exception
2409 def ExtendCopyDictionaryLists(CopyToDict
, CopyFromDict
):
2410 for Key
in CopyFromDict
:
2411 CopyToDict
[Key
].extend(CopyFromDict
[Key
])
2413 # Create a directory specified by a set of path elements and return the full path
2414 def _MakeDir(PathList
):
2415 RetVal
= path
.join(*PathList
)
2416 CreateDirectory(RetVal
)
2419 ## ModuleAutoGen class
2421 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2422 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2423 # to the [depex] section in module's inf file.
2425 class ModuleAutoGen(AutoGen
):
2426 # call super().__init__ then call the worker function with different parameter count
2427 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2428 if not hasattr(self
, "_Init"):
2429 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2430 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2433 ## Cache the timestamps of metafiles of every module in a class attribute
2437 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2438 # check if this module is employed by active platform
2439 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2440 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2443 return super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2445 ## Initialize ModuleAutoGen
2447 # @param Workspace EdkIIWorkspaceBuild object
2448 # @param ModuleFile The path of module file
2449 # @param Target Build target (DEBUG, RELEASE)
2450 # @param Toolchain Name of tool chain
2451 # @param Arch The arch the module supports
2452 # @param PlatformFile Platform meta-file
2454 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2455 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2456 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2458 self
.Workspace
= Workspace
2459 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2460 self
.MetaFile
= ModuleFile
2461 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2463 self
.SourceDir
= self
.MetaFile
.SubDir
2464 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2466 self
.SourceOverrideDir
= None
2467 # use overrided path defined in DSC file
2468 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2469 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2471 self
.ToolChain
= Toolchain
2472 self
.BuildTarget
= Target
2474 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2475 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2477 self
.IsCodeFileCreated
= False
2478 self
.IsAsBuiltInfCreated
= False
2479 self
.DepexGenerated
= False
2481 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2482 self
.BuildRuleOrder
= None
2485 self
._PcdComments
= OrderedListDict()
2486 self
._GuidComments
= OrderedListDict()
2487 self
._ProtocolComments
= OrderedListDict()
2488 self
._PpiComments
= OrderedListDict()
2489 self
._BuildTargets
= None
2490 self
._IntroBuildTargetList
= None
2491 self
._FinalBuildTargetList
= None
2492 self
._FileTypes
= None
2494 self
.AutoGenDepSet
= set()
2495 self
.ReferenceModules
= []
2500 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2502 # Get FixedAtBuild Pcds of this Module
2504 def FixedAtBuildPcds(self
):
2506 for Pcd
in self
.ModulePcdList
:
2507 if Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
2509 if Pcd
not in RetVal
:
2514 def FixedVoidTypePcds(self
):
2516 for Pcd
in self
.FixedAtBuildPcds
:
2517 if Pcd
.DatumType
== TAB_VOID
:
2518 if '{}.{}'.format(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) not in RetVal
:
2519 RetVal
['{}.{}'.format(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
)] = Pcd
.DefaultValue
2523 def UniqueBaseName(self
):
2524 BaseName
= self
.Name
2525 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2526 if Module
.MetaFile
== self
.MetaFile
:
2528 if Module
.Name
== self
.Name
:
2529 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2530 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2531 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2532 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2535 # Macros could be used in build_rule.txt (also Makefile)
2538 return OrderedDict((
2539 ("WORKSPACE" ,self
.WorkspaceDir
),
2540 ("MODULE_NAME" ,self
.Name
),
2541 ("MODULE_NAME_GUID" ,self
.UniqueBaseName
),
2542 ("MODULE_GUID" ,self
.Guid
),
2543 ("MODULE_VERSION" ,self
.Version
),
2544 ("MODULE_TYPE" ,self
.ModuleType
),
2545 ("MODULE_FILE" ,str(self
.MetaFile
)),
2546 ("MODULE_FILE_BASE_NAME" ,self
.MetaFile
.BaseName
),
2547 ("MODULE_RELATIVE_DIR" ,self
.SourceDir
),
2548 ("MODULE_DIR" ,self
.SourceDir
),
2549 ("BASE_NAME" ,self
.Name
),
2550 ("ARCH" ,self
.Arch
),
2551 ("TOOLCHAIN" ,self
.ToolChain
),
2552 ("TOOLCHAIN_TAG" ,self
.ToolChain
),
2553 ("TOOL_CHAIN_TAG" ,self
.ToolChain
),
2554 ("TARGET" ,self
.BuildTarget
),
2555 ("BUILD_DIR" ,self
.PlatformInfo
.BuildDir
),
2556 ("BIN_DIR" ,os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)),
2557 ("LIB_DIR" ,os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)),
2558 ("MODULE_BUILD_DIR" ,self
.BuildDir
),
2559 ("OUTPUT_DIR" ,self
.OutputDir
),
2560 ("DEBUG_DIR" ,self
.DebugDir
),
2561 ("DEST_DIR_OUTPUT" ,self
.OutputDir
),
2562 ("DEST_DIR_DEBUG" ,self
.DebugDir
),
2563 ("PLATFORM_NAME" ,self
.PlatformInfo
.Name
),
2564 ("PLATFORM_GUID" ,self
.PlatformInfo
.Guid
),
2565 ("PLATFORM_VERSION" ,self
.PlatformInfo
.Version
),
2566 ("PLATFORM_RELATIVE_DIR" ,self
.PlatformInfo
.SourceDir
),
2567 ("PLATFORM_DIR" ,mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)),
2568 ("PLATFORM_OUTPUT_DIR" ,self
.PlatformInfo
.OutputDir
),
2569 ("FFS_OUTPUT_DIR" ,self
.FfsOutputDir
)
2572 ## Return the module build data object
2575 return self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2577 ## Return the module name
2580 return self
.Module
.BaseName
2582 ## Return the module DxsFile if exist
2585 return self
.Module
.DxsFile
2587 ## Return the module meta-file GUID
2591 # To build same module more than once, the module path with FILE_GUID overridden has
2592 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2593 # in DSC. The overridden GUID can be retrieved from file name
2595 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2597 # Length of GUID is 36
2599 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2600 return self
.Module
.Guid
2602 ## Return the module version
2605 return self
.Module
.Version
2607 ## Return the module type
2609 def ModuleType(self
):
2610 return self
.Module
.ModuleType
2612 ## Return the component type (for Edk.x style of module)
2614 def ComponentType(self
):
2615 return self
.Module
.ComponentType
2617 ## Return the build type
2619 def BuildType(self
):
2620 return self
.Module
.BuildType
2622 ## Return the PCD_IS_DRIVER setting
2624 def PcdIsDriver(self
):
2625 return self
.Module
.PcdIsDriver
2627 ## Return the autogen version, i.e. module meta-file version
2629 def AutoGenVersion(self
):
2630 return self
.Module
.AutoGenVersion
2632 ## Check if the module is library or not
2634 def IsLibrary(self
):
2635 return bool(self
.Module
.LibraryClass
)
2637 ## Check if the module is binary module or not
2639 def IsBinaryModule(self
):
2640 return self
.Module
.IsBinaryModule
2642 ## Return the directory to store intermediate files of the module
2646 self
.PlatformInfo
.BuildDir
,
2649 self
.MetaFile
.BaseName
2652 ## Return the directory to store the intermediate object files of the mdoule
2654 def OutputDir(self
):
2655 return _MakeDir((self
.BuildDir
, "OUTPUT"))
2657 ## Return the directory path to store ffs file
2659 def FfsOutputDir(self
):
2660 if GlobalData
.gFdfParser
:
2661 return path
.join(self
.PlatformInfo
.BuildDir
, TAB_FV_DIRECTORY
, "Ffs", self
.Guid
+ self
.Name
)
2664 ## Return the directory to store auto-gened source files of the mdoule
2667 return _MakeDir((self
.BuildDir
, "DEBUG"))
2669 ## Return the path of custom file
2671 def CustomMakefile(self
):
2673 for Type
in self
.Module
.CustomMakefile
:
2674 MakeType
= gMakeTypeMap
[Type
] if Type
in gMakeTypeMap
else 'nmake'
2675 if self
.SourceOverrideDir
is not None:
2676 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
2677 if not os
.path
.exists(File
):
2678 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
2680 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
2681 RetVal
[MakeType
] = File
2684 ## Return the directory of the makefile
2686 # @retval string The directory string of module's makefile
2689 def MakeFileDir(self
):
2690 return self
.BuildDir
2692 ## Return build command string
2694 # @retval string Build command string
2697 def BuildCommand(self
):
2698 return self
.PlatformInfo
.BuildCommand
2700 ## Get object list of all packages the module and its dependent libraries belong to
2702 # @retval list The list of package object
2705 def DerivedPackageList(self
):
2707 for M
in [self
.Module
] + self
.DependentLibraryList
:
2708 for Package
in M
.Packages
:
2709 if Package
in PackageList
:
2711 PackageList
.append(Package
)
2714 ## Get the depex string
2716 # @return : a string contain all depex expresion.
2717 def _GetDepexExpresionString(self
):
2720 ## DPX_SOURCE IN Define section.
2721 if self
.Module
.DxsFile
:
2723 for M
in [self
.Module
] + self
.DependentLibraryList
:
2724 Filename
= M
.MetaFile
.Path
2725 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
2726 DepexExpresionList
= InfObj
.GetDepexExpresionList()
2727 for DepexExpresion
in DepexExpresionList
:
2728 for key
in DepexExpresion
:
2729 Arch
, ModuleType
= key
2730 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
2731 # the type of build module is USER_DEFINED.
2732 # All different DEPEX section tags would be copied into the As Built INF file
2733 # and there would be separate DEPEX section tags
2734 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
2735 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
2736 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
2738 if Arch
.upper() == TAB_ARCH_COMMON
or \
2739 (Arch
.upper() == self
.Arch
.upper() and \
2740 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
2741 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
2743 #the type of build module is USER_DEFINED.
2744 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
2745 for Depex
in DepexList
:
2747 DepexStr
+= '[Depex.%s.%s]\n' % key
2748 DepexStr
+= '\n'.join('# '+ val
for val
in Depex
[key
])
2751 return '[Depex.%s]\n' % self
.Arch
2754 #the type of build module not is USER_DEFINED.
2756 for Depex
in DepexList
:
2761 for D
in Depex
.values():
2762 DepexStr
+= ' '.join(val
for val
in D
)
2763 Index
= DepexStr
.find('END')
2764 if Index
> -1 and Index
== len(DepexStr
) - 3:
2765 DepexStr
= DepexStr
[:-3]
2766 DepexStr
= DepexStr
.strip()
2769 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
2771 return '[Depex.%s]\n' % self
.Arch
2772 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
2774 ## Merge dependency expression
2776 # @retval list The token list of the dependency expression after parsed
2779 def DepexList(self
):
2780 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
2785 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2787 for M
in [self
.Module
] + self
.DependentLibraryList
:
2789 for D
in M
.Depex
[self
.Arch
, self
.ModuleType
]:
2791 DepexList
.append('AND')
2792 DepexList
.append('(')
2793 #replace D with value if D is FixedAtBuild PCD
2797 NewList
.append(item
)
2799 if item
not in self
._FixedPcdVoidTypeDict
:
2800 EdkLogger
.error("build", FORMAT_INVALID
, "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type in the module.".format(item
))
2802 Value
= self
._FixedPcdVoidTypeDict
[item
]
2803 if len(Value
.split(',')) != 16:
2804 EdkLogger
.error("build", FORMAT_INVALID
,
2805 "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type and 16 bytes in the module.".format(item
))
2806 NewList
.append(Value
)
2807 DepexList
.extend(NewList
)
2808 if DepexList
[-1] == 'END': # no need of a END at this time
2810 DepexList
.append(')')
2813 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
2814 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
2816 if len(DepexList
) > 0:
2817 EdkLogger
.verbose('')
2818 return {self
.ModuleType
:DepexList
}
2820 ## Merge dependency expression
2822 # @retval list The token list of the dependency expression after parsed
2825 def DepexExpressionDict(self
):
2826 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
2829 DepexExpressionString
= ''
2831 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
2833 for M
in [self
.Module
] + self
.DependentLibraryList
:
2835 for D
in M
.DepexExpression
[self
.Arch
, self
.ModuleType
]:
2836 if DepexExpressionString
!= '':
2837 DepexExpressionString
+= ' AND '
2838 DepexExpressionString
+= '('
2839 DepexExpressionString
+= D
2840 DepexExpressionString
= DepexExpressionString
.rstrip('END').strip()
2841 DepexExpressionString
+= ')'
2844 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionString
))
2845 if 'BEFORE' in DepexExpressionString
or 'AFTER' in DepexExpressionString
:
2847 if len(DepexExpressionString
) > 0:
2848 EdkLogger
.verbose('')
2850 return {self
.ModuleType
:DepexExpressionString
}
2852 # Get the tiano core user extension, it is contain dependent library.
2853 # @retval: a list contain tiano core userextension.
2855 def _GetTianoCoreUserExtensionList(self
):
2856 TianoCoreUserExtentionList
= []
2857 for M
in [self
.Module
] + self
.DependentLibraryList
:
2858 Filename
= M
.MetaFile
.Path
2859 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
2860 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
2861 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
2862 for Section
in TianoCoreUserExtent
:
2863 ItemList
= Section
.split(TAB_SPLIT
)
2865 if len(ItemList
) == 4:
2867 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
2869 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
2870 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
2871 TianoCoreList
.append('\n')
2872 TianoCoreUserExtentionList
.append(TianoCoreList
)
2874 return TianoCoreUserExtentionList
2876 ## Return the list of specification version required for the module
2878 # @retval list The list of specification defined in module file
2881 def Specification(self
):
2882 return self
.Module
.Specification
2884 ## Tool option for the module build
2886 # @param PlatformInfo The object of PlatformBuildInfo
2887 # @retval dict The dict containing valid options
2890 def BuildOption(self
):
2891 RetVal
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
2892 if self
.BuildRuleOrder
:
2893 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
2896 ## Get include path list from tool option for the module build
2898 # @retval list The include path list
2901 def BuildOptionIncPathList(self
):
2903 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
2904 # is the former use /I , the Latter used -I to specify include directories
2906 if self
.PlatformInfo
.ToolChainFamily
in (TAB_COMPILER_MSFT
):
2907 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
2908 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
2909 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
2912 # New ToolChainFamily, don't known whether there is option to specify include directories
2917 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
2919 FlagOption
= self
.BuildOption
[Tool
]['FLAGS']
2923 if self
.ToolChainFamily
!= 'RVCT':
2924 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
2927 # RVCT may specify a list of directory seperated by commas
2930 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
2931 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
2932 IncPathList
.extend(NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
)
2935 # EDK II modules must not reference header files outside of the packages they depend on or
2936 # within the module's directory tree. Report error if violation.
2938 if self
.AutoGenVersion
>= 0x00010005:
2939 for Path
in IncPathList
:
2940 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
2941 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
2942 EdkLogger
.error("build",
2945 File
=str(self
.MetaFile
))
2946 RetVal
+= IncPathList
2949 ## Return a list of files which can be built from source
2951 # What kind of files can be built is determined by build rules in
2952 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
2955 def SourceFileList(self
):
2957 ToolChainTagSet
= {"", "*", self
.ToolChain
}
2958 ToolChainFamilySet
= {"", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
}
2959 for F
in self
.Module
.Sources
:
2961 if F
.TagName
not in ToolChainTagSet
:
2962 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
2963 "but [%s] is currently used" % (F
.TagName
, str(F
), self
.ToolChain
))
2965 # match tool chain family or build rule family
2966 if F
.ToolChainFamily
not in ToolChainFamilySet
:
2969 "The file [%s] must be built by tools of [%s], " \
2970 "but current toolchain family is [%s], buildrule family is [%s]" \
2971 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
2974 # add the file path into search path list for file including
2975 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
2976 self
.IncludePathList
.insert(0, F
.Dir
)
2979 self
._MatchBuildRuleOrder
(RetVal
)
2982 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
2985 def _MatchBuildRuleOrder(self
, FileList
):
2988 for SingleFile
in FileList
:
2989 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
2990 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
2991 if key
in Order_Dict
:
2992 Order_Dict
[key
].append(SingleFile
.Ext
)
2994 Order_Dict
[key
] = [SingleFile
.Ext
]
2997 for F
in Order_Dict
:
2998 if len(Order_Dict
[F
]) > 1:
2999 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3000 for Ext
in Order_Dict
[F
][1:]:
3001 RemoveList
.append(F
+ Ext
)
3003 for item
in RemoveList
:
3004 FileList
.remove(item
)
3008 ## Return the list of unicode files
3010 def UnicodeFileList(self
):
3011 return self
.FileTypes
.get(TAB_UNICODE_FILE
,[])
3013 ## Return the list of vfr files
3015 def VfrFileList(self
):
3016 return self
.FileTypes
.get(TAB_VFR_FILE
, [])
3018 ## Return the list of Image Definition files
3020 def IdfFileList(self
):
3021 return self
.FileTypes
.get(TAB_IMAGE_FILE
,[])
3023 ## Return a list of files which can be built from binary
3025 # "Build" binary files are just to copy them to build directory.
3027 # @retval list The list of files which can be built later
3030 def BinaryFileList(self
):
3032 for F
in self
.Module
.Binaries
:
3033 if F
.Target
not in [TAB_ARCH_COMMON
, '*'] and F
.Target
!= self
.BuildTarget
:
3036 self
._ApplyBuildRule
(F
, F
.Type
, BinaryFileList
=RetVal
)
3040 def BuildRules(self
):
3042 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3043 for Type
in BuildRuleDatabase
.FileTypeList
:
3044 #first try getting build rule by BuildRuleFamily
3045 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3047 # build type is always module type, but ...
3048 if self
.ModuleType
!= self
.BuildType
:
3049 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3050 #second try getting build rule by ToolChainFamily
3052 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3054 # build type is always module type, but ...
3055 if self
.ModuleType
!= self
.BuildType
:
3056 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3059 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3060 RetVal
[Type
] = RuleObject
3061 for Ext
in RuleObject
.SourceFileExtList
:
3062 RetVal
[Ext
] = RuleObject
3065 def _ApplyBuildRule(self
, File
, FileType
, BinaryFileList
=None):
3066 if self
._BuildTargets
is None:
3067 self
._IntroBuildTargetList
= set()
3068 self
._FinalBuildTargetList
= set()
3069 self
._BuildTargets
= defaultdict(set)
3070 self
._FileTypes
= defaultdict(set)
3072 if not BinaryFileList
:
3073 BinaryFileList
= self
.BinaryFileList
3075 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3076 if not os
.path
.exists(SubDirectory
):
3077 CreateDirectory(SubDirectory
)
3083 # Make sure to get build rule order value
3087 while Index
< len(SourceList
):
3088 Source
= SourceList
[Index
]
3092 CreateDirectory(Source
.Dir
)
3094 if File
.IsBinary
and File
== Source
and File
in BinaryFileList
:
3095 # Skip all files that are not binary libraries
3096 if not self
.IsLibrary
:
3098 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3099 elif FileType
in self
.BuildRules
:
3100 RuleObject
= self
.BuildRules
[FileType
]
3101 elif Source
.Ext
in self
.BuildRules
:
3102 RuleObject
= self
.BuildRules
[Source
.Ext
]
3104 # stop at no more rules
3106 self
._FinalBuildTargetList
.add(LastTarget
)
3109 FileType
= RuleObject
.SourceFileType
3110 self
._FileTypes
[FileType
].add(Source
)
3112 # stop at STATIC_LIBRARY for library
3113 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3115 self
._FinalBuildTargetList
.add(LastTarget
)
3118 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3121 self
._FinalBuildTargetList
.add(LastTarget
)
3123 elif not Target
.Outputs
:
3124 # Only do build for target with outputs
3125 self
._FinalBuildTargetList
.add(Target
)
3127 self
._BuildTargets
[FileType
].add(Target
)
3129 if not Source
.IsBinary
and Source
== File
:
3130 self
._IntroBuildTargetList
.add(Target
)
3132 # to avoid cyclic rule
3133 if FileType
in RuleChain
:
3136 RuleChain
.add(FileType
)
3137 SourceList
.extend(Target
.Outputs
)
3139 FileType
= TAB_UNKNOWN_FILE
3143 if self
._BuildTargets
is None:
3144 self
._IntroBuildTargetList
= set()
3145 self
._FinalBuildTargetList
= set()
3146 self
._BuildTargets
= defaultdict(set)
3147 self
._FileTypes
= defaultdict(set)
3149 #TRICK: call SourceFileList property to apply build rule for source files
3152 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3155 return self
._BuildTargets
3158 def IntroTargetList(self
):
3160 return self
._IntroBuildTargetList
3163 def CodaTargetList(self
):
3165 return self
._FinalBuildTargetList
3168 def FileTypes(self
):
3170 return self
._FileTypes
3172 ## Get the list of package object the module depends on
3174 # @retval list The package object list
3177 def DependentPackageList(self
):
3178 return self
.Module
.Packages
3180 ## Return the list of auto-generated code file
3182 # @retval list The list of auto-generated file
3185 def AutoGenFileList(self
):
3186 AutoGenUniIdf
= self
.BuildType
!= 'UEFI_HII'
3187 UniStringBinBuffer
= BytesIO()
3188 IdfGenBinBuffer
= BytesIO()
3190 AutoGenC
= TemplateString()
3191 AutoGenH
= TemplateString()
3192 StringH
= TemplateString()
3193 StringIdf
= TemplateString()
3194 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, AutoGenUniIdf
, UniStringBinBuffer
, StringIdf
, AutoGenUniIdf
, IdfGenBinBuffer
)
3196 # AutoGen.c is generated if there are library classes in inf, or there are object files
3198 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3199 or TAB_OBJECT_FILE
in self
.FileTypes
):
3200 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3201 RetVal
[AutoFile
] = str(AutoGenC
)
3202 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3203 if str(AutoGenH
) != "":
3204 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3205 RetVal
[AutoFile
] = str(AutoGenH
)
3206 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3207 if str(StringH
) != "":
3208 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3209 RetVal
[AutoFile
] = str(StringH
)
3210 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3211 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3212 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3213 RetVal
[AutoFile
] = UniStringBinBuffer
.getvalue()
3214 AutoFile
.IsBinary
= True
3215 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3216 if UniStringBinBuffer
is not None:
3217 UniStringBinBuffer
.close()
3218 if str(StringIdf
) != "":
3219 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3220 RetVal
[AutoFile
] = str(StringIdf
)
3221 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3222 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3223 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3224 RetVal
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3225 AutoFile
.IsBinary
= True
3226 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3227 if IdfGenBinBuffer
is not None:
3228 IdfGenBinBuffer
.close()
3231 ## Return the list of library modules explicitly or implicityly used by this module
3233 def DependentLibraryList(self
):
3234 # only merge library classes and PCD for non-library module
3237 if self
.AutoGenVersion
< 0x00010005:
3238 return self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3239 return self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3241 ## Get the list of PCDs from current module
3243 # @retval list The list of PCD
3246 def ModulePcdList(self
):
3247 # apply PCD settings from platform
3248 RetVal
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3249 ExtendCopyDictionaryLists(self
._PcdComments
, self
.Module
.PcdComments
)
3252 ## Get the list of PCDs from dependent libraries
3254 # @retval list The list of PCD
3257 def LibraryPcdList(self
):
3262 # get PCDs from dependent libraries
3263 for Library
in self
.DependentLibraryList
:
3264 PcdsInLibrary
= OrderedDict()
3265 ExtendCopyDictionaryLists(self
._PcdComments
, Library
.PcdComments
)
3266 for Key
in Library
.Pcds
:
3267 # skip duplicated PCDs
3268 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3271 PcdsInLibrary
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3272 RetVal
.extend(self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, PcdsInLibrary
, Library
=Library
))
3275 ## Get the GUID value mapping
3277 # @retval dict The mapping between GUID cname and its value
3281 RetVal
= OrderedDict(self
.Module
.Guids
)
3282 for Library
in self
.DependentLibraryList
:
3283 RetVal
.update(Library
.Guids
)
3284 ExtendCopyDictionaryLists(self
._GuidComments
, Library
.GuidComments
)
3285 ExtendCopyDictionaryLists(self
._GuidComments
, self
.Module
.GuidComments
)
3289 def GetGuidsUsedByPcd(self
):
3290 RetVal
= OrderedDict(self
.Module
.GetGuidsUsedByPcd())
3291 for Library
in self
.DependentLibraryList
:
3292 RetVal
.update(Library
.GetGuidsUsedByPcd())
3294 ## Get the protocol value mapping
3296 # @retval dict The mapping between protocol cname and its value
3299 def ProtocolList(self
):
3300 RetVal
= OrderedDict(self
.Module
.Protocols
)
3301 for Library
in self
.DependentLibraryList
:
3302 RetVal
.update(Library
.Protocols
)
3303 ExtendCopyDictionaryLists(self
._ProtocolComments
, Library
.ProtocolComments
)
3304 ExtendCopyDictionaryLists(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3307 ## Get the PPI value mapping
3309 # @retval dict The mapping between PPI cname and its value
3313 RetVal
= OrderedDict(self
.Module
.Ppis
)
3314 for Library
in self
.DependentLibraryList
:
3315 RetVal
.update(Library
.Ppis
)
3316 ExtendCopyDictionaryLists(self
._PpiComments
, Library
.PpiComments
)
3317 ExtendCopyDictionaryLists(self
._PpiComments
, self
.Module
.PpiComments
)
3320 ## Get the list of include search path
3322 # @retval list The list path
3325 def IncludePathList(self
):
3327 if self
.AutoGenVersion
< 0x00010005:
3328 for Inc
in self
.Module
.Includes
:
3329 if Inc
not in RetVal
:
3332 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3333 if os
.path
.exists(Inc
) and Inc
not in RetVal
:
3335 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3336 RetVal
.append(self
.DebugDir
)
3338 RetVal
.append(self
.MetaFile
.Dir
)
3339 RetVal
.append(self
.DebugDir
)
3341 for Package
in self
.Module
.Packages
:
3342 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3343 if PackageDir
not in RetVal
:
3344 RetVal
.append(PackageDir
)
3345 IncludesList
= Package
.Includes
3346 if Package
._PrivateIncludes
:
3347 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3348 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3349 for Inc
in IncludesList
:
3350 if Inc
not in RetVal
:
3351 RetVal
.append(str(Inc
))
3355 def IncludePathLength(self
):
3356 return sum(len(inc
)+1 for inc
in self
.IncludePathList
)
3358 ## Get HII EX PCDs which maybe used by VFR
3360 # efivarstore used by VFR may relate with HII EX PCDs
3361 # Get the variable name and GUID from efivarstore and HII EX PCD
3362 # List the HII EX PCDs in As Built INF if both name and GUID match.
3364 # @retval list HII EX PCDs
3366 def _GetPcdsMaybeUsedByVfr(self
):
3367 if not self
.SourceFileList
:
3371 for SrcFile
in self
.SourceFileList
:
3372 if SrcFile
.Ext
.lower() != '.vfr':
3374 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3375 if not os
.path
.exists(Vfri
):
3377 VfriFile
= open(Vfri
, 'r')
3378 Content
= VfriFile
.read()
3380 Pos
= Content
.find('efivarstore')
3383 # Make sure 'efivarstore' is the start of efivarstore statement
3384 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3387 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3389 if Index
>= 0 and Content
[Index
] != ';':
3390 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3393 # 'efivarstore' must be followed by name and guid
3395 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3398 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3401 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3402 NameGuids
.add((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3403 Pos
= Content
.find('efivarstore', Name
.end())
3407 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3408 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3410 for SkuInfo
in Pcd
.SkuInfoList
.values():
3411 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3414 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3415 Guid
= GuidStructureStringToGuidString(Value
)
3416 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3417 HiiExPcds
.append(Pcd
)
3422 def _GenOffsetBin(self
):
3424 for SourceFile
in self
.Module
.Sources
:
3425 if SourceFile
.Type
.upper() == ".VFR" :
3427 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3429 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3430 elif SourceFile
.Type
.upper() == ".UNI" :
3432 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3434 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3436 if not VfrUniBaseName
:
3438 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3439 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3440 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3441 if not VfrUniOffsetList
:
3444 OutputName
= '%sOffset.bin' % self
.Name
3445 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3448 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3450 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
, None)
3452 # Use a instance of BytesIO to cache data
3453 fStringIO
= BytesIO('')
3455 for Item
in VfrUniOffsetList
:
3456 if (Item
[0].find("Strings") != -1):
3458 # UNI offset in image.
3460 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3462 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3463 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3464 fStringIO
.write(''.join(UniGuid
))
3465 UniValue
= pack ('Q', int (Item
[1], 16))
3466 fStringIO
.write (UniValue
)
3469 # VFR binary offset in image.
3471 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3473 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3474 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3475 fStringIO
.write(''.join(VfrGuid
))
3476 VfrValue
= pack ('Q', int (Item
[1], 16))
3477 fStringIO
.write (VfrValue
)
3479 # write data into file.
3482 fInputfile
.write (fStringIO
.getvalue())
3484 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3485 "file been locked or using by other applications." %UniVfrOffsetFileName
, None)
3491 ## Create AsBuilt INF file the module
3493 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3494 self
.OutputFile
= set()
3495 if IsOnlyCopy
and GlobalData
.gBinCacheDest
:
3496 self
.CopyModuleToCache()
3499 if self
.IsAsBuiltInfCreated
:
3502 # Skip the following code for EDK I inf
3503 if self
.AutoGenVersion
< 0x00010005:
3506 # Skip the following code for libraries
3510 # Skip the following code for modules with no source files
3511 if not self
.SourceFileList
:
3514 # Skip the following code for modules without any binary files
3515 if self
.BinaryFileList
:
3518 ### TODO: How to handles mixed source and binary modules
3520 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3521 # Also find all packages that the DynamicEx PCDs depend on
3526 PcdTokenSpaceList
= []
3527 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3528 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3529 PatchablePcds
.append(Pcd
)
3530 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_PATCHABLE_IN_MODULE
))
3531 elif Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
3534 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
))
3535 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
))
3536 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3537 GuidList
= OrderedDict(self
.GuidList
)
3538 for TokenSpace
in self
.GetGuidsUsedByPcd
:
3539 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3540 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3541 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3542 GuidList
.pop(TokenSpace
)
3543 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3544 for Package
in self
.DerivedPackageList
:
3545 if Package
in Packages
:
3547 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3549 for Index
in range(len(BeChecked
)):
3550 for Item
in CheckList
[Index
]:
3551 if Item
in BeChecked
[Index
]:
3552 Packages
.append(Package
)
3558 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3559 for Pkg
in self
.PlatformInfo
.PackageList
:
3562 for VfrPcd
in VfrPcds
:
3563 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
) in Pkg
.Pcds
or
3564 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
) in Pkg
.Pcds
):
3565 Packages
.append(Pkg
)
3568 ModuleType
= SUP_MODULE_DXE_DRIVER
if self
.ModuleType
== SUP_MODULE_UEFI_DRIVER
and self
.DepexGenerated
else self
.ModuleType
3569 DriverType
= self
.PcdIsDriver
if self
.PcdIsDriver
else ''
3571 MDefs
= self
.Module
.Defines
3574 'module_name' : self
.Name
,
3575 'module_guid' : Guid
,
3576 'module_module_type' : ModuleType
,
3577 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3578 'pcd_is_driver_string' : [],
3579 'module_uefi_specification_version' : [],
3580 'module_pi_specification_version' : [],
3581 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3582 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3583 'module_constructor' : self
.Module
.ConstructorList
,
3584 'module_destructor' : self
.Module
.DestructorList
,
3585 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
3586 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
3587 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
3588 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
3589 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
3590 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
3591 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
3592 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
3593 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
3594 'module_arch' : self
.Arch
,
3595 'package_item' : [Package
.MetaFile
.File
.replace('\\', '/') for Package
in Packages
],
3597 'patchablepcd_item' : [],
3599 'protocol_item' : [],
3603 'libraryclasses_item' : []
3606 if 'MODULE_UNI_FILE' in MDefs
:
3607 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
3608 if os
.path
.isfile(UNIFile
):
3609 shutil
.copy2(UNIFile
, self
.OutputDir
)
3611 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
3612 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
3614 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
3617 AsBuiltInfDict
['pcd_is_driver_string'].append(DriverType
)
3619 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
3620 AsBuiltInfDict
['module_uefi_specification_version'].append(self
.Specification
['UEFI_SPECIFICATION_VERSION'])
3621 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
3622 AsBuiltInfDict
['module_pi_specification_version'].append(self
.Specification
['PI_SPECIFICATION_VERSION'])
3624 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
3625 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
3626 for Item
in self
.CodaTargetList
:
3627 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
3628 self
.OutputFile
.add(File
)
3629 if os
.path
.isabs(File
):
3630 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
3631 if Item
.Target
.Ext
.lower() == '.aml':
3632 AsBuiltInfDict
['binary_item'].append('ASL|' + File
)
3633 elif Item
.Target
.Ext
.lower() == '.acpi':
3634 AsBuiltInfDict
['binary_item'].append('ACPI|' + File
)
3635 elif Item
.Target
.Ext
.lower() == '.efi':
3636 AsBuiltInfDict
['binary_item'].append('PE32|' + self
.Name
+ '.efi')
3638 AsBuiltInfDict
['binary_item'].append('BIN|' + File
)
3639 if self
.DepexGenerated
:
3640 self
.OutputFile
.add(self
.Name
+ '.depex')
3641 if self
.ModuleType
in [SUP_MODULE_PEIM
]:
3642 AsBuiltInfDict
['binary_item'].append('PEI_DEPEX|' + self
.Name
+ '.depex')
3643 elif self
.ModuleType
in [SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
3644 AsBuiltInfDict
['binary_item'].append('DXE_DEPEX|' + self
.Name
+ '.depex')
3645 elif self
.ModuleType
in [SUP_MODULE_DXE_SMM_DRIVER
]:
3646 AsBuiltInfDict
['binary_item'].append('SMM_DEPEX|' + self
.Name
+ '.depex')
3648 Bin
= self
._GenOffsetBin
()
3650 AsBuiltInfDict
['binary_item'].append('BIN|%s' % Bin
)
3651 self
.OutputFile
.add(Bin
)
3653 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
3655 if File
.lower().endswith('.pdb'):
3656 AsBuiltInfDict
['binary_item'].append('DISPOSABLE|' + File
)
3657 self
.OutputFile
.add(File
)
3658 HeaderComments
= self
.Module
.HeaderComments
3660 for Index
in range(len(HeaderComments
)):
3661 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
3662 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
3665 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
3666 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
3669 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
3670 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
3671 (GuidList
, self
._GuidComments
, 'guid_item')
3673 for Item
in GenList
:
3674 for CName
in Item
[0]:
3675 Comments
= '\n '.join(Item
[1][CName
]) if CName
in Item
[1] else ''
3676 Entry
= Comments
+ '\n ' + CName
if Comments
else CName
3677 AsBuiltInfDict
[Item
[2]].append(Entry
)
3678 PatchList
= parsePcdInfoFromMapFile(
3679 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
3680 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
3683 for Pcd
in PatchablePcds
:
3684 TokenCName
= Pcd
.TokenCName
3685 for PcdItem
in GlobalData
.MixedPcd
:
3686 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
3687 TokenCName
= PcdItem
[0]
3689 for PatchPcd
in PatchList
:
3690 if TokenCName
== PatchPcd
[0]:
3695 if Pcd
.DatumType
== 'BOOLEAN':
3696 BoolValue
= Pcd
.DefaultValue
.upper()
3697 if BoolValue
== 'TRUE':
3698 Pcd
.DefaultValue
= '1'
3699 elif BoolValue
== 'FALSE':
3700 Pcd
.DefaultValue
= '0'
3702 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
3703 HexFormat
= '0x%02x'
3704 if Pcd
.DatumType
== TAB_UINT16
:
3705 HexFormat
= '0x%04x'
3706 elif Pcd
.DatumType
== TAB_UINT32
:
3707 HexFormat
= '0x%08x'
3708 elif Pcd
.DatumType
== TAB_UINT64
:
3709 HexFormat
= '0x%016x'
3710 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
3712 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
3713 EdkLogger
.error("build", AUTOGEN_ERROR
,
3714 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3716 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
3717 PcdValue
= Pcd
.DefaultValue
3718 if PcdValue
[0] != '{':
3720 if PcdValue
[0] == 'L':
3722 PcdValue
= PcdValue
.lstrip('L')
3723 PcdValue
= eval(PcdValue
)
3725 for Index
in range(0, len(PcdValue
)):
3727 CharVal
= ord(PcdValue
[Index
])
3728 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
3729 + '0x%02x' % (CharVal
>> 8) + ', '
3731 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
3734 Padding
= Padding
* 2
3735 ArraySize
= ArraySize
/ 2
3736 if ArraySize
< (len(PcdValue
) + 1):
3737 if Pcd
.MaxSizeUserSet
:
3738 EdkLogger
.error("build", AUTOGEN_ERROR
,
3739 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3742 ArraySize
= len(PcdValue
) + 1
3743 if ArraySize
> len(PcdValue
) + 1:
3744 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
3745 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
3746 elif len(PcdValue
.split(',')) <= ArraySize
:
3747 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
3750 if Pcd
.MaxSizeUserSet
:
3751 EdkLogger
.error("build", AUTOGEN_ERROR
,
3752 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
3755 ArraySize
= len(PcdValue
) + 1
3756 PcdItem
= '%s.%s|%s|0x%X' % \
3757 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
3759 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
3760 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
3762 PcdItem
= PcdComments
+ '\n ' + PcdItem
3763 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
3765 for Pcd
in Pcds
+ VfrPcds
:
3768 TokenCName
= Pcd
.TokenCName
3769 for PcdItem
in GlobalData
.MixedPcd
:
3770 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
3771 TokenCName
= PcdItem
[0]
3773 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
3774 for SkuName
in Pcd
.SkuInfoList
:
3775 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3776 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
3778 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
3779 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
3783 for Index
, Comment
in enumerate(PcdCommentList
):
3784 for Usage
in UsageList
:
3785 if Comment
.find(Usage
) != -1:
3789 if UsageIndex
!= -1:
3790 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
3792 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
3793 PcdComments
= '\n '.join(PcdCommentList
)
3794 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
3796 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
3797 AsBuiltInfDict
['pcd_item'].append(PcdEntry
)
3798 for Item
in self
.BuildOption
:
3799 if 'FLAGS' in self
.BuildOption
[Item
]:
3800 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()))
3802 # Generated LibraryClasses section in comments.
3803 for Library
in self
.LibraryAutoGenList
:
3804 AsBuiltInfDict
['libraryclasses_item'].append(Library
.MetaFile
.File
.replace('\\', '/'))
3806 # Generated UserExtensions TianoCore section.
3807 # All tianocore user extensions are copied.
3809 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
3810 UserExtStr
+= '\n'.join(TianoCore
)
3811 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
3812 if os
.path
.isfile(ExtensionFile
):
3813 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
3814 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
3816 # Generated depex expression section in comments.
3817 DepexExpresion
= self
._GetDepexExpresionString
()
3818 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
if DepexExpresion
else ''
3820 AsBuiltInf
= TemplateString()
3821 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
3823 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
3825 self
.IsAsBuiltInfCreated
= True
3826 if GlobalData
.gBinCacheDest
:
3827 self
.CopyModuleToCache()
3829 def CopyModuleToCache(self
):
3830 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
3831 CreateDirectory (FileDir
)
3832 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
3833 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
3834 if os
.path
.exists(HashFile
):
3835 shutil
.copy2(HashFile
, FileDir
)
3836 if os
.path
.exists(ModuleFile
):
3837 shutil
.copy2(ModuleFile
, FileDir
)
3838 if not self
.OutputFile
:
3839 Ma
= self
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
3840 self
.OutputFile
= Ma
.Binaries
3842 for File
in self
.OutputFile
:
3844 if not os
.path
.isabs(File
):
3845 File
= os
.path
.join(self
.OutputDir
, File
)
3846 if os
.path
.exists(File
):
3847 shutil
.copy2(File
, FileDir
)
3849 def AttemptModuleCacheCopy(self
):
3850 if self
.IsBinaryModule
:
3852 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
3853 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
3854 if os
.path
.exists(HashFile
):
3855 f
= open(HashFile
, 'r')
3856 CacheHash
= f
.read()
3858 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
3859 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
3860 for root
, dir, files
in os
.walk(FileDir
):
3862 if self
.Name
+ '.hash' in f
:
3863 shutil
.copy2(HashFile
, self
.BuildDir
)
3865 File
= path
.join(root
, f
)
3866 shutil
.copy2(File
, self
.OutputDir
)
3867 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
3868 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
3872 ## Create makefile for the module and its dependent libraries
3874 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
3875 # dependent libraries will be created
3877 @cached_class_function
3878 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
3879 # nest this function inside it's only caller.
3880 def CreateTimeStamp():
3881 FileSet
= {self
.MetaFile
.Path
}
3883 for SourceFile
in self
.Module
.Sources
:
3884 FileSet
.add (SourceFile
.Path
)
3886 for Lib
in self
.DependentLibraryList
:
3887 FileSet
.add (Lib
.MetaFile
.Path
)
3889 for f
in self
.AutoGenDepSet
:
3890 FileSet
.add (f
.Path
)
3892 if os
.path
.exists (self
.TimeStampPath
):
3893 os
.remove (self
.TimeStampPath
)
3894 with
open(self
.TimeStampPath
, 'w+') as file:
3898 # Ignore generating makefile when it is a binary module
3899 if self
.IsBinaryModule
:
3902 self
.GenFfsList
= GenFfsList
3903 if not self
.IsLibrary
and CreateLibraryMakeFile
:
3904 for LibraryAutoGen
in self
.LibraryAutoGenList
:
3905 LibraryAutoGen
.CreateMakeFile()
3910 if len(self
.CustomMakefile
) == 0:
3911 Makefile
= GenMake
.ModuleMakefile(self
)
3913 Makefile
= GenMake
.CustomMakefile(self
)
3914 if Makefile
.Generate():
3915 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
3916 (self
.Name
, self
.Arch
))
3918 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
3919 (self
.Name
, self
.Arch
))
3923 def CopyBinaryFiles(self
):
3924 for File
in self
.Module
.Binaries
:
3926 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
3927 CopyLongFilePath(SrcPath
, DstPath
)
3928 ## Create autogen code for the module and its dependent libraries
3930 # @param CreateLibraryCodeFile Flag indicating if or not the code of
3931 # dependent libraries will be created
3933 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
3934 if self
.IsCodeFileCreated
:
3937 # Need to generate PcdDatabase even PcdDriver is binarymodule
3938 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
3939 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
3941 if self
.IsBinaryModule
:
3943 self
.CopyBinaryFiles()
3946 if not self
.IsLibrary
and CreateLibraryCodeFile
:
3947 for LibraryAutoGen
in self
.LibraryAutoGenList
:
3948 LibraryAutoGen
.CreateCodeFile()
3954 IgoredAutoGenList
= []
3956 for File
in self
.AutoGenFileList
:
3957 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
3958 #Ignore Edk AutoGen.c
3959 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
3962 AutoGenList
.append(str(File
))
3964 IgoredAutoGenList
.append(str(File
))
3966 # Skip the following code for EDK I inf
3967 if self
.AutoGenVersion
< 0x00010005:
3970 for ModuleType
in self
.DepexList
:
3971 # Ignore empty [depex] section or [depex] section for SUP_MODULE_USER_DEFINED module
3972 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== SUP_MODULE_USER_DEFINED
:
3975 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
3976 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
3978 if len(Dpx
.PostfixNotation
) != 0:
3979 self
.DepexGenerated
= True
3981 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
3982 AutoGenList
.append(str(DpxFile
))
3984 IgoredAutoGenList
.append(str(DpxFile
))
3986 if IgoredAutoGenList
== []:
3987 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
3988 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
3989 elif AutoGenList
== []:
3990 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
3991 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
3993 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
3994 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
3996 self
.IsCodeFileCreated
= True
3999 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4001 def LibraryAutoGenList(self
):
4003 for Library
in self
.DependentLibraryList
:
4010 self
.PlatformInfo
.MetaFile
4012 if La
not in RetVal
:
4014 for Lib
in La
.CodaTargetList
:
4015 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4018 def GenModuleHash(self
):
4019 if self
.Arch
not in GlobalData
.gModuleHash
:
4020 GlobalData
.gModuleHash
[self
.Arch
] = {}
4022 # Add Platform level hash
4023 m
.update(GlobalData
.gPlatformHash
)
4024 # Add Package level hash
4025 if self
.DependentPackageList
:
4026 for Pkg
in sorted(self
.DependentPackageList
, key
=lambda x
: x
.PackageName
):
4027 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4028 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4031 if self
.LibraryAutoGenList
:
4032 for Lib
in sorted(self
.LibraryAutoGenList
, key
=lambda x
: x
.Name
):
4033 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4035 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4038 f
= open(str(self
.MetaFile
), 'r')
4042 # Add Module's source files
4043 if self
.SourceFileList
:
4044 for File
in sorted(self
.SourceFileList
, key
=lambda x
: str(x
)):
4045 f
= open(str(File
), 'r')
4050 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4051 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4052 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4053 if GlobalData
.gBinCacheSource
:
4054 if self
.AttemptModuleCacheCopy():
4056 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4058 ## Decide whether we can skip the ModuleAutoGen process
4059 def CanSkipbyHash(self
):
4060 if GlobalData
.gUseHashCache
:
4061 return not self
.GenModuleHash()
4064 ## Decide whether we can skip the ModuleAutoGen process
4065 # If any source file is newer than the module than we cannot skip
4068 if self
.MakeFileDir
in GlobalData
.gSikpAutoGenCache
:
4070 if not os
.path
.exists(self
.TimeStampPath
):
4072 #last creation time of the module
4073 DstTimeStamp
= os
.stat(self
.TimeStampPath
)[8]
4075 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4076 if SrcTimeStamp
> DstTimeStamp
:
4079 with
open(self
.TimeStampPath
,'r') as f
:
4081 source
= source
.rstrip('\n')
4082 if not os
.path
.exists(source
):
4084 if source
not in ModuleAutoGen
.TimeDict
:
4085 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4086 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4088 GlobalData
.gSikpAutoGenCache
.add(self
.MakeFileDir
)
4092 def TimeStampPath(self
):
4093 return os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')