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 import Common
.LongFilePathOs
as os
20 import os
.path
as path
27 from StringIO
import StringIO
29 from StrGather
import *
30 from BuildEngine
import BuildRule
32 from Common
.LongFilePathSupport
import CopyLongFilePath
33 from Common
.BuildToolError
import *
34 from Common
.DataType
import *
35 from Common
.Misc
import *
36 from Common
.String
import *
37 import Common
.GlobalData
as GlobalData
38 from GenFds
.FdfParser
import *
39 from CommonDataClass
.CommonClass
import SkuInfoClass
40 from Workspace
.BuildClassObject
import *
41 from GenPatchPcdTable
.GenPatchPcdTable
import parsePcdInfoFromMapFile
42 import Common
.VpdInfoFile
as VpdInfoFile
43 from GenPcdDb
import CreatePcdDatabaseCode
44 from Workspace
.MetaFileCommentParser
import UsageList
45 from Common
.MultipleWorkspace
import MultipleWorkspace
as mws
46 import InfSectionParser
49 from GenVar
import VariableMgr
,var_info
50 from collections
import OrderedDict
51 from collections
import defaultdict
53 ## Regular expression for splitting Dependency Expression string into tokens
54 gDepexTokenPattern
= re
.compile("(\(|\)|\w+| \S+\.inf)")
56 ## Regular expression for match: PCD(xxxx.yyy)
57 gPCDAsGuidPattern
= re
.compile(r
"^PCD\(.+\..+\)$")
60 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
61 # is the former use /I , the Latter used -I to specify include directories
63 gBuildOptIncludePatternMsft
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
64 gBuildOptIncludePatternOther
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
67 # Match name = variable
69 gEfiVarStoreNamePattern
= re
.compile("\s*name\s*=\s*(\w+)")
71 # The format of guid in efivarstore statement likes following and must be correct:
72 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
74 gEfiVarStoreGuidPattern
= re
.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
76 ## Mapping Makefile type
77 gMakeTypeMap
= {"MSFT":"nmake", "GCC":"gmake"}
80 ## Build rule configuration file
81 gDefaultBuildRuleFile
= 'build_rule.txt'
83 ## Tools definition configuration file
84 gDefaultToolsDefFile
= 'tools_def.txt'
86 ## Build rule default version
87 AutoGenReqBuildRuleVerNum
= "0.1"
89 ## default file name for AutoGen
90 gAutoGenCodeFileName
= "AutoGen.c"
91 gAutoGenHeaderFileName
= "AutoGen.h"
92 gAutoGenStringFileName
= "%(module_name)sStrDefs.h"
93 gAutoGenStringFormFileName
= "%(module_name)sStrDefs.hpk"
94 gAutoGenDepexFileName
= "%(module_name)s.depex"
95 gAutoGenImageDefFileName
= "%(module_name)sImgDefs.h"
96 gAutoGenIdfFileName
= "%(module_name)sIdf.hpk"
97 gInfSpecVersion
= "0x00010017"
100 # Template string to generic AsBuilt INF
102 gAsBuiltInfHeaderString
= TemplateString("""${header_comments}
105 # FILE auto-generated
108 INF_VERSION = ${module_inf_version}
109 BASE_NAME = ${module_name}
110 FILE_GUID = ${module_guid}
111 MODULE_TYPE = ${module_module_type}${BEGIN}
112 VERSION_STRING = ${module_version_string}${END}${BEGIN}
113 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
114 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
115 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
116 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
117 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
118 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
119 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
120 SHADOW = ${module_shadow}${END}${BEGIN}
121 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
122 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
123 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
124 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
125 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
126 SPEC = ${module_spec}${END}${BEGIN}
127 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
128 MODULE_UNI_FILE = ${module_uni_file}${END}
130 [Packages.${module_arch}]${BEGIN}
131 ${package_item}${END}
133 [Binaries.${module_arch}]${BEGIN}
136 [PatchPcd.${module_arch}]${BEGIN}
140 [Protocols.${module_arch}]${BEGIN}
144 [Ppis.${module_arch}]${BEGIN}
148 [Guids.${module_arch}]${BEGIN}
152 [PcdEx.${module_arch}]${BEGIN}
156 [LibraryClasses.${module_arch}]
157 ## @LIB_INSTANCES${BEGIN}
158 # ${libraryclasses_item}${END}
162 ${userextension_tianocore_item}
166 [BuildOptions.${module_arch}]
168 ## ${flags_item}${END}
171 ## Base class for AutoGen
173 # This class just implements the cache mechanism of AutoGen objects.
175 class AutoGen(object):
176 # database to maintain the objects in each child class
177 __ObjectCache
= {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object
181 # @param Class class object of real AutoGen class
182 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
183 # @param Workspace Workspace directory or WorkspaceAutoGen object
184 # @param MetaFile The path of meta file
185 # @param Target Build target
186 # @param Toolchain Tool chain name
187 # @param Arch Target arch
188 # @param *args The specific class related parameters
189 # @param **kwargs The specific class related dict parameters
191 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
192 # check if the object has been created
193 Key
= (Target
, Toolchain
, Arch
, MetaFile
)
195 # if it exists, just return it directly
196 return cls
.__ObjectCache
[Key
]
198 # it didnt exist. create it, cache it, then return it
199 cls
.__ObjectCache
[Key
] = super(AutoGen
, cls
).__new
__(cls
)
200 return cls
.__ObjectCache
[Key
]
202 def __init__ (self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
203 super(AutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
207 # The file path of platform file will be used to represent hash value of this object
209 # @retval int Hash value of the file path of platform file
212 return hash(self
.MetaFile
)
216 # The file path of platform file will be used to represent this object
218 # @retval string String of platform file path
221 return str(self
.MetaFile
)
224 def __eq__(self
, Other
):
225 return Other
and self
.MetaFile
== Other
227 ## Workspace AutoGen class
229 # This class is used mainly to control the whole platform build for different
230 # architecture. This class will generate top level makefile.
232 class WorkspaceAutoGen(AutoGen
):
233 # call super().__init__ then call the worker function with different parameter count
234 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
238 super(WorkspaceAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
239 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
242 ## Initialize WorkspaceAutoGen
244 # @param WorkspaceDir Root directory of workspace
245 # @param ActivePlatform Meta-file of active platform
246 # @param Target Build target
247 # @param Toolchain Tool chain name
248 # @param ArchList List of architecture of current build
249 # @param MetaFileDb Database containing meta-files
250 # @param BuildConfig Configuration of build
251 # @param ToolDefinition Tool chain definitions
252 # @param FlashDefinitionFile File of flash definition
253 # @param Fds FD list to be generated
254 # @param Fvs FV list to be generated
255 # @param Caps Capsule list to be generated
256 # @param SkuId SKU id from command line
258 def _InitWorker(self
, WorkspaceDir
, ActivePlatform
, Target
, Toolchain
, ArchList
, MetaFileDb
,
259 BuildConfig
, ToolDefinition
, FlashDefinitionFile
='', Fds
=None, Fvs
=None, Caps
=None, SkuId
='', UniFlag
=None,
260 Progress
=None, BuildModule
=None):
261 self
.BuildDatabase
= MetaFileDb
262 self
.MetaFile
= ActivePlatform
263 self
.WorkspaceDir
= WorkspaceDir
264 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, TAB_ARCH_COMMON
, Target
, Toolchain
]
265 GlobalData
.gActivePlatform
= self
.Platform
266 self
.BuildTarget
= Target
267 self
.ToolChain
= Toolchain
268 self
.ArchList
= ArchList
270 self
.UniFlag
= UniFlag
272 self
.TargetTxt
= BuildConfig
273 self
.ToolDef
= ToolDefinition
274 self
.FdfFile
= FlashDefinitionFile
275 self
.FdTargetList
= Fds
if Fds
else []
276 self
.FvTargetList
= Fvs
if Fvs
else []
277 self
.CapTargetList
= Caps
if Caps
else []
278 self
.AutoGenObjectList
= []
279 self
._BuildDir
= None
281 self
._MakeFileDir
= None
282 self
._BuildCommand
= None
285 # there's many relative directory operations, so ...
286 os
.chdir(self
.WorkspaceDir
)
291 if not self
.ArchList
:
292 ArchList
= set(self
.Platform
.SupArchList
)
294 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
296 EdkLogger
.error("build", PARAMETER_INVALID
,
297 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
298 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
299 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
300 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
301 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
302 self
.ArchList
= tuple(ArchList
)
304 # Validate build target
305 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
306 EdkLogger
.error("build", PARAMETER_INVALID
,
307 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
308 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
311 # parse FDF file to get PCDs in it, if any
313 self
.FdfFile
= self
.Platform
.FlashDefinition
317 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
318 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
319 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
321 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
323 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
326 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
328 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
331 Progress
.Start("\nProcessing meta-data")
335 # Mark now build in AutoGen Phase
337 GlobalData
.gAutoGenPhase
= True
338 Fdf
= FdfParser(self
.FdfFile
.Path
)
340 GlobalData
.gFdfParser
= Fdf
341 GlobalData
.gAutoGenPhase
= False
342 PcdSet
= Fdf
.Profile
.PcdDict
343 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
344 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
345 for FdRegion
in FdDict
.RegionList
:
346 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
347 if int(FdRegion
.Offset
) % 8 != 0:
348 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
349 ModuleList
= Fdf
.Profile
.InfList
350 self
.FdfProfile
= Fdf
.Profile
351 for fvname
in self
.FvTargetList
:
352 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
353 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
354 "No such an FV in FDF file: %s" % fvname
)
356 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
357 # but the path (self.MetaFile.Path) is the real path
358 for key
in self
.FdfProfile
.InfDict
:
360 MetaFile_cache
= defaultdict(set)
361 for Arch
in self
.ArchList
:
362 Current_Platform_cache
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
363 for Pkey
in Current_Platform_cache
.Modules
:
364 MetaFile_cache
[Arch
].add(Current_Platform_cache
.Modules
[Pkey
].MetaFile
)
365 for Inf
in self
.FdfProfile
.InfDict
[key
]:
366 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
367 for Arch
in self
.ArchList
:
368 if ModuleFile
in MetaFile_cache
[Arch
]:
371 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
372 if not ModuleData
.IsBinaryModule
:
373 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
376 for Arch
in self
.ArchList
:
378 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
380 for Pkey
in Platform
.Modules
:
381 MetaFileList
.add(Platform
.Modules
[Pkey
].MetaFile
)
382 for Inf
in self
.FdfProfile
.InfDict
[key
]:
383 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
384 if ModuleFile
in MetaFileList
:
386 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
387 if not ModuleData
.IsBinaryModule
:
388 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
393 self
.FdfProfile
= None
394 if self
.FdTargetList
:
395 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
396 self
.FdTargetList
= []
397 if self
.FvTargetList
:
398 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
399 self
.FvTargetList
= []
400 if self
.CapTargetList
:
401 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
402 self
.CapTargetList
= []
404 # apply SKU and inject PCDs from Flash Definition file
405 for Arch
in self
.ArchList
:
406 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
407 PlatformPcds
= Platform
.Pcds
408 self
._GuidDict
= Platform
._GuidDict
409 SourcePcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set(),TAB_PCDS_DYNAMIC
:set(),TAB_PCDS_FIXED_AT_BUILD
:set()}
410 BinaryPcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set()}
411 SourcePcdDict_Keys
= SourcePcdDict
.keys()
412 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
414 # generate the SourcePcdDict and BinaryPcdDict
415 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
416 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
417 if BuildData
.Arch
!= Arch
:
419 if BuildData
.MetaFile
.Ext
== '.inf':
420 for key
in BuildData
.Pcds
:
421 if BuildData
.Pcds
[key
].Pending
:
422 if key
in Platform
.Pcds
:
423 PcdInPlatform
= Platform
.Pcds
[key
]
424 if PcdInPlatform
.Type
:
425 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
426 BuildData
.Pcds
[key
].Pending
= False
428 if BuildData
.MetaFile
in Platform
.Modules
:
429 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
430 if key
in PlatformModule
.Pcds
:
431 PcdInPlatform
= PlatformModule
.Pcds
[key
]
432 if PcdInPlatform
.Type
:
433 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
434 BuildData
.Pcds
[key
].Pending
= False
436 if TAB_PCDS_DYNAMIC_EX
in BuildData
.Pcds
[key
].Type
:
437 if BuildData
.IsBinaryModule
:
438 BinaryPcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
440 SourcePcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
442 elif TAB_PCDS_PATCHABLE_IN_MODULE
in BuildData
.Pcds
[key
].Type
:
443 if BuildData
.MetaFile
.Ext
== '.inf':
444 if BuildData
.IsBinaryModule
:
445 BinaryPcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
447 SourcePcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
449 elif TAB_PCDS_DYNAMIC
in BuildData
.Pcds
[key
].Type
:
450 SourcePcdDict
[TAB_PCDS_DYNAMIC
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
451 elif TAB_PCDS_FIXED_AT_BUILD
in BuildData
.Pcds
[key
].Type
:
452 SourcePcdDict
[TAB_PCDS_FIXED_AT_BUILD
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
456 # A PCD can only use one type for all source modules
458 for i
in SourcePcdDict_Keys
:
459 for j
in SourcePcdDict_Keys
:
461 Intersections
= SourcePcdDict
[i
].intersection(SourcePcdDict
[j
])
462 if len(Intersections
) > 0:
466 "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
),
467 ExtraData
="%s" % '\n\t'.join(str(P
[1]+'.'+P
[0]) for P
in Intersections
)
471 # intersection the BinaryPCD for Mixed PCD
473 for i
in BinaryPcdDict_Keys
:
474 for j
in BinaryPcdDict_Keys
:
476 Intersections
= BinaryPcdDict
[i
].intersection(BinaryPcdDict
[j
])
477 for item
in Intersections
:
478 NewPcd1
= (item
[0] + '_' + i
, item
[1])
479 NewPcd2
= (item
[0] + '_' + j
, item
[1])
480 if item
not in GlobalData
.MixedPcd
:
481 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
483 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
484 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
485 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
486 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
489 # intersection the SourcePCD and BinaryPCD for Mixed PCD
491 for i
in SourcePcdDict_Keys
:
492 for j
in BinaryPcdDict_Keys
:
494 Intersections
= SourcePcdDict
[i
].intersection(BinaryPcdDict
[j
])
495 for item
in Intersections
:
496 NewPcd1
= (item
[0] + '_' + i
, item
[1])
497 NewPcd2
= (item
[0] + '_' + j
, item
[1])
498 if item
not in GlobalData
.MixedPcd
:
499 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
501 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
502 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
503 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
504 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
506 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
507 if BuildData
.Arch
!= Arch
:
509 for key
in BuildData
.Pcds
:
510 for SinglePcd
in GlobalData
.MixedPcd
:
511 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
512 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
513 Pcd_Type
= item
[0].split('_')[-1]
514 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 \
515 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in PCD_DYNAMIC_TYPE_SET
):
516 Value
= BuildData
.Pcds
[key
]
517 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
519 newkey
= (Value
.TokenCName
, key
[1])
521 newkey
= (Value
.TokenCName
, key
[1], key
[2])
522 del BuildData
.Pcds
[key
]
523 BuildData
.Pcds
[newkey
] = Value
527 # handle the mixed pcd in FDF file
529 if key
in GlobalData
.MixedPcd
:
532 for item
in GlobalData
.MixedPcd
[key
]:
535 #Collect package set information from INF of FDF
537 for Inf
in ModuleList
:
538 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
539 if ModuleFile
in Platform
.Modules
:
541 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
542 PkgSet
.update(ModuleData
.Packages
)
543 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
548 DecPcds
.add((Pcd
[0], Pcd
[1]))
549 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
551 Platform
.SkuName
= self
.SkuId
552 for Name
, Guid
in PcdSet
:
553 if (Name
, Guid
) not in DecPcds
:
557 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
558 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
559 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
562 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
563 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
564 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
565 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
566 Platform
.AddPcd(Name
, Guid
, PcdSet
[Name
, Guid
])
568 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
572 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
573 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
574 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
577 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
579 # Explicitly collect platform's dynamic PCDs
581 Pa
.CollectPlatformDynamicPcds()
582 Pa
.CollectFixedAtBuildPcds()
583 self
.AutoGenObjectList
.append(Pa
)
586 # Generate Package level hash value
588 GlobalData
.gPackageHash
[Arch
] = {}
589 if GlobalData
.gUseHashCache
:
591 self
._GenPkgLevelHash
(Pkg
)
594 # Check PCDs token value conflict in each DEC file.
596 self
._CheckAllPcdsTokenValueConflict
()
599 # Check PCD type and definition between DSC and DEC
601 self
._CheckPcdDefineAndType
()
604 # self._CheckDuplicateInFV(Fdf)
607 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
609 content
= 'gCommandLineDefines: '
610 content
+= str(GlobalData
.gCommandLineDefines
)
611 content
+= os
.linesep
612 content
+= 'BuildOptionPcd: '
613 content
+= str(GlobalData
.BuildOptionPcd
)
614 content
+= os
.linesep
615 content
+= 'Active Platform: '
616 content
+= str(self
.Platform
)
617 content
+= os
.linesep
619 content
+= 'Flash Image Definition: '
620 content
+= str(self
.FdfFile
)
621 content
+= os
.linesep
622 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
625 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
627 PcdTokenNumber
= 'PcdTokenNumber: '
628 if Pa
.PcdTokenNumber
:
629 if Pa
.DynamicPcdList
:
630 for Pcd
in Pa
.DynamicPcdList
:
631 PcdTokenNumber
+= os
.linesep
632 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
633 PcdTokenNumber
+= ' : '
634 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
635 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
638 # Get set of workspace metafiles
640 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
643 # Retrieve latest modified time of all metafiles
646 for f
in AllWorkSpaceMetaFiles
:
647 if os
.stat(f
)[8] > SrcTimeStamp
:
648 SrcTimeStamp
= os
.stat(f
)[8]
649 self
._SrcTimeStamp
= SrcTimeStamp
651 if GlobalData
.gUseHashCache
:
653 for files
in AllWorkSpaceMetaFiles
:
654 if files
.endswith('.dec'):
660 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
661 GlobalData
.gPlatformHash
= m
.hexdigest()
664 # Write metafile list to build directory
666 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
667 if os
.path
.exists (AutoGenFilePath
):
668 os
.remove(AutoGenFilePath
)
669 if not os
.path
.exists(self
.BuildDir
):
670 os
.makedirs(self
.BuildDir
)
671 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
672 for f
in AllWorkSpaceMetaFiles
:
676 def _GenPkgLevelHash(self
, Pkg
):
677 if Pkg
.PackageName
in GlobalData
.gPackageHash
[Pkg
.Arch
]:
680 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
681 CreateDirectory(PkgDir
)
682 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
684 # Get .dec file's hash value
685 f
= open(Pkg
.MetaFile
.Path
, 'r')
689 # Get include files hash value
691 for inc
in sorted(Pkg
.Includes
, key
=lambda x
: str(x
)):
692 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
693 for File
in sorted(Files
):
694 File_Path
= os
.path
.join(Root
, File
)
695 f
= open(File_Path
, 'r')
699 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
700 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
702 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
703 AllWorkSpaceMetaFiles
= set()
708 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
710 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
712 AllWorkSpaceMetaFiles
.add (f
.FileName
)
716 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
719 # add build_rule.txt & tools_def.txt
721 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
722 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
724 # add BuildOption metafile
726 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
728 # add PcdToken Number file for Dynamic/DynamicEx Pcd
730 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
732 for Arch
in self
.ArchList
:
733 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
734 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
739 for Package
in PGen
.PackageList
:
740 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
745 for filePath
in Platform
._RawData
.IncludedFiles
:
746 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
748 return AllWorkSpaceMetaFiles
750 ## _CheckDuplicateInFV() method
752 # Check whether there is duplicate modules/files exist in FV section.
753 # The check base on the file GUID;
755 def _CheckDuplicateInFV(self
, Fdf
):
756 for Fv
in Fdf
.Profile
.FvDict
:
758 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
759 if FfsFile
.InfFileName
and FfsFile
.NameGuid
is None:
764 for Pa
in self
.AutoGenObjectList
:
767 for Module
in Pa
.ModuleAutoGenList
:
768 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
770 if Module
.Guid
.upper() not in _GuidDict
:
771 _GuidDict
[Module
.Guid
.upper()] = FfsFile
774 EdkLogger
.error("build",
776 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
777 FfsFile
.CurrentLineContent
,
778 _GuidDict
[Module
.Guid
.upper()].CurrentLineNum
,
779 _GuidDict
[Module
.Guid
.upper()].CurrentLineContent
,
780 Module
.Guid
.upper()),
781 ExtraData
=self
.FdfFile
)
783 # Some INF files not have entity in DSC file.
786 if FfsFile
.InfFileName
.find('$') == -1:
787 InfPath
= NormPath(FfsFile
.InfFileName
)
788 if not os
.path
.exists(InfPath
):
789 EdkLogger
.error('build', GENFDS_ERROR
, "Non-existant Module %s !" % (FfsFile
.InfFileName
))
791 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
793 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
794 # BuildObject from one of AutoGenObjectList is enough.
796 InfObj
= self
.AutoGenObjectList
[0].BuildDatabase
.WorkspaceDb
.BuildObject
[PathClassObj
, TAB_ARCH_COMMON
, self
.BuildTarget
, self
.ToolChain
]
797 if InfObj
.Guid
.upper() not in _GuidDict
:
798 _GuidDict
[InfObj
.Guid
.upper()] = FfsFile
800 EdkLogger
.error("build",
802 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
803 FfsFile
.CurrentLineContent
,
804 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineNum
,
805 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineContent
,
806 InfObj
.Guid
.upper()),
807 ExtraData
=self
.FdfFile
)
810 if FfsFile
.NameGuid
is not None:
812 # If the NameGuid reference a PCD name.
813 # The style must match: PCD(xxxx.yyy)
815 if gPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
817 # Replace the PCD value.
819 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
821 for Pa
in self
.AutoGenObjectList
:
823 for PcdItem
in Pa
.AllPcdList
:
824 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
826 # First convert from CFormatGuid to GUID string
828 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
830 if not _PcdGuidString
:
832 # Then try Byte array.
834 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
836 if not _PcdGuidString
:
838 # Not Byte array or CFormat GUID, raise error.
840 EdkLogger
.error("build",
842 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
843 ExtraData
=self
.FdfFile
)
845 if _PcdGuidString
.upper() not in _GuidDict
:
846 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
850 EdkLogger
.error("build",
852 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
853 FfsFile
.CurrentLineContent
,
854 _GuidDict
[_PcdGuidString
.upper()].CurrentLineNum
,
855 _GuidDict
[_PcdGuidString
.upper()].CurrentLineContent
,
856 FfsFile
.NameGuid
.upper()),
857 ExtraData
=self
.FdfFile
)
859 if FfsFile
.NameGuid
.upper() not in _GuidDict
:
860 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
863 # Two raw file GUID conflict.
865 EdkLogger
.error("build",
867 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
868 FfsFile
.CurrentLineContent
,
869 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineNum
,
870 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineContent
,
871 FfsFile
.NameGuid
.upper()),
872 ExtraData
=self
.FdfFile
)
875 def _CheckPcdDefineAndType(self
):
877 TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_PATCHABLE_IN_MODULE
, TAB_PCDS_FEATURE_FLAG
,
878 TAB_PCDS_DYNAMIC
, #TAB_PCDS_DYNAMIC_HII, TAB_PCDS_DYNAMIC_VPD,
879 TAB_PCDS_DYNAMIC_EX
, # TAB_PCDS_DYNAMIC_EX_HII, TAB_PCDS_DYNAMIC_EX_VPD
882 # This dict store PCDs which are not used by any modules with specified arches
883 UnusedPcd
= OrderedDict()
884 for Pa
in self
.AutoGenObjectList
:
885 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
886 for Pcd
in Pa
.Platform
.Pcds
:
887 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
889 # If no PCD type, this PCD comes from FDF
893 # Try to remove Hii and Vpd suffix
894 if PcdType
.startswith(TAB_PCDS_DYNAMIC_EX
):
895 PcdType
= TAB_PCDS_DYNAMIC_EX
896 elif PcdType
.startswith(TAB_PCDS_DYNAMIC
):
897 PcdType
= TAB_PCDS_DYNAMIC
899 for Package
in Pa
.PackageList
:
900 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
901 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
903 for Type
in PcdTypeList
:
904 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
908 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
909 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
914 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
916 for Pcd
in UnusedPcd
:
919 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
920 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
921 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
926 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
928 ## Return the directory to store FV files
930 if self
._FvDir
is None:
931 self
._FvDir
= path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
)
934 ## Return the directory to store all intermediate and final files built
935 def _GetBuildDir(self
):
936 if self
._BuildDir
is None:
937 return self
.AutoGenObjectList
[0].BuildDir
939 ## Return the build output directory platform specifies
940 def _GetOutputDir(self
):
941 return self
.Platform
.OutputDirectory
943 ## Return platform name
945 return self
.Platform
.PlatformName
947 ## Return meta-file GUID
949 return self
.Platform
.Guid
951 ## Return platform version
952 def _GetVersion(self
):
953 return self
.Platform
.Version
955 ## Return paths of tools
956 def _GetToolDefinition(self
):
957 return self
.AutoGenObjectList
[0].ToolDefinition
959 ## Return directory of platform makefile
961 # @retval string Makefile directory
963 def _GetMakeFileDir(self
):
964 if self
._MakeFileDir
is None:
965 self
._MakeFileDir
= self
.BuildDir
966 return self
._MakeFileDir
968 ## Return build command string
970 # @retval string Build command string
972 def _GetBuildCommand(self
):
973 if self
._BuildCommand
is None:
974 # BuildCommand should be all the same. So just get one from platform AutoGen
975 self
._BuildCommand
= self
.AutoGenObjectList
[0].BuildCommand
976 return self
._BuildCommand
978 ## Check the PCDs token value conflict in each DEC file.
980 # Will cause build break and raise error message while two PCDs conflict.
984 def _CheckAllPcdsTokenValueConflict(self
):
985 for Pa
in self
.AutoGenObjectList
:
986 for Package
in Pa
.PackageList
:
987 PcdList
= Package
.Pcds
.values()
988 PcdList
.sort(lambda x
, y
: cmp(int(x
.TokenValue
, 0), int(y
.TokenValue
, 0)))
990 while (Count
< len(PcdList
) - 1) :
991 Item
= PcdList
[Count
]
992 ItemNext
= PcdList
[Count
+ 1]
994 # Make sure in the same token space the TokenValue should be unique
996 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
997 SameTokenValuePcdList
= []
998 SameTokenValuePcdList
.append(Item
)
999 SameTokenValuePcdList
.append(ItemNext
)
1000 RemainPcdListLength
= len(PcdList
) - Count
- 2
1001 for ValueSameCount
in range(RemainPcdListLength
):
1002 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
1003 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
1007 # Sort same token value PCD list with TokenGuid and TokenCName
1009 SameTokenValuePcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1010 SameTokenValuePcdListCount
= 0
1011 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
1013 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1014 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
1016 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
1017 for PcdItem
in GlobalData
.MixedPcd
:
1018 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
1019 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1025 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1026 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
1029 SameTokenValuePcdListCount
+= 1
1030 Count
+= SameTokenValuePcdListCount
1033 PcdList
= Package
.Pcds
.values()
1034 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1036 while (Count
< len(PcdList
) - 1) :
1037 Item
= PcdList
[Count
]
1038 ItemNext
= PcdList
[Count
+ 1]
1040 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1042 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
1046 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1047 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
1051 ## Generate fds command
1052 def _GenFdsCommand(self
):
1053 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1055 ## Create makefile for the platform and modules in it
1057 # @param CreateDepsMakeFile Flag indicating if the makefile for
1058 # modules will be created as well
1060 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1061 if CreateDepsMakeFile
:
1062 for Pa
in self
.AutoGenObjectList
:
1063 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1065 ## Create autogen code for platform and modules
1067 # Since there's no autogen code for platform, this method will do nothing
1068 # if CreateModuleCodeFile is set to False.
1070 # @param CreateDepsCodeFile Flag indicating if creating module's
1071 # autogen code file or not
1073 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1074 if not CreateDepsCodeFile
:
1076 for Pa
in self
.AutoGenObjectList
:
1077 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1079 ## Create AsBuilt INF file the platform
1081 def CreateAsBuiltInf(self
):
1084 Name
= property(_GetName
)
1085 Guid
= property(_GetGuid
)
1086 Version
= property(_GetVersion
)
1087 OutputDir
= property(_GetOutputDir
)
1089 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1091 BuildDir
= property(_GetBuildDir
)
1092 FvDir
= property(_GetFvDir
)
1093 MakeFileDir
= property(_GetMakeFileDir
)
1094 BuildCommand
= property(_GetBuildCommand
)
1095 GenFdsCommand
= property(_GenFdsCommand
)
1097 ## AutoGen class for platform
1099 # PlatformAutoGen class will process the original information in platform
1100 # file in order to generate makefile for platform.
1102 class PlatformAutoGen(AutoGen
):
1103 # call super().__init__ then call the worker function with different parameter count
1104 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
1108 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
1109 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
1112 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1113 # correct PCD database
1116 _NonDynaPcdList_
= []
1120 # The priority list while override build option
1122 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1123 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1124 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1125 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1126 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1127 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1128 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1129 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1130 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1131 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1132 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1133 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1134 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1135 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1136 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1137 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1139 ## Initialize PlatformAutoGen
1142 # @param Workspace WorkspaceAutoGen object
1143 # @param PlatformFile Platform file (DSC file)
1144 # @param Target Build target (DEBUG, RELEASE)
1145 # @param Toolchain Name of tool chain
1146 # @param Arch arch of the platform supports
1148 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1149 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1150 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1152 self
.MetaFile
= PlatformFile
1153 self
.Workspace
= Workspace
1154 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1155 self
.ToolChain
= Toolchain
1156 self
.BuildTarget
= Target
1158 self
.SourceDir
= PlatformFile
.SubDir
1159 self
.SourceOverrideDir
= None
1160 self
.FdTargetList
= self
.Workspace
.FdTargetList
1161 self
.FvTargetList
= self
.Workspace
.FvTargetList
1162 self
.AllPcdList
= []
1163 # get the original module/package/platform objects
1164 self
.BuildDatabase
= Workspace
.BuildDatabase
1165 self
.DscBuildDataObj
= Workspace
.Platform
1166 self
._GuidDict
= Workspace
._GuidDict
1168 # flag indicating if the makefile/C-code file has been created or not
1169 self
.IsMakeFileCreated
= False
1170 self
.IsCodeFileCreated
= False
1172 self
._Platform
= None
1175 self
._Version
= None
1177 self
._BuildRule
= None
1178 self
._SourceDir
= None
1179 self
._BuildDir
= None
1180 self
._OutputDir
= None
1182 self
._MakeFileDir
= None
1183 self
._FdfFile
= None
1185 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1186 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1187 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1188 self
._NonDynamicPcdDict
= {}
1190 self
._ToolDefinitions
= None
1191 self
._ToolDefFile
= None # toolcode : tool path
1192 self
._ToolChainFamily
= None
1193 self
._BuildRuleFamily
= None
1194 self
._BuildOption
= None # toolcode : option
1195 self
._EdkBuildOption
= None # edktoolcode : option
1196 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1197 self
._PackageList
= None
1198 self
._ModuleAutoGenList
= None
1199 self
._LibraryAutoGenList
= None
1200 self
._BuildCommand
= None
1201 self
._AsBuildInfList
= []
1202 self
._AsBuildModuleList
= []
1204 self
.VariableInfo
= None
1206 if GlobalData
.gFdfParser
is not None:
1207 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1208 for Inf
in self
._AsBuildInfList
:
1209 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1210 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1211 if not M
.IsSupportedArch
:
1213 self
._AsBuildModuleList
.append(InfClass
)
1214 # get library/modules for build
1215 self
.LibraryBuildDirectoryList
= []
1216 self
.ModuleBuildDirectoryList
= []
1221 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1223 ## Create autogen code for platform and modules
1225 # Since there's no autogen code for platform, this method will do nothing
1226 # if CreateModuleCodeFile is set to False.
1228 # @param CreateModuleCodeFile Flag indicating if creating module's
1229 # autogen code file or not
1231 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1232 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1233 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1236 for Ma
in self
.ModuleAutoGenList
:
1237 Ma
.CreateCodeFile(True)
1239 # don't do this twice
1240 self
.IsCodeFileCreated
= True
1242 ## Generate Fds Command
1243 def _GenFdsCommand(self
):
1244 return self
.Workspace
.GenFdsCommand
1246 ## Create makefile for the platform and mdoules in it
1248 # @param CreateModuleMakeFile Flag indicating if the makefile for
1249 # modules will be created as well
1251 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1252 if CreateModuleMakeFile
:
1253 for ModuleFile
in self
.Platform
.Modules
:
1254 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1255 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1256 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1257 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1259 Ma
.CreateMakeFile(True)
1260 #Ma.CreateAsBuiltInf()
1262 # no need to create makefile for the platform more than once
1263 if self
.IsMakeFileCreated
:
1266 # create library/module build dirs for platform
1267 Makefile
= GenMake
.PlatformMakefile(self
)
1268 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1269 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1271 self
.IsMakeFileCreated
= True
1273 ## Deal with Shared FixedAtBuild Pcds
1275 def CollectFixedAtBuildPcds(self
):
1276 for LibAuto
in self
.LibraryAutoGenList
:
1277 FixedAtBuildPcds
= {}
1278 ShareFixedAtBuildPcdsSameValue
= {}
1279 for Module
in LibAuto
._ReferenceModules
:
1280 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1281 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1282 if key
not in FixedAtBuildPcds
:
1283 ShareFixedAtBuildPcdsSameValue
[key
] = True
1284 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1286 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1287 ShareFixedAtBuildPcdsSameValue
[key
] = False
1288 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1289 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1290 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1293 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1294 if DscPcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
1296 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1297 LibAuto
.ConstPcd
[key
] = FixedAtBuildPcds
[key
]
1299 def CollectVariables(self
, DynamicPcdSet
):
1303 if self
.Workspace
.FdfFile
:
1304 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1305 for FdRegion
in FdDict
.RegionList
:
1306 for item
in FdRegion
.RegionDataList
:
1307 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1308 VpdRegionSize
= FdRegion
.Size
1309 VpdRegionBase
= FdRegion
.Offset
1313 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1314 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1315 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1317 for Pcd
in DynamicPcdSet
:
1318 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1319 for SkuName
in Pcd
.SkuInfoList
:
1320 Sku
= Pcd
.SkuInfoList
[SkuName
]
1322 if SkuId
is None or SkuId
== '':
1324 if len(Sku
.VariableName
) > 0:
1325 VariableGuidStructure
= Sku
.VariableGuidValue
1326 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1327 for StorageName
in Sku
.DefaultStoreDict
:
1328 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1332 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1333 if self
.VariableInfo
:
1334 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1335 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1337 if PcdNvStoreDfBuffer
:
1338 if os
.path
.exists(VpdMapFilePath
):
1339 OrgVpdFile
.Read(VpdMapFilePath
)
1340 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1341 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1343 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1345 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1346 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get(TAB_DEFAULT
)
1347 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1348 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1350 if var_data
and default_skuobj
:
1351 default_skuobj
.DefaultValue
= var_data
1352 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1353 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1354 PcdNvStoreDfBuffer
[0].SkuInfoList
[TAB_DEFAULT
] = default_skuobj
1355 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1359 ## Collect dynamic PCDs
1361 # Gather dynamic PCDs list from each module and their settings from platform
1362 # This interface should be invoked explicitly when platform action is created.
1364 def CollectPlatformDynamicPcds(self
):
1366 for key
in self
.Platform
.Pcds
:
1367 for SinglePcd
in GlobalData
.MixedPcd
:
1368 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1369 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1370 Pcd_Type
= item
[0].split('_')[-1]
1371 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 \
1372 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in PCD_DYNAMIC_TYPE_SET
):
1373 Value
= self
.Platform
.Pcds
[key
]
1374 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1376 newkey
= (Value
.TokenCName
, key
[1])
1378 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1379 del self
.Platform
.Pcds
[key
]
1380 self
.Platform
.Pcds
[newkey
] = Value
1388 # for gathering error information
1389 NoDatumTypePcdList
= set()
1391 for InfName
in self
._AsBuildInfList
:
1392 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1393 FdfModuleList
.append(os
.path
.normpath(InfName
))
1394 for F
in self
.Platform
.Modules
.keys():
1395 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1396 #GuidValue.update(M.Guids)
1398 self
.Platform
.Modules
[F
].M
= M
1400 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1401 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1402 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1403 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1405 # Check the PCD from Binary INF or Source INF
1406 if M
.IsBinaryModule
== True:
1407 PcdFromModule
.IsFromBinaryInf
= True
1409 # Check the PCD from DSC or not
1410 PcdFromModule
.IsFromDsc
= (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
1412 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
or PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1413 if F
.Path
not in FdfModuleList
:
1414 # If one of the Source built modules listed in the DSC is not listed
1415 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1416 # access method (it is only listed in the DEC file that declares the
1417 # PCD as PcdsDynamic), then build tool will report warning message
1418 # notify the PI that they are attempting to build a module that must
1419 # be included in a flash image in order to be functional. These Dynamic
1420 # PCD will not be added into the Database unless it is used by other
1421 # modules that are included in the FDF file.
1422 if PcdFromModule
.Type
in PCD_DYNAMIC_TYPE_SET
and \
1423 PcdFromModule
.IsFromBinaryInf
== False:
1424 # Print warning message to let the developer make a determine.
1426 # If one of the Source built modules listed in the DSC is not listed in
1427 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1428 # access method (it is only listed in the DEC file that declares the
1429 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1430 # PCD to the Platform's PCD Database.
1431 if PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1434 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1435 # it should be stored in Pcd PEI database, If a dynamic only
1436 # used by DXE module, it should be stored in DXE PCD database.
1437 # The default Phase is DXE
1439 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1440 PcdFromModule
.Phase
= "PEI"
1441 if PcdFromModule
not in self
._DynaPcdList
_:
1442 self
._DynaPcdList
_.append(PcdFromModule
)
1443 elif PcdFromModule
.Phase
== 'PEI':
1444 # overwrite any the same PCD existing, if Phase is PEI
1445 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1446 self
._DynaPcdList
_[Index
] = PcdFromModule
1447 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1448 self
._NonDynaPcdList
_.append(PcdFromModule
)
1449 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1450 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1451 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1452 #The PCD from Binary INF will override the same one from source INF
1453 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1454 PcdFromModule
.Pending
= False
1455 self
._NonDynaPcdList
_.append (PcdFromModule
)
1456 DscModuleSet
= {os
.path
.normpath(ModuleInf
.Path
) for ModuleInf
in self
.Platform
.Modules
}
1457 # add the PCD from modules that listed in FDF but not in DSC to Database
1458 for InfName
in FdfModuleList
:
1459 if InfName
not in DscModuleSet
:
1460 InfClass
= PathClass(InfName
)
1461 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1462 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1463 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1464 # For binary module, if in current arch, we need to list the PCDs into database.
1465 if not M
.IsSupportedArch
:
1467 # Override the module PCD setting by platform setting
1468 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1469 for PcdFromModule
in ModulePcdList
:
1470 PcdFromModule
.IsFromBinaryInf
= True
1471 PcdFromModule
.IsFromDsc
= False
1472 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1473 if PcdFromModule
.Type
not in PCD_DYNAMIC_EX_TYPE_SET
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1474 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1476 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1477 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1478 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1479 if PcdFromModule
.DatumType
== TAB_VOID
and not PcdFromModule
.MaxDatumSize
:
1480 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1481 if M
.ModuleType
in SUP_MODULE_SET_PEI
:
1482 PcdFromModule
.Phase
= "PEI"
1483 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1484 self
._DynaPcdList
_.append(PcdFromModule
)
1485 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1486 self
._NonDynaPcdList
_.append(PcdFromModule
)
1487 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1488 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1489 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1490 # module & DXE module at a same time.
1491 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1492 # INF file as DynamicEx.
1493 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1494 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1495 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1496 for PcdFromModule
in self
._NonDynaPcdList
_:
1497 # If a PCD is not listed in the DSC file, but binary INF files used by
1498 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1499 # section, AND all source INF files used by this platform the build
1500 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1501 # section, then the tools must NOT add the PCD to the Platform's PCD
1502 # Database; the build must assign the access method for this PCD as
1503 # PcdsPatchableInModule.
1504 if PcdFromModule
not in self
._DynaPcdList
_:
1506 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1507 if PcdFromModule
.IsFromDsc
== False and \
1508 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1509 PcdFromModule
.IsFromBinaryInf
== True and \
1510 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1511 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1512 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1514 # print out error information and break the build, if error found
1515 if len(NoDatumTypePcdList
) > 0:
1516 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1517 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1519 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1520 % NoDatumTypePcdListString
)
1521 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1522 self
._DynamicPcdList
= self
._DynaPcdList
_
1524 # Sort dynamic PCD list to:
1525 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1526 # try to be put header of dynamicd List
1527 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1529 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1531 UnicodePcdArray
= set()
1533 OtherPcdArray
= set()
1535 VpdFile
= VpdInfoFile
.VpdInfoFile()
1536 NeedProcessVpdMapFile
= False
1538 for pcd
in self
.Platform
.Pcds
:
1539 if pcd
not in self
._PlatformPcds
:
1540 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1542 for item
in self
._PlatformPcds
:
1543 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1544 self
._PlatformPcds
[item
].DatumType
= TAB_VOID
1546 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1547 for Pcd
in self
._DynamicPcdList
:
1548 # just pick the a value to determine whether is unicode string type
1549 Sku
= Pcd
.SkuInfoList
.values()[0]
1550 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1552 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1553 Pcd
.DatumType
= TAB_VOID
1555 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1556 # if found HII type PCD then insert to right of UnicodeIndex
1557 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1558 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1560 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1561 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1562 if PcdNvStoreDfBuffer
:
1563 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1564 vardump
= self
.VariableInfo
.dump()
1566 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1567 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1568 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1569 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1571 PlatformPcds
= self
._PlatformPcds
.keys()
1574 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1577 for PcdKey
in PlatformPcds
:
1578 Pcd
= self
._PlatformPcds
[PcdKey
]
1579 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1580 PcdKey
in VpdPcdDict
:
1581 Pcd
= VpdPcdDict
[PcdKey
]
1583 DefaultSku
= Pcd
.SkuInfoList
.get(TAB_DEFAULT
)
1585 PcdValue
= DefaultSku
.DefaultValue
1586 if PcdValue
not in SkuValueMap
:
1587 SkuValueMap
[PcdValue
] = []
1588 VpdFile
.Add(Pcd
, TAB_DEFAULT
,DefaultSku
.VpdOffset
)
1589 SkuValueMap
[PcdValue
].append(DefaultSku
)
1591 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1592 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1593 PcdValue
= Sku
.DefaultValue
1595 PcdValue
= Pcd
.DefaultValue
1596 if Sku
.VpdOffset
!= '*':
1597 if PcdValue
.startswith("{"):
1599 elif PcdValue
.startswith("L"):
1604 VpdOffset
= int(Sku
.VpdOffset
)
1607 VpdOffset
= int(Sku
.VpdOffset
, 16)
1609 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1610 if VpdOffset
% Alignment
!= 0:
1611 if PcdValue
.startswith("{"):
1612 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1614 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1615 if PcdValue
not in SkuValueMap
:
1616 SkuValueMap
[PcdValue
] = []
1617 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1618 SkuValueMap
[PcdValue
].append(Sku
)
1619 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1620 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1621 NeedProcessVpdMapFile
= True
1622 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1623 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1624 "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.")
1626 VpdSkuMap
[PcdKey
] = SkuValueMap
1628 # Fix the PCDs define in VPD PCD section that never referenced by module.
1629 # An example is PCD for signature usage.
1631 for DscPcd
in PlatformPcds
:
1632 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1633 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1634 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1636 for VpdPcd
in VpdFile
._VpdArray
:
1637 # This PCD has been referenced by module
1638 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1639 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1642 # Not found, it should be signature
1644 # just pick the a value to determine whether is unicode string type
1646 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1647 DefaultSku
= DscPcdEntry
.SkuInfoList
.get(TAB_DEFAULT
)
1649 defaultindex
= SkuObjList
.index((TAB_DEFAULT
,DefaultSku
))
1650 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1651 for (SkuName
,Sku
) in SkuObjList
:
1652 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1654 # Need to iterate DEC pcd information to get the value & datumtype
1655 for eachDec
in self
.PackageList
:
1656 for DecPcd
in eachDec
.Pcds
:
1657 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1658 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1659 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1660 # Print warning message to let the developer make a determine.
1661 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1662 File
=self
.MetaFile
, \
1663 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1664 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1666 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1667 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1668 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1669 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1670 # Only fix the value while no value provided in DSC file.
1671 if not Sku
.DefaultValue
:
1672 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1674 if DscPcdEntry
not in self
._DynamicPcdList
:
1675 self
._DynamicPcdList
.append(DscPcdEntry
)
1676 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1677 PcdValue
= Sku
.DefaultValue
1679 PcdValue
= DscPcdEntry
.DefaultValue
1680 if Sku
.VpdOffset
!= '*':
1681 if PcdValue
.startswith("{"):
1683 elif PcdValue
.startswith("L"):
1688 VpdOffset
= int(Sku
.VpdOffset
)
1691 VpdOffset
= int(Sku
.VpdOffset
, 16)
1693 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1694 if VpdOffset
% Alignment
!= 0:
1695 if PcdValue
.startswith("{"):
1696 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1698 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1699 if PcdValue
not in SkuValueMap
:
1700 SkuValueMap
[PcdValue
] = []
1701 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1702 SkuValueMap
[PcdValue
].append(Sku
)
1703 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1704 NeedProcessVpdMapFile
= True
1705 if DscPcdEntry
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1706 UnicodePcdArray
.add(DscPcdEntry
)
1707 elif len(Sku
.VariableName
) > 0:
1708 HiiPcdArray
.add(DscPcdEntry
)
1710 OtherPcdArray
.add(DscPcdEntry
)
1712 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1713 VpdSkuMap
[DscPcd
] = SkuValueMap
1714 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1715 VpdFile
.GetCount() != 0:
1716 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1717 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1719 if VpdFile
.GetCount() != 0:
1721 self
.FixVpdOffset(VpdFile
)
1723 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1725 # Process VPD map file generated by third party BPDG tool
1726 if NeedProcessVpdMapFile
:
1727 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
, "%s.map" % self
.Platform
.VpdToolGuid
)
1728 if os
.path
.exists(VpdMapFilePath
):
1729 VpdFile
.Read(VpdMapFilePath
)
1732 for pcd
in VpdSkuMap
:
1733 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1735 # just pick the a value to determine whether is unicode string type
1737 for pcdvalue
in VpdSkuMap
[pcd
]:
1738 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1739 for item
in vpdinfo
:
1740 if item
[2] == pcdvalue
:
1741 sku
.VpdOffset
= item
[1]
1743 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1745 # Delete the DynamicPcdList At the last time enter into this function
1746 for Pcd
in self
._DynamicPcdList
:
1747 # just pick the a value to determine whether is unicode string type
1748 Sku
= Pcd
.SkuInfoList
.values()[0]
1749 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1751 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1752 Pcd
.DatumType
= TAB_VOID
1754 PcdValue
= Sku
.DefaultValue
1755 if Pcd
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1756 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1757 UnicodePcdArray
.add(Pcd
)
1758 elif len(Sku
.VariableName
) > 0:
1759 # if found HII type PCD then insert to right of UnicodeIndex
1760 HiiPcdArray
.add(Pcd
)
1762 OtherPcdArray
.add(Pcd
)
1763 del self
._DynamicPcdList
[:]
1764 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1765 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1766 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1767 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1768 for pcd
in self
._DynamicPcdList
:
1769 if len(pcd
.SkuInfoList
) == 1:
1770 for (SkuName
,SkuId
) in allskuset
:
1771 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1773 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
[TAB_DEFAULT
])
1774 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1775 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1777 def FixVpdOffset(self
,VpdFile
):
1778 FvPath
= os
.path
.join(self
.BuildDir
, TAB_FV_DIRECTORY
)
1779 if not os
.path
.exists(FvPath
):
1783 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1785 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1787 if VpdFile
.Write(VpdFilePath
):
1788 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1790 for ToolDef
in self
.ToolDefinition
.values():
1791 if ToolDef
.has_key(TAB_GUID
) and ToolDef
[TAB_GUID
] == self
.Platform
.VpdToolGuid
:
1792 if not ToolDef
.has_key("PATH"):
1793 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1794 BPDGToolName
= ToolDef
["PATH"]
1796 # Call third party GUID BPDG tool.
1797 if BPDGToolName
is not None:
1798 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1800 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.")
1802 ## Return the platform build data object
1803 def _GetPlatform(self
):
1804 if self
._Platform
is None:
1805 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1806 return self
._Platform
1808 ## Return platform name
1810 return self
.Platform
.PlatformName
1812 ## Return the meta file GUID
1814 return self
.Platform
.Guid
1816 ## Return the platform version
1817 def _GetVersion(self
):
1818 return self
.Platform
.Version
1820 ## Return the FDF file name
1821 def _GetFdfFile(self
):
1822 if self
._FdfFile
is None:
1823 if self
.Workspace
.FdfFile
!= "":
1824 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1827 return self
._FdfFile
1829 ## Return the build output directory platform specifies
1830 def _GetOutputDir(self
):
1831 return self
.Platform
.OutputDirectory
1833 ## Return the directory to store all intermediate and final files built
1834 def _GetBuildDir(self
):
1835 if self
._BuildDir
is None:
1836 if os
.path
.isabs(self
.OutputDir
):
1837 self
._BuildDir
= path
.join(
1838 path
.abspath(self
.OutputDir
),
1839 self
.BuildTarget
+ "_" + self
.ToolChain
,
1842 self
._BuildDir
= path
.join(
1845 self
.BuildTarget
+ "_" + self
.ToolChain
,
1847 GlobalData
.gBuildDirectory
= self
._BuildDir
1848 return self
._BuildDir
1850 ## Return directory of platform makefile
1852 # @retval string Makefile directory
1854 def _GetMakeFileDir(self
):
1855 if self
._MakeFileDir
is None:
1856 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1857 return self
._MakeFileDir
1859 ## Return build command string
1861 # @retval string Build command string
1863 def _GetBuildCommand(self
):
1864 if self
._BuildCommand
is None:
1865 self
._BuildCommand
= []
1866 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1867 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1868 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1869 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1871 self
._BuildCommand
+= SplitOption(NewOption
)
1872 if "MAKE" in self
.EdkIIBuildOption
:
1873 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1874 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1875 if Flags
.startswith('='):
1876 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1878 self
._BuildCommand
+= [Flags
]
1879 return self
._BuildCommand
1881 ## Get tool chain definition
1883 # Get each tool defition for given tool chain from tools_def.txt and platform
1885 def _GetToolDefinition(self
):
1886 if self
._ToolDefinitions
is None:
1887 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1888 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1889 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1890 ExtraData
="[%s]" % self
.MetaFile
)
1891 self
._ToolDefinitions
= {}
1893 for Def
in ToolDefinition
:
1894 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1895 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1898 Value
= ToolDefinition
[Def
]
1899 # don't record the DLL
1901 DllPathList
.add(Value
)
1904 if Tool
not in self
._ToolDefinitions
:
1905 self
._ToolDefinitions
[Tool
] = {}
1906 self
._ToolDefinitions
[Tool
][Attr
] = Value
1909 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1910 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1911 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1912 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1914 for Tool
in self
._ToolDefinitions
:
1915 for Attr
in self
._ToolDefinitions
[Tool
]:
1916 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1917 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1918 # check if override is indicated
1919 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1920 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1923 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1925 Value
= self
.BuildOption
[Tool
][Attr
]
1928 # Don't put MAKE definition in the file
1930 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1932 # Don't put MAKE definition in the file
1937 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1940 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1941 for DllPath
in DllPathList
:
1942 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1943 os
.environ
["MAKE_FLAGS"] = MakeFlags
1945 return self
._ToolDefinitions
1947 ## Return the paths of tools
1948 def _GetToolDefFile(self
):
1949 if self
._ToolDefFile
is None:
1950 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1951 return self
._ToolDefFile
1953 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1954 def _GetToolChainFamily(self
):
1955 if self
._ToolChainFamily
is None:
1956 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1957 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1958 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1959 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1960 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1962 self
._ToolChainFamily
= "MSFT"
1964 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1965 return self
._ToolChainFamily
1967 def _GetBuildRuleFamily(self
):
1968 if self
._BuildRuleFamily
is None:
1969 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1970 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1971 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1972 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1973 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1975 self
._BuildRuleFamily
= "MSFT"
1977 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1978 return self
._BuildRuleFamily
1980 ## Return the build options specific for all modules in this platform
1981 def _GetBuildOptions(self
):
1982 if self
._BuildOption
is None:
1983 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1984 return self
._BuildOption
1986 ## Return the build options specific for EDK modules in this platform
1987 def _GetEdkBuildOptions(self
):
1988 if self
._EdkBuildOption
is None:
1989 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1990 return self
._EdkBuildOption
1992 ## Return the build options specific for EDKII modules in this platform
1993 def _GetEdkIIBuildOptions(self
):
1994 if self
._EdkIIBuildOption
is None:
1995 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1996 return self
._EdkIIBuildOption
1998 ## Parse build_rule.txt in Conf Directory.
2000 # @retval BuildRule object
2002 def _GetBuildRule(self
):
2003 if self
._BuildRule
is None:
2004 BuildRuleFile
= None
2005 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2006 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2007 if not BuildRuleFile
:
2008 BuildRuleFile
= gDefaultBuildRuleFile
2009 self
._BuildRule
= BuildRule(BuildRuleFile
)
2010 if self
._BuildRule
._FileVersion
== "":
2011 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2013 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2014 # If Build Rule's version is less than the version number required by the tools, halting the build.
2015 EdkLogger
.error("build", AUTOGEN_ERROR
,
2016 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])"\
2017 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2019 return self
._BuildRule
2021 ## Summarize the packages used by modules in this platform
2022 def _GetPackageList(self
):
2023 if self
._PackageList
is None:
2024 self
._PackageList
= set()
2025 for La
in self
.LibraryAutoGenList
:
2026 self
._PackageList
.update(La
.DependentPackageList
)
2027 for Ma
in self
.ModuleAutoGenList
:
2028 self
._PackageList
.update(Ma
.DependentPackageList
)
2029 #Collect package set information from INF of FDF
2031 for ModuleFile
in self
._AsBuildModuleList
:
2032 if ModuleFile
in self
.Platform
.Modules
:
2034 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2035 PkgSet
.update(ModuleData
.Packages
)
2036 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2037 return self
._PackageList
2039 def _GetNonDynamicPcdDict(self
):
2040 if self
._NonDynamicPcdDict
:
2041 return self
._NonDynamicPcdDict
2042 for Pcd
in self
.NonDynamicPcdList
:
2043 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2044 return self
._NonDynamicPcdDict
2046 ## Get list of non-dynamic PCDs
2047 def _GetNonDynamicPcdList(self
):
2048 if self
._NonDynamicPcdList
is None:
2049 self
.CollectPlatformDynamicPcds()
2050 return self
._NonDynamicPcdList
2052 ## Get list of dynamic PCDs
2053 def _GetDynamicPcdList(self
):
2054 if self
._DynamicPcdList
is None:
2055 self
.CollectPlatformDynamicPcds()
2056 return self
._DynamicPcdList
2058 ## Generate Token Number for all PCD
2059 def _GetPcdTokenNumbers(self
):
2060 if self
._PcdTokenNumber
is None:
2061 self
._PcdTokenNumber
= OrderedDict()
2064 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2068 # TokenNumber 0 ~ 10
2070 # TokeNumber 11 ~ 20
2072 for Pcd
in self
.DynamicPcdList
:
2073 if Pcd
.Phase
== "PEI":
2074 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
2075 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2076 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2079 for Pcd
in self
.DynamicPcdList
:
2080 if Pcd
.Phase
== "PEI":
2081 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
2082 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2083 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2086 for Pcd
in self
.DynamicPcdList
:
2087 if Pcd
.Phase
== "DXE":
2088 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
2089 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2090 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2093 for Pcd
in self
.DynamicPcdList
:
2094 if Pcd
.Phase
== "DXE":
2095 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
2096 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2097 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2100 for Pcd
in self
.NonDynamicPcdList
:
2101 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2103 return self
._PcdTokenNumber
2105 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2106 def _GetAutoGenObjectList(self
):
2107 self
._ModuleAutoGenList
= []
2108 self
._LibraryAutoGenList
= []
2109 for ModuleFile
in self
.Platform
.Modules
:
2118 if Ma
not in self
._ModuleAutoGenList
:
2119 self
._ModuleAutoGenList
.append(Ma
)
2120 for La
in Ma
.LibraryAutoGenList
:
2121 if La
not in self
._LibraryAutoGenList
:
2122 self
._LibraryAutoGenList
.append(La
)
2123 if Ma
not in La
._ReferenceModules
:
2124 La
._ReferenceModules
.append(Ma
)
2126 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2127 def _GetModuleAutoGenList(self
):
2128 if self
._ModuleAutoGenList
is None:
2129 self
._GetAutoGenObjectList
()
2130 return self
._ModuleAutoGenList
2132 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2133 def _GetLibraryAutoGenList(self
):
2134 if self
._LibraryAutoGenList
is None:
2135 self
._GetAutoGenObjectList
()
2136 return self
._LibraryAutoGenList
2138 ## Test if a module is supported by the platform
2140 # An error will be raised directly if the module or its arch is not supported
2141 # by the platform or current configuration
2143 def ValidModule(self
, Module
):
2144 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2145 or Module
in self
._AsBuildModuleList
2147 ## Resolve the library classes in a module to library instances
2149 # This method will not only resolve library classes but also sort the library
2150 # instances according to the dependency-ship.
2152 # @param Module The module from which the library classes will be resolved
2154 # @retval library_list List of library instances sorted
2156 def ApplyLibraryInstance(self
, Module
):
2157 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2158 if str(Module
) not in self
.Platform
.Modules
:
2161 ModuleType
= Module
.ModuleType
2163 # for overridding library instances with module specific setting
2164 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2166 # add forced library instances (specified under LibraryClasses sections)
2168 # If a module has a MODULE_TYPE of USER_DEFINED,
2169 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2171 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2172 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2173 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2174 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2176 # add forced library instances (specified in module overrides)
2177 for LibraryClass
in PlatformModule
.LibraryClasses
:
2178 if LibraryClass
.startswith("NULL"):
2179 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2182 LibraryConsumerList
= [Module
]
2184 ConsumedByList
= OrderedDict()
2185 LibraryInstance
= OrderedDict()
2187 EdkLogger
.verbose("")
2188 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2189 while len(LibraryConsumerList
) > 0:
2190 M
= LibraryConsumerList
.pop()
2191 for LibraryClassName
in M
.LibraryClasses
:
2192 if LibraryClassName
not in LibraryInstance
:
2193 # override library instance for this module
2194 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2195 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2197 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2198 if LibraryPath
is None or LibraryPath
== "":
2199 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2200 if LibraryPath
is None or LibraryPath
== "":
2201 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2202 "Instance of library class [%s] is not found" % LibraryClassName
,
2204 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2206 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2207 # for those forced library instance (NULL library), add a fake library class
2208 if LibraryClassName
.startswith("NULL"):
2209 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2210 elif LibraryModule
.LibraryClass
is None \
2211 or len(LibraryModule
.LibraryClass
) == 0 \
2212 or (ModuleType
!= SUP_MODULE_USER_DEFINED
2213 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2214 # only USER_DEFINED can link against any library instance despite of its SupModList
2215 EdkLogger
.error("build", OPTION_MISSING
,
2216 "Module type [%s] is not supported by library instance [%s]" \
2217 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2218 ExtraData
="consumed by [%s]" % str(Module
))
2220 LibraryInstance
[LibraryClassName
] = LibraryModule
2221 LibraryConsumerList
.append(LibraryModule
)
2222 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2224 LibraryModule
= LibraryInstance
[LibraryClassName
]
2226 if LibraryModule
is None:
2229 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2230 Constructor
.append(LibraryModule
)
2232 if LibraryModule
not in ConsumedByList
:
2233 ConsumedByList
[LibraryModule
] = []
2234 # don't add current module itself to consumer list
2236 if M
in ConsumedByList
[LibraryModule
]:
2238 ConsumedByList
[LibraryModule
].append(M
)
2240 # Initialize the sorted output list to the empty set
2242 SortedLibraryList
= []
2244 # Q <- Set of all nodes with no incoming edges
2246 LibraryList
= [] #LibraryInstance.values()
2248 for LibraryClassName
in LibraryInstance
:
2249 M
= LibraryInstance
[LibraryClassName
]
2250 LibraryList
.append(M
)
2251 if ConsumedByList
[M
] == []:
2255 # start the DAG algorithm
2259 while Q
== [] and EdgeRemoved
:
2261 # for each node Item with a Constructor
2262 for Item
in LibraryList
:
2263 if Item
not in Constructor
:
2265 # for each Node without a constructor with an edge e from Item to Node
2266 for Node
in ConsumedByList
[Item
]:
2267 if Node
in Constructor
:
2269 # remove edge e from the graph if Node has no constructor
2270 ConsumedByList
[Item
].remove(Node
)
2272 if ConsumedByList
[Item
] == []:
2273 # insert Item into Q
2278 # DAG is done if there's no more incoming edge for all nodes
2282 # remove node from Q
2285 SortedLibraryList
.append(Node
)
2287 # for each node Item with an edge e from Node to Item do
2288 for Item
in LibraryList
:
2289 if Node
not in ConsumedByList
[Item
]:
2291 # remove edge e from the graph
2292 ConsumedByList
[Item
].remove(Node
)
2294 if ConsumedByList
[Item
] != []:
2296 # insert Item into Q, if Item has no other incoming edges
2300 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2302 for Item
in LibraryList
:
2303 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2304 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join(str(L
) for L
in ConsumedByList
[Item
])
2305 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2306 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2307 if Item
not in SortedLibraryList
:
2308 SortedLibraryList
.append(Item
)
2311 # Build the list of constructor and destructir names
2312 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2314 SortedLibraryList
.reverse()
2315 return SortedLibraryList
2318 ## Override PCD setting (type, value, ...)
2320 # @param ToPcd The PCD to be overrided
2321 # @param FromPcd The PCD overrideing from
2323 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2325 # in case there's PCDs coming from FDF file, which have no type given.
2326 # at this point, ToPcd.Type has the type found from dependent
2329 TokenCName
= ToPcd
.TokenCName
2330 for PcdItem
in GlobalData
.MixedPcd
:
2331 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2332 TokenCName
= PcdItem
[0]
2334 if FromPcd
is not None:
2335 if ToPcd
.Pending
and FromPcd
.Type
:
2336 ToPcd
.Type
= FromPcd
.Type
2337 elif (ToPcd
.Type
) and (FromPcd
.Type
)\
2338 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2339 if ToPcd
.Type
.strip() == TAB_PCDS_DYNAMIC_EX
:
2340 ToPcd
.Type
= FromPcd
.Type
2341 elif ToPcd
.Type
and FromPcd
.Type \
2342 and ToPcd
.Type
!= FromPcd
.Type
:
2343 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2344 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2345 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2346 ToPcd
.Type
, Module
, FromPcd
.Type
),
2349 if FromPcd
.MaxDatumSize
:
2350 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2351 ToPcd
.MaxSizeUserSet
= FromPcd
.MaxDatumSize
2352 if FromPcd
.DefaultValue
:
2353 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2354 if FromPcd
.TokenValue
:
2355 ToPcd
.TokenValue
= FromPcd
.TokenValue
2356 if FromPcd
.DatumType
:
2357 ToPcd
.DatumType
= FromPcd
.DatumType
2358 if FromPcd
.SkuInfoList
:
2359 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2360 # Add Flexible PCD format parse
2361 if ToPcd
.DefaultValue
:
2363 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2364 except BadExpression
, Value
:
2365 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2368 # check the validation of datum
2369 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2371 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2372 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2373 ToPcd
.validateranges
= FromPcd
.validateranges
2374 ToPcd
.validlists
= FromPcd
.validlists
2375 ToPcd
.expressions
= FromPcd
.expressions
2377 if FromPcd
is not None and ToPcd
.DatumType
== TAB_VOID
and not ToPcd
.MaxDatumSize
:
2378 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2379 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2380 Value
= ToPcd
.DefaultValue
2382 ToPcd
.MaxDatumSize
= '1'
2383 elif Value
[0] == 'L':
2384 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2385 elif Value
[0] == '{':
2386 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2388 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2390 # apply default SKU for dynamic PCDS if specified one is not available
2391 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_SET
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
) \
2392 and not ToPcd
.SkuInfoList
:
2393 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2394 SkuName
= self
.Platform
.SkuName
2396 SkuName
= TAB_DEFAULT
2397 ToPcd
.SkuInfoList
= {
2398 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2401 ## Apply PCD setting defined platform to a module
2403 # @param Module The module from which the PCD setting will be overrided
2405 # @retval PCD_list The list PCDs with settings from platform
2407 def ApplyPcdSetting(self
, Module
, Pcds
):
2408 # for each PCD in module
2409 for Name
, Guid
in Pcds
:
2410 PcdInModule
= Pcds
[Name
, Guid
]
2411 # find out the PCD setting in platform
2412 if (Name
, Guid
) in self
.Platform
.Pcds
:
2413 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2415 PcdInPlatform
= None
2416 # then override the settings if any
2417 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2418 # resolve the VariableGuid value
2419 for SkuId
in PcdInModule
.SkuInfoList
:
2420 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2421 if Sku
.VariableGuid
== '': continue
2422 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2423 if Sku
.VariableGuidValue
is None:
2424 PackageList
= "\n\t".join(str(P
) for P
in self
.PackageList
)
2427 RESOURCE_NOT_AVAILABLE
,
2428 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2429 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2430 % (Guid
, Name
, str(Module
)),
2434 # override PCD settings with module specific setting
2435 if Module
in self
.Platform
.Modules
:
2436 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2437 for Key
in PlatformModule
.Pcds
:
2442 elif Key
in GlobalData
.MixedPcd
:
2443 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2445 ToPcd
= Pcds
[PcdItem
]
2449 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2450 # use PCD value to calculate the MaxDatumSize when it is not specified
2451 for Name
, Guid
in Pcds
:
2452 Pcd
= Pcds
[Name
, Guid
]
2453 if Pcd
.DatumType
== TAB_VOID
and not Pcd
.MaxDatumSize
:
2454 Pcd
.MaxSizeUserSet
= None
2455 Value
= Pcd
.DefaultValue
2457 Pcd
.MaxDatumSize
= '1'
2458 elif Value
[0] == 'L':
2459 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2460 elif Value
[0] == '{':
2461 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2463 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2464 return Pcds
.values()
2466 ## Resolve library names to library modules
2468 # (for Edk.x modules)
2470 # @param Module The module from which the library names will be resolved
2472 # @retval library_list The list of library modules
2474 def ResolveLibraryReference(self
, Module
):
2475 EdkLogger
.verbose("")
2476 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2477 LibraryConsumerList
= [Module
]
2479 # "CompilerStub" is a must for Edk modules
2480 if Module
.Libraries
:
2481 Module
.Libraries
.append("CompilerStub")
2483 while len(LibraryConsumerList
) > 0:
2484 M
= LibraryConsumerList
.pop()
2485 for LibraryName
in M
.Libraries
:
2486 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2488 for Key
in self
.Platform
.LibraryClasses
.data
:
2489 if LibraryName
.upper() == Key
.upper():
2490 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2493 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2494 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2497 if Library
not in LibraryList
:
2498 LibraryList
.append(Library
)
2499 LibraryConsumerList
.append(Library
)
2500 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2503 ## Calculate the priority value of the build option
2505 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2507 # @retval Value Priority value based on the priority list.
2509 def CalculatePriorityValue(self
, Key
):
2510 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2511 PriorityValue
= 0x11111
2513 PriorityValue
&= 0x01111
2514 if ToolChain
== "*":
2515 PriorityValue
&= 0x10111
2517 PriorityValue
&= 0x11011
2518 if CommandType
== "*":
2519 PriorityValue
&= 0x11101
2521 PriorityValue
&= 0x11110
2523 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2526 ## Expand * in build option key
2528 # @param Options Options to be expanded
2530 # @retval options Options expanded
2532 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2539 # Construct a list contain the build options which need override.
2543 # Key[0] -- tool family
2544 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2546 if (Key
[0] == self
.BuildRuleFamily
and
2547 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2548 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2549 if Target
== self
.BuildTarget
or Target
== "*":
2550 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2551 if Arch
== self
.Arch
or Arch
== "*":
2552 if Options
[Key
].startswith("="):
2553 if OverrideList
.get(Key
[1]) is not None:
2554 OverrideList
.pop(Key
[1])
2555 OverrideList
[Key
[1]] = Options
[Key
]
2558 # Use the highest priority value.
2560 if (len(OverrideList
) >= 2):
2561 KeyList
= OverrideList
.keys()
2562 for Index
in range(len(KeyList
)):
2563 NowKey
= KeyList
[Index
]
2564 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2565 for Index1
in range(len(KeyList
) - Index
- 1):
2566 NextKey
= KeyList
[Index1
+ Index
+ 1]
2568 # Compare two Key, if one is included by another, choose the higher priority one
2570 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2571 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2572 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2573 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2574 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2575 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2576 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2577 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2578 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2580 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2581 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2584 if ModuleStyle
is not None and len (Key
) > 2:
2585 # Check Module style is EDK or EDKII.
2586 # Only append build option for the matched style module.
2587 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2589 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2592 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2593 # if tool chain family doesn't match, skip it
2594 if Tool
in self
.ToolDefinition
and Family
!= "":
2595 FamilyIsNull
= False
2596 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2597 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2599 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2602 # expand any wildcard
2603 if Target
== "*" or Target
== self
.BuildTarget
:
2604 if Tag
== "*" or Tag
== self
.ToolChain
:
2605 if Arch
== "*" or Arch
== self
.Arch
:
2606 if Tool
not in BuildOptions
:
2607 BuildOptions
[Tool
] = {}
2608 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2609 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2611 # append options for the same tool except PATH
2613 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2615 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2616 # Build Option Family has been checked, which need't to be checked again for family.
2617 if FamilyMatch
or FamilyIsNull
:
2621 if ModuleStyle
is not None and len (Key
) > 2:
2622 # Check Module style is EDK or EDKII.
2623 # Only append build option for the matched style module.
2624 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2626 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2629 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2630 # if tool chain family doesn't match, skip it
2631 if Tool
not in self
.ToolDefinition
or Family
== "":
2633 # option has been added before
2634 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2637 # expand any wildcard
2638 if Target
== "*" or Target
== self
.BuildTarget
:
2639 if Tag
== "*" or Tag
== self
.ToolChain
:
2640 if Arch
== "*" or Arch
== self
.Arch
:
2641 if Tool
not in BuildOptions
:
2642 BuildOptions
[Tool
] = {}
2643 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2644 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2646 # append options for the same tool except PATH
2648 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2650 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2653 ## Append build options in platform to a module
2655 # @param Module The module to which the build options will be appened
2657 # @retval options The options appended with build options in platform
2659 def ApplyBuildOption(self
, Module
):
2660 # Get the different options for the different style module
2661 if Module
.AutoGenVersion
< 0x00010005:
2662 PlatformOptions
= self
.EdkBuildOption
2663 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2665 PlatformOptions
= self
.EdkIIBuildOption
2666 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2667 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2668 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2669 if Module
in self
.Platform
.Modules
:
2670 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2671 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2673 PlatformModuleOptions
= {}
2675 BuildRuleOrder
= None
2676 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2677 for Tool
in Options
:
2678 for Attr
in Options
[Tool
]:
2679 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2680 BuildRuleOrder
= Options
[Tool
][Attr
]
2682 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2683 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2684 self
.ToolDefinition
.keys())
2685 BuildOptions
= defaultdict(lambda: defaultdict(str))
2686 for Tool
in AllTools
:
2687 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2688 if Tool
not in Options
:
2690 for Attr
in Options
[Tool
]:
2692 # Do not generate it in Makefile
2694 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2696 Value
= Options
[Tool
][Attr
]
2697 # check if override is indicated
2698 if Value
.startswith('='):
2699 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
[1:])
2702 BuildOptions
[Tool
][Attr
] += " " + mws
.handleWsMacro(Value
)
2704 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
)
2706 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2708 # Override UNI flag only for EDK module.
2710 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2711 return BuildOptions
, BuildRuleOrder
2713 Platform
= property(_GetPlatform
)
2714 Name
= property(_GetName
)
2715 Guid
= property(_GetGuid
)
2716 Version
= property(_GetVersion
)
2718 OutputDir
= property(_GetOutputDir
)
2719 BuildDir
= property(_GetBuildDir
)
2720 MakeFileDir
= property(_GetMakeFileDir
)
2721 FdfFile
= property(_GetFdfFile
)
2723 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2724 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2725 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2726 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2727 PackageList
= property(_GetPackageList
)
2729 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2730 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2731 ToolChainFamily
= property(_GetToolChainFamily
)
2732 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2733 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2734 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2735 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2737 BuildCommand
= property(_GetBuildCommand
)
2738 BuildRule
= property(_GetBuildRule
)
2739 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2740 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2741 GenFdsCommand
= property(_GenFdsCommand
)
2743 ## ModuleAutoGen class
2745 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2746 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2747 # to the [depex] section in module's inf file.
2749 class ModuleAutoGen(AutoGen
):
2750 # call super().__init__ then call the worker function with different parameter count
2751 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2755 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2756 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2759 ## Cache the timestamps of metafiles of every module in a class variable
2763 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2764 obj
= super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2765 # check if this module is employed by active platform
2766 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2767 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2772 ## Initialize ModuleAutoGen
2774 # @param Workspace EdkIIWorkspaceBuild object
2775 # @param ModuleFile The path of module file
2776 # @param Target Build target (DEBUG, RELEASE)
2777 # @param Toolchain Name of tool chain
2778 # @param Arch The arch the module supports
2779 # @param PlatformFile Platform meta-file
2781 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2782 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2783 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2785 self
.Workspace
= Workspace
2786 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2787 self
._GuidDict
= Workspace
._GuidDict
2788 self
.MetaFile
= ModuleFile
2789 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2791 self
.SourceDir
= self
.MetaFile
.SubDir
2792 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2794 self
.SourceOverrideDir
= None
2795 # use overrided path defined in DSC file
2796 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2797 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2799 self
.ToolChain
= Toolchain
2800 self
.BuildTarget
= Target
2802 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2803 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2805 self
.IsMakeFileCreated
= False
2806 self
.IsCodeFileCreated
= False
2807 self
.IsAsBuiltInfCreated
= False
2808 self
.DepexGenerated
= False
2810 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2811 self
.BuildRuleOrder
= None
2817 self
._Version
= None
2818 self
._ModuleType
= None
2819 self
._ComponentType
= None
2820 self
._PcdIsDriver
= None
2821 self
._AutoGenVersion
= None
2822 self
._LibraryFlag
= None
2823 self
._CustomMakefile
= None
2826 self
._BuildDir
= None
2827 self
._OutputDir
= None
2828 self
._FfsOutputDir
= None
2829 self
._DebugDir
= None
2830 self
._MakeFileDir
= None
2832 self
._IncludePathList
= None
2833 self
._IncludePathLength
= 0
2834 self
._AutoGenFileList
= None
2835 self
._UnicodeFileList
= None
2836 self
._VfrFileList
= None
2837 self
._IdfFileList
= None
2838 self
._SourceFileList
= None
2839 self
._ObjectFileList
= None
2840 self
._BinaryFileList
= None
2842 self
._DependentPackageList
= None
2843 self
._DependentLibraryList
= None
2844 self
._LibraryAutoGenList
= None
2845 self
._DerivedPackageList
= None
2846 self
._ModulePcdList
= None
2847 self
._LibraryPcdList
= None
2848 self
._PcdComments
= OrderedDict()
2849 self
._GuidList
= None
2850 self
._GuidsUsedByPcd
= None
2851 self
._GuidComments
= OrderedDict()
2852 self
._ProtocolList
= None
2853 self
._ProtocolComments
= OrderedDict()
2854 self
._PpiList
= None
2855 self
._PpiComments
= OrderedDict()
2856 self
._DepexList
= None
2857 self
._DepexExpressionList
= None
2858 self
._BuildOption
= None
2859 self
._BuildOptionIncPathList
= None
2860 self
._BuildTargets
= None
2861 self
._IntroBuildTargetList
= None
2862 self
._FinalBuildTargetList
= None
2863 self
._FileTypes
= None
2864 self
._BuildRules
= None
2866 self
._TimeStampPath
= None
2868 self
.AutoGenDepSet
= set()
2871 ## The Modules referenced to this Library
2872 # Only Library has this attribute
2873 self
._ReferenceModules
= []
2875 ## Store the FixedAtBuild Pcds
2877 self
._FixedAtBuildPcds
= []
2882 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2884 # Get FixedAtBuild Pcds of this Module
2885 def _GetFixedAtBuildPcds(self
):
2886 if self
._FixedAtBuildPcds
:
2887 return self
._FixedAtBuildPcds
2888 for Pcd
in self
.ModulePcdList
:
2889 if Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
2891 if Pcd
not in self
._FixedAtBuildPcds
:
2892 self
._FixedAtBuildPcds
.append(Pcd
)
2894 return self
._FixedAtBuildPcds
2896 def _GetUniqueBaseName(self
):
2897 BaseName
= self
.Name
2898 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2899 if Module
.MetaFile
== self
.MetaFile
:
2901 if Module
.Name
== self
.Name
:
2902 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2903 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2904 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2905 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2908 # Macros could be used in build_rule.txt (also Makefile)
2909 def _GetMacros(self
):
2910 if self
._Macro
is None:
2911 self
._Macro
= OrderedDict()
2912 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2913 self
._Macro
["MODULE_NAME" ] = self
.Name
2914 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2915 self
._Macro
["MODULE_GUID" ] = self
.Guid
2916 self
._Macro
["MODULE_VERSION" ] = self
.Version
2917 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2918 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2919 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2920 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2921 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2923 self
._Macro
["BASE_NAME" ] = self
.Name
2925 self
._Macro
["ARCH" ] = self
.Arch
2926 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2927 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2928 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2929 self
._Macro
["TARGET" ] = self
.BuildTarget
2931 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2932 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2933 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2934 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2935 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2936 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2937 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2938 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2939 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2940 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2941 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2942 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2943 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2944 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2945 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2948 ## Return the module build data object
2949 def _GetModule(self
):
2950 if self
._Module
is None:
2951 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2954 ## Return the module name
2955 def _GetBaseName(self
):
2956 return self
.Module
.BaseName
2958 ## Return the module DxsFile if exist
2959 def _GetDxsFile(self
):
2960 return self
.Module
.DxsFile
2962 ## Return the module SourceOverridePath
2963 def _GetSourceOverridePath(self
):
2964 return self
.Module
.SourceOverridePath
2966 ## Return the module meta-file GUID
2969 # To build same module more than once, the module path with FILE_GUID overridden has
2970 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2971 # in DSC. The overridden GUID can be retrieved from file name
2973 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2975 # Length of GUID is 36
2977 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2978 return self
.Module
.Guid
2980 ## Return the module version
2981 def _GetVersion(self
):
2982 return self
.Module
.Version
2984 ## Return the module type
2985 def _GetModuleType(self
):
2986 return self
.Module
.ModuleType
2988 ## Return the component type (for Edk.x style of module)
2989 def _GetComponentType(self
):
2990 return self
.Module
.ComponentType
2992 ## Return the build type
2993 def _GetBuildType(self
):
2994 return self
.Module
.BuildType
2996 ## Return the PCD_IS_DRIVER setting
2997 def _GetPcdIsDriver(self
):
2998 return self
.Module
.PcdIsDriver
3000 ## Return the autogen version, i.e. module meta-file version
3001 def _GetAutoGenVersion(self
):
3002 return self
.Module
.AutoGenVersion
3004 ## Check if the module is library or not
3005 def _IsLibrary(self
):
3006 if self
._LibraryFlag
is None:
3007 if self
.Module
.LibraryClass
is not None and self
.Module
.LibraryClass
!= []:
3008 self
._LibraryFlag
= True
3010 self
._LibraryFlag
= False
3011 return self
._LibraryFlag
3013 ## Check if the module is binary module or not
3014 def _IsBinaryModule(self
):
3015 return self
.Module
.IsBinaryModule
3017 ## Return the directory to store intermediate files of the module
3018 def _GetBuildDir(self
):
3019 if self
._BuildDir
is None:
3020 self
._BuildDir
= path
.join(
3021 self
.PlatformInfo
.BuildDir
,
3024 self
.MetaFile
.BaseName
3026 CreateDirectory(self
._BuildDir
)
3027 return self
._BuildDir
3029 ## Return the directory to store the intermediate object files of the mdoule
3030 def _GetOutputDir(self
):
3031 if self
._OutputDir
is None:
3032 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3033 CreateDirectory(self
._OutputDir
)
3034 return self
._OutputDir
3036 ## Return the directory to store ffs file
3037 def _GetFfsOutputDir(self
):
3038 if self
._FfsOutputDir
is None:
3039 if GlobalData
.gFdfParser
is not None:
3040 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, TAB_FV_DIRECTORY
, "Ffs", self
.Guid
+ self
.Name
)
3042 self
._FfsOutputDir
= ''
3043 return self
._FfsOutputDir
3045 ## Return the directory to store auto-gened source files of the mdoule
3046 def _GetDebugDir(self
):
3047 if self
._DebugDir
is None:
3048 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3049 CreateDirectory(self
._DebugDir
)
3050 return self
._DebugDir
3052 ## Return the path of custom file
3053 def _GetCustomMakefile(self
):
3054 if self
._CustomMakefile
is None:
3055 self
._CustomMakefile
= {}
3056 for Type
in self
.Module
.CustomMakefile
:
3057 if Type
in gMakeTypeMap
:
3058 MakeType
= gMakeTypeMap
[Type
]
3061 if self
.SourceOverrideDir
is not None:
3062 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3063 if not os
.path
.exists(File
):
3064 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3066 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3067 self
._CustomMakefile
[MakeType
] = File
3068 return self
._CustomMakefile
3070 ## Return the directory of the makefile
3072 # @retval string The directory string of module's makefile
3074 def _GetMakeFileDir(self
):
3075 return self
.BuildDir
3077 ## Return build command string
3079 # @retval string Build command string
3081 def _GetBuildCommand(self
):
3082 return self
.PlatformInfo
.BuildCommand
3084 ## Get object list of all packages the module and its dependent libraries belong to
3086 # @retval list The list of package object
3088 def _GetDerivedPackageList(self
):
3090 for M
in [self
.Module
] + self
.DependentLibraryList
:
3091 for Package
in M
.Packages
:
3092 if Package
in PackageList
:
3094 PackageList
.append(Package
)
3097 ## Get the depex string
3099 # @return : a string contain all depex expresion.
3100 def _GetDepexExpresionString(self
):
3103 ## DPX_SOURCE IN Define section.
3104 if self
.Module
.DxsFile
:
3106 for M
in [self
.Module
] + self
.DependentLibraryList
:
3107 Filename
= M
.MetaFile
.Path
3108 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3109 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3110 for DepexExpresion
in DepexExpresionList
:
3111 for key
in DepexExpresion
:
3112 Arch
, ModuleType
= key
3113 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3114 # the type of build module is USER_DEFINED.
3115 # All different DEPEX section tags would be copied into the As Built INF file
3116 # and there would be separate DEPEX section tags
3117 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3118 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3119 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3121 if Arch
.upper() == TAB_ARCH_COMMON
or \
3122 (Arch
.upper() == self
.Arch
.upper() and \
3123 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3124 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3126 #the type of build module is USER_DEFINED.
3127 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3128 for Depex
in DepexList
:
3130 DepexStr
+= '[Depex.%s.%s]\n' % key
3131 DepexStr
+= '\n'.join('# '+ val
for val
in Depex
[key
])
3134 return '[Depex.%s]\n' % self
.Arch
3137 #the type of build module not is USER_DEFINED.
3139 for Depex
in DepexList
:
3144 for D
in Depex
.values():
3145 DepexStr
+= ' '.join(val
for val
in D
)
3146 Index
= DepexStr
.find('END')
3147 if Index
> -1 and Index
== len(DepexStr
) - 3:
3148 DepexStr
= DepexStr
[:-3]
3149 DepexStr
= DepexStr
.strip()
3152 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3154 return '[Depex.%s]\n' % self
.Arch
3155 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3157 ## Merge dependency expression
3159 # @retval list The token list of the dependency expression after parsed
3161 def _GetDepexTokenList(self
):
3162 if self
._DepexList
is None:
3163 self
._DepexList
= {}
3164 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3165 return self
._DepexList
3167 self
._DepexList
[self
.ModuleType
] = []
3169 for ModuleType
in self
._DepexList
:
3170 DepexList
= self
._DepexList
[ModuleType
]
3172 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3174 for M
in [self
.Module
] + self
.DependentLibraryList
:
3176 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3178 DepexList
.append('AND')
3179 DepexList
.append('(')
3181 if DepexList
[-1] == 'END': # no need of a END at this time
3183 DepexList
.append(')')
3186 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3187 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3189 if len(DepexList
) > 0:
3190 EdkLogger
.verbose('')
3191 return self
._DepexList
3193 ## Merge dependency expression
3195 # @retval list The token list of the dependency expression after parsed
3197 def _GetDepexExpressionTokenList(self
):
3198 if self
._DepexExpressionList
is None:
3199 self
._DepexExpressionList
= {}
3200 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3201 return self
._DepexExpressionList
3203 self
._DepexExpressionList
[self
.ModuleType
] = ''
3205 for ModuleType
in self
._DepexExpressionList
:
3206 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3208 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3210 for M
in [self
.Module
] + self
.DependentLibraryList
:
3212 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3213 if DepexExpressionList
!= '':
3214 DepexExpressionList
+= ' AND '
3215 DepexExpressionList
+= '('
3216 DepexExpressionList
+= D
3217 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3218 DepexExpressionList
+= ')'
3221 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3222 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3224 if len(DepexExpressionList
) > 0:
3225 EdkLogger
.verbose('')
3226 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3227 return self
._DepexExpressionList
3229 # Get the tiano core user extension, it is contain dependent library.
3230 # @retval: a list contain tiano core userextension.
3232 def _GetTianoCoreUserExtensionList(self
):
3233 TianoCoreUserExtentionList
= []
3234 for M
in [self
.Module
] + self
.DependentLibraryList
:
3235 Filename
= M
.MetaFile
.Path
3236 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3237 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3238 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3239 for Section
in TianoCoreUserExtent
:
3240 ItemList
= Section
.split(TAB_SPLIT
)
3242 if len(ItemList
) == 4:
3244 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3246 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3247 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3248 TianoCoreList
.append('\n')
3249 TianoCoreUserExtentionList
.append(TianoCoreList
)
3251 return TianoCoreUserExtentionList
3253 ## Return the list of specification version required for the module
3255 # @retval list The list of specification defined in module file
3257 def _GetSpecification(self
):
3258 return self
.Module
.Specification
3260 ## Tool option for the module build
3262 # @param PlatformInfo The object of PlatformBuildInfo
3263 # @retval dict The dict containing valid options
3265 def _GetModuleBuildOption(self
):
3266 if self
._BuildOption
is None:
3267 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3268 if self
.BuildRuleOrder
:
3269 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3270 return self
._BuildOption
3272 ## Get include path list from tool option for the module build
3274 # @retval list The include path list
3276 def _GetBuildOptionIncPathList(self
):
3277 if self
._BuildOptionIncPathList
is None:
3279 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3280 # is the former use /I , the Latter used -I to specify include directories
3282 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3283 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
3284 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3285 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
3288 # New ToolChainFamily, don't known whether there is option to specify include directories
3290 self
._BuildOptionIncPathList
= []
3291 return self
._BuildOptionIncPathList
3293 BuildOptionIncPathList
= []
3294 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3297 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3301 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3302 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
3305 # RVCT may specify a list of directory seperated by commas
3308 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
3309 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3310 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3313 # EDK II modules must not reference header files outside of the packages they depend on or
3314 # within the module's directory tree. Report error if violation.
3316 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3317 for Path
in IncPathList
:
3318 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3319 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3320 EdkLogger
.error("build",
3323 File
=str(self
.MetaFile
))
3326 BuildOptionIncPathList
+= IncPathList
3328 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3330 return self
._BuildOptionIncPathList
3332 ## Return a list of files which can be built from source
3334 # What kind of files can be built is determined by build rules in
3335 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3337 def _GetSourceFileList(self
):
3338 if self
._SourceFileList
is None:
3339 self
._SourceFileList
= []
3340 for F
in self
.Module
.Sources
:
3342 if F
.TagName
not in ("", "*", self
.ToolChain
):
3343 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3344 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3346 # match tool chain family or build rule family
3347 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3350 "The file [%s] must be built by tools of [%s], " \
3351 "but current toolchain family is [%s], buildrule family is [%s]" \
3352 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3355 # add the file path into search path list for file including
3356 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3357 self
.IncludePathList
.insert(0, F
.Dir
)
3358 self
._SourceFileList
.append(F
)
3360 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3362 for F
in self
._SourceFileList
:
3363 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3364 return self
._SourceFileList
3366 def _MatchBuildRuleOrder(self
, FileList
):
3368 self
._GetModuleBuildOption
()
3369 for SingleFile
in FileList
:
3370 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3371 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3372 if key
in Order_Dict
:
3373 Order_Dict
[key
].append(SingleFile
.Ext
)
3375 Order_Dict
[key
] = [SingleFile
.Ext
]
3378 for F
in Order_Dict
:
3379 if len(Order_Dict
[F
]) > 1:
3380 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3381 for Ext
in Order_Dict
[F
][1:]:
3382 RemoveList
.append(F
+ Ext
)
3384 for item
in RemoveList
:
3385 FileList
.remove(item
)
3389 ## Return the list of unicode files
3390 def _GetUnicodeFileList(self
):
3391 if self
._UnicodeFileList
is None:
3392 if TAB_UNICODE_FILE
in self
.FileTypes
:
3393 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3395 self
._UnicodeFileList
= []
3396 return self
._UnicodeFileList
3398 ## Return the list of vfr files
3399 def _GetVfrFileList(self
):
3400 if self
._VfrFileList
is None:
3401 if TAB_VFR_FILE
in self
.FileTypes
:
3402 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3404 self
._VfrFileList
= []
3405 return self
._VfrFileList
3407 ## Return the list of Image Definition files
3408 def _GetIdfFileList(self
):
3409 if self
._IdfFileList
is None:
3410 if TAB_IMAGE_FILE
in self
.FileTypes
:
3411 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3413 self
._IdfFileList
= []
3414 return self
._IdfFileList
3416 ## Return a list of files which can be built from binary
3418 # "Build" binary files are just to copy them to build directory.
3420 # @retval list The list of files which can be built later
3422 def _GetBinaryFiles(self
):
3423 if self
._BinaryFileList
is None:
3424 self
._BinaryFileList
= []
3425 for F
in self
.Module
.Binaries
:
3426 if F
.Target
not in [TAB_ARCH_COMMON
, '*'] and F
.Target
!= self
.BuildTarget
:
3428 self
._BinaryFileList
.append(F
)
3429 self
._ApplyBuildRule
(F
, F
.Type
)
3430 return self
._BinaryFileList
3432 def _GetBuildRules(self
):
3433 if self
._BuildRules
is None:
3435 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3436 for Type
in BuildRuleDatabase
.FileTypeList
:
3437 #first try getting build rule by BuildRuleFamily
3438 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3440 # build type is always module type, but ...
3441 if self
.ModuleType
!= self
.BuildType
:
3442 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3443 #second try getting build rule by ToolChainFamily
3445 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3447 # build type is always module type, but ...
3448 if self
.ModuleType
!= self
.BuildType
:
3449 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3452 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3453 BuildRules
[Type
] = RuleObject
3454 for Ext
in RuleObject
.SourceFileExtList
:
3455 BuildRules
[Ext
] = RuleObject
3456 self
._BuildRules
= BuildRules
3457 return self
._BuildRules
3459 def _ApplyBuildRule(self
, File
, FileType
):
3460 if self
._BuildTargets
is None:
3461 self
._IntroBuildTargetList
= set()
3462 self
._FinalBuildTargetList
= set()
3463 self
._BuildTargets
= defaultdict(set)
3464 self
._FileTypes
= defaultdict(set)
3466 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3467 if not os
.path
.exists(SubDirectory
):
3468 CreateDirectory(SubDirectory
)
3474 # Make sure to get build rule order value
3476 self
._GetModuleBuildOption
()
3478 while Index
< len(SourceList
):
3479 Source
= SourceList
[Index
]
3483 CreateDirectory(Source
.Dir
)
3485 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
is not None and File
in self
._BinaryFileList
:
3486 # Skip all files that are not binary libraries
3487 if not self
.IsLibrary
:
3489 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3490 elif FileType
in self
.BuildRules
:
3491 RuleObject
= self
.BuildRules
[FileType
]
3492 elif Source
.Ext
in self
.BuildRules
:
3493 RuleObject
= self
.BuildRules
[Source
.Ext
]
3495 # stop at no more rules
3497 self
._FinalBuildTargetList
.add(LastTarget
)
3500 FileType
= RuleObject
.SourceFileType
3501 self
._FileTypes
[FileType
].add(Source
)
3503 # stop at STATIC_LIBRARY for library
3504 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3506 self
._FinalBuildTargetList
.add(LastTarget
)
3509 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3512 self
._FinalBuildTargetList
.add(LastTarget
)
3514 elif not Target
.Outputs
:
3515 # Only do build for target with outputs
3516 self
._FinalBuildTargetList
.add(Target
)
3518 self
._BuildTargets
[FileType
].add(Target
)
3520 if not Source
.IsBinary
and Source
== File
:
3521 self
._IntroBuildTargetList
.add(Target
)
3523 # to avoid cyclic rule
3524 if FileType
in RuleChain
:
3527 RuleChain
.append(FileType
)
3528 SourceList
.extend(Target
.Outputs
)
3530 FileType
= TAB_UNKNOWN_FILE
3532 def _GetTargets(self
):
3533 if self
._BuildTargets
is None:
3534 self
._IntroBuildTargetList
= set()
3535 self
._FinalBuildTargetList
= set()
3536 self
._BuildTargets
= defaultdict(set)
3537 self
._FileTypes
= defaultdict(set)
3539 #TRICK: call _GetSourceFileList to apply build rule for source files
3540 if self
.SourceFileList
:
3543 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3544 if self
.BinaryFileList
:
3547 return self
._BuildTargets
3549 def _GetIntroTargetList(self
):
3551 return self
._IntroBuildTargetList
3553 def _GetFinalTargetList(self
):
3555 return self
._FinalBuildTargetList
3557 def _GetFileTypes(self
):
3559 return self
._FileTypes
3561 ## Get the list of package object the module depends on
3563 # @retval list The package object list
3565 def _GetDependentPackageList(self
):
3566 return self
.Module
.Packages
3568 ## Return the list of auto-generated code file
3570 # @retval list The list of auto-generated file
3572 def _GetAutoGenFileList(self
):
3573 UniStringAutoGenC
= True
3574 IdfStringAutoGenC
= True
3575 UniStringBinBuffer
= StringIO()
3576 IdfGenBinBuffer
= StringIO()
3577 if self
.BuildType
== 'UEFI_HII':
3578 UniStringAutoGenC
= False
3579 IdfStringAutoGenC
= False
3580 if self
._AutoGenFileList
is None:
3581 self
._AutoGenFileList
= {}
3582 AutoGenC
= TemplateString()
3583 AutoGenH
= TemplateString()
3584 StringH
= TemplateString()
3585 StringIdf
= TemplateString()
3586 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3588 # AutoGen.c is generated if there are library classes in inf, or there are object files
3590 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3591 or TAB_OBJECT_FILE
in self
.FileTypes
):
3592 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3593 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3594 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3595 if str(AutoGenH
) != "":
3596 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3597 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3598 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3599 if str(StringH
) != "":
3600 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3601 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3602 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3603 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3604 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3605 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3606 AutoFile
.IsBinary
= True
3607 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3608 if UniStringBinBuffer
is not None:
3609 UniStringBinBuffer
.close()
3610 if str(StringIdf
) != "":
3611 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3612 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3613 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3614 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3615 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3616 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3617 AutoFile
.IsBinary
= True
3618 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3619 if IdfGenBinBuffer
is not None:
3620 IdfGenBinBuffer
.close()
3621 return self
._AutoGenFileList
3623 ## Return the list of library modules explicitly or implicityly used by this module
3624 def _GetLibraryList(self
):
3625 if self
._DependentLibraryList
is None:
3626 # only merge library classes and PCD for non-library module
3628 self
._DependentLibraryList
= []
3630 if self
.AutoGenVersion
< 0x00010005:
3631 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3633 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3634 return self
._DependentLibraryList
3637 def UpdateComments(Recver
, Src
):
3639 if Key
not in Recver
:
3641 Recver
[Key
].extend(Src
[Key
])
3642 ## Get the list of PCDs from current module
3644 # @retval list The list of PCD
3646 def _GetModulePcdList(self
):
3647 if self
._ModulePcdList
is None:
3648 # apply PCD settings from platform
3649 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3650 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3651 return self
._ModulePcdList
3653 ## Get the list of PCDs from dependent libraries
3655 # @retval list The list of PCD
3657 def _GetLibraryPcdList(self
):
3658 if self
._LibraryPcdList
is None:
3659 Pcds
= OrderedDict()
3660 if not self
.IsLibrary
:
3661 # get PCDs from dependent libraries
3662 for Library
in self
.DependentLibraryList
:
3663 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3664 for Key
in Library
.Pcds
:
3665 # skip duplicated PCDs
3666 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3668 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3669 # apply PCD settings from platform
3670 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3672 self
._LibraryPcdList
= []
3673 return self
._LibraryPcdList
3675 ## Get the GUID value mapping
3677 # @retval dict The mapping between GUID cname and its value
3679 def _GetGuidList(self
):
3680 if self
._GuidList
is None:
3681 self
._GuidList
= OrderedDict()
3682 self
._GuidList
.update(self
.Module
.Guids
)
3683 for Library
in self
.DependentLibraryList
:
3684 self
._GuidList
.update(Library
.Guids
)
3685 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3686 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3687 return self
._GuidList
3689 def GetGuidsUsedByPcd(self
):
3690 if self
._GuidsUsedByPcd
is None:
3691 self
._GuidsUsedByPcd
= OrderedDict()
3692 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3693 for Library
in self
.DependentLibraryList
:
3694 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3695 return self
._GuidsUsedByPcd
3696 ## Get the protocol value mapping
3698 # @retval dict The mapping between protocol cname and its value
3700 def _GetProtocolList(self
):
3701 if self
._ProtocolList
is None:
3702 self
._ProtocolList
= OrderedDict()
3703 self
._ProtocolList
.update(self
.Module
.Protocols
)
3704 for Library
in self
.DependentLibraryList
:
3705 self
._ProtocolList
.update(Library
.Protocols
)
3706 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3707 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3708 return self
._ProtocolList
3710 ## Get the PPI value mapping
3712 # @retval dict The mapping between PPI cname and its value
3714 def _GetPpiList(self
):
3715 if self
._PpiList
is None:
3716 self
._PpiList
= OrderedDict()
3717 self
._PpiList
.update(self
.Module
.Ppis
)
3718 for Library
in self
.DependentLibraryList
:
3719 self
._PpiList
.update(Library
.Ppis
)
3720 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3721 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3722 return self
._PpiList
3724 ## Get the list of include search path
3726 # @retval list The list path
3728 def _GetIncludePathList(self
):
3729 if self
._IncludePathList
is None:
3730 self
._IncludePathList
= []
3731 if self
.AutoGenVersion
< 0x00010005:
3732 for Inc
in self
.Module
.Includes
:
3733 if Inc
not in self
._IncludePathList
:
3734 self
._IncludePathList
.append(Inc
)
3736 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3737 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3738 self
._IncludePathList
.append(Inc
)
3739 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3740 self
._IncludePathList
.append(self
.DebugDir
)
3742 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3743 self
._IncludePathList
.append(self
.DebugDir
)
3745 for Package
in self
.Module
.Packages
:
3746 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3747 if PackageDir
not in self
._IncludePathList
:
3748 self
._IncludePathList
.append(PackageDir
)
3749 IncludesList
= Package
.Includes
3750 if Package
._PrivateIncludes
:
3751 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3752 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3753 for Inc
in IncludesList
:
3754 if Inc
not in self
._IncludePathList
:
3755 self
._IncludePathList
.append(str(Inc
))
3756 return self
._IncludePathList
3758 def _GetIncludePathLength(self
):
3759 self
._IncludePathLength
= 0
3760 if self
._IncludePathList
:
3761 for inc
in self
._IncludePathList
:
3762 self
._IncludePathLength
+= len(' ' + inc
)
3763 return self
._IncludePathLength
3765 ## Get HII EX PCDs which maybe used by VFR
3767 # efivarstore used by VFR may relate with HII EX PCDs
3768 # Get the variable name and GUID from efivarstore and HII EX PCD
3769 # List the HII EX PCDs in As Built INF if both name and GUID match.
3771 # @retval list HII EX PCDs
3773 def _GetPcdsMaybeUsedByVfr(self
):
3774 if not self
.SourceFileList
:
3778 for SrcFile
in self
.SourceFileList
:
3779 if SrcFile
.Ext
.lower() != '.vfr':
3781 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3782 if not os
.path
.exists(Vfri
):
3784 VfriFile
= open(Vfri
, 'r')
3785 Content
= VfriFile
.read()
3787 Pos
= Content
.find('efivarstore')
3790 # Make sure 'efivarstore' is the start of efivarstore statement
3791 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3794 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3796 if Index
>= 0 and Content
[Index
] != ';':
3797 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3800 # 'efivarstore' must be followed by name and guid
3802 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3805 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3808 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3809 NameGuids
.add((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3810 Pos
= Content
.find('efivarstore', Name
.end())
3814 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3815 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3817 for SkuName
in Pcd
.SkuInfoList
:
3818 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3819 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3820 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3823 Guid
= GuidStructureStringToGuidString(Value
)
3824 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3825 HiiExPcds
.append(Pcd
)
3830 def _GenOffsetBin(self
):
3832 for SourceFile
in self
.Module
.Sources
:
3833 if SourceFile
.Type
.upper() == ".VFR" :
3835 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3837 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3838 if SourceFile
.Type
.upper() == ".UNI" :
3840 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3842 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3844 if len(VfrUniBaseName
) == 0:
3846 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3847 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3848 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3849 if not VfrUniOffsetList
:
3852 OutputName
= '%sOffset.bin' % self
.Name
3853 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3856 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3858 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3860 # Use a instance of StringIO to cache data
3861 fStringIO
= StringIO('')
3863 for Item
in VfrUniOffsetList
:
3864 if (Item
[0].find("Strings") != -1):
3866 # UNI offset in image.
3868 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3870 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3871 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3872 fStringIO
.write(''.join(UniGuid
))
3873 UniValue
= pack ('Q', int (Item
[1], 16))
3874 fStringIO
.write (UniValue
)
3877 # VFR binary offset in image.
3879 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3881 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3882 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3883 fStringIO
.write(''.join(VfrGuid
))
3884 VfrValue
= pack ('Q', int (Item
[1], 16))
3885 fStringIO
.write (VfrValue
)
3887 # write data into file.
3890 fInputfile
.write (fStringIO
.getvalue())
3892 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3893 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3899 ## Create AsBuilt INF file the module
3901 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3902 self
.OutputFile
= set()
3904 if GlobalData
.gBinCacheDest
:
3905 self
.CopyModuleToCache()
3908 if self
.IsAsBuiltInfCreated
:
3911 # Skip the following code for EDK I inf
3912 if self
.AutoGenVersion
< 0x00010005:
3915 # Skip the following code for libraries
3919 # Skip the following code for modules with no source files
3920 if not self
.SourceFileList
:
3923 # Skip the following code for modules without any binary files
3924 if self
.BinaryFileList
:
3927 ### TODO: How to handles mixed source and binary modules
3929 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3930 # Also find all packages that the DynamicEx PCDs depend on
3935 PcdTokenSpaceList
= []
3936 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3937 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3938 PatchablePcds
+= [Pcd
]
3939 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_PATCHABLE_IN_MODULE
))
3940 elif Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
3943 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
))
3944 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
))
3945 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3946 GuidList
= OrderedDict()
3947 GuidList
.update(self
.GuidList
)
3948 for TokenSpace
in self
.GetGuidsUsedByPcd():
3949 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3950 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3951 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3952 GuidList
.pop(TokenSpace
)
3953 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3954 for Package
in self
.DerivedPackageList
:
3955 if Package
in Packages
:
3957 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3959 for Index
in range(len(BeChecked
)):
3960 for Item
in CheckList
[Index
]:
3961 if Item
in BeChecked
[Index
]:
3962 Packages
+= [Package
]
3967 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3968 for Pkg
in self
.PlatformInfo
.PackageList
:
3971 for VfrPcd
in VfrPcds
:
3972 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
) in Pkg
.Pcds
or
3973 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
) in Pkg
.Pcds
):
3977 ModuleType
= self
.ModuleType
3978 if ModuleType
== SUP_MODULE_UEFI_DRIVER
and self
.DepexGenerated
:
3979 ModuleType
= SUP_MODULE_DXE_DRIVER
3982 if self
.PcdIsDriver
!= '':
3983 DriverType
= self
.PcdIsDriver
3986 MDefs
= self
.Module
.Defines
3989 'module_name' : self
.Name
,
3990 'module_guid' : Guid
,
3991 'module_module_type' : ModuleType
,
3992 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3993 'pcd_is_driver_string' : [],
3994 'module_uefi_specification_version' : [],
3995 'module_pi_specification_version' : [],
3996 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3997 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3998 'module_constructor' : self
.Module
.ConstructorList
,
3999 'module_destructor' : self
.Module
.DestructorList
,
4000 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4001 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4002 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4003 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4004 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4005 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4006 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4007 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4008 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4009 'module_arch' : self
.Arch
,
4010 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4012 'patchablepcd_item' : [],
4014 'protocol_item' : [],
4018 'libraryclasses_item' : []
4021 if 'MODULE_UNI_FILE' in MDefs
:
4022 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4023 if os
.path
.isfile(UNIFile
):
4024 shutil
.copy2(UNIFile
, self
.OutputDir
)
4026 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4027 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4029 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4032 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4034 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4035 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4036 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4037 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4039 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4040 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4041 for Item
in self
.CodaTargetList
:
4042 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
4043 self
.OutputFile
.add(File
)
4044 if os
.path
.isabs(File
):
4045 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4046 if Item
.Target
.Ext
.lower() == '.aml':
4047 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4048 elif Item
.Target
.Ext
.lower() == '.acpi':
4049 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4050 elif Item
.Target
.Ext
.lower() == '.efi':
4051 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4053 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4054 if self
.DepexGenerated
:
4055 self
.OutputFile
.add(self
.Name
+ '.depex')
4056 if self
.ModuleType
in [SUP_MODULE_PEIM
]:
4057 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4058 if self
.ModuleType
in [SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
4059 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4060 if self
.ModuleType
in [SUP_MODULE_DXE_SMM_DRIVER
]:
4061 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4063 Bin
= self
._GenOffsetBin
()
4065 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4066 self
.OutputFile
.add(Bin
)
4068 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4070 if File
.lower().endswith('.pdb'):
4071 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4072 self
.OutputFile
.add(File
)
4073 HeaderComments
= self
.Module
.HeaderComments
4075 for Index
in range(len(HeaderComments
)):
4076 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4077 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4080 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4081 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4084 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4085 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4086 (GuidList
, self
._GuidComments
, 'guid_item')
4088 for Item
in GenList
:
4089 for CName
in Item
[0]:
4091 if CName
in Item
[1]:
4092 Comments
= '\n '.join(Item
[1][CName
])
4095 Entry
= Comments
+ '\n ' + CName
4096 AsBuiltInfDict
[Item
[2]].append(Entry
)
4097 PatchList
= parsePcdInfoFromMapFile(
4098 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4099 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4102 for Pcd
in PatchablePcds
:
4103 TokenCName
= Pcd
.TokenCName
4104 for PcdItem
in GlobalData
.MixedPcd
:
4105 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4106 TokenCName
= PcdItem
[0]
4108 for PatchPcd
in PatchList
:
4109 if TokenCName
== PatchPcd
[0]:
4114 if Pcd
.DatumType
== 'BOOLEAN':
4115 BoolValue
= Pcd
.DefaultValue
.upper()
4116 if BoolValue
== 'TRUE':
4117 Pcd
.DefaultValue
= '1'
4118 elif BoolValue
== 'FALSE':
4119 Pcd
.DefaultValue
= '0'
4121 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
4122 HexFormat
= '0x%02x'
4123 if Pcd
.DatumType
== TAB_UINT16
:
4124 HexFormat
= '0x%04x'
4125 elif Pcd
.DatumType
== TAB_UINT32
:
4126 HexFormat
= '0x%08x'
4127 elif Pcd
.DatumType
== TAB_UINT64
:
4128 HexFormat
= '0x%016x'
4129 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4131 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
4132 EdkLogger
.error("build", AUTOGEN_ERROR
,
4133 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4135 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4136 PcdValue
= Pcd
.DefaultValue
4137 if PcdValue
[0] != '{':
4139 if PcdValue
[0] == 'L':
4141 PcdValue
= PcdValue
.lstrip('L')
4142 PcdValue
= eval(PcdValue
)
4144 for Index
in range(0, len(PcdValue
)):
4146 CharVal
= ord(PcdValue
[Index
])
4147 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4148 + '0x%02x' % (CharVal
>> 8) + ', '
4150 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4153 Padding
= Padding
* 2
4154 ArraySize
= ArraySize
/ 2
4155 if ArraySize
< (len(PcdValue
) + 1):
4156 if Pcd
.MaxSizeUserSet
:
4157 EdkLogger
.error("build", AUTOGEN_ERROR
,
4158 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4161 ArraySize
= len(PcdValue
) + 1
4162 if ArraySize
> len(PcdValue
) + 1:
4163 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4164 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4165 elif len(PcdValue
.split(',')) <= ArraySize
:
4166 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4169 if Pcd
.MaxSizeUserSet
:
4170 EdkLogger
.error("build", AUTOGEN_ERROR
,
4171 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4174 ArraySize
= len(PcdValue
) + 1
4175 PcdItem
= '%s.%s|%s|0x%X' % \
4176 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4178 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4179 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4181 PcdItem
= PcdComments
+ '\n ' + PcdItem
4182 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4185 for Pcd
in Pcds
+ VfrPcds
:
4190 TokenCName
= Pcd
.TokenCName
4191 for PcdItem
in GlobalData
.MixedPcd
:
4192 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4193 TokenCName
= PcdItem
[0]
4195 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4196 for SkuName
in Pcd
.SkuInfoList
:
4197 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4198 SkuId
= SkuInfo
.SkuId
4199 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4203 # Don't generate duplicated HII PCD
4205 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4207 HiiPcds
.add((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4208 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4209 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4213 for Index
, Comment
in enumerate(PcdCommentList
):
4214 for Usage
in UsageList
:
4215 if Comment
.find(Usage
) != -1:
4219 if UsageIndex
!= -1:
4220 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4222 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4223 PcdComments
= '\n '.join(PcdCommentList
)
4224 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4226 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4227 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4228 for Item
in self
.BuildOption
:
4229 if 'FLAGS' in self
.BuildOption
[Item
]:
4230 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4232 # Generated LibraryClasses section in comments.
4233 for Library
in self
.LibraryAutoGenList
:
4234 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4236 # Generated UserExtensions TianoCore section.
4237 # All tianocore user extensions are copied.
4239 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4240 UserExtStr
+= '\n'.join(TianoCore
)
4241 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4242 if os
.path
.isfile(ExtensionFile
):
4243 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4244 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4246 # Generated depex expression section in comments.
4247 AsBuiltInfDict
['depexsection_item'] = ''
4248 DepexExpresion
= self
._GetDepexExpresionString
()
4250 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4252 AsBuiltInf
= TemplateString()
4253 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4255 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4257 self
.IsAsBuiltInfCreated
= True
4258 if GlobalData
.gBinCacheDest
:
4259 self
.CopyModuleToCache()
4261 def CopyModuleToCache(self
):
4262 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4263 CreateDirectory (FileDir
)
4264 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4265 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4266 if os
.path
.exists(HashFile
):
4267 shutil
.copy2(HashFile
, FileDir
)
4268 if os
.path
.exists(ModuleFile
):
4269 shutil
.copy2(ModuleFile
, FileDir
)
4270 if not self
.OutputFile
:
4271 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4272 self
.OutputFile
= Ma
.Binaries
4274 for File
in self
.OutputFile
:
4276 if not os
.path
.isabs(File
):
4277 File
= os
.path
.join(self
.OutputDir
, File
)
4278 if os
.path
.exists(File
):
4279 shutil
.copy2(File
, FileDir
)
4281 def AttemptModuleCacheCopy(self
):
4282 if self
.IsBinaryModule
:
4284 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4285 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4286 if os
.path
.exists(HashFile
):
4287 f
= open(HashFile
, 'r')
4288 CacheHash
= f
.read()
4290 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4291 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4292 for root
, dir, files
in os
.walk(FileDir
):
4294 if self
.Name
+ '.hash' in f
:
4295 shutil
.copy2(HashFile
, self
.BuildDir
)
4297 File
= path
.join(root
, f
)
4298 shutil
.copy2(File
, self
.OutputDir
)
4299 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4300 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4304 ## Create makefile for the module and its dependent libraries
4306 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4307 # dependent libraries will be created
4309 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4310 # Ignore generating makefile when it is a binary module
4311 if self
.IsBinaryModule
:
4314 if self
.IsMakeFileCreated
:
4316 self
.GenFfsList
= GenFfsList
4317 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4318 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4319 LibraryAutoGen
.CreateMakeFile()
4324 if len(self
.CustomMakefile
) == 0:
4325 Makefile
= GenMake
.ModuleMakefile(self
)
4327 Makefile
= GenMake
.CustomMakefile(self
)
4328 if Makefile
.Generate():
4329 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4330 (self
.Name
, self
.Arch
))
4332 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4333 (self
.Name
, self
.Arch
))
4335 self
.CreateTimeStamp(Makefile
)
4336 self
.IsMakeFileCreated
= True
4338 def CopyBinaryFiles(self
):
4339 for File
in self
.Module
.Binaries
:
4341 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4342 CopyLongFilePath(SrcPath
, DstPath
)
4343 ## Create autogen code for the module and its dependent libraries
4345 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4346 # dependent libraries will be created
4348 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4349 if self
.IsCodeFileCreated
:
4352 # Need to generate PcdDatabase even PcdDriver is binarymodule
4353 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4354 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4356 if self
.IsBinaryModule
:
4358 self
.CopyBinaryFiles()
4361 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4362 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4363 LibraryAutoGen
.CreateCodeFile()
4369 IgoredAutoGenList
= []
4371 for File
in self
.AutoGenFileList
:
4372 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4373 #Ignore Edk AutoGen.c
4374 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4377 AutoGenList
.append(str(File
))
4379 IgoredAutoGenList
.append(str(File
))
4381 # Skip the following code for EDK I inf
4382 if self
.AutoGenVersion
< 0x00010005:
4385 for ModuleType
in self
.DepexList
:
4386 # Ignore empty [depex] section or [depex] section for SUP_MODULE_USER_DEFINED module
4387 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== SUP_MODULE_USER_DEFINED
:
4390 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4391 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4393 if len(Dpx
.PostfixNotation
) <> 0:
4394 self
.DepexGenerated
= True
4396 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4397 AutoGenList
.append(str(DpxFile
))
4399 IgoredAutoGenList
.append(str(DpxFile
))
4401 if IgoredAutoGenList
== []:
4402 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4403 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4404 elif AutoGenList
== []:
4405 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4406 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4408 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4409 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4411 self
.IsCodeFileCreated
= True
4414 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4415 def _GetLibraryAutoGenList(self
):
4416 if self
._LibraryAutoGenList
is None:
4417 self
._LibraryAutoGenList
= []
4418 for Library
in self
.DependentLibraryList
:
4425 self
.PlatformInfo
.MetaFile
4427 if La
not in self
._LibraryAutoGenList
:
4428 self
._LibraryAutoGenList
.append(La
)
4429 for Lib
in La
.CodaTargetList
:
4430 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4431 return self
._LibraryAutoGenList
4433 def GenModuleHash(self
):
4434 if self
.Arch
not in GlobalData
.gModuleHash
:
4435 GlobalData
.gModuleHash
[self
.Arch
] = {}
4437 # Add Platform level hash
4438 m
.update(GlobalData
.gPlatformHash
)
4439 # Add Package level hash
4440 if self
.DependentPackageList
:
4441 for Pkg
in sorted(self
.DependentPackageList
, key
=lambda x
: x
.PackageName
):
4442 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4443 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4446 if self
.LibraryAutoGenList
:
4447 for Lib
in sorted(self
.LibraryAutoGenList
, key
=lambda x
: x
.Name
):
4448 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4450 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4453 f
= open(str(self
.MetaFile
), 'r')
4457 # Add Module's source files
4458 if self
.SourceFileList
:
4459 for File
in sorted(self
.SourceFileList
, key
=lambda x
: str(x
)):
4460 f
= open(str(File
), 'r')
4465 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4466 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4467 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4468 if GlobalData
.gBinCacheSource
:
4469 CacheValid
= self
.AttemptModuleCacheCopy()
4472 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4474 ## Decide whether we can skip the ModuleAutoGen process
4475 def CanSkipbyHash(self
):
4476 if GlobalData
.gUseHashCache
:
4477 return not self
.GenModuleHash()
4479 ## Decide whether we can skip the ModuleAutoGen process
4480 # If any source file is newer than the module than we cannot skip
4483 if not os
.path
.exists(self
.GetTimeStampPath()):
4485 #last creation time of the module
4486 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4488 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4489 if SrcTimeStamp
> DstTimeStamp
:
4492 with
open(self
.GetTimeStampPath(),'r') as f
:
4494 source
= source
.rstrip('\n')
4495 if not os
.path
.exists(source
):
4497 if source
not in ModuleAutoGen
.TimeDict
:
4498 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4499 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4503 def GetTimeStampPath(self
):
4504 if self
._TimeStampPath
is None:
4505 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4506 return self
._TimeStampPath
4507 def CreateTimeStamp(self
, Makefile
):
4511 FileSet
.add (self
.MetaFile
.Path
)
4513 for SourceFile
in self
.Module
.Sources
:
4514 FileSet
.add (SourceFile
.Path
)
4516 for Lib
in self
.DependentLibraryList
:
4517 FileSet
.add (Lib
.MetaFile
.Path
)
4519 for f
in self
.AutoGenDepSet
:
4520 FileSet
.add (f
.Path
)
4522 if os
.path
.exists (self
.GetTimeStampPath()):
4523 os
.remove (self
.GetTimeStampPath())
4524 with
open(self
.GetTimeStampPath(), 'w+') as file:
4528 Module
= property(_GetModule
)
4529 Name
= property(_GetBaseName
)
4530 Guid
= property(_GetGuid
)
4531 Version
= property(_GetVersion
)
4532 ModuleType
= property(_GetModuleType
)
4533 ComponentType
= property(_GetComponentType
)
4534 BuildType
= property(_GetBuildType
)
4535 PcdIsDriver
= property(_GetPcdIsDriver
)
4536 AutoGenVersion
= property(_GetAutoGenVersion
)
4537 Macros
= property(_GetMacros
)
4538 Specification
= property(_GetSpecification
)
4540 IsLibrary
= property(_IsLibrary
)
4541 IsBinaryModule
= property(_IsBinaryModule
)
4542 BuildDir
= property(_GetBuildDir
)
4543 OutputDir
= property(_GetOutputDir
)
4544 FfsOutputDir
= property(_GetFfsOutputDir
)
4545 DebugDir
= property(_GetDebugDir
)
4546 MakeFileDir
= property(_GetMakeFileDir
)
4547 CustomMakefile
= property(_GetCustomMakefile
)
4549 IncludePathList
= property(_GetIncludePathList
)
4550 IncludePathLength
= property(_GetIncludePathLength
)
4551 AutoGenFileList
= property(_GetAutoGenFileList
)
4552 UnicodeFileList
= property(_GetUnicodeFileList
)
4553 VfrFileList
= property(_GetVfrFileList
)
4554 SourceFileList
= property(_GetSourceFileList
)
4555 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4556 Targets
= property(_GetTargets
)
4557 IntroTargetList
= property(_GetIntroTargetList
)
4558 CodaTargetList
= property(_GetFinalTargetList
)
4559 FileTypes
= property(_GetFileTypes
)
4560 BuildRules
= property(_GetBuildRules
)
4561 IdfFileList
= property(_GetIdfFileList
)
4563 DependentPackageList
= property(_GetDependentPackageList
)
4564 DependentLibraryList
= property(_GetLibraryList
)
4565 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4566 DerivedPackageList
= property(_GetDerivedPackageList
)
4568 ModulePcdList
= property(_GetModulePcdList
)
4569 LibraryPcdList
= property(_GetLibraryPcdList
)
4570 GuidList
= property(_GetGuidList
)
4571 ProtocolList
= property(_GetProtocolList
)
4572 PpiList
= property(_GetPpiList
)
4573 DepexList
= property(_GetDepexTokenList
)
4574 DxsFile
= property(_GetDxsFile
)
4575 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4576 BuildOption
= property(_GetModuleBuildOption
)
4577 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4578 BuildCommand
= property(_GetBuildCommand
)
4580 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4582 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4583 if __name__
== '__main__':