2 # Generate AutoGen.h, AutoGen.c and *.depex files
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 import Common
.LongFilePathOs
as os
18 import os
.path
as path
25 from StringIO
import StringIO
27 from StrGather
import *
28 from BuildEngine
import BuildRule
30 from Common
.LongFilePathSupport
import CopyLongFilePath
31 from Common
.BuildToolError
import *
32 from Common
.DataType
import *
33 from Common
.Misc
import *
34 from Common
.String
import *
35 import Common
.GlobalData
as GlobalData
36 from GenFds
.FdfParser
import *
37 from CommonDataClass
.CommonClass
import SkuInfoClass
38 from Workspace
.BuildClassObject
import *
39 from GenPatchPcdTable
.GenPatchPcdTable
import parsePcdInfoFromMapFile
40 import Common
.VpdInfoFile
as VpdInfoFile
41 from GenPcdDb
import CreatePcdDatabaseCode
42 from Workspace
.MetaFileCommentParser
import UsageList
43 from Common
.MultipleWorkspace
import MultipleWorkspace
as mws
44 import InfSectionParser
47 from GenVar
import VariableMgr
,var_info
48 from collections
import OrderedDict
49 from collections
import defaultdict
51 ## Regular expression for splitting Dependency Expression string into tokens
52 gDepexTokenPattern
= re
.compile("(\(|\)|\w+| \S+\.inf)")
54 ## Regular expression for match: PCD(xxxx.yyy)
55 gPCDAsGuidPattern
= re
.compile(r
"^PCD\(.+\..+\)$")
58 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
59 # is the former use /I , the Latter used -I to specify include directories
61 gBuildOptIncludePatternMsft
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
62 gBuildOptIncludePatternOther
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
65 # Match name = variable
67 gEfiVarStoreNamePattern
= re
.compile("\s*name\s*=\s*(\w+)")
69 # The format of guid in efivarstore statement likes following and must be correct:
70 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
72 gEfiVarStoreGuidPattern
= re
.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
74 ## Mapping Makefile type
75 gMakeTypeMap
= {"MSFT":"nmake", "GCC":"gmake"}
78 ## Build rule configuration file
79 gDefaultBuildRuleFile
= 'build_rule.txt'
81 ## Tools definition configuration file
82 gDefaultToolsDefFile
= 'tools_def.txt'
84 ## Build rule default version
85 AutoGenReqBuildRuleVerNum
= "0.1"
87 ## default file name for AutoGen
88 gAutoGenCodeFileName
= "AutoGen.c"
89 gAutoGenHeaderFileName
= "AutoGen.h"
90 gAutoGenStringFileName
= "%(module_name)sStrDefs.h"
91 gAutoGenStringFormFileName
= "%(module_name)sStrDefs.hpk"
92 gAutoGenDepexFileName
= "%(module_name)s.depex"
93 gAutoGenImageDefFileName
= "%(module_name)sImgDefs.h"
94 gAutoGenIdfFileName
= "%(module_name)sIdf.hpk"
95 gInfSpecVersion
= "0x00010017"
98 # Template string to generic AsBuilt INF
100 gAsBuiltInfHeaderString
= TemplateString("""${header_comments}
103 # FILE auto-generated
106 INF_VERSION = ${module_inf_version}
107 BASE_NAME = ${module_name}
108 FILE_GUID = ${module_guid}
109 MODULE_TYPE = ${module_module_type}${BEGIN}
110 VERSION_STRING = ${module_version_string}${END}${BEGIN}
111 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
112 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
113 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
114 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
115 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
116 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
117 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
118 SHADOW = ${module_shadow}${END}${BEGIN}
119 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
120 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
121 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
122 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
123 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
124 SPEC = ${module_spec}${END}${BEGIN}
125 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
126 MODULE_UNI_FILE = ${module_uni_file}${END}
128 [Packages.${module_arch}]${BEGIN}
129 ${package_item}${END}
131 [Binaries.${module_arch}]${BEGIN}
134 [PatchPcd.${module_arch}]${BEGIN}
138 [Protocols.${module_arch}]${BEGIN}
142 [Ppis.${module_arch}]${BEGIN}
146 [Guids.${module_arch}]${BEGIN}
150 [PcdEx.${module_arch}]${BEGIN}
154 [LibraryClasses.${module_arch}]
155 ## @LIB_INSTANCES${BEGIN}
156 # ${libraryclasses_item}${END}
160 ${userextension_tianocore_item}
164 [BuildOptions.${module_arch}]
166 ## ${flags_item}${END}
169 ## Base class for AutoGen
171 # This class just implements the cache mechanism of AutoGen objects.
173 class AutoGen(object):
174 # database to maintain the objects in each child class
175 __ObjectCache
= {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object
179 # @param Class class object of real AutoGen class
180 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
181 # @param Workspace Workspace directory or WorkspaceAutoGen object
182 # @param MetaFile The path of meta file
183 # @param Target Build target
184 # @param Toolchain Tool chain name
185 # @param Arch Target arch
186 # @param *args The specific class related parameters
187 # @param **kwargs The specific class related dict parameters
189 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
190 # check if the object has been created
191 Key
= (Target
, Toolchain
, Arch
, MetaFile
)
193 # if it exists, just return it directly
194 return cls
.__ObjectCache
[Key
]
196 # it didnt exist. create it, cache it, then return it
197 cls
.__ObjectCache
[Key
] = super(AutoGen
, cls
).__new
__(cls
)
198 return cls
.__ObjectCache
[Key
]
200 def __init__ (self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
201 super(AutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
205 # The file path of platform file will be used to represent hash value of this object
207 # @retval int Hash value of the file path of platform file
210 return hash(self
.MetaFile
)
214 # The file path of platform file will be used to represent this object
216 # @retval string String of platform file path
219 return str(self
.MetaFile
)
222 def __eq__(self
, Other
):
223 return Other
and self
.MetaFile
== Other
225 ## Workspace AutoGen class
227 # This class is used mainly to control the whole platform build for different
228 # architecture. This class will generate top level makefile.
230 class WorkspaceAutoGen(AutoGen
):
231 # call super().__init__ then call the worker function with different parameter count
232 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
236 super(WorkspaceAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
237 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
240 ## Initialize WorkspaceAutoGen
242 # @param WorkspaceDir Root directory of workspace
243 # @param ActivePlatform Meta-file of active platform
244 # @param Target Build target
245 # @param Toolchain Tool chain name
246 # @param ArchList List of architecture of current build
247 # @param MetaFileDb Database containing meta-files
248 # @param BuildConfig Configuration of build
249 # @param ToolDefinition Tool chain definitions
250 # @param FlashDefinitionFile File of flash definition
251 # @param Fds FD list to be generated
252 # @param Fvs FV list to be generated
253 # @param Caps Capsule list to be generated
254 # @param SkuId SKU id from command line
256 def _InitWorker(self
, WorkspaceDir
, ActivePlatform
, Target
, Toolchain
, ArchList
, MetaFileDb
,
257 BuildConfig
, ToolDefinition
, FlashDefinitionFile
='', Fds
=None, Fvs
=None, Caps
=None, SkuId
='', UniFlag
=None,
258 Progress
=None, BuildModule
=None):
259 self
.BuildDatabase
= MetaFileDb
260 self
.MetaFile
= ActivePlatform
261 self
.WorkspaceDir
= WorkspaceDir
262 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, TAB_ARCH_COMMON
, Target
, Toolchain
]
263 GlobalData
.gActivePlatform
= self
.Platform
264 self
.BuildTarget
= Target
265 self
.ToolChain
= Toolchain
266 self
.ArchList
= ArchList
268 self
.UniFlag
= UniFlag
270 self
.TargetTxt
= BuildConfig
271 self
.ToolDef
= ToolDefinition
272 self
.FdfFile
= FlashDefinitionFile
273 self
.FdTargetList
= Fds
if Fds
else []
274 self
.FvTargetList
= Fvs
if Fvs
else []
275 self
.CapTargetList
= Caps
if Caps
else []
276 self
.AutoGenObjectList
= []
277 self
._BuildDir
= None
279 self
._MakeFileDir
= None
280 self
._BuildCommand
= None
283 # there's many relative directory operations, so ...
284 os
.chdir(self
.WorkspaceDir
)
289 if not self
.ArchList
:
290 ArchList
= set(self
.Platform
.SupArchList
)
292 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
294 EdkLogger
.error("build", PARAMETER_INVALID
,
295 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
296 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
297 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
298 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
299 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
300 self
.ArchList
= tuple(ArchList
)
302 # Validate build target
303 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
304 EdkLogger
.error("build", PARAMETER_INVALID
,
305 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
306 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
309 # parse FDF file to get PCDs in it, if any
311 self
.FdfFile
= self
.Platform
.FlashDefinition
315 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
316 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
317 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
319 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
321 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
324 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
326 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
329 Progress
.Start("\nProcessing meta-data")
333 # Mark now build in AutoGen Phase
335 GlobalData
.gAutoGenPhase
= True
336 Fdf
= FdfParser(self
.FdfFile
.Path
)
338 GlobalData
.gFdfParser
= Fdf
339 GlobalData
.gAutoGenPhase
= False
340 PcdSet
= Fdf
.Profile
.PcdDict
341 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
342 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
343 for FdRegion
in FdDict
.RegionList
:
344 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
345 if int(FdRegion
.Offset
) % 8 != 0:
346 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
347 ModuleList
= Fdf
.Profile
.InfList
348 self
.FdfProfile
= Fdf
.Profile
349 for fvname
in self
.FvTargetList
:
350 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
351 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
352 "No such an FV in FDF file: %s" % fvname
)
354 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
355 # but the path (self.MetaFile.Path) is the real path
356 for key
in self
.FdfProfile
.InfDict
:
359 for Arch
in self
.ArchList
:
360 Current_Platform_cache
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
361 MetaFile_cache
[Arch
] = set()
362 for Pkey
in Current_Platform_cache
.Modules
:
363 MetaFile_cache
[Arch
].add(Current_Platform_cache
.Modules
[Pkey
].MetaFile
)
364 for Inf
in self
.FdfProfile
.InfDict
[key
]:
365 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
366 for Arch
in self
.ArchList
:
367 if ModuleFile
in MetaFile_cache
[Arch
]:
370 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
371 if not ModuleData
.IsBinaryModule
:
372 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
375 for Arch
in self
.ArchList
:
377 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
379 for Pkey
in Platform
.Modules
:
380 MetaFileList
.add(Platform
.Modules
[Pkey
].MetaFile
)
381 for Inf
in self
.FdfProfile
.InfDict
[key
]:
382 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
383 if ModuleFile
in MetaFileList
:
385 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
386 if not ModuleData
.IsBinaryModule
:
387 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
392 self
.FdfProfile
= None
393 if self
.FdTargetList
:
394 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
395 self
.FdTargetList
= []
396 if self
.FvTargetList
:
397 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
398 self
.FvTargetList
= []
399 if self
.CapTargetList
:
400 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
401 self
.CapTargetList
= []
403 # apply SKU and inject PCDs from Flash Definition file
404 for Arch
in self
.ArchList
:
405 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
406 PlatformPcds
= Platform
.Pcds
407 self
._GuidDict
= Platform
._GuidDict
408 SourcePcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set(),TAB_PCDS_DYNAMIC
:set(),TAB_PCDS_FIXED_AT_BUILD
:set()}
409 BinaryPcdDict
= {TAB_PCDS_DYNAMIC_EX
:set(), TAB_PCDS_PATCHABLE_IN_MODULE
:set()}
410 SourcePcdDict_Keys
= SourcePcdDict
.keys()
411 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
413 # generate the SourcePcdDict and BinaryPcdDict
414 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
415 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
416 if BuildData
.Arch
!= Arch
:
418 if BuildData
.MetaFile
.Ext
== '.inf':
419 for key
in BuildData
.Pcds
:
420 if BuildData
.Pcds
[key
].Pending
:
421 if key
in Platform
.Pcds
:
422 PcdInPlatform
= Platform
.Pcds
[key
]
423 if PcdInPlatform
.Type
not in [None, '']:
424 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
426 if BuildData
.MetaFile
in Platform
.Modules
:
427 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
428 if key
in PlatformModule
.Pcds
:
429 PcdInPlatform
= PlatformModule
.Pcds
[key
]
430 if PcdInPlatform
.Type
not in [None, '']:
431 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
433 if TAB_PCDS_DYNAMIC_EX
in BuildData
.Pcds
[key
].Type
:
434 if BuildData
.IsBinaryModule
:
435 BinaryPcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
437 SourcePcdDict
[TAB_PCDS_DYNAMIC_EX
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
439 elif TAB_PCDS_PATCHABLE_IN_MODULE
in BuildData
.Pcds
[key
].Type
:
440 if BuildData
.MetaFile
.Ext
== '.inf':
441 if BuildData
.IsBinaryModule
:
442 BinaryPcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
444 SourcePcdDict
[TAB_PCDS_PATCHABLE_IN_MODULE
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
446 elif TAB_PCDS_DYNAMIC
in BuildData
.Pcds
[key
].Type
:
447 SourcePcdDict
[TAB_PCDS_DYNAMIC
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
448 elif TAB_PCDS_FIXED_AT_BUILD
in BuildData
.Pcds
[key
].Type
:
449 SourcePcdDict
[TAB_PCDS_FIXED_AT_BUILD
].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
453 # A PCD can only use one type for all source modules
455 for i
in SourcePcdDict_Keys
:
456 for j
in SourcePcdDict_Keys
:
458 Intersections
= SourcePcdDict
[i
].intersection(SourcePcdDict
[j
])
459 if len(Intersections
) > 0:
463 "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
),
464 ExtraData
="%s" % '\n\t'.join([str(P
[1]+'.'+P
[0]) for P
in Intersections
])
468 # intersection the BinaryPCD for Mixed PCD
470 for i
in BinaryPcdDict_Keys
:
471 for j
in BinaryPcdDict_Keys
:
473 Intersections
= BinaryPcdDict
[i
].intersection(BinaryPcdDict
[j
])
474 for item
in Intersections
:
475 NewPcd1
= (item
[0] + '_' + i
, item
[1])
476 NewPcd2
= (item
[0] + '_' + j
, item
[1])
477 if item
not in GlobalData
.MixedPcd
:
478 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
480 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
481 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
482 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
483 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
486 # intersection the SourcePCD and BinaryPCD for Mixed PCD
488 for i
in SourcePcdDict_Keys
:
489 for j
in BinaryPcdDict_Keys
:
491 Intersections
= SourcePcdDict
[i
].intersection(BinaryPcdDict
[j
])
492 for item
in Intersections
:
493 NewPcd1
= (item
[0] + '_' + i
, item
[1])
494 NewPcd2
= (item
[0] + '_' + j
, item
[1])
495 if item
not in GlobalData
.MixedPcd
:
496 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
498 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
499 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
500 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
501 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
503 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
504 if BuildData
.Arch
!= Arch
:
506 for key
in BuildData
.Pcds
:
507 for SinglePcd
in GlobalData
.MixedPcd
:
508 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
509 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
510 Pcd_Type
= item
[0].split('_')[-1]
511 if (Pcd_Type
== BuildData
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
512 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
513 Value
= BuildData
.Pcds
[key
]
514 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
516 newkey
= (Value
.TokenCName
, key
[1])
518 newkey
= (Value
.TokenCName
, key
[1], key
[2])
519 del BuildData
.Pcds
[key
]
520 BuildData
.Pcds
[newkey
] = Value
524 # handle the mixed pcd in FDF file
526 if key
in GlobalData
.MixedPcd
:
529 for item
in GlobalData
.MixedPcd
[key
]:
532 #Collect package set information from INF of FDF
534 for Inf
in ModuleList
:
535 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
536 if ModuleFile
in Platform
.Modules
:
538 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
539 PkgSet
.update(ModuleData
.Packages
)
540 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
545 DecPcds
.add((Pcd
[0], Pcd
[1]))
546 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
548 Platform
.SkuName
= self
.SkuId
549 for Name
, Guid
in PcdSet
:
550 if (Name
, Guid
) not in DecPcds
:
554 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
555 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
556 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
559 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
560 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
561 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
562 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
563 Platform
.AddPcd(Name
, Guid
, PcdSet
[Name
, Guid
])
565 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
569 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
570 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
571 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
574 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
576 # Explicitly collect platform's dynamic PCDs
578 Pa
.CollectPlatformDynamicPcds()
579 Pa
.CollectFixedAtBuildPcds()
580 self
.AutoGenObjectList
.append(Pa
)
583 # Generate Package level hash value
585 GlobalData
.gPackageHash
[Arch
] = {}
586 if GlobalData
.gUseHashCache
:
588 self
._GenPkgLevelHash
(Pkg
)
591 # Check PCDs token value conflict in each DEC file.
593 self
._CheckAllPcdsTokenValueConflict
()
596 # Check PCD type and definition between DSC and DEC
598 self
._CheckPcdDefineAndType
()
601 # self._CheckDuplicateInFV(Fdf)
604 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
606 content
= 'gCommandLineDefines: '
607 content
+= str(GlobalData
.gCommandLineDefines
)
608 content
+= os
.linesep
609 content
+= 'BuildOptionPcd: '
610 content
+= str(GlobalData
.BuildOptionPcd
)
611 content
+= os
.linesep
612 content
+= 'Active Platform: '
613 content
+= str(self
.Platform
)
614 content
+= os
.linesep
616 content
+= 'Flash Image Definition: '
617 content
+= str(self
.FdfFile
)
618 content
+= os
.linesep
619 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
622 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
624 PcdTokenNumber
= 'PcdTokenNumber: '
625 if Pa
.PcdTokenNumber
:
626 if Pa
.DynamicPcdList
:
627 for Pcd
in Pa
.DynamicPcdList
:
628 PcdTokenNumber
+= os
.linesep
629 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
630 PcdTokenNumber
+= ' : '
631 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
632 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
635 # Get set of workspace metafiles
637 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
640 # Retrieve latest modified time of all metafiles
643 for f
in AllWorkSpaceMetaFiles
:
644 if os
.stat(f
)[8] > SrcTimeStamp
:
645 SrcTimeStamp
= os
.stat(f
)[8]
646 self
._SrcTimeStamp
= SrcTimeStamp
648 if GlobalData
.gUseHashCache
:
650 for files
in AllWorkSpaceMetaFiles
:
651 if files
.endswith('.dec'):
657 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
658 GlobalData
.gPlatformHash
= m
.hexdigest()
661 # Write metafile list to build directory
663 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
664 if os
.path
.exists (AutoGenFilePath
):
665 os
.remove(AutoGenFilePath
)
666 if not os
.path
.exists(self
.BuildDir
):
667 os
.makedirs(self
.BuildDir
)
668 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
669 for f
in AllWorkSpaceMetaFiles
:
673 def _GenPkgLevelHash(self
, Pkg
):
674 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
675 CreateDirectory(PkgDir
)
676 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
678 # Get .dec file's hash value
679 f
= open(Pkg
.MetaFile
.Path
, 'r')
683 # Get include files hash value
685 for inc
in Pkg
.Includes
:
686 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
688 File_Path
= os
.path
.join(Root
, File
)
689 f
= open(File_Path
, 'r')
693 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
694 if Pkg
.PackageName
not in GlobalData
.gPackageHash
[Pkg
.Arch
]:
695 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
697 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
698 AllWorkSpaceMetaFiles
= set()
703 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
705 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
707 AllWorkSpaceMetaFiles
.add (f
.FileName
)
711 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
714 # add build_rule.txt & tools_def.txt
716 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
717 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
719 # add BuildOption metafile
721 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
723 # add PcdToken Number file for Dynamic/DynamicEx Pcd
725 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
727 for Arch
in self
.ArchList
:
728 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
729 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
734 for Package
in PGen
.PackageList
:
735 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
740 for filePath
in Platform
._RawData
.IncludedFiles
:
741 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
743 return AllWorkSpaceMetaFiles
745 ## _CheckDuplicateInFV() method
747 # Check whether there is duplicate modules/files exist in FV section.
748 # The check base on the file GUID;
750 def _CheckDuplicateInFV(self
, Fdf
):
751 for Fv
in Fdf
.Profile
.FvDict
:
753 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
754 if FfsFile
.InfFileName
and FfsFile
.NameGuid
is None:
759 for Pa
in self
.AutoGenObjectList
:
762 for Module
in Pa
.ModuleAutoGenList
:
763 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
765 if Module
.Guid
.upper() not in _GuidDict
:
766 _GuidDict
[Module
.Guid
.upper()] = FfsFile
769 EdkLogger
.error("build",
771 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
772 FfsFile
.CurrentLineContent
,
773 _GuidDict
[Module
.Guid
.upper()].CurrentLineNum
,
774 _GuidDict
[Module
.Guid
.upper()].CurrentLineContent
,
775 Module
.Guid
.upper()),
776 ExtraData
=self
.FdfFile
)
778 # Some INF files not have entity in DSC file.
781 if FfsFile
.InfFileName
.find('$') == -1:
782 InfPath
= NormPath(FfsFile
.InfFileName
)
783 if not os
.path
.exists(InfPath
):
784 EdkLogger
.error('build', GENFDS_ERROR
, "Non-existant Module %s !" % (FfsFile
.InfFileName
))
786 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
788 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
789 # BuildObject from one of AutoGenObjectList is enough.
791 InfObj
= self
.AutoGenObjectList
[0].BuildDatabase
.WorkspaceDb
.BuildObject
[PathClassObj
, TAB_ARCH_COMMON
, self
.BuildTarget
, self
.ToolChain
]
792 if InfObj
.Guid
.upper() not in _GuidDict
:
793 _GuidDict
[InfObj
.Guid
.upper()] = FfsFile
795 EdkLogger
.error("build",
797 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
798 FfsFile
.CurrentLineContent
,
799 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineNum
,
800 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineContent
,
801 InfObj
.Guid
.upper()),
802 ExtraData
=self
.FdfFile
)
805 if FfsFile
.NameGuid
is not None:
807 # If the NameGuid reference a PCD name.
808 # The style must match: PCD(xxxx.yyy)
810 if gPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
812 # Replace the PCD value.
814 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
816 for Pa
in self
.AutoGenObjectList
:
818 for PcdItem
in Pa
.AllPcdList
:
819 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
821 # First convert from CFormatGuid to GUID string
823 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
825 if not _PcdGuidString
:
827 # Then try Byte array.
829 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
831 if not _PcdGuidString
:
833 # Not Byte array or CFormat GUID, raise error.
835 EdkLogger
.error("build",
837 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
838 ExtraData
=self
.FdfFile
)
840 if _PcdGuidString
.upper() not in _GuidDict
:
841 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
845 EdkLogger
.error("build",
847 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
848 FfsFile
.CurrentLineContent
,
849 _GuidDict
[_PcdGuidString
.upper()].CurrentLineNum
,
850 _GuidDict
[_PcdGuidString
.upper()].CurrentLineContent
,
851 FfsFile
.NameGuid
.upper()),
852 ExtraData
=self
.FdfFile
)
854 if FfsFile
.NameGuid
.upper() not in _GuidDict
:
855 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
858 # Two raw file GUID conflict.
860 EdkLogger
.error("build",
862 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
863 FfsFile
.CurrentLineContent
,
864 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineNum
,
865 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineContent
,
866 FfsFile
.NameGuid
.upper()),
867 ExtraData
=self
.FdfFile
)
870 def _CheckPcdDefineAndType(self
):
872 TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_PATCHABLE_IN_MODULE
, TAB_PCDS_FEATURE_FLAG
,
873 TAB_PCDS_DYNAMIC
, #"DynamicHii", "DynamicVpd",
874 TAB_PCDS_DYNAMIC_EX
, # "DynamicExHii", "DynamicExVpd"
877 # This dict store PCDs which are not used by any modules with specified arches
878 UnusedPcd
= OrderedDict()
879 for Pa
in self
.AutoGenObjectList
:
880 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
881 for Pcd
in Pa
.Platform
.Pcds
:
882 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
884 # If no PCD type, this PCD comes from FDF
888 # Try to remove Hii and Vpd suffix
889 if PcdType
.startswith(TAB_PCDS_DYNAMIC_EX
):
890 PcdType
= TAB_PCDS_DYNAMIC_EX
891 elif PcdType
.startswith(TAB_PCDS_DYNAMIC
):
892 PcdType
= TAB_PCDS_DYNAMIC
894 for Package
in Pa
.PackageList
:
895 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
896 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
898 for Type
in PcdTypeList
:
899 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
903 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
904 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
909 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
911 for Pcd
in UnusedPcd
:
914 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
915 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
916 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
921 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
923 ## Return the directory to store FV files
925 if self
._FvDir
is None:
926 self
._FvDir
= path
.join(self
.BuildDir
, 'FV')
929 ## Return the directory to store all intermediate and final files built
930 def _GetBuildDir(self
):
931 if self
._BuildDir
is None:
932 return self
.AutoGenObjectList
[0].BuildDir
934 ## Return the build output directory platform specifies
935 def _GetOutputDir(self
):
936 return self
.Platform
.OutputDirectory
938 ## Return platform name
940 return self
.Platform
.PlatformName
942 ## Return meta-file GUID
944 return self
.Platform
.Guid
946 ## Return platform version
947 def _GetVersion(self
):
948 return self
.Platform
.Version
950 ## Return paths of tools
951 def _GetToolDefinition(self
):
952 return self
.AutoGenObjectList
[0].ToolDefinition
954 ## Return directory of platform makefile
956 # @retval string Makefile directory
958 def _GetMakeFileDir(self
):
959 if self
._MakeFileDir
is None:
960 self
._MakeFileDir
= self
.BuildDir
961 return self
._MakeFileDir
963 ## Return build command string
965 # @retval string Build command string
967 def _GetBuildCommand(self
):
968 if self
._BuildCommand
is None:
969 # BuildCommand should be all the same. So just get one from platform AutoGen
970 self
._BuildCommand
= self
.AutoGenObjectList
[0].BuildCommand
971 return self
._BuildCommand
973 ## Check the PCDs token value conflict in each DEC file.
975 # Will cause build break and raise error message while two PCDs conflict.
979 def _CheckAllPcdsTokenValueConflict(self
):
980 for Pa
in self
.AutoGenObjectList
:
981 for Package
in Pa
.PackageList
:
982 PcdList
= Package
.Pcds
.values()
983 PcdList
.sort(lambda x
, y
: cmp(int(x
.TokenValue
, 0), int(y
.TokenValue
, 0)))
985 while (Count
< len(PcdList
) - 1) :
986 Item
= PcdList
[Count
]
987 ItemNext
= PcdList
[Count
+ 1]
989 # Make sure in the same token space the TokenValue should be unique
991 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
992 SameTokenValuePcdList
= []
993 SameTokenValuePcdList
.append(Item
)
994 SameTokenValuePcdList
.append(ItemNext
)
995 RemainPcdListLength
= len(PcdList
) - Count
- 2
996 for ValueSameCount
in range(RemainPcdListLength
):
997 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
998 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
1002 # Sort same token value PCD list with TokenGuid and TokenCName
1004 SameTokenValuePcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1005 SameTokenValuePcdListCount
= 0
1006 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
1008 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1009 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
1011 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
1012 for PcdItem
in GlobalData
.MixedPcd
:
1013 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
1014 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1020 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1021 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
1024 SameTokenValuePcdListCount
+= 1
1025 Count
+= SameTokenValuePcdListCount
1028 PcdList
= Package
.Pcds
.values()
1029 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1031 while (Count
< len(PcdList
) - 1) :
1032 Item
= PcdList
[Count
]
1033 ItemNext
= PcdList
[Count
+ 1]
1035 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1037 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
1041 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1042 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
1046 ## Generate fds command
1047 def _GenFdsCommand(self
):
1048 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1050 ## Create makefile for the platform and modules in it
1052 # @param CreateDepsMakeFile Flag indicating if the makefile for
1053 # modules will be created as well
1055 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1056 if CreateDepsMakeFile
:
1057 for Pa
in self
.AutoGenObjectList
:
1058 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1060 ## Create autogen code for platform and modules
1062 # Since there's no autogen code for platform, this method will do nothing
1063 # if CreateModuleCodeFile is set to False.
1065 # @param CreateDepsCodeFile Flag indicating if creating module's
1066 # autogen code file or not
1068 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1069 if not CreateDepsCodeFile
:
1071 for Pa
in self
.AutoGenObjectList
:
1072 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1074 ## Create AsBuilt INF file the platform
1076 def CreateAsBuiltInf(self
):
1079 Name
= property(_GetName
)
1080 Guid
= property(_GetGuid
)
1081 Version
= property(_GetVersion
)
1082 OutputDir
= property(_GetOutputDir
)
1084 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1086 BuildDir
= property(_GetBuildDir
)
1087 FvDir
= property(_GetFvDir
)
1088 MakeFileDir
= property(_GetMakeFileDir
)
1089 BuildCommand
= property(_GetBuildCommand
)
1090 GenFdsCommand
= property(_GenFdsCommand
)
1092 ## AutoGen class for platform
1094 # PlatformAutoGen class will process the original information in platform
1095 # file in order to generate makefile for platform.
1097 class PlatformAutoGen(AutoGen
):
1098 # call super().__init__ then call the worker function with different parameter count
1099 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
1103 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
1104 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
1107 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1108 # correct PCD database
1111 _NonDynaPcdList_
= []
1115 # The priority list while override build option
1117 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1118 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1119 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1120 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1121 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1122 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1123 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1124 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1125 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1126 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1127 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1128 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1129 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1130 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1131 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1132 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1134 ## Initialize PlatformAutoGen
1137 # @param Workspace WorkspaceAutoGen object
1138 # @param PlatformFile Platform file (DSC file)
1139 # @param Target Build target (DEBUG, RELEASE)
1140 # @param Toolchain Name of tool chain
1141 # @param Arch arch of the platform supports
1143 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1144 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1145 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1147 self
.MetaFile
= PlatformFile
1148 self
.Workspace
= Workspace
1149 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1150 self
.ToolChain
= Toolchain
1151 self
.BuildTarget
= Target
1153 self
.SourceDir
= PlatformFile
.SubDir
1154 self
.SourceOverrideDir
= None
1155 self
.FdTargetList
= self
.Workspace
.FdTargetList
1156 self
.FvTargetList
= self
.Workspace
.FvTargetList
1157 self
.AllPcdList
= []
1158 # get the original module/package/platform objects
1159 self
.BuildDatabase
= Workspace
.BuildDatabase
1160 self
.DscBuildDataObj
= Workspace
.Platform
1161 self
._GuidDict
= Workspace
._GuidDict
1163 # flag indicating if the makefile/C-code file has been created or not
1164 self
.IsMakeFileCreated
= False
1165 self
.IsCodeFileCreated
= False
1167 self
._Platform
= None
1170 self
._Version
= None
1172 self
._BuildRule
= None
1173 self
._SourceDir
= None
1174 self
._BuildDir
= None
1175 self
._OutputDir
= None
1177 self
._MakeFileDir
= None
1178 self
._FdfFile
= None
1180 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1181 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1182 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1183 self
._NonDynamicPcdDict
= {}
1185 self
._ToolDefinitions
= None
1186 self
._ToolDefFile
= None # toolcode : tool path
1187 self
._ToolChainFamily
= None
1188 self
._BuildRuleFamily
= None
1189 self
._BuildOption
= None # toolcode : option
1190 self
._EdkBuildOption
= None # edktoolcode : option
1191 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1192 self
._PackageList
= None
1193 self
._ModuleAutoGenList
= None
1194 self
._LibraryAutoGenList
= None
1195 self
._BuildCommand
= None
1196 self
._AsBuildInfList
= []
1197 self
._AsBuildModuleList
= []
1199 self
.VariableInfo
= None
1201 if GlobalData
.gFdfParser
is not None:
1202 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1203 for Inf
in self
._AsBuildInfList
:
1204 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1205 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1206 if not M
.IsSupportedArch
:
1208 self
._AsBuildModuleList
.append(InfClass
)
1209 # get library/modules for build
1210 self
.LibraryBuildDirectoryList
= []
1211 self
.ModuleBuildDirectoryList
= []
1216 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1218 ## Create autogen code for platform and modules
1220 # Since there's no autogen code for platform, this method will do nothing
1221 # if CreateModuleCodeFile is set to False.
1223 # @param CreateModuleCodeFile Flag indicating if creating module's
1224 # autogen code file or not
1226 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1227 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1228 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1231 for Ma
in self
.ModuleAutoGenList
:
1232 Ma
.CreateCodeFile(True)
1234 # don't do this twice
1235 self
.IsCodeFileCreated
= True
1237 ## Generate Fds Command
1238 def _GenFdsCommand(self
):
1239 return self
.Workspace
.GenFdsCommand
1241 ## Create makefile for the platform and mdoules in it
1243 # @param CreateModuleMakeFile Flag indicating if the makefile for
1244 # modules will be created as well
1246 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1247 if CreateModuleMakeFile
:
1248 for ModuleFile
in self
.Platform
.Modules
:
1249 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1250 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1251 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1252 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1254 Ma
.CreateMakeFile(True)
1255 #Ma.CreateAsBuiltInf()
1257 # no need to create makefile for the platform more than once
1258 if self
.IsMakeFileCreated
:
1261 # create library/module build dirs for platform
1262 Makefile
= GenMake
.PlatformMakefile(self
)
1263 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1264 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1266 self
.IsMakeFileCreated
= True
1268 ## Deal with Shared FixedAtBuild Pcds
1270 def CollectFixedAtBuildPcds(self
):
1271 for LibAuto
in self
.LibraryAutoGenList
:
1272 FixedAtBuildPcds
= {}
1273 ShareFixedAtBuildPcdsSameValue
= {}
1274 for Module
in LibAuto
._ReferenceModules
:
1275 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1276 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1277 if key
not in FixedAtBuildPcds
:
1278 ShareFixedAtBuildPcdsSameValue
[key
] = True
1279 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1281 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1282 ShareFixedAtBuildPcdsSameValue
[key
] = False
1283 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1284 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1285 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1288 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1289 if DscPcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
1291 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1292 LibAuto
.ConstPcd
[key
] = FixedAtBuildPcds
[key
]
1294 def CollectVariables(self
, DynamicPcdSet
):
1298 if self
.Workspace
.FdfFile
:
1299 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1300 for FdRegion
in FdDict
.RegionList
:
1301 for item
in FdRegion
.RegionDataList
:
1302 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1303 VpdRegionSize
= FdRegion
.Size
1304 VpdRegionBase
= FdRegion
.Offset
1308 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1309 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1310 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1312 for Pcd
in DynamicPcdSet
:
1313 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1314 for SkuName
in Pcd
.SkuInfoList
:
1315 Sku
= Pcd
.SkuInfoList
[SkuName
]
1317 if SkuId
is None or SkuId
== '':
1319 if len(Sku
.VariableName
) > 0:
1320 VariableGuidStructure
= Sku
.VariableGuidValue
1321 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1322 for StorageName
in Sku
.DefaultStoreDict
:
1323 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1327 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1328 if self
.VariableInfo
:
1329 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1330 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1332 if PcdNvStoreDfBuffer
:
1333 if os
.path
.exists(VpdMapFilePath
):
1334 OrgVpdFile
.Read(VpdMapFilePath
)
1335 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1336 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1338 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1340 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1341 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get(TAB_DEFAULT
)
1342 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1343 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1345 if var_data
and default_skuobj
:
1346 default_skuobj
.DefaultValue
= var_data
1347 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1348 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1349 PcdNvStoreDfBuffer
[0].SkuInfoList
[TAB_DEFAULT
] = default_skuobj
1350 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1354 ## Collect dynamic PCDs
1356 # Gather dynamic PCDs list from each module and their settings from platform
1357 # This interface should be invoked explicitly when platform action is created.
1359 def CollectPlatformDynamicPcds(self
):
1361 for key
in self
.Platform
.Pcds
:
1362 for SinglePcd
in GlobalData
.MixedPcd
:
1363 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1364 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1365 Pcd_Type
= item
[0].split('_')[-1]
1366 if (Pcd_Type
== self
.Platform
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
1367 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1368 Value
= self
.Platform
.Pcds
[key
]
1369 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1371 newkey
= (Value
.TokenCName
, key
[1])
1373 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1374 del self
.Platform
.Pcds
[key
]
1375 self
.Platform
.Pcds
[newkey
] = Value
1383 # for gathering error information
1384 NoDatumTypePcdList
= set()
1386 for InfName
in self
._AsBuildInfList
:
1387 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1388 FdfModuleList
.append(os
.path
.normpath(InfName
))
1389 for F
in self
.Platform
.Modules
.keys():
1390 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1391 #GuidValue.update(M.Guids)
1393 self
.Platform
.Modules
[F
].M
= M
1395 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1396 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1397 if PcdFromModule
.DatumType
== TAB_VOID
and PcdFromModule
.MaxDatumSize
in [None, '']:
1398 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1400 # Check the PCD from Binary INF or Source INF
1401 if M
.IsBinaryModule
== True:
1402 PcdFromModule
.IsFromBinaryInf
= True
1404 # Check the PCD from DSC or not
1405 PcdFromModule
.IsFromDsc
= (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
1407 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1408 if F
.Path
not in FdfModuleList
:
1409 # If one of the Source built modules listed in the DSC is not listed
1410 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1411 # access method (it is only listed in the DEC file that declares the
1412 # PCD as PcdsDynamic), then build tool will report warning message
1413 # notify the PI that they are attempting to build a module that must
1414 # be included in a flash image in order to be functional. These Dynamic
1415 # PCD will not be added into the Database unless it is used by other
1416 # modules that are included in the FDF file.
1417 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1418 PcdFromModule
.IsFromBinaryInf
== False:
1419 # Print warning message to let the developer make a determine.
1421 # If one of the Source built modules listed in the DSC is not listed in
1422 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1423 # access method (it is only listed in the DEC file that declares the
1424 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1425 # PCD to the Platform's PCD Database.
1426 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1429 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1430 # it should be stored in Pcd PEI database, If a dynamic only
1431 # used by DXE module, it should be stored in DXE PCD database.
1432 # The default Phase is DXE
1434 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1435 PcdFromModule
.Phase
= "PEI"
1436 if PcdFromModule
not in self
._DynaPcdList
_:
1437 self
._DynaPcdList
_.append(PcdFromModule
)
1438 elif PcdFromModule
.Phase
== 'PEI':
1439 # overwrite any the same PCD existing, if Phase is PEI
1440 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1441 self
._DynaPcdList
_[Index
] = PcdFromModule
1442 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1443 self
._NonDynaPcdList
_.append(PcdFromModule
)
1444 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1445 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1446 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1447 #The PCD from Binary INF will override the same one from source INF
1448 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1449 PcdFromModule
.Pending
= False
1450 self
._NonDynaPcdList
_.append (PcdFromModule
)
1451 DscModuleSet
= {os
.path
.normpath(ModuleInf
.Path
) for ModuleInf
in self
.Platform
.Modules
}
1452 # add the PCD from modules that listed in FDF but not in DSC to Database
1453 for InfName
in FdfModuleList
:
1454 if InfName
not in DscModuleSet
:
1455 InfClass
= PathClass(InfName
)
1456 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1457 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1458 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1459 # For binary module, if in current arch, we need to list the PCDs into database.
1460 if not M
.IsSupportedArch
:
1462 # Override the module PCD setting by platform setting
1463 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1464 for PcdFromModule
in ModulePcdList
:
1465 PcdFromModule
.IsFromBinaryInf
= True
1466 PcdFromModule
.IsFromDsc
= False
1467 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1468 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1469 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1471 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1472 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1473 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1474 if PcdFromModule
.DatumType
== TAB_VOID
and PcdFromModule
.MaxDatumSize
in [None, '']:
1475 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1476 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1477 PcdFromModule
.Phase
= "PEI"
1478 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1479 self
._DynaPcdList
_.append(PcdFromModule
)
1480 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1481 self
._NonDynaPcdList
_.append(PcdFromModule
)
1482 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1483 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1484 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1485 # module & DXE module at a same time.
1486 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1487 # INF file as DynamicEx.
1488 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1489 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1490 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1491 for PcdFromModule
in self
._NonDynaPcdList
_:
1492 # If a PCD is not listed in the DSC file, but binary INF files used by
1493 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1494 # section, AND all source INF files used by this platform the build
1495 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1496 # section, then the tools must NOT add the PCD to the Platform's PCD
1497 # Database; the build must assign the access method for this PCD as
1498 # PcdsPatchableInModule.
1499 if PcdFromModule
not in self
._DynaPcdList
_:
1501 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1502 if PcdFromModule
.IsFromDsc
== False and \
1503 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1504 PcdFromModule
.IsFromBinaryInf
== True and \
1505 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1506 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1507 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1509 # print out error information and break the build, if error found
1510 if len(NoDatumTypePcdList
) > 0:
1511 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1512 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1514 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1515 % NoDatumTypePcdListString
)
1516 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1517 self
._DynamicPcdList
= self
._DynaPcdList
_
1519 # Sort dynamic PCD list to:
1520 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1521 # try to be put header of dynamicd List
1522 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1524 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1526 UnicodePcdArray
= set()
1528 OtherPcdArray
= set()
1530 VpdFile
= VpdInfoFile
.VpdInfoFile()
1531 NeedProcessVpdMapFile
= False
1533 for pcd
in self
.Platform
.Pcds
:
1534 if pcd
not in self
._PlatformPcds
:
1535 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1537 for item
in self
._PlatformPcds
:
1538 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1539 self
._PlatformPcds
[item
].DatumType
= TAB_VOID
1541 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1542 for Pcd
in self
._DynamicPcdList
:
1543 # just pick the a value to determine whether is unicode string type
1544 Sku
= Pcd
.SkuInfoList
.values()[0]
1545 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1547 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1548 Pcd
.DatumType
= TAB_VOID
1550 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1551 # if found HII type PCD then insert to right of UnicodeIndex
1552 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1553 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1555 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1556 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1557 if PcdNvStoreDfBuffer
:
1558 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1559 vardump
= self
.VariableInfo
.dump()
1561 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1562 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1563 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1564 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1566 PlatformPcds
= self
._PlatformPcds
.keys()
1569 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1572 for PcdKey
in PlatformPcds
:
1573 Pcd
= self
._PlatformPcds
[PcdKey
]
1574 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1575 PcdKey
in VpdPcdDict
:
1576 Pcd
= VpdPcdDict
[PcdKey
]
1578 DefaultSku
= Pcd
.SkuInfoList
.get(TAB_DEFAULT
)
1580 PcdValue
= DefaultSku
.DefaultValue
1581 if PcdValue
not in SkuValueMap
:
1582 SkuValueMap
[PcdValue
] = []
1583 VpdFile
.Add(Pcd
, TAB_DEFAULT
,DefaultSku
.VpdOffset
)
1584 SkuValueMap
[PcdValue
].append(DefaultSku
)
1586 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1587 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1588 PcdValue
= Sku
.DefaultValue
1590 PcdValue
= Pcd
.DefaultValue
1591 if Sku
.VpdOffset
!= '*':
1592 if PcdValue
.startswith("{"):
1594 elif PcdValue
.startswith("L"):
1599 VpdOffset
= int(Sku
.VpdOffset
)
1602 VpdOffset
= int(Sku
.VpdOffset
, 16)
1604 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1605 if VpdOffset
% Alignment
!= 0:
1606 if PcdValue
.startswith("{"):
1607 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1609 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1610 if PcdValue
not in SkuValueMap
:
1611 SkuValueMap
[PcdValue
] = []
1612 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1613 SkuValueMap
[PcdValue
].append(Sku
)
1614 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1615 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1616 NeedProcessVpdMapFile
= True
1617 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1618 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1619 "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.")
1621 VpdSkuMap
[PcdKey
] = SkuValueMap
1623 # Fix the PCDs define in VPD PCD section that never referenced by module.
1624 # An example is PCD for signature usage.
1626 for DscPcd
in PlatformPcds
:
1627 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1628 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1629 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1631 for VpdPcd
in VpdFile
._VpdArray
:
1632 # This PCD has been referenced by module
1633 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1634 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1637 # Not found, it should be signature
1639 # just pick the a value to determine whether is unicode string type
1641 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1642 DefaultSku
= DscPcdEntry
.SkuInfoList
.get(TAB_DEFAULT
)
1644 defaultindex
= SkuObjList
.index((TAB_DEFAULT
,DefaultSku
))
1645 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1646 for (SkuName
,Sku
) in SkuObjList
:
1647 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1649 # Need to iterate DEC pcd information to get the value & datumtype
1650 for eachDec
in self
.PackageList
:
1651 for DecPcd
in eachDec
.Pcds
:
1652 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1653 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1654 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1655 # Print warning message to let the developer make a determine.
1656 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1657 File
=self
.MetaFile
, \
1658 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1659 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1661 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1662 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1663 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1664 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1665 # Only fix the value while no value provided in DSC file.
1666 if not Sku
.DefaultValue
:
1667 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1669 if DscPcdEntry
not in self
._DynamicPcdList
:
1670 self
._DynamicPcdList
.append(DscPcdEntry
)
1671 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1672 PcdValue
= Sku
.DefaultValue
1674 PcdValue
= DscPcdEntry
.DefaultValue
1675 if Sku
.VpdOffset
!= '*':
1676 if PcdValue
.startswith("{"):
1678 elif PcdValue
.startswith("L"):
1683 VpdOffset
= int(Sku
.VpdOffset
)
1686 VpdOffset
= int(Sku
.VpdOffset
, 16)
1688 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1689 if VpdOffset
% Alignment
!= 0:
1690 if PcdValue
.startswith("{"):
1691 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1693 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1694 if PcdValue
not in SkuValueMap
:
1695 SkuValueMap
[PcdValue
] = []
1696 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1697 SkuValueMap
[PcdValue
].append(Sku
)
1698 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1699 NeedProcessVpdMapFile
= True
1700 if DscPcdEntry
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1701 UnicodePcdArray
.add(DscPcdEntry
)
1702 elif len(Sku
.VariableName
) > 0:
1703 HiiPcdArray
.add(DscPcdEntry
)
1705 OtherPcdArray
.add(DscPcdEntry
)
1707 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1708 VpdSkuMap
[DscPcd
] = SkuValueMap
1709 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1710 VpdFile
.GetCount() != 0:
1711 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1712 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1714 if VpdFile
.GetCount() != 0:
1716 self
.FixVpdOffset(VpdFile
)
1718 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1720 # Process VPD map file generated by third party BPDG tool
1721 if NeedProcessVpdMapFile
:
1722 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1723 if os
.path
.exists(VpdMapFilePath
):
1724 VpdFile
.Read(VpdMapFilePath
)
1727 for pcd
in VpdSkuMap
:
1728 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1730 # just pick the a value to determine whether is unicode string type
1732 for pcdvalue
in VpdSkuMap
[pcd
]:
1733 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1734 for item
in vpdinfo
:
1735 if item
[2] == pcdvalue
:
1736 sku
.VpdOffset
= item
[1]
1738 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1740 # Delete the DynamicPcdList At the last time enter into this function
1741 for Pcd
in self
._DynamicPcdList
:
1742 # just pick the a value to determine whether is unicode string type
1743 Sku
= Pcd
.SkuInfoList
.values()[0]
1744 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1746 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1747 Pcd
.DatumType
= TAB_VOID
1749 PcdValue
= Sku
.DefaultValue
1750 if Pcd
.DatumType
== TAB_VOID
and PcdValue
.startswith("L"):
1751 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1752 UnicodePcdArray
.add(Pcd
)
1753 elif len(Sku
.VariableName
) > 0:
1754 # if found HII type PCD then insert to right of UnicodeIndex
1755 HiiPcdArray
.add(Pcd
)
1757 OtherPcdArray
.add(Pcd
)
1758 del self
._DynamicPcdList
[:]
1759 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1760 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1761 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1762 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1763 for pcd
in self
._DynamicPcdList
:
1764 if len(pcd
.SkuInfoList
) == 1:
1765 for (SkuName
,SkuId
) in allskuset
:
1766 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1768 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
[TAB_DEFAULT
])
1769 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1770 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1772 def FixVpdOffset(self
,VpdFile
):
1773 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1774 if not os
.path
.exists(FvPath
):
1778 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1780 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1782 if VpdFile
.Write(VpdFilePath
):
1783 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1785 for ToolDef
in self
.ToolDefinition
.values():
1786 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1787 if not ToolDef
.has_key("PATH"):
1788 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1789 BPDGToolName
= ToolDef
["PATH"]
1791 # Call third party GUID BPDG tool.
1792 if BPDGToolName
is not None:
1793 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1795 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.")
1797 ## Return the platform build data object
1798 def _GetPlatform(self
):
1799 if self
._Platform
is None:
1800 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1801 return self
._Platform
1803 ## Return platform name
1805 return self
.Platform
.PlatformName
1807 ## Return the meta file GUID
1809 return self
.Platform
.Guid
1811 ## Return the platform version
1812 def _GetVersion(self
):
1813 return self
.Platform
.Version
1815 ## Return the FDF file name
1816 def _GetFdfFile(self
):
1817 if self
._FdfFile
is None:
1818 if self
.Workspace
.FdfFile
!= "":
1819 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1822 return self
._FdfFile
1824 ## Return the build output directory platform specifies
1825 def _GetOutputDir(self
):
1826 return self
.Platform
.OutputDirectory
1828 ## Return the directory to store all intermediate and final files built
1829 def _GetBuildDir(self
):
1830 if self
._BuildDir
is None:
1831 if os
.path
.isabs(self
.OutputDir
):
1832 self
._BuildDir
= path
.join(
1833 path
.abspath(self
.OutputDir
),
1834 self
.BuildTarget
+ "_" + self
.ToolChain
,
1837 self
._BuildDir
= path
.join(
1840 self
.BuildTarget
+ "_" + self
.ToolChain
,
1842 GlobalData
.gBuildDirectory
= self
._BuildDir
1843 return self
._BuildDir
1845 ## Return directory of platform makefile
1847 # @retval string Makefile directory
1849 def _GetMakeFileDir(self
):
1850 if self
._MakeFileDir
is None:
1851 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1852 return self
._MakeFileDir
1854 ## Return build command string
1856 # @retval string Build command string
1858 def _GetBuildCommand(self
):
1859 if self
._BuildCommand
is None:
1860 self
._BuildCommand
= []
1861 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1862 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1863 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1864 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1866 self
._BuildCommand
+= SplitOption(NewOption
)
1867 if "MAKE" in self
.EdkIIBuildOption
:
1868 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1869 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1870 if Flags
.startswith('='):
1871 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1873 self
._BuildCommand
+= [Flags
]
1874 return self
._BuildCommand
1876 ## Get tool chain definition
1878 # Get each tool defition for given tool chain from tools_def.txt and platform
1880 def _GetToolDefinition(self
):
1881 if self
._ToolDefinitions
is None:
1882 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1883 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1884 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1885 ExtraData
="[%s]" % self
.MetaFile
)
1886 self
._ToolDefinitions
= {}
1888 for Def
in ToolDefinition
:
1889 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1890 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1893 Value
= ToolDefinition
[Def
]
1894 # don't record the DLL
1896 DllPathList
.add(Value
)
1899 if Tool
not in self
._ToolDefinitions
:
1900 self
._ToolDefinitions
[Tool
] = {}
1901 self
._ToolDefinitions
[Tool
][Attr
] = Value
1904 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1905 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1906 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1907 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1909 for Tool
in self
._ToolDefinitions
:
1910 for Attr
in self
._ToolDefinitions
[Tool
]:
1911 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1912 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1913 # check if override is indicated
1914 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1915 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1918 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1920 Value
= self
.BuildOption
[Tool
][Attr
]
1923 # Don't put MAKE definition in the file
1925 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1927 # Don't put MAKE definition in the file
1932 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1935 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1936 for DllPath
in DllPathList
:
1937 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1938 os
.environ
["MAKE_FLAGS"] = MakeFlags
1940 return self
._ToolDefinitions
1942 ## Return the paths of tools
1943 def _GetToolDefFile(self
):
1944 if self
._ToolDefFile
is None:
1945 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1946 return self
._ToolDefFile
1948 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1949 def _GetToolChainFamily(self
):
1950 if self
._ToolChainFamily
is None:
1951 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1952 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1953 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1954 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1955 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1957 self
._ToolChainFamily
= "MSFT"
1959 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1960 return self
._ToolChainFamily
1962 def _GetBuildRuleFamily(self
):
1963 if self
._BuildRuleFamily
is None:
1964 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1965 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1966 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1967 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1968 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1970 self
._BuildRuleFamily
= "MSFT"
1972 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1973 return self
._BuildRuleFamily
1975 ## Return the build options specific for all modules in this platform
1976 def _GetBuildOptions(self
):
1977 if self
._BuildOption
is None:
1978 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1979 return self
._BuildOption
1981 ## Return the build options specific for EDK modules in this platform
1982 def _GetEdkBuildOptions(self
):
1983 if self
._EdkBuildOption
is None:
1984 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1985 return self
._EdkBuildOption
1987 ## Return the build options specific for EDKII modules in this platform
1988 def _GetEdkIIBuildOptions(self
):
1989 if self
._EdkIIBuildOption
is None:
1990 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1991 return self
._EdkIIBuildOption
1993 ## Parse build_rule.txt in Conf Directory.
1995 # @retval BuildRule object
1997 def _GetBuildRule(self
):
1998 if self
._BuildRule
is None:
1999 BuildRuleFile
= None
2000 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2001 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2002 if BuildRuleFile
in [None, '']:
2003 BuildRuleFile
= gDefaultBuildRuleFile
2004 self
._BuildRule
= BuildRule(BuildRuleFile
)
2005 if self
._BuildRule
._FileVersion
== "":
2006 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2008 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2009 # If Build Rule's version is less than the version number required by the tools, halting the build.
2010 EdkLogger
.error("build", AUTOGEN_ERROR
,
2011 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])"\
2012 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2014 return self
._BuildRule
2016 ## Summarize the packages used by modules in this platform
2017 def _GetPackageList(self
):
2018 if self
._PackageList
is None:
2019 self
._PackageList
= set()
2020 for La
in self
.LibraryAutoGenList
:
2021 self
._PackageList
.update(La
.DependentPackageList
)
2022 for Ma
in self
.ModuleAutoGenList
:
2023 self
._PackageList
.update(Ma
.DependentPackageList
)
2024 #Collect package set information from INF of FDF
2026 for ModuleFile
in self
._AsBuildModuleList
:
2027 if ModuleFile
in self
.Platform
.Modules
:
2029 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2030 PkgSet
.update(ModuleData
.Packages
)
2031 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2032 return self
._PackageList
2034 def _GetNonDynamicPcdDict(self
):
2035 if self
._NonDynamicPcdDict
:
2036 return self
._NonDynamicPcdDict
2037 for Pcd
in self
.NonDynamicPcdList
:
2038 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2039 return self
._NonDynamicPcdDict
2041 ## Get list of non-dynamic PCDs
2042 def _GetNonDynamicPcdList(self
):
2043 if self
._NonDynamicPcdList
is None:
2044 self
.CollectPlatformDynamicPcds()
2045 return self
._NonDynamicPcdList
2047 ## Get list of dynamic PCDs
2048 def _GetDynamicPcdList(self
):
2049 if self
._DynamicPcdList
is None:
2050 self
.CollectPlatformDynamicPcds()
2051 return self
._DynamicPcdList
2053 ## Generate Token Number for all PCD
2054 def _GetPcdTokenNumbers(self
):
2055 if self
._PcdTokenNumber
is None:
2056 self
._PcdTokenNumber
= OrderedDict()
2059 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2063 # TokenNumber 0 ~ 10
2065 # TokeNumber 11 ~ 20
2067 for Pcd
in self
.DynamicPcdList
:
2068 if Pcd
.Phase
== "PEI":
2069 if Pcd
.Type
in [TAB_PCDS_DYNAMIC
, "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2070 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2071 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2074 for Pcd
in self
.DynamicPcdList
:
2075 if Pcd
.Phase
== "PEI":
2076 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_EX
, "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2077 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2078 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2081 for Pcd
in self
.DynamicPcdList
:
2082 if Pcd
.Phase
== "DXE":
2083 if Pcd
.Type
in [TAB_PCDS_DYNAMIC
, "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2084 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2085 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2088 for Pcd
in self
.DynamicPcdList
:
2089 if Pcd
.Phase
== "DXE":
2090 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_EX
, "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2091 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2092 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2095 for Pcd
in self
.NonDynamicPcdList
:
2096 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2098 return self
._PcdTokenNumber
2100 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2101 def _GetAutoGenObjectList(self
):
2102 self
._ModuleAutoGenList
= []
2103 self
._LibraryAutoGenList
= []
2104 for ModuleFile
in self
.Platform
.Modules
:
2113 if Ma
not in self
._ModuleAutoGenList
:
2114 self
._ModuleAutoGenList
.append(Ma
)
2115 for La
in Ma
.LibraryAutoGenList
:
2116 if La
not in self
._LibraryAutoGenList
:
2117 self
._LibraryAutoGenList
.append(La
)
2118 if Ma
not in La
._ReferenceModules
:
2119 La
._ReferenceModules
.append(Ma
)
2121 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2122 def _GetModuleAutoGenList(self
):
2123 if self
._ModuleAutoGenList
is None:
2124 self
._GetAutoGenObjectList
()
2125 return self
._ModuleAutoGenList
2127 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2128 def _GetLibraryAutoGenList(self
):
2129 if self
._LibraryAutoGenList
is None:
2130 self
._GetAutoGenObjectList
()
2131 return self
._LibraryAutoGenList
2133 ## Test if a module is supported by the platform
2135 # An error will be raised directly if the module or its arch is not supported
2136 # by the platform or current configuration
2138 def ValidModule(self
, Module
):
2139 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2140 or Module
in self
._AsBuildModuleList
2142 ## Resolve the library classes in a module to library instances
2144 # This method will not only resolve library classes but also sort the library
2145 # instances according to the dependency-ship.
2147 # @param Module The module from which the library classes will be resolved
2149 # @retval library_list List of library instances sorted
2151 def ApplyLibraryInstance(self
, Module
):
2152 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2153 if str(Module
) not in self
.Platform
.Modules
:
2156 ModuleType
= Module
.ModuleType
2158 # for overridding library instances with module specific setting
2159 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2161 # add forced library instances (specified under LibraryClasses sections)
2163 # If a module has a MODULE_TYPE of USER_DEFINED,
2164 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2166 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2167 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2168 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2169 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2171 # add forced library instances (specified in module overrides)
2172 for LibraryClass
in PlatformModule
.LibraryClasses
:
2173 if LibraryClass
.startswith("NULL"):
2174 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2177 LibraryConsumerList
= [Module
]
2179 ConsumedByList
= OrderedDict()
2180 LibraryInstance
= OrderedDict()
2182 EdkLogger
.verbose("")
2183 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2184 while len(LibraryConsumerList
) > 0:
2185 M
= LibraryConsumerList
.pop()
2186 for LibraryClassName
in M
.LibraryClasses
:
2187 if LibraryClassName
not in LibraryInstance
:
2188 # override library instance for this module
2189 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2190 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2192 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2193 if LibraryPath
is None or LibraryPath
== "":
2194 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2195 if LibraryPath
is None or LibraryPath
== "":
2196 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2197 "Instance of library class [%s] is not found" % LibraryClassName
,
2199 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2201 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2202 # for those forced library instance (NULL library), add a fake library class
2203 if LibraryClassName
.startswith("NULL"):
2204 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2205 elif LibraryModule
.LibraryClass
is None \
2206 or len(LibraryModule
.LibraryClass
) == 0 \
2207 or (ModuleType
!= 'USER_DEFINED'
2208 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2209 # only USER_DEFINED can link against any library instance despite of its SupModList
2210 EdkLogger
.error("build", OPTION_MISSING
,
2211 "Module type [%s] is not supported by library instance [%s]" \
2212 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2213 ExtraData
="consumed by [%s]" % str(Module
))
2215 LibraryInstance
[LibraryClassName
] = LibraryModule
2216 LibraryConsumerList
.append(LibraryModule
)
2217 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2219 LibraryModule
= LibraryInstance
[LibraryClassName
]
2221 if LibraryModule
is None:
2224 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2225 Constructor
.append(LibraryModule
)
2227 if LibraryModule
not in ConsumedByList
:
2228 ConsumedByList
[LibraryModule
] = []
2229 # don't add current module itself to consumer list
2231 if M
in ConsumedByList
[LibraryModule
]:
2233 ConsumedByList
[LibraryModule
].append(M
)
2235 # Initialize the sorted output list to the empty set
2237 SortedLibraryList
= []
2239 # Q <- Set of all nodes with no incoming edges
2241 LibraryList
= [] #LibraryInstance.values()
2243 for LibraryClassName
in LibraryInstance
:
2244 M
= LibraryInstance
[LibraryClassName
]
2245 LibraryList
.append(M
)
2246 if ConsumedByList
[M
] == []:
2250 # start the DAG algorithm
2254 while Q
== [] and EdgeRemoved
:
2256 # for each node Item with a Constructor
2257 for Item
in LibraryList
:
2258 if Item
not in Constructor
:
2260 # for each Node without a constructor with an edge e from Item to Node
2261 for Node
in ConsumedByList
[Item
]:
2262 if Node
in Constructor
:
2264 # remove edge e from the graph if Node has no constructor
2265 ConsumedByList
[Item
].remove(Node
)
2267 if ConsumedByList
[Item
] == []:
2268 # insert Item into Q
2273 # DAG is done if there's no more incoming edge for all nodes
2277 # remove node from Q
2280 SortedLibraryList
.append(Node
)
2282 # for each node Item with an edge e from Node to Item do
2283 for Item
in LibraryList
:
2284 if Node
not in ConsumedByList
[Item
]:
2286 # remove edge e from the graph
2287 ConsumedByList
[Item
].remove(Node
)
2289 if ConsumedByList
[Item
] != []:
2291 # insert Item into Q, if Item has no other incoming edges
2295 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2297 for Item
in LibraryList
:
2298 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2299 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2300 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2301 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2302 if Item
not in SortedLibraryList
:
2303 SortedLibraryList
.append(Item
)
2306 # Build the list of constructor and destructir names
2307 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2309 SortedLibraryList
.reverse()
2310 return SortedLibraryList
2313 ## Override PCD setting (type, value, ...)
2315 # @param ToPcd The PCD to be overrided
2316 # @param FromPcd The PCD overrideing from
2318 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2320 # in case there's PCDs coming from FDF file, which have no type given.
2321 # at this point, ToPcd.Type has the type found from dependent
2324 TokenCName
= ToPcd
.TokenCName
2325 for PcdItem
in GlobalData
.MixedPcd
:
2326 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2327 TokenCName
= PcdItem
[0]
2329 if FromPcd
is not None:
2330 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2331 ToPcd
.Type
= FromPcd
.Type
2332 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2333 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2334 if ToPcd
.Type
.strip() == TAB_PCDS_DYNAMIC_EX
:
2335 ToPcd
.Type
= FromPcd
.Type
2336 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2337 and ToPcd
.Type
!= FromPcd
.Type
:
2338 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2339 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2340 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2341 ToPcd
.Type
, Module
, FromPcd
.Type
),
2344 if FromPcd
.MaxDatumSize
:
2345 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2346 ToPcd
.MaxSizeUserSet
= FromPcd
.MaxDatumSize
2347 if FromPcd
.DefaultValue
:
2348 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2349 if FromPcd
.TokenValue
:
2350 ToPcd
.TokenValue
= FromPcd
.TokenValue
2351 if FromPcd
.DatumType
:
2352 ToPcd
.DatumType
= FromPcd
.DatumType
2353 if FromPcd
.SkuInfoList
:
2354 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2355 # Add Flexible PCD format parse
2356 if ToPcd
.DefaultValue
:
2358 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2359 except BadExpression
, Value
:
2360 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2363 # check the validation of datum
2364 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2366 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2367 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2368 ToPcd
.validateranges
= FromPcd
.validateranges
2369 ToPcd
.validlists
= FromPcd
.validlists
2370 ToPcd
.expressions
= FromPcd
.expressions
2372 if FromPcd
is not None and ToPcd
.DatumType
== TAB_VOID
and ToPcd
.MaxDatumSize
in ['', None]:
2373 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2374 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2375 Value
= ToPcd
.DefaultValue
2376 if Value
in [None, '']:
2377 ToPcd
.MaxDatumSize
= '1'
2378 elif Value
[0] == 'L':
2379 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2380 elif Value
[0] == '{':
2381 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2383 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2385 # apply default SKU for dynamic PCDS if specified one is not available
2386 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2387 and ToPcd
.SkuInfoList
in [None, {}, '']:
2388 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2389 SkuName
= self
.Platform
.SkuName
2391 SkuName
= TAB_DEFAULT
2392 ToPcd
.SkuInfoList
= {
2393 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2396 ## Apply PCD setting defined platform to a module
2398 # @param Module The module from which the PCD setting will be overrided
2400 # @retval PCD_list The list PCDs with settings from platform
2402 def ApplyPcdSetting(self
, Module
, Pcds
):
2403 # for each PCD in module
2404 for Name
, Guid
in Pcds
:
2405 PcdInModule
= Pcds
[Name
, Guid
]
2406 # find out the PCD setting in platform
2407 if (Name
, Guid
) in self
.Platform
.Pcds
:
2408 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2410 PcdInPlatform
= None
2411 # then override the settings if any
2412 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2413 # resolve the VariableGuid value
2414 for SkuId
in PcdInModule
.SkuInfoList
:
2415 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2416 if Sku
.VariableGuid
== '': continue
2417 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2418 if Sku
.VariableGuidValue
is None:
2419 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2422 RESOURCE_NOT_AVAILABLE
,
2423 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2424 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2425 % (Guid
, Name
, str(Module
)),
2429 # override PCD settings with module specific setting
2430 if Module
in self
.Platform
.Modules
:
2431 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2432 for Key
in PlatformModule
.Pcds
:
2437 elif Key
in GlobalData
.MixedPcd
:
2438 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2440 ToPcd
= Pcds
[PcdItem
]
2444 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2445 # use PCD value to calculate the MaxDatumSize when it is not specified
2446 for Name
, Guid
in Pcds
:
2447 Pcd
= Pcds
[Name
, Guid
]
2448 if Pcd
.DatumType
== TAB_VOID
and Pcd
.MaxDatumSize
in ['', None]:
2449 Pcd
.MaxSizeUserSet
= None
2450 Value
= Pcd
.DefaultValue
2451 if Value
in [None, '']:
2452 Pcd
.MaxDatumSize
= '1'
2453 elif Value
[0] == 'L':
2454 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2455 elif Value
[0] == '{':
2456 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2458 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2459 return Pcds
.values()
2461 ## Resolve library names to library modules
2463 # (for Edk.x modules)
2465 # @param Module The module from which the library names will be resolved
2467 # @retval library_list The list of library modules
2469 def ResolveLibraryReference(self
, Module
):
2470 EdkLogger
.verbose("")
2471 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2472 LibraryConsumerList
= [Module
]
2474 # "CompilerStub" is a must for Edk modules
2475 if Module
.Libraries
:
2476 Module
.Libraries
.append("CompilerStub")
2478 while len(LibraryConsumerList
) > 0:
2479 M
= LibraryConsumerList
.pop()
2480 for LibraryName
in M
.Libraries
:
2481 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2483 for Key
in self
.Platform
.LibraryClasses
.data
:
2484 if LibraryName
.upper() == Key
.upper():
2485 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2488 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2489 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2492 if Library
not in LibraryList
:
2493 LibraryList
.append(Library
)
2494 LibraryConsumerList
.append(Library
)
2495 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2498 ## Calculate the priority value of the build option
2500 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2502 # @retval Value Priority value based on the priority list.
2504 def CalculatePriorityValue(self
, Key
):
2505 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2506 PriorityValue
= 0x11111
2508 PriorityValue
&= 0x01111
2509 if ToolChain
== "*":
2510 PriorityValue
&= 0x10111
2512 PriorityValue
&= 0x11011
2513 if CommandType
== "*":
2514 PriorityValue
&= 0x11101
2516 PriorityValue
&= 0x11110
2518 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2521 ## Expand * in build option key
2523 # @param Options Options to be expanded
2525 # @retval options Options expanded
2527 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2534 # Construct a list contain the build options which need override.
2538 # Key[0] -- tool family
2539 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2541 if (Key
[0] == self
.BuildRuleFamily
and
2542 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2543 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2544 if Target
== self
.BuildTarget
or Target
== "*":
2545 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2546 if Arch
== self
.Arch
or Arch
== "*":
2547 if Options
[Key
].startswith("="):
2548 if OverrideList
.get(Key
[1]) is not None:
2549 OverrideList
.pop(Key
[1])
2550 OverrideList
[Key
[1]] = Options
[Key
]
2553 # Use the highest priority value.
2555 if (len(OverrideList
) >= 2):
2556 KeyList
= OverrideList
.keys()
2557 for Index
in range(len(KeyList
)):
2558 NowKey
= KeyList
[Index
]
2559 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2560 for Index1
in range(len(KeyList
) - Index
- 1):
2561 NextKey
= KeyList
[Index1
+ Index
+ 1]
2563 # Compare two Key, if one is included by another, choose the higher priority one
2565 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2566 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2567 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2568 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2569 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2570 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2571 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2572 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2573 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2575 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2576 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2579 if ModuleStyle
is not None and len (Key
) > 2:
2580 # Check Module style is EDK or EDKII.
2581 # Only append build option for the matched style module.
2582 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2584 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2587 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2588 # if tool chain family doesn't match, skip it
2589 if Tool
in self
.ToolDefinition
and Family
!= "":
2590 FamilyIsNull
= False
2591 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2592 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2594 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2597 # expand any wildcard
2598 if Target
== "*" or Target
== self
.BuildTarget
:
2599 if Tag
== "*" or Tag
== self
.ToolChain
:
2600 if Arch
== "*" or Arch
== self
.Arch
:
2601 if Tool
not in BuildOptions
:
2602 BuildOptions
[Tool
] = {}
2603 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2604 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2606 # append options for the same tool except PATH
2608 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2610 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2611 # Build Option Family has been checked, which need't to be checked again for family.
2612 if FamilyMatch
or FamilyIsNull
:
2616 if ModuleStyle
is not None and len (Key
) > 2:
2617 # Check Module style is EDK or EDKII.
2618 # Only append build option for the matched style module.
2619 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2621 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2624 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2625 # if tool chain family doesn't match, skip it
2626 if Tool
not in self
.ToolDefinition
or Family
== "":
2628 # option has been added before
2629 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2632 # expand any wildcard
2633 if Target
== "*" or Target
== self
.BuildTarget
:
2634 if Tag
== "*" or Tag
== self
.ToolChain
:
2635 if Arch
== "*" or Arch
== self
.Arch
:
2636 if Tool
not in BuildOptions
:
2637 BuildOptions
[Tool
] = {}
2638 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2639 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2641 # append options for the same tool except PATH
2643 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2645 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2648 ## Append build options in platform to a module
2650 # @param Module The module to which the build options will be appened
2652 # @retval options The options appended with build options in platform
2654 def ApplyBuildOption(self
, Module
):
2655 # Get the different options for the different style module
2656 if Module
.AutoGenVersion
< 0x00010005:
2657 PlatformOptions
= self
.EdkBuildOption
2658 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2660 PlatformOptions
= self
.EdkIIBuildOption
2661 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2662 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2663 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2664 if Module
in self
.Platform
.Modules
:
2665 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2666 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2668 PlatformModuleOptions
= {}
2670 BuildRuleOrder
= None
2671 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2672 for Tool
in Options
:
2673 for Attr
in Options
[Tool
]:
2674 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2675 BuildRuleOrder
= Options
[Tool
][Attr
]
2677 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2678 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2679 self
.ToolDefinition
.keys())
2680 BuildOptions
= defaultdict(lambda: defaultdict(str))
2681 for Tool
in AllTools
:
2682 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2683 if Tool
not in Options
:
2685 for Attr
in Options
[Tool
]:
2687 # Do not generate it in Makefile
2689 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2691 Value
= Options
[Tool
][Attr
]
2692 # check if override is indicated
2693 if Value
.startswith('='):
2694 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
[1:])
2697 BuildOptions
[Tool
][Attr
] += " " + mws
.handleWsMacro(Value
)
2699 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
)
2701 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2703 # Override UNI flag only for EDK module.
2705 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2706 return BuildOptions
, BuildRuleOrder
2708 Platform
= property(_GetPlatform
)
2709 Name
= property(_GetName
)
2710 Guid
= property(_GetGuid
)
2711 Version
= property(_GetVersion
)
2713 OutputDir
= property(_GetOutputDir
)
2714 BuildDir
= property(_GetBuildDir
)
2715 MakeFileDir
= property(_GetMakeFileDir
)
2716 FdfFile
= property(_GetFdfFile
)
2718 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2719 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2720 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2721 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2722 PackageList
= property(_GetPackageList
)
2724 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2725 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2726 ToolChainFamily
= property(_GetToolChainFamily
)
2727 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2728 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2729 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2730 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2732 BuildCommand
= property(_GetBuildCommand
)
2733 BuildRule
= property(_GetBuildRule
)
2734 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2735 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2736 GenFdsCommand
= property(_GenFdsCommand
)
2738 ## ModuleAutoGen class
2740 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2741 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2742 # to the [depex] section in module's inf file.
2744 class ModuleAutoGen(AutoGen
):
2745 # call super().__init__ then call the worker function with different parameter count
2746 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2750 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2751 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2754 ## Cache the timestamps of metafiles of every module in a class variable
2758 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2759 obj
= super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2760 # check if this module is employed by active platform
2761 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2762 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2767 ## Initialize ModuleAutoGen
2769 # @param Workspace EdkIIWorkspaceBuild object
2770 # @param ModuleFile The path of module file
2771 # @param Target Build target (DEBUG, RELEASE)
2772 # @param Toolchain Name of tool chain
2773 # @param Arch The arch the module supports
2774 # @param PlatformFile Platform meta-file
2776 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2777 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2778 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2780 self
.Workspace
= Workspace
2781 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2782 self
._GuidDict
= Workspace
._GuidDict
2783 self
.MetaFile
= ModuleFile
2784 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2786 self
.SourceDir
= self
.MetaFile
.SubDir
2787 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2789 self
.SourceOverrideDir
= None
2790 # use overrided path defined in DSC file
2791 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2792 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2794 self
.ToolChain
= Toolchain
2795 self
.BuildTarget
= Target
2797 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2798 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2800 self
.IsMakeFileCreated
= False
2801 self
.IsCodeFileCreated
= False
2802 self
.IsAsBuiltInfCreated
= False
2803 self
.DepexGenerated
= False
2805 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2806 self
.BuildRuleOrder
= None
2812 self
._Version
= None
2813 self
._ModuleType
= None
2814 self
._ComponentType
= None
2815 self
._PcdIsDriver
= None
2816 self
._AutoGenVersion
= None
2817 self
._LibraryFlag
= None
2818 self
._CustomMakefile
= None
2821 self
._BuildDir
= None
2822 self
._OutputDir
= None
2823 self
._FfsOutputDir
= None
2824 self
._DebugDir
= None
2825 self
._MakeFileDir
= None
2827 self
._IncludePathList
= None
2828 self
._IncludePathLength
= 0
2829 self
._AutoGenFileList
= None
2830 self
._UnicodeFileList
= None
2831 self
._VfrFileList
= None
2832 self
._IdfFileList
= None
2833 self
._SourceFileList
= None
2834 self
._ObjectFileList
= None
2835 self
._BinaryFileList
= None
2837 self
._DependentPackageList
= None
2838 self
._DependentLibraryList
= None
2839 self
._LibraryAutoGenList
= None
2840 self
._DerivedPackageList
= None
2841 self
._ModulePcdList
= None
2842 self
._LibraryPcdList
= None
2843 self
._PcdComments
= OrderedDict()
2844 self
._GuidList
= None
2845 self
._GuidsUsedByPcd
= None
2846 self
._GuidComments
= OrderedDict()
2847 self
._ProtocolList
= None
2848 self
._ProtocolComments
= OrderedDict()
2849 self
._PpiList
= None
2850 self
._PpiComments
= OrderedDict()
2851 self
._DepexList
= None
2852 self
._DepexExpressionList
= None
2853 self
._BuildOption
= None
2854 self
._BuildOptionIncPathList
= None
2855 self
._BuildTargets
= None
2856 self
._IntroBuildTargetList
= None
2857 self
._FinalBuildTargetList
= None
2858 self
._FileTypes
= None
2859 self
._BuildRules
= None
2861 self
._TimeStampPath
= None
2863 self
.AutoGenDepSet
= set()
2866 ## The Modules referenced to this Library
2867 # Only Library has this attribute
2868 self
._ReferenceModules
= []
2870 ## Store the FixedAtBuild Pcds
2872 self
._FixedAtBuildPcds
= []
2877 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2879 # Get FixedAtBuild Pcds of this Module
2880 def _GetFixedAtBuildPcds(self
):
2881 if self
._FixedAtBuildPcds
:
2882 return self
._FixedAtBuildPcds
2883 for Pcd
in self
.ModulePcdList
:
2884 if Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
2886 if Pcd
not in self
._FixedAtBuildPcds
:
2887 self
._FixedAtBuildPcds
.append(Pcd
)
2889 return self
._FixedAtBuildPcds
2891 def _GetUniqueBaseName(self
):
2892 BaseName
= self
.Name
2893 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2894 if Module
.MetaFile
== self
.MetaFile
:
2896 if Module
.Name
== self
.Name
:
2897 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2898 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2899 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2900 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2903 # Macros could be used in build_rule.txt (also Makefile)
2904 def _GetMacros(self
):
2905 if self
._Macro
is None:
2906 self
._Macro
= OrderedDict()
2907 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2908 self
._Macro
["MODULE_NAME" ] = self
.Name
2909 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2910 self
._Macro
["MODULE_GUID" ] = self
.Guid
2911 self
._Macro
["MODULE_VERSION" ] = self
.Version
2912 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2913 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2914 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2915 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2916 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2918 self
._Macro
["BASE_NAME" ] = self
.Name
2920 self
._Macro
["ARCH" ] = self
.Arch
2921 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2922 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2923 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2924 self
._Macro
["TARGET" ] = self
.BuildTarget
2926 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2927 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2928 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2929 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2930 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2931 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2932 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2933 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2934 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2935 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2936 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2937 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2938 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2939 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2940 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2943 ## Return the module build data object
2944 def _GetModule(self
):
2945 if self
._Module
is None:
2946 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2949 ## Return the module name
2950 def _GetBaseName(self
):
2951 return self
.Module
.BaseName
2953 ## Return the module DxsFile if exist
2954 def _GetDxsFile(self
):
2955 return self
.Module
.DxsFile
2957 ## Return the module SourceOverridePath
2958 def _GetSourceOverridePath(self
):
2959 return self
.Module
.SourceOverridePath
2961 ## Return the module meta-file GUID
2964 # To build same module more than once, the module path with FILE_GUID overridden has
2965 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2966 # in DSC. The overridden GUID can be retrieved from file name
2968 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2970 # Length of GUID is 36
2972 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2973 return self
.Module
.Guid
2975 ## Return the module version
2976 def _GetVersion(self
):
2977 return self
.Module
.Version
2979 ## Return the module type
2980 def _GetModuleType(self
):
2981 return self
.Module
.ModuleType
2983 ## Return the component type (for Edk.x style of module)
2984 def _GetComponentType(self
):
2985 return self
.Module
.ComponentType
2987 ## Return the build type
2988 def _GetBuildType(self
):
2989 return self
.Module
.BuildType
2991 ## Return the PCD_IS_DRIVER setting
2992 def _GetPcdIsDriver(self
):
2993 return self
.Module
.PcdIsDriver
2995 ## Return the autogen version, i.e. module meta-file version
2996 def _GetAutoGenVersion(self
):
2997 return self
.Module
.AutoGenVersion
2999 ## Check if the module is library or not
3000 def _IsLibrary(self
):
3001 if self
._LibraryFlag
is None:
3002 if self
.Module
.LibraryClass
is not None and self
.Module
.LibraryClass
!= []:
3003 self
._LibraryFlag
= True
3005 self
._LibraryFlag
= False
3006 return self
._LibraryFlag
3008 ## Check if the module is binary module or not
3009 def _IsBinaryModule(self
):
3010 return self
.Module
.IsBinaryModule
3012 ## Return the directory to store intermediate files of the module
3013 def _GetBuildDir(self
):
3014 if self
._BuildDir
is None:
3015 self
._BuildDir
= path
.join(
3016 self
.PlatformInfo
.BuildDir
,
3019 self
.MetaFile
.BaseName
3021 CreateDirectory(self
._BuildDir
)
3022 return self
._BuildDir
3024 ## Return the directory to store the intermediate object files of the mdoule
3025 def _GetOutputDir(self
):
3026 if self
._OutputDir
is None:
3027 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3028 CreateDirectory(self
._OutputDir
)
3029 return self
._OutputDir
3031 ## Return the directory to store ffs file
3032 def _GetFfsOutputDir(self
):
3033 if self
._FfsOutputDir
is None:
3034 if GlobalData
.gFdfParser
is not None:
3035 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3037 self
._FfsOutputDir
= ''
3038 return self
._FfsOutputDir
3040 ## Return the directory to store auto-gened source files of the mdoule
3041 def _GetDebugDir(self
):
3042 if self
._DebugDir
is None:
3043 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3044 CreateDirectory(self
._DebugDir
)
3045 return self
._DebugDir
3047 ## Return the path of custom file
3048 def _GetCustomMakefile(self
):
3049 if self
._CustomMakefile
is None:
3050 self
._CustomMakefile
= {}
3051 for Type
in self
.Module
.CustomMakefile
:
3052 if Type
in gMakeTypeMap
:
3053 MakeType
= gMakeTypeMap
[Type
]
3056 if self
.SourceOverrideDir
is not None:
3057 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3058 if not os
.path
.exists(File
):
3059 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3061 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3062 self
._CustomMakefile
[MakeType
] = File
3063 return self
._CustomMakefile
3065 ## Return the directory of the makefile
3067 # @retval string The directory string of module's makefile
3069 def _GetMakeFileDir(self
):
3070 return self
.BuildDir
3072 ## Return build command string
3074 # @retval string Build command string
3076 def _GetBuildCommand(self
):
3077 return self
.PlatformInfo
.BuildCommand
3079 ## Get object list of all packages the module and its dependent libraries belong to
3081 # @retval list The list of package object
3083 def _GetDerivedPackageList(self
):
3085 for M
in [self
.Module
] + self
.DependentLibraryList
:
3086 for Package
in M
.Packages
:
3087 if Package
in PackageList
:
3089 PackageList
.append(Package
)
3092 ## Get the depex string
3094 # @return : a string contain all depex expresion.
3095 def _GetDepexExpresionString(self
):
3098 ## DPX_SOURCE IN Define section.
3099 if self
.Module
.DxsFile
:
3101 for M
in [self
.Module
] + self
.DependentLibraryList
:
3102 Filename
= M
.MetaFile
.Path
3103 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3104 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3105 for DepexExpresion
in DepexExpresionList
:
3106 for key
in DepexExpresion
:
3107 Arch
, ModuleType
= key
3108 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3109 # the type of build module is USER_DEFINED.
3110 # All different DEPEX section tags would be copied into the As Built INF file
3111 # and there would be separate DEPEX section tags
3112 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3113 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3114 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3116 if Arch
.upper() == TAB_ARCH_COMMON
or \
3117 (Arch
.upper() == self
.Arch
.upper() and \
3118 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3119 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3121 #the type of build module is USER_DEFINED.
3122 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3123 for Depex
in DepexList
:
3125 DepexStr
+= '[Depex.%s.%s]\n' % key
3126 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3129 return '[Depex.%s]\n' % self
.Arch
3132 #the type of build module not is USER_DEFINED.
3134 for Depex
in DepexList
:
3139 for D
in Depex
.values():
3140 DepexStr
+= ' '.join([val
for val
in D
])
3141 Index
= DepexStr
.find('END')
3142 if Index
> -1 and Index
== len(DepexStr
) - 3:
3143 DepexStr
= DepexStr
[:-3]
3144 DepexStr
= DepexStr
.strip()
3147 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3149 return '[Depex.%s]\n' % self
.Arch
3150 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3152 ## Merge dependency expression
3154 # @retval list The token list of the dependency expression after parsed
3156 def _GetDepexTokenList(self
):
3157 if self
._DepexList
is None:
3158 self
._DepexList
= {}
3159 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3160 return self
._DepexList
3162 self
._DepexList
[self
.ModuleType
] = []
3164 for ModuleType
in self
._DepexList
:
3165 DepexList
= self
._DepexList
[ModuleType
]
3167 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3169 for M
in [self
.Module
] + self
.DependentLibraryList
:
3171 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3173 DepexList
.append('AND')
3174 DepexList
.append('(')
3176 if DepexList
[-1] == 'END': # no need of a END at this time
3178 DepexList
.append(')')
3181 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3182 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3184 if len(DepexList
) > 0:
3185 EdkLogger
.verbose('')
3186 return self
._DepexList
3188 ## Merge dependency expression
3190 # @retval list The token list of the dependency expression after parsed
3192 def _GetDepexExpressionTokenList(self
):
3193 if self
._DepexExpressionList
is None:
3194 self
._DepexExpressionList
= {}
3195 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3196 return self
._DepexExpressionList
3198 self
._DepexExpressionList
[self
.ModuleType
] = ''
3200 for ModuleType
in self
._DepexExpressionList
:
3201 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3203 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3205 for M
in [self
.Module
] + self
.DependentLibraryList
:
3207 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3208 if DepexExpressionList
!= '':
3209 DepexExpressionList
+= ' AND '
3210 DepexExpressionList
+= '('
3211 DepexExpressionList
+= D
3212 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3213 DepexExpressionList
+= ')'
3216 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3217 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3219 if len(DepexExpressionList
) > 0:
3220 EdkLogger
.verbose('')
3221 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3222 return self
._DepexExpressionList
3224 # Get the tiano core user extension, it is contain dependent library.
3225 # @retval: a list contain tiano core userextension.
3227 def _GetTianoCoreUserExtensionList(self
):
3228 TianoCoreUserExtentionList
= []
3229 for M
in [self
.Module
] + self
.DependentLibraryList
:
3230 Filename
= M
.MetaFile
.Path
3231 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3232 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3233 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3234 for Section
in TianoCoreUserExtent
:
3235 ItemList
= Section
.split(TAB_SPLIT
)
3237 if len(ItemList
) == 4:
3239 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3241 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3242 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3243 TianoCoreList
.append('\n')
3244 TianoCoreUserExtentionList
.append(TianoCoreList
)
3246 return TianoCoreUserExtentionList
3248 ## Return the list of specification version required for the module
3250 # @retval list The list of specification defined in module file
3252 def _GetSpecification(self
):
3253 return self
.Module
.Specification
3255 ## Tool option for the module build
3257 # @param PlatformInfo The object of PlatformBuildInfo
3258 # @retval dict The dict containing valid options
3260 def _GetModuleBuildOption(self
):
3261 if self
._BuildOption
is None:
3262 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3263 if self
.BuildRuleOrder
:
3264 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3265 return self
._BuildOption
3267 ## Get include path list from tool option for the module build
3269 # @retval list The include path list
3271 def _GetBuildOptionIncPathList(self
):
3272 if self
._BuildOptionIncPathList
is None:
3274 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3275 # is the former use /I , the Latter used -I to specify include directories
3277 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3278 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
3279 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3280 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
3283 # New ToolChainFamily, don't known whether there is option to specify include directories
3285 self
._BuildOptionIncPathList
= []
3286 return self
._BuildOptionIncPathList
3288 BuildOptionIncPathList
= []
3289 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3292 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3296 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3297 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
3300 # RVCT may specify a list of directory seperated by commas
3303 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
3304 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3305 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3308 # EDK II modules must not reference header files outside of the packages they depend on or
3309 # within the module's directory tree. Report error if violation.
3311 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3312 for Path
in IncPathList
:
3313 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3314 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3315 EdkLogger
.error("build",
3318 File
=str(self
.MetaFile
))
3321 BuildOptionIncPathList
+= IncPathList
3323 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3325 return self
._BuildOptionIncPathList
3327 ## Return a list of files which can be built from source
3329 # What kind of files can be built is determined by build rules in
3330 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3332 def _GetSourceFileList(self
):
3333 if self
._SourceFileList
is None:
3334 self
._SourceFileList
= []
3335 for F
in self
.Module
.Sources
:
3337 if F
.TagName
not in ("", "*", self
.ToolChain
):
3338 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3339 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3341 # match tool chain family or build rule family
3342 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3345 "The file [%s] must be built by tools of [%s], " \
3346 "but current toolchain family is [%s], buildrule family is [%s]" \
3347 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3350 # add the file path into search path list for file including
3351 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3352 self
.IncludePathList
.insert(0, F
.Dir
)
3353 self
._SourceFileList
.append(F
)
3355 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3357 for F
in self
._SourceFileList
:
3358 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3359 return self
._SourceFileList
3361 def _MatchBuildRuleOrder(self
, FileList
):
3363 self
._GetModuleBuildOption
()
3364 for SingleFile
in FileList
:
3365 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3366 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3367 if key
in Order_Dict
:
3368 Order_Dict
[key
].append(SingleFile
.Ext
)
3370 Order_Dict
[key
] = [SingleFile
.Ext
]
3373 for F
in Order_Dict
:
3374 if len(Order_Dict
[F
]) > 1:
3375 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3376 for Ext
in Order_Dict
[F
][1:]:
3377 RemoveList
.append(F
+ Ext
)
3379 for item
in RemoveList
:
3380 FileList
.remove(item
)
3384 ## Return the list of unicode files
3385 def _GetUnicodeFileList(self
):
3386 if self
._UnicodeFileList
is None:
3387 if TAB_UNICODE_FILE
in self
.FileTypes
:
3388 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3390 self
._UnicodeFileList
= []
3391 return self
._UnicodeFileList
3393 ## Return the list of vfr files
3394 def _GetVfrFileList(self
):
3395 if self
._VfrFileList
is None:
3396 if TAB_VFR_FILE
in self
.FileTypes
:
3397 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3399 self
._VfrFileList
= []
3400 return self
._VfrFileList
3402 ## Return the list of Image Definition files
3403 def _GetIdfFileList(self
):
3404 if self
._IdfFileList
is None:
3405 if TAB_IMAGE_FILE
in self
.FileTypes
:
3406 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3408 self
._IdfFileList
= []
3409 return self
._IdfFileList
3411 ## Return a list of files which can be built from binary
3413 # "Build" binary files are just to copy them to build directory.
3415 # @retval list The list of files which can be built later
3417 def _GetBinaryFiles(self
):
3418 if self
._BinaryFileList
is None:
3419 self
._BinaryFileList
= []
3420 for F
in self
.Module
.Binaries
:
3421 if F
.Target
not in [TAB_ARCH_COMMON
, '*'] and F
.Target
!= self
.BuildTarget
:
3423 self
._BinaryFileList
.append(F
)
3424 self
._ApplyBuildRule
(F
, F
.Type
)
3425 return self
._BinaryFileList
3427 def _GetBuildRules(self
):
3428 if self
._BuildRules
is None:
3430 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3431 for Type
in BuildRuleDatabase
.FileTypeList
:
3432 #first try getting build rule by BuildRuleFamily
3433 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3435 # build type is always module type, but ...
3436 if self
.ModuleType
!= self
.BuildType
:
3437 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3438 #second try getting build rule by ToolChainFamily
3440 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3442 # build type is always module type, but ...
3443 if self
.ModuleType
!= self
.BuildType
:
3444 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3447 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3448 BuildRules
[Type
] = RuleObject
3449 for Ext
in RuleObject
.SourceFileExtList
:
3450 BuildRules
[Ext
] = RuleObject
3451 self
._BuildRules
= BuildRules
3452 return self
._BuildRules
3454 def _ApplyBuildRule(self
, File
, FileType
):
3455 if self
._BuildTargets
is None:
3456 self
._IntroBuildTargetList
= set()
3457 self
._FinalBuildTargetList
= set()
3458 self
._BuildTargets
= defaultdict(set)
3459 self
._FileTypes
= defaultdict(set)
3461 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3462 if not os
.path
.exists(SubDirectory
):
3463 CreateDirectory(SubDirectory
)
3469 # Make sure to get build rule order value
3471 self
._GetModuleBuildOption
()
3473 while Index
< len(SourceList
):
3474 Source
= SourceList
[Index
]
3478 CreateDirectory(Source
.Dir
)
3480 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
is not None and File
in self
._BinaryFileList
:
3481 # Skip all files that are not binary libraries
3482 if not self
.IsLibrary
:
3484 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3485 elif FileType
in self
.BuildRules
:
3486 RuleObject
= self
.BuildRules
[FileType
]
3487 elif Source
.Ext
in self
.BuildRules
:
3488 RuleObject
= self
.BuildRules
[Source
.Ext
]
3490 # stop at no more rules
3492 self
._FinalBuildTargetList
.add(LastTarget
)
3495 FileType
= RuleObject
.SourceFileType
3496 self
._FileTypes
[FileType
].add(Source
)
3498 # stop at STATIC_LIBRARY for library
3499 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3501 self
._FinalBuildTargetList
.add(LastTarget
)
3504 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3507 self
._FinalBuildTargetList
.add(LastTarget
)
3509 elif not Target
.Outputs
:
3510 # Only do build for target with outputs
3511 self
._FinalBuildTargetList
.add(Target
)
3513 self
._BuildTargets
[FileType
].add(Target
)
3515 if not Source
.IsBinary
and Source
== File
:
3516 self
._IntroBuildTargetList
.add(Target
)
3518 # to avoid cyclic rule
3519 if FileType
in RuleChain
:
3522 RuleChain
.append(FileType
)
3523 SourceList
.extend(Target
.Outputs
)
3525 FileType
= TAB_UNKNOWN_FILE
3527 def _GetTargets(self
):
3528 if self
._BuildTargets
is None:
3529 self
._IntroBuildTargetList
= set()
3530 self
._FinalBuildTargetList
= set()
3531 self
._BuildTargets
= defaultdict(set)
3532 self
._FileTypes
= defaultdict(set)
3534 #TRICK: call _GetSourceFileList to apply build rule for source files
3535 if self
.SourceFileList
:
3538 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3539 if self
.BinaryFileList
:
3542 return self
._BuildTargets
3544 def _GetIntroTargetList(self
):
3546 return self
._IntroBuildTargetList
3548 def _GetFinalTargetList(self
):
3550 return self
._FinalBuildTargetList
3552 def _GetFileTypes(self
):
3554 return self
._FileTypes
3556 ## Get the list of package object the module depends on
3558 # @retval list The package object list
3560 def _GetDependentPackageList(self
):
3561 return self
.Module
.Packages
3563 ## Return the list of auto-generated code file
3565 # @retval list The list of auto-generated file
3567 def _GetAutoGenFileList(self
):
3568 UniStringAutoGenC
= True
3569 IdfStringAutoGenC
= True
3570 UniStringBinBuffer
= StringIO()
3571 IdfGenBinBuffer
= StringIO()
3572 if self
.BuildType
== 'UEFI_HII':
3573 UniStringAutoGenC
= False
3574 IdfStringAutoGenC
= False
3575 if self
._AutoGenFileList
is None:
3576 self
._AutoGenFileList
= {}
3577 AutoGenC
= TemplateString()
3578 AutoGenH
= TemplateString()
3579 StringH
= TemplateString()
3580 StringIdf
= TemplateString()
3581 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3583 # AutoGen.c is generated if there are library classes in inf, or there are object files
3585 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3586 or TAB_OBJECT_FILE
in self
.FileTypes
):
3587 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3588 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3589 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3590 if str(AutoGenH
) != "":
3591 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3592 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3593 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3594 if str(StringH
) != "":
3595 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3596 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3597 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3598 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3599 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3600 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3601 AutoFile
.IsBinary
= True
3602 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3603 if UniStringBinBuffer
is not None:
3604 UniStringBinBuffer
.close()
3605 if str(StringIdf
) != "":
3606 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3607 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3608 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3609 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3610 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3611 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3612 AutoFile
.IsBinary
= True
3613 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3614 if IdfGenBinBuffer
is not None:
3615 IdfGenBinBuffer
.close()
3616 return self
._AutoGenFileList
3618 ## Return the list of library modules explicitly or implicityly used by this module
3619 def _GetLibraryList(self
):
3620 if self
._DependentLibraryList
is None:
3621 # only merge library classes and PCD for non-library module
3623 self
._DependentLibraryList
= []
3625 if self
.AutoGenVersion
< 0x00010005:
3626 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3628 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3629 return self
._DependentLibraryList
3632 def UpdateComments(Recver
, Src
):
3634 if Key
not in Recver
:
3636 Recver
[Key
].extend(Src
[Key
])
3637 ## Get the list of PCDs from current module
3639 # @retval list The list of PCD
3641 def _GetModulePcdList(self
):
3642 if self
._ModulePcdList
is None:
3643 # apply PCD settings from platform
3644 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3645 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3646 return self
._ModulePcdList
3648 ## Get the list of PCDs from dependent libraries
3650 # @retval list The list of PCD
3652 def _GetLibraryPcdList(self
):
3653 if self
._LibraryPcdList
is None:
3654 Pcds
= OrderedDict()
3655 if not self
.IsLibrary
:
3656 # get PCDs from dependent libraries
3657 for Library
in self
.DependentLibraryList
:
3658 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3659 for Key
in Library
.Pcds
:
3660 # skip duplicated PCDs
3661 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3663 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3664 # apply PCD settings from platform
3665 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3667 self
._LibraryPcdList
= []
3668 return self
._LibraryPcdList
3670 ## Get the GUID value mapping
3672 # @retval dict The mapping between GUID cname and its value
3674 def _GetGuidList(self
):
3675 if self
._GuidList
is None:
3676 self
._GuidList
= OrderedDict()
3677 self
._GuidList
.update(self
.Module
.Guids
)
3678 for Library
in self
.DependentLibraryList
:
3679 self
._GuidList
.update(Library
.Guids
)
3680 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3681 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3682 return self
._GuidList
3684 def GetGuidsUsedByPcd(self
):
3685 if self
._GuidsUsedByPcd
is None:
3686 self
._GuidsUsedByPcd
= OrderedDict()
3687 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3688 for Library
in self
.DependentLibraryList
:
3689 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3690 return self
._GuidsUsedByPcd
3691 ## Get the protocol value mapping
3693 # @retval dict The mapping between protocol cname and its value
3695 def _GetProtocolList(self
):
3696 if self
._ProtocolList
is None:
3697 self
._ProtocolList
= OrderedDict()
3698 self
._ProtocolList
.update(self
.Module
.Protocols
)
3699 for Library
in self
.DependentLibraryList
:
3700 self
._ProtocolList
.update(Library
.Protocols
)
3701 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3702 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3703 return self
._ProtocolList
3705 ## Get the PPI value mapping
3707 # @retval dict The mapping between PPI cname and its value
3709 def _GetPpiList(self
):
3710 if self
._PpiList
is None:
3711 self
._PpiList
= OrderedDict()
3712 self
._PpiList
.update(self
.Module
.Ppis
)
3713 for Library
in self
.DependentLibraryList
:
3714 self
._PpiList
.update(Library
.Ppis
)
3715 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3716 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3717 return self
._PpiList
3719 ## Get the list of include search path
3721 # @retval list The list path
3723 def _GetIncludePathList(self
):
3724 if self
._IncludePathList
is None:
3725 self
._IncludePathList
= []
3726 if self
.AutoGenVersion
< 0x00010005:
3727 for Inc
in self
.Module
.Includes
:
3728 if Inc
not in self
._IncludePathList
:
3729 self
._IncludePathList
.append(Inc
)
3731 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3732 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3733 self
._IncludePathList
.append(Inc
)
3734 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3735 self
._IncludePathList
.append(self
.DebugDir
)
3737 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3738 self
._IncludePathList
.append(self
.DebugDir
)
3740 for Package
in self
.Module
.Packages
:
3741 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3742 if PackageDir
not in self
._IncludePathList
:
3743 self
._IncludePathList
.append(PackageDir
)
3744 IncludesList
= Package
.Includes
3745 if Package
._PrivateIncludes
:
3746 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3747 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3748 for Inc
in IncludesList
:
3749 if Inc
not in self
._IncludePathList
:
3750 self
._IncludePathList
.append(str(Inc
))
3751 return self
._IncludePathList
3753 def _GetIncludePathLength(self
):
3754 self
._IncludePathLength
= 0
3755 if self
._IncludePathList
:
3756 for inc
in self
._IncludePathList
:
3757 self
._IncludePathLength
+= len(' ' + inc
)
3758 return self
._IncludePathLength
3760 ## Get HII EX PCDs which maybe used by VFR
3762 # efivarstore used by VFR may relate with HII EX PCDs
3763 # Get the variable name and GUID from efivarstore and HII EX PCD
3764 # List the HII EX PCDs in As Built INF if both name and GUID match.
3766 # @retval list HII EX PCDs
3768 def _GetPcdsMaybeUsedByVfr(self
):
3769 if not self
.SourceFileList
:
3773 for SrcFile
in self
.SourceFileList
:
3774 if SrcFile
.Ext
.lower() != '.vfr':
3776 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3777 if not os
.path
.exists(Vfri
):
3779 VfriFile
= open(Vfri
, 'r')
3780 Content
= VfriFile
.read()
3782 Pos
= Content
.find('efivarstore')
3785 # Make sure 'efivarstore' is the start of efivarstore statement
3786 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3789 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3791 if Index
>= 0 and Content
[Index
] != ';':
3792 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3795 # 'efivarstore' must be followed by name and guid
3797 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3800 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3803 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3804 NameGuids
.add((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3805 Pos
= Content
.find('efivarstore', Name
.end())
3809 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3810 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3812 for SkuName
in Pcd
.SkuInfoList
:
3813 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3814 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3815 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3818 Guid
= GuidStructureStringToGuidString(Value
)
3819 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3820 HiiExPcds
.append(Pcd
)
3825 def _GenOffsetBin(self
):
3827 for SourceFile
in self
.Module
.Sources
:
3828 if SourceFile
.Type
.upper() == ".VFR" :
3830 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3832 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3833 if SourceFile
.Type
.upper() == ".UNI" :
3835 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3837 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3839 if len(VfrUniBaseName
) == 0:
3841 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3842 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3843 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3844 if not VfrUniOffsetList
:
3847 OutputName
= '%sOffset.bin' % self
.Name
3848 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3851 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3853 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3855 # Use a instance of StringIO to cache data
3856 fStringIO
= StringIO('')
3858 for Item
in VfrUniOffsetList
:
3859 if (Item
[0].find("Strings") != -1):
3861 # UNI offset in image.
3863 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3865 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3866 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3867 fStringIO
.write(''.join(UniGuid
))
3868 UniValue
= pack ('Q', int (Item
[1], 16))
3869 fStringIO
.write (UniValue
)
3872 # VFR binary offset in image.
3874 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3876 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3877 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3878 fStringIO
.write(''.join(VfrGuid
))
3879 VfrValue
= pack ('Q', int (Item
[1], 16))
3880 fStringIO
.write (VfrValue
)
3882 # write data into file.
3885 fInputfile
.write (fStringIO
.getvalue())
3887 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3888 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3894 ## Create AsBuilt INF file the module
3896 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3897 self
.OutputFile
= set()
3899 if GlobalData
.gBinCacheDest
:
3900 self
.CopyModuleToCache()
3903 if self
.IsAsBuiltInfCreated
:
3906 # Skip the following code for EDK I inf
3907 if self
.AutoGenVersion
< 0x00010005:
3910 # Skip the following code for libraries
3914 # Skip the following code for modules with no source files
3915 if not self
.SourceFileList
:
3918 # Skip the following code for modules without any binary files
3919 if not self
.BinaryFileList
:
3922 ### TODO: How to handles mixed source and binary modules
3924 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3925 # Also find all packages that the DynamicEx PCDs depend on
3930 PcdTokenSpaceList
= []
3931 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3932 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3933 PatchablePcds
+= [Pcd
]
3934 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_PATCHABLE_IN_MODULE
))
3935 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3938 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
))
3939 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
))
3940 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3941 GuidList
= OrderedDict()
3942 GuidList
.update(self
.GuidList
)
3943 for TokenSpace
in self
.GetGuidsUsedByPcd():
3944 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3945 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3946 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3947 GuidList
.pop(TokenSpace
)
3948 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3949 for Package
in self
.DerivedPackageList
:
3950 if Package
in Packages
:
3952 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3954 for Index
in range(len(BeChecked
)):
3955 for Item
in CheckList
[Index
]:
3956 if Item
in BeChecked
[Index
]:
3957 Packages
+= [Package
]
3962 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3963 for Pkg
in self
.PlatformInfo
.PackageList
:
3966 for VfrPcd
in VfrPcds
:
3967 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC_EX
) in Pkg
.Pcds
or
3968 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, TAB_PCDS_DYNAMIC
) in Pkg
.Pcds
):
3972 ModuleType
= self
.ModuleType
3973 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
3974 ModuleType
= 'DXE_DRIVER'
3977 if self
.PcdIsDriver
!= '':
3978 DriverType
= self
.PcdIsDriver
3981 MDefs
= self
.Module
.Defines
3984 'module_name' : self
.Name
,
3985 'module_guid' : Guid
,
3986 'module_module_type' : ModuleType
,
3987 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3988 'pcd_is_driver_string' : [],
3989 'module_uefi_specification_version' : [],
3990 'module_pi_specification_version' : [],
3991 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3992 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3993 'module_constructor' : self
.Module
.ConstructorList
,
3994 'module_destructor' : self
.Module
.DestructorList
,
3995 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
3996 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
3997 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
3998 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
3999 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4000 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4001 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4002 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4003 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4004 'module_arch' : self
.Arch
,
4005 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4007 'patchablepcd_item' : [],
4009 'protocol_item' : [],
4013 'libraryclasses_item' : []
4016 if 'MODULE_UNI_FILE' in MDefs
:
4017 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4018 if os
.path
.isfile(UNIFile
):
4019 shutil
.copy2(UNIFile
, self
.OutputDir
)
4021 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4022 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4024 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4027 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4029 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4030 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4031 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4032 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4034 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4035 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4036 for Item
in self
.CodaTargetList
:
4037 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
4038 self
.OutputFile
.add(File
)
4039 if os
.path
.isabs(File
):
4040 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4041 if Item
.Target
.Ext
.lower() == '.aml':
4042 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4043 elif Item
.Target
.Ext
.lower() == '.acpi':
4044 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4045 elif Item
.Target
.Ext
.lower() == '.efi':
4046 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4048 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4049 if self
.DepexGenerated
:
4050 self
.OutputFile
.add(self
.Name
+ '.depex')
4051 if self
.ModuleType
in ['PEIM']:
4052 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4053 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4054 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4055 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4056 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4058 Bin
= self
._GenOffsetBin
()
4060 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4061 self
.OutputFile
.add(Bin
)
4063 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4065 if File
.lower().endswith('.pdb'):
4066 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4067 self
.OutputFile
.add(File
)
4068 HeaderComments
= self
.Module
.HeaderComments
4070 for Index
in range(len(HeaderComments
)):
4071 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4072 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4075 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4076 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4079 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4080 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4081 (GuidList
, self
._GuidComments
, 'guid_item')
4083 for Item
in GenList
:
4084 for CName
in Item
[0]:
4086 if CName
in Item
[1]:
4087 Comments
= '\n '.join(Item
[1][CName
])
4090 Entry
= Comments
+ '\n ' + CName
4091 AsBuiltInfDict
[Item
[2]].append(Entry
)
4092 PatchList
= parsePcdInfoFromMapFile(
4093 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4094 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4097 for Pcd
in PatchablePcds
:
4098 TokenCName
= Pcd
.TokenCName
4099 for PcdItem
in GlobalData
.MixedPcd
:
4100 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4101 TokenCName
= PcdItem
[0]
4103 for PatchPcd
in PatchList
:
4104 if TokenCName
== PatchPcd
[0]:
4109 if Pcd
.DatumType
== 'BOOLEAN':
4110 BoolValue
= Pcd
.DefaultValue
.upper()
4111 if BoolValue
== 'TRUE':
4112 Pcd
.DefaultValue
= '1'
4113 elif BoolValue
== 'FALSE':
4114 Pcd
.DefaultValue
= '0'
4116 if Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES
:
4117 HexFormat
= '0x%02x'
4118 if Pcd
.DatumType
== TAB_UINT16
:
4119 HexFormat
= '0x%04x'
4120 elif Pcd
.DatumType
== TAB_UINT32
:
4121 HexFormat
= '0x%08x'
4122 elif Pcd
.DatumType
== TAB_UINT64
:
4123 HexFormat
= '0x%016x'
4124 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4126 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
4127 EdkLogger
.error("build", AUTOGEN_ERROR
,
4128 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4130 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4131 PcdValue
= Pcd
.DefaultValue
4132 if PcdValue
[0] != '{':
4134 if PcdValue
[0] == 'L':
4136 PcdValue
= PcdValue
.lstrip('L')
4137 PcdValue
= eval(PcdValue
)
4139 for Index
in range(0, len(PcdValue
)):
4141 CharVal
= ord(PcdValue
[Index
])
4142 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4143 + '0x%02x' % (CharVal
>> 8) + ', '
4145 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4148 Padding
= Padding
* 2
4149 ArraySize
= ArraySize
/ 2
4150 if ArraySize
< (len(PcdValue
) + 1):
4151 if Pcd
.MaxSizeUserSet
:
4152 EdkLogger
.error("build", AUTOGEN_ERROR
,
4153 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4156 ArraySize
= len(PcdValue
) + 1
4157 if ArraySize
> len(PcdValue
) + 1:
4158 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4159 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4160 elif len(PcdValue
.split(',')) <= ArraySize
:
4161 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4164 if Pcd
.MaxSizeUserSet
:
4165 EdkLogger
.error("build", AUTOGEN_ERROR
,
4166 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4169 ArraySize
= len(PcdValue
) + 1
4170 PcdItem
= '%s.%s|%s|0x%X' % \
4171 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4173 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4174 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4176 PcdItem
= PcdComments
+ '\n ' + PcdItem
4177 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4180 for Pcd
in Pcds
+ VfrPcds
:
4185 TokenCName
= Pcd
.TokenCName
4186 for PcdItem
in GlobalData
.MixedPcd
:
4187 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4188 TokenCName
= PcdItem
[0]
4190 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4191 for SkuName
in Pcd
.SkuInfoList
:
4192 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4193 SkuId
= SkuInfo
.SkuId
4194 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4198 # Don't generate duplicated HII PCD
4200 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4202 HiiPcds
.add((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4203 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4204 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4208 for Index
, Comment
in enumerate(PcdCommentList
):
4209 for Usage
in UsageList
:
4210 if Comment
.find(Usage
) != -1:
4214 if UsageIndex
!= -1:
4215 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4217 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4218 PcdComments
= '\n '.join(PcdCommentList
)
4219 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4221 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4222 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4223 for Item
in self
.BuildOption
:
4224 if 'FLAGS' in self
.BuildOption
[Item
]:
4225 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4227 # Generated LibraryClasses section in comments.
4228 for Library
in self
.LibraryAutoGenList
:
4229 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4231 # Generated UserExtensions TianoCore section.
4232 # All tianocore user extensions are copied.
4234 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4235 UserExtStr
+= '\n'.join(TianoCore
)
4236 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4237 if os
.path
.isfile(ExtensionFile
):
4238 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4239 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4241 # Generated depex expression section in comments.
4242 AsBuiltInfDict
['depexsection_item'] = ''
4243 DepexExpresion
= self
._GetDepexExpresionString
()
4245 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4247 AsBuiltInf
= TemplateString()
4248 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4250 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4252 self
.IsAsBuiltInfCreated
= True
4253 if GlobalData
.gBinCacheDest
:
4254 self
.CopyModuleToCache()
4256 def CopyModuleToCache(self
):
4257 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4258 CreateDirectory (FileDir
)
4259 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4260 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4261 if os
.path
.exists(HashFile
):
4262 shutil
.copy2(HashFile
, FileDir
)
4263 if os
.path
.exists(ModuleFile
):
4264 shutil
.copy2(ModuleFile
, FileDir
)
4265 if not self
.OutputFile
:
4266 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4267 self
.OutputFile
= Ma
.Binaries
4269 for File
in self
.OutputFile
:
4271 if not os
.path
.isabs(File
):
4272 File
= os
.path
.join(self
.OutputDir
, File
)
4273 if os
.path
.exists(File
):
4274 shutil
.copy2(File
, FileDir
)
4276 def AttemptModuleCacheCopy(self
):
4277 if self
.IsBinaryModule
:
4279 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4280 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4281 if os
.path
.exists(HashFile
):
4282 f
= open(HashFile
, 'r')
4283 CacheHash
= f
.read()
4285 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4286 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4287 for root
, dir, files
in os
.walk(FileDir
):
4289 if self
.Name
+ '.hash' in f
:
4290 shutil
.copy2(HashFile
, self
.BuildDir
)
4292 File
= path
.join(root
, f
)
4293 shutil
.copy2(File
, self
.OutputDir
)
4294 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4295 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4299 ## Create makefile for the module and its dependent libraries
4301 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4302 # dependent libraries will be created
4304 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4305 # Ignore generating makefile when it is a binary module
4306 if self
.IsBinaryModule
:
4309 if self
.IsMakeFileCreated
:
4311 self
.GenFfsList
= GenFfsList
4312 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4313 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4314 LibraryAutoGen
.CreateMakeFile()
4319 if len(self
.CustomMakefile
) == 0:
4320 Makefile
= GenMake
.ModuleMakefile(self
)
4322 Makefile
= GenMake
.CustomMakefile(self
)
4323 if Makefile
.Generate():
4324 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4325 (self
.Name
, self
.Arch
))
4327 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4328 (self
.Name
, self
.Arch
))
4330 self
.CreateTimeStamp(Makefile
)
4331 self
.IsMakeFileCreated
= True
4333 def CopyBinaryFiles(self
):
4334 for File
in self
.Module
.Binaries
:
4336 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4337 CopyLongFilePath(SrcPath
, DstPath
)
4338 ## Create autogen code for the module and its dependent libraries
4340 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4341 # dependent libraries will be created
4343 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4344 if self
.IsCodeFileCreated
:
4347 # Need to generate PcdDatabase even PcdDriver is binarymodule
4348 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4349 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4351 if self
.IsBinaryModule
:
4353 self
.CopyBinaryFiles()
4356 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4357 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4358 LibraryAutoGen
.CreateCodeFile()
4364 IgoredAutoGenList
= []
4366 for File
in self
.AutoGenFileList
:
4367 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4368 #Ignore Edk AutoGen.c
4369 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4372 AutoGenList
.append(str(File
))
4374 IgoredAutoGenList
.append(str(File
))
4376 # Skip the following code for EDK I inf
4377 if self
.AutoGenVersion
< 0x00010005:
4380 for ModuleType
in self
.DepexList
:
4381 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4382 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4385 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4386 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4388 if len(Dpx
.PostfixNotation
) <> 0:
4389 self
.DepexGenerated
= True
4391 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4392 AutoGenList
.append(str(DpxFile
))
4394 IgoredAutoGenList
.append(str(DpxFile
))
4396 if IgoredAutoGenList
== []:
4397 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4398 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4399 elif AutoGenList
== []:
4400 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4401 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4403 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4404 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4406 self
.IsCodeFileCreated
= True
4409 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4410 def _GetLibraryAutoGenList(self
):
4411 if self
._LibraryAutoGenList
is None:
4412 self
._LibraryAutoGenList
= []
4413 for Library
in self
.DependentLibraryList
:
4420 self
.PlatformInfo
.MetaFile
4422 if La
not in self
._LibraryAutoGenList
:
4423 self
._LibraryAutoGenList
.append(La
)
4424 for Lib
in La
.CodaTargetList
:
4425 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4426 return self
._LibraryAutoGenList
4428 def GenModuleHash(self
):
4429 if self
.Arch
not in GlobalData
.gModuleHash
:
4430 GlobalData
.gModuleHash
[self
.Arch
] = {}
4432 # Add Platform level hash
4433 m
.update(GlobalData
.gPlatformHash
)
4434 # Add Package level hash
4435 if self
.DependentPackageList
:
4436 for Pkg
in self
.DependentPackageList
:
4437 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4438 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4441 if self
.LibraryAutoGenList
:
4442 for Lib
in self
.LibraryAutoGenList
:
4443 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4445 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4448 f
= open(str(self
.MetaFile
), 'r')
4452 # Add Module's source files
4453 if self
.SourceFileList
:
4454 for File
in self
.SourceFileList
:
4455 f
= open(str(File
), 'r')
4460 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4461 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4462 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4463 if GlobalData
.gBinCacheSource
:
4464 CacheValid
= self
.AttemptModuleCacheCopy()
4467 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4469 ## Decide whether we can skip the ModuleAutoGen process
4470 def CanSkipbyHash(self
):
4471 if GlobalData
.gUseHashCache
:
4472 return not self
.GenModuleHash()
4474 ## Decide whether we can skip the ModuleAutoGen process
4475 # If any source file is newer than the module than we cannot skip
4478 if not os
.path
.exists(self
.GetTimeStampPath()):
4480 #last creation time of the module
4481 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4483 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4484 if SrcTimeStamp
> DstTimeStamp
:
4487 with
open(self
.GetTimeStampPath(),'r') as f
:
4489 source
= source
.rstrip('\n')
4490 if not os
.path
.exists(source
):
4492 if source
not in ModuleAutoGen
.TimeDict
:
4493 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4494 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4498 def GetTimeStampPath(self
):
4499 if self
._TimeStampPath
is None:
4500 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4501 return self
._TimeStampPath
4502 def CreateTimeStamp(self
, Makefile
):
4506 FileSet
.add (self
.MetaFile
.Path
)
4508 for SourceFile
in self
.Module
.Sources
:
4509 FileSet
.add (SourceFile
.Path
)
4511 for Lib
in self
.DependentLibraryList
:
4512 FileSet
.add (Lib
.MetaFile
.Path
)
4514 for f
in self
.AutoGenDepSet
:
4515 FileSet
.add (f
.Path
)
4517 if os
.path
.exists (self
.GetTimeStampPath()):
4518 os
.remove (self
.GetTimeStampPath())
4519 with
open(self
.GetTimeStampPath(), 'w+') as file:
4523 Module
= property(_GetModule
)
4524 Name
= property(_GetBaseName
)
4525 Guid
= property(_GetGuid
)
4526 Version
= property(_GetVersion
)
4527 ModuleType
= property(_GetModuleType
)
4528 ComponentType
= property(_GetComponentType
)
4529 BuildType
= property(_GetBuildType
)
4530 PcdIsDriver
= property(_GetPcdIsDriver
)
4531 AutoGenVersion
= property(_GetAutoGenVersion
)
4532 Macros
= property(_GetMacros
)
4533 Specification
= property(_GetSpecification
)
4535 IsLibrary
= property(_IsLibrary
)
4536 IsBinaryModule
= property(_IsBinaryModule
)
4537 BuildDir
= property(_GetBuildDir
)
4538 OutputDir
= property(_GetOutputDir
)
4539 FfsOutputDir
= property(_GetFfsOutputDir
)
4540 DebugDir
= property(_GetDebugDir
)
4541 MakeFileDir
= property(_GetMakeFileDir
)
4542 CustomMakefile
= property(_GetCustomMakefile
)
4544 IncludePathList
= property(_GetIncludePathList
)
4545 IncludePathLength
= property(_GetIncludePathLength
)
4546 AutoGenFileList
= property(_GetAutoGenFileList
)
4547 UnicodeFileList
= property(_GetUnicodeFileList
)
4548 VfrFileList
= property(_GetVfrFileList
)
4549 SourceFileList
= property(_GetSourceFileList
)
4550 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4551 Targets
= property(_GetTargets
)
4552 IntroTargetList
= property(_GetIntroTargetList
)
4553 CodaTargetList
= property(_GetFinalTargetList
)
4554 FileTypes
= property(_GetFileTypes
)
4555 BuildRules
= property(_GetBuildRules
)
4556 IdfFileList
= property(_GetIdfFileList
)
4558 DependentPackageList
= property(_GetDependentPackageList
)
4559 DependentLibraryList
= property(_GetLibraryList
)
4560 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4561 DerivedPackageList
= property(_GetDerivedPackageList
)
4563 ModulePcdList
= property(_GetModulePcdList
)
4564 LibraryPcdList
= property(_GetLibraryPcdList
)
4565 GuidList
= property(_GetGuidList
)
4566 ProtocolList
= property(_GetProtocolList
)
4567 PpiList
= property(_GetPpiList
)
4568 DepexList
= property(_GetDepexTokenList
)
4569 DxsFile
= property(_GetDxsFile
)
4570 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4571 BuildOption
= property(_GetModuleBuildOption
)
4572 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4573 BuildCommand
= property(_GetBuildCommand
)
4575 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4577 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4578 if __name__
== '__main__':