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
, '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
= {'DynamicEx':set(), 'PatchableInModule':set(),'Dynamic':set(),'FixedAtBuild':set()}
409 BinaryPcdDict
= {'DynamicEx':set(), 'PatchableInModule':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 'DynamicEx' in BuildData
.Pcds
[key
].Type
:
434 if BuildData
.IsBinaryModule
:
435 BinaryPcdDict
['DynamicEx'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
437 SourcePcdDict
['DynamicEx'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
439 elif 'PatchableInModule' in BuildData
.Pcds
[key
].Type
:
440 if BuildData
.MetaFile
.Ext
== '.inf':
441 if BuildData
.IsBinaryModule
:
442 BinaryPcdDict
['PatchableInModule'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
444 SourcePcdDict
['PatchableInModule'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
446 elif 'Dynamic' in BuildData
.Pcds
[key
].Type
:
447 SourcePcdDict
['Dynamic'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
448 elif 'FixedAtBuild' in BuildData
.Pcds
[key
].Type
:
449 SourcePcdDict
['FixedAtBuild'].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 not Module
.Guid
.upper() in _GuidDict
.keys():
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
, 'COMMON', self
.BuildTarget
, self
.ToolChain
]
792 if not InfObj
.Guid
.upper() in _GuidDict
.keys():
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 not _PcdGuidString
.upper() in _GuidDict
.keys():
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 not FfsFile
.NameGuid
.upper() in _GuidDict
.keys():
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 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
873 "Dynamic", #"DynamicHii", "DynamicVpd",
874 "DynamicEx", # "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("DynamicEx"):
890 PcdType
= "DynamicEx"
891 elif PcdType
.startswith("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
!= "FixedAtBuild":
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("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
['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
== "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 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1406 PcdFromModule
.IsFromDsc
= True
1408 PcdFromModule
.IsFromDsc
= False
1409 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1410 if F
.Path
not in FdfModuleList
:
1411 # If one of the Source built modules listed in the DSC is not listed
1412 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1413 # access method (it is only listed in the DEC file that declares the
1414 # PCD as PcdsDynamic), then build tool will report warning message
1415 # notify the PI that they are attempting to build a module that must
1416 # be included in a flash image in order to be functional. These Dynamic
1417 # PCD will not be added into the Database unless it is used by other
1418 # modules that are included in the FDF file.
1419 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1420 PcdFromModule
.IsFromBinaryInf
== False:
1421 # Print warning message to let the developer make a determine.
1423 # If one of the Source built modules listed in the DSC is not listed in
1424 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1425 # access method (it is only listed in the DEC file that declares the
1426 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1427 # PCD to the Platform's PCD Database.
1428 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1431 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1432 # it should be stored in Pcd PEI database, If a dynamic only
1433 # used by DXE module, it should be stored in DXE PCD database.
1434 # The default Phase is DXE
1436 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1437 PcdFromModule
.Phase
= "PEI"
1438 if PcdFromModule
not in self
._DynaPcdList
_:
1439 self
._DynaPcdList
_.append(PcdFromModule
)
1440 elif PcdFromModule
.Phase
== 'PEI':
1441 # overwrite any the same PCD existing, if Phase is PEI
1442 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1443 self
._DynaPcdList
_[Index
] = PcdFromModule
1444 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1445 self
._NonDynaPcdList
_.append(PcdFromModule
)
1446 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1447 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1448 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1449 #The PCD from Binary INF will override the same one from source INF
1450 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1451 PcdFromModule
.Pending
= False
1452 self
._NonDynaPcdList
_.append (PcdFromModule
)
1453 DscModuleSet
= {os
.path
.normpath(ModuleInf
.Path
) for ModuleInf
in self
.Platform
.Modules
}
1454 # add the PCD from modules that listed in FDF but not in DSC to Database
1455 for InfName
in FdfModuleList
:
1456 if InfName
not in DscModuleSet
:
1457 InfClass
= PathClass(InfName
)
1458 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1459 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1460 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1461 # For binary module, if in current arch, we need to list the PCDs into database.
1462 if not M
.IsSupportedArch
:
1464 # Override the module PCD setting by platform setting
1465 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1466 for PcdFromModule
in ModulePcdList
:
1467 PcdFromModule
.IsFromBinaryInf
= True
1468 PcdFromModule
.IsFromDsc
= False
1469 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1470 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1471 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1473 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1474 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1475 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1476 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1477 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1478 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1479 PcdFromModule
.Phase
= "PEI"
1480 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1481 self
._DynaPcdList
_.append(PcdFromModule
)
1482 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1483 self
._NonDynaPcdList
_.append(PcdFromModule
)
1484 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1485 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1486 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1487 # module & DXE module at a same time.
1488 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1489 # INF file as DynamicEx.
1490 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1491 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1492 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1493 for PcdFromModule
in self
._NonDynaPcdList
_:
1494 # If a PCD is not listed in the DSC file, but binary INF files used by
1495 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1496 # section, AND all source INF files used by this platform the build
1497 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1498 # section, then the tools must NOT add the PCD to the Platform's PCD
1499 # Database; the build must assign the access method for this PCD as
1500 # PcdsPatchableInModule.
1501 if PcdFromModule
not in self
._DynaPcdList
_:
1503 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1504 if PcdFromModule
.IsFromDsc
== False and \
1505 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1506 PcdFromModule
.IsFromBinaryInf
== True and \
1507 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1508 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1509 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1511 # print out error information and break the build, if error found
1512 if len(NoDatumTypePcdList
) > 0:
1513 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1514 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1516 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1517 % NoDatumTypePcdListString
)
1518 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1519 self
._DynamicPcdList
= self
._DynaPcdList
_
1521 # Sort dynamic PCD list to:
1522 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1523 # try to be put header of dynamicd List
1524 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1526 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1528 UnicodePcdArray
= set()
1530 OtherPcdArray
= set()
1532 VpdFile
= VpdInfoFile
.VpdInfoFile()
1533 NeedProcessVpdMapFile
= False
1535 for pcd
in self
.Platform
.Pcds
.keys():
1536 if pcd
not in self
._PlatformPcds
.keys():
1537 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1539 for item
in self
._PlatformPcds
:
1540 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1541 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1543 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1544 for Pcd
in self
._DynamicPcdList
:
1545 # just pick the a value to determine whether is unicode string type
1546 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1547 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1549 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1550 Pcd
.DatumType
= "VOID*"
1552 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1553 # if found HII type PCD then insert to right of UnicodeIndex
1554 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1555 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1557 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1558 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1559 if PcdNvStoreDfBuffer
:
1560 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1561 vardump
= self
.VariableInfo
.dump()
1563 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1564 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1565 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1566 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1568 PlatformPcds
= self
._PlatformPcds
.keys()
1571 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1574 for PcdKey
in PlatformPcds
:
1575 Pcd
= self
._PlatformPcds
[PcdKey
]
1576 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1577 PcdKey
in VpdPcdDict
:
1578 Pcd
= VpdPcdDict
[PcdKey
]
1580 DefaultSku
= Pcd
.SkuInfoList
.get('DEFAULT')
1582 PcdValue
= DefaultSku
.DefaultValue
1583 if PcdValue
not in SkuValueMap
:
1584 SkuValueMap
[PcdValue
] = []
1585 VpdFile
.Add(Pcd
, 'DEFAULT',DefaultSku
.VpdOffset
)
1586 SkuValueMap
[PcdValue
].append(DefaultSku
)
1588 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1589 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1590 PcdValue
= Sku
.DefaultValue
1592 PcdValue
= Pcd
.DefaultValue
1593 if Sku
.VpdOffset
!= '*':
1594 if PcdValue
.startswith("{"):
1596 elif PcdValue
.startswith("L"):
1601 VpdOffset
= int(Sku
.VpdOffset
)
1604 VpdOffset
= int(Sku
.VpdOffset
, 16)
1606 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1607 if VpdOffset
% Alignment
!= 0:
1608 if PcdValue
.startswith("{"):
1609 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1611 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1612 if PcdValue
not in SkuValueMap
:
1613 SkuValueMap
[PcdValue
] = []
1614 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1615 SkuValueMap
[PcdValue
].append(Sku
)
1616 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1617 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1618 NeedProcessVpdMapFile
= True
1619 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1620 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1621 "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.")
1623 VpdSkuMap
[PcdKey
] = SkuValueMap
1625 # Fix the PCDs define in VPD PCD section that never referenced by module.
1626 # An example is PCD for signature usage.
1628 for DscPcd
in PlatformPcds
:
1629 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1630 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1631 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1633 for VpdPcd
in VpdFile
._VpdArray
.keys():
1634 # This PCD has been referenced by module
1635 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1636 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1639 # Not found, it should be signature
1641 # just pick the a value to determine whether is unicode string type
1643 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1644 DefaultSku
= DscPcdEntry
.SkuInfoList
.get('DEFAULT')
1646 defaultindex
= SkuObjList
.index(('DEFAULT',DefaultSku
))
1647 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1648 for (SkuName
,Sku
) in SkuObjList
:
1649 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1651 # Need to iterate DEC pcd information to get the value & datumtype
1652 for eachDec
in self
.PackageList
:
1653 for DecPcd
in eachDec
.Pcds
:
1654 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1655 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1656 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1657 # Print warning message to let the developer make a determine.
1658 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1659 File
=self
.MetaFile
, \
1660 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1661 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1663 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1664 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1665 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1666 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1667 # Only fix the value while no value provided in DSC file.
1668 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1669 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1671 if DscPcdEntry
not in self
._DynamicPcdList
:
1672 self
._DynamicPcdList
.append(DscPcdEntry
)
1673 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1674 PcdValue
= Sku
.DefaultValue
1676 PcdValue
= DscPcdEntry
.DefaultValue
1677 if Sku
.VpdOffset
!= '*':
1678 if PcdValue
.startswith("{"):
1680 elif PcdValue
.startswith("L"):
1685 VpdOffset
= int(Sku
.VpdOffset
)
1688 VpdOffset
= int(Sku
.VpdOffset
, 16)
1690 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1691 if VpdOffset
% Alignment
!= 0:
1692 if PcdValue
.startswith("{"):
1693 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1695 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1696 if PcdValue
not in SkuValueMap
:
1697 SkuValueMap
[PcdValue
] = []
1698 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1699 SkuValueMap
[PcdValue
].append(Sku
)
1700 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1701 NeedProcessVpdMapFile
= True
1702 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1703 UnicodePcdArray
.add(DscPcdEntry
)
1704 elif len(Sku
.VariableName
) > 0:
1705 HiiPcdArray
.add(DscPcdEntry
)
1707 OtherPcdArray
.add(DscPcdEntry
)
1709 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1710 VpdSkuMap
[DscPcd
] = SkuValueMap
1711 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1712 VpdFile
.GetCount() != 0:
1713 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1714 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1716 if VpdFile
.GetCount() != 0:
1718 self
.FixVpdOffset(VpdFile
)
1720 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1722 # Process VPD map file generated by third party BPDG tool
1723 if NeedProcessVpdMapFile
:
1724 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1725 if os
.path
.exists(VpdMapFilePath
):
1726 VpdFile
.Read(VpdMapFilePath
)
1729 for pcd
in VpdSkuMap
:
1730 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1732 # just pick the a value to determine whether is unicode string type
1734 for pcdvalue
in VpdSkuMap
[pcd
]:
1735 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1736 for item
in vpdinfo
:
1737 if item
[2] == pcdvalue
:
1738 sku
.VpdOffset
= item
[1]
1740 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1742 # Delete the DynamicPcdList At the last time enter into this function
1743 for Pcd
in self
._DynamicPcdList
:
1744 # just pick the a value to determine whether is unicode string type
1745 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1746 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1748 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1749 Pcd
.DatumType
= "VOID*"
1751 PcdValue
= Sku
.DefaultValue
1752 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1753 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1754 UnicodePcdArray
.add(Pcd
)
1755 elif len(Sku
.VariableName
) > 0:
1756 # if found HII type PCD then insert to right of UnicodeIndex
1757 HiiPcdArray
.add(Pcd
)
1759 OtherPcdArray
.add(Pcd
)
1760 del self
._DynamicPcdList
[:]
1761 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1762 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1763 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1764 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1765 for pcd
in self
._DynamicPcdList
:
1766 if len(pcd
.SkuInfoList
) == 1:
1767 for (SkuName
,SkuId
) in allskuset
:
1768 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1770 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
['DEFAULT'])
1771 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1772 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1774 def FixVpdOffset(self
,VpdFile
):
1775 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1776 if not os
.path
.exists(FvPath
):
1780 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1782 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1784 if VpdFile
.Write(VpdFilePath
):
1785 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1787 for ToolDef
in self
.ToolDefinition
.values():
1788 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1789 if not ToolDef
.has_key("PATH"):
1790 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1791 BPDGToolName
= ToolDef
["PATH"]
1793 # Call third party GUID BPDG tool.
1794 if BPDGToolName
is not None:
1795 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1797 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.")
1799 ## Return the platform build data object
1800 def _GetPlatform(self
):
1801 if self
._Platform
is None:
1802 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1803 return self
._Platform
1805 ## Return platform name
1807 return self
.Platform
.PlatformName
1809 ## Return the meta file GUID
1811 return self
.Platform
.Guid
1813 ## Return the platform version
1814 def _GetVersion(self
):
1815 return self
.Platform
.Version
1817 ## Return the FDF file name
1818 def _GetFdfFile(self
):
1819 if self
._FdfFile
is None:
1820 if self
.Workspace
.FdfFile
!= "":
1821 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1824 return self
._FdfFile
1826 ## Return the build output directory platform specifies
1827 def _GetOutputDir(self
):
1828 return self
.Platform
.OutputDirectory
1830 ## Return the directory to store all intermediate and final files built
1831 def _GetBuildDir(self
):
1832 if self
._BuildDir
is None:
1833 if os
.path
.isabs(self
.OutputDir
):
1834 self
._BuildDir
= path
.join(
1835 path
.abspath(self
.OutputDir
),
1836 self
.BuildTarget
+ "_" + self
.ToolChain
,
1839 self
._BuildDir
= path
.join(
1842 self
.BuildTarget
+ "_" + self
.ToolChain
,
1844 GlobalData
.gBuildDirectory
= self
._BuildDir
1845 return self
._BuildDir
1847 ## Return directory of platform makefile
1849 # @retval string Makefile directory
1851 def _GetMakeFileDir(self
):
1852 if self
._MakeFileDir
is None:
1853 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1854 return self
._MakeFileDir
1856 ## Return build command string
1858 # @retval string Build command string
1860 def _GetBuildCommand(self
):
1861 if self
._BuildCommand
is None:
1862 self
._BuildCommand
= []
1863 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1864 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1865 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1866 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1868 self
._BuildCommand
+= SplitOption(NewOption
)
1869 if "MAKE" in self
.EdkIIBuildOption
:
1870 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1871 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1872 if Flags
.startswith('='):
1873 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1875 self
._BuildCommand
+= [Flags
]
1876 return self
._BuildCommand
1878 ## Get tool chain definition
1880 # Get each tool defition for given tool chain from tools_def.txt and platform
1882 def _GetToolDefinition(self
):
1883 if self
._ToolDefinitions
is None:
1884 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1885 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1886 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1887 ExtraData
="[%s]" % self
.MetaFile
)
1888 self
._ToolDefinitions
= {}
1890 for Def
in ToolDefinition
:
1891 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1892 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1895 Value
= ToolDefinition
[Def
]
1896 # don't record the DLL
1898 DllPathList
.add(Value
)
1901 if Tool
not in self
._ToolDefinitions
:
1902 self
._ToolDefinitions
[Tool
] = {}
1903 self
._ToolDefinitions
[Tool
][Attr
] = Value
1906 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1907 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1908 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1909 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1911 for Tool
in self
._ToolDefinitions
:
1912 for Attr
in self
._ToolDefinitions
[Tool
]:
1913 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1914 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1915 # check if override is indicated
1916 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1917 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1920 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1922 Value
= self
.BuildOption
[Tool
][Attr
]
1925 # Don't put MAKE definition in the file
1927 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1929 # Don't put MAKE definition in the file
1934 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1937 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1938 for DllPath
in DllPathList
:
1939 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1940 os
.environ
["MAKE_FLAGS"] = MakeFlags
1942 return self
._ToolDefinitions
1944 ## Return the paths of tools
1945 def _GetToolDefFile(self
):
1946 if self
._ToolDefFile
is None:
1947 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1948 return self
._ToolDefFile
1950 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1951 def _GetToolChainFamily(self
):
1952 if self
._ToolChainFamily
is None:
1953 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1954 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1955 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1956 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1957 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1959 self
._ToolChainFamily
= "MSFT"
1961 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1962 return self
._ToolChainFamily
1964 def _GetBuildRuleFamily(self
):
1965 if self
._BuildRuleFamily
is None:
1966 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1967 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1968 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1969 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1970 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1972 self
._BuildRuleFamily
= "MSFT"
1974 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1975 return self
._BuildRuleFamily
1977 ## Return the build options specific for all modules in this platform
1978 def _GetBuildOptions(self
):
1979 if self
._BuildOption
is None:
1980 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1981 return self
._BuildOption
1983 ## Return the build options specific for EDK modules in this platform
1984 def _GetEdkBuildOptions(self
):
1985 if self
._EdkBuildOption
is None:
1986 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1987 return self
._EdkBuildOption
1989 ## Return the build options specific for EDKII modules in this platform
1990 def _GetEdkIIBuildOptions(self
):
1991 if self
._EdkIIBuildOption
is None:
1992 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
1993 return self
._EdkIIBuildOption
1995 ## Parse build_rule.txt in Conf Directory.
1997 # @retval BuildRule object
1999 def _GetBuildRule(self
):
2000 if self
._BuildRule
is None:
2001 BuildRuleFile
= None
2002 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2003 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2004 if BuildRuleFile
in [None, '']:
2005 BuildRuleFile
= gDefaultBuildRuleFile
2006 self
._BuildRule
= BuildRule(BuildRuleFile
)
2007 if self
._BuildRule
._FileVersion
== "":
2008 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2010 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2011 # If Build Rule's version is less than the version number required by the tools, halting the build.
2012 EdkLogger
.error("build", AUTOGEN_ERROR
,
2013 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])"\
2014 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2016 return self
._BuildRule
2018 ## Summarize the packages used by modules in this platform
2019 def _GetPackageList(self
):
2020 if self
._PackageList
is None:
2021 self
._PackageList
= set()
2022 for La
in self
.LibraryAutoGenList
:
2023 self
._PackageList
.update(La
.DependentPackageList
)
2024 for Ma
in self
.ModuleAutoGenList
:
2025 self
._PackageList
.update(Ma
.DependentPackageList
)
2026 #Collect package set information from INF of FDF
2028 for ModuleFile
in self
._AsBuildModuleList
:
2029 if ModuleFile
in self
.Platform
.Modules
:
2031 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2032 PkgSet
.update(ModuleData
.Packages
)
2033 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2034 return self
._PackageList
2036 def _GetNonDynamicPcdDict(self
):
2037 if self
._NonDynamicPcdDict
:
2038 return self
._NonDynamicPcdDict
2039 for Pcd
in self
.NonDynamicPcdList
:
2040 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2041 return self
._NonDynamicPcdDict
2043 ## Get list of non-dynamic PCDs
2044 def _GetNonDynamicPcdList(self
):
2045 if self
._NonDynamicPcdList
is None:
2046 self
.CollectPlatformDynamicPcds()
2047 return self
._NonDynamicPcdList
2049 ## Get list of dynamic PCDs
2050 def _GetDynamicPcdList(self
):
2051 if self
._DynamicPcdList
is None:
2052 self
.CollectPlatformDynamicPcds()
2053 return self
._DynamicPcdList
2055 ## Generate Token Number for all PCD
2056 def _GetPcdTokenNumbers(self
):
2057 if self
._PcdTokenNumber
is None:
2058 self
._PcdTokenNumber
= OrderedDict()
2061 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2065 # TokenNumber 0 ~ 10
2067 # TokeNumber 11 ~ 20
2069 for Pcd
in self
.DynamicPcdList
:
2070 if Pcd
.Phase
== "PEI":
2071 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2072 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2073 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2076 for Pcd
in self
.DynamicPcdList
:
2077 if Pcd
.Phase
== "PEI":
2078 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2079 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2080 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2083 for Pcd
in self
.DynamicPcdList
:
2084 if Pcd
.Phase
== "DXE":
2085 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2086 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2087 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2090 for Pcd
in self
.DynamicPcdList
:
2091 if Pcd
.Phase
== "DXE":
2092 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2093 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2094 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2097 for Pcd
in self
.NonDynamicPcdList
:
2098 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2100 return self
._PcdTokenNumber
2102 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2103 def _GetAutoGenObjectList(self
):
2104 self
._ModuleAutoGenList
= []
2105 self
._LibraryAutoGenList
= []
2106 for ModuleFile
in self
.Platform
.Modules
:
2115 if Ma
not in self
._ModuleAutoGenList
:
2116 self
._ModuleAutoGenList
.append(Ma
)
2117 for La
in Ma
.LibraryAutoGenList
:
2118 if La
not in self
._LibraryAutoGenList
:
2119 self
._LibraryAutoGenList
.append(La
)
2120 if Ma
not in La
._ReferenceModules
:
2121 La
._ReferenceModules
.append(Ma
)
2123 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2124 def _GetModuleAutoGenList(self
):
2125 if self
._ModuleAutoGenList
is None:
2126 self
._GetAutoGenObjectList
()
2127 return self
._ModuleAutoGenList
2129 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2130 def _GetLibraryAutoGenList(self
):
2131 if self
._LibraryAutoGenList
is None:
2132 self
._GetAutoGenObjectList
()
2133 return self
._LibraryAutoGenList
2135 ## Test if a module is supported by the platform
2137 # An error will be raised directly if the module or its arch is not supported
2138 # by the platform or current configuration
2140 def ValidModule(self
, Module
):
2141 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2142 or Module
in self
._AsBuildModuleList
2144 ## Resolve the library classes in a module to library instances
2146 # This method will not only resolve library classes but also sort the library
2147 # instances according to the dependency-ship.
2149 # @param Module The module from which the library classes will be resolved
2151 # @retval library_list List of library instances sorted
2153 def ApplyLibraryInstance(self
, Module
):
2154 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2155 if str(Module
) not in self
.Platform
.Modules
:
2158 ModuleType
= Module
.ModuleType
2160 # for overridding library instances with module specific setting
2161 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2163 # add forced library instances (specified under LibraryClasses sections)
2165 # If a module has a MODULE_TYPE of USER_DEFINED,
2166 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2168 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2169 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2170 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2171 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2173 # add forced library instances (specified in module overrides)
2174 for LibraryClass
in PlatformModule
.LibraryClasses
:
2175 if LibraryClass
.startswith("NULL"):
2176 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2179 LibraryConsumerList
= [Module
]
2181 ConsumedByList
= OrderedDict()
2182 LibraryInstance
= OrderedDict()
2184 EdkLogger
.verbose("")
2185 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2186 while len(LibraryConsumerList
) > 0:
2187 M
= LibraryConsumerList
.pop()
2188 for LibraryClassName
in M
.LibraryClasses
:
2189 if LibraryClassName
not in LibraryInstance
:
2190 # override library instance for this module
2191 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2192 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2194 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2195 if LibraryPath
is None or LibraryPath
== "":
2196 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2197 if LibraryPath
is None or LibraryPath
== "":
2198 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2199 "Instance of library class [%s] is not found" % LibraryClassName
,
2201 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2203 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2204 # for those forced library instance (NULL library), add a fake library class
2205 if LibraryClassName
.startswith("NULL"):
2206 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2207 elif LibraryModule
.LibraryClass
is None \
2208 or len(LibraryModule
.LibraryClass
) == 0 \
2209 or (ModuleType
!= 'USER_DEFINED'
2210 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2211 # only USER_DEFINED can link against any library instance despite of its SupModList
2212 EdkLogger
.error("build", OPTION_MISSING
,
2213 "Module type [%s] is not supported by library instance [%s]" \
2214 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2215 ExtraData
="consumed by [%s]" % str(Module
))
2217 LibraryInstance
[LibraryClassName
] = LibraryModule
2218 LibraryConsumerList
.append(LibraryModule
)
2219 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2221 LibraryModule
= LibraryInstance
[LibraryClassName
]
2223 if LibraryModule
is None:
2226 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2227 Constructor
.append(LibraryModule
)
2229 if LibraryModule
not in ConsumedByList
:
2230 ConsumedByList
[LibraryModule
] = []
2231 # don't add current module itself to consumer list
2233 if M
in ConsumedByList
[LibraryModule
]:
2235 ConsumedByList
[LibraryModule
].append(M
)
2237 # Initialize the sorted output list to the empty set
2239 SortedLibraryList
= []
2241 # Q <- Set of all nodes with no incoming edges
2243 LibraryList
= [] #LibraryInstance.values()
2245 for LibraryClassName
in LibraryInstance
:
2246 M
= LibraryInstance
[LibraryClassName
]
2247 LibraryList
.append(M
)
2248 if ConsumedByList
[M
] == []:
2252 # start the DAG algorithm
2256 while Q
== [] and EdgeRemoved
:
2258 # for each node Item with a Constructor
2259 for Item
in LibraryList
:
2260 if Item
not in Constructor
:
2262 # for each Node without a constructor with an edge e from Item to Node
2263 for Node
in ConsumedByList
[Item
]:
2264 if Node
in Constructor
:
2266 # remove edge e from the graph if Node has no constructor
2267 ConsumedByList
[Item
].remove(Node
)
2269 if ConsumedByList
[Item
] == []:
2270 # insert Item into Q
2275 # DAG is done if there's no more incoming edge for all nodes
2279 # remove node from Q
2282 SortedLibraryList
.append(Node
)
2284 # for each node Item with an edge e from Node to Item do
2285 for Item
in LibraryList
:
2286 if Node
not in ConsumedByList
[Item
]:
2288 # remove edge e from the graph
2289 ConsumedByList
[Item
].remove(Node
)
2291 if ConsumedByList
[Item
] != []:
2293 # insert Item into Q, if Item has no other incoming edges
2297 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2299 for Item
in LibraryList
:
2300 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2301 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2302 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2303 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2304 if Item
not in SortedLibraryList
:
2305 SortedLibraryList
.append(Item
)
2308 # Build the list of constructor and destructir names
2309 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2311 SortedLibraryList
.reverse()
2312 return SortedLibraryList
2315 ## Override PCD setting (type, value, ...)
2317 # @param ToPcd The PCD to be overrided
2318 # @param FromPcd The PCD overrideing from
2320 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2322 # in case there's PCDs coming from FDF file, which have no type given.
2323 # at this point, ToPcd.Type has the type found from dependent
2326 TokenCName
= ToPcd
.TokenCName
2327 for PcdItem
in GlobalData
.MixedPcd
:
2328 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2329 TokenCName
= PcdItem
[0]
2331 if FromPcd
is not None:
2332 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2333 ToPcd
.Type
= FromPcd
.Type
2334 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2335 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2336 if ToPcd
.Type
.strip() == "DynamicEx":
2337 ToPcd
.Type
= FromPcd
.Type
2338 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2339 and ToPcd
.Type
!= FromPcd
.Type
:
2340 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2341 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2342 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2343 ToPcd
.Type
, Module
, FromPcd
.Type
),
2346 if FromPcd
.MaxDatumSize
:
2347 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2348 ToPcd
.MaxSizeUserSet
= FromPcd
.MaxDatumSize
2349 if FromPcd
.DefaultValue
:
2350 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2351 if FromPcd
.TokenValue
:
2352 ToPcd
.TokenValue
= FromPcd
.TokenValue
2353 if FromPcd
.DatumType
:
2354 ToPcd
.DatumType
= FromPcd
.DatumType
2355 if FromPcd
.SkuInfoList
:
2356 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2357 # Add Flexible PCD format parse
2358 if ToPcd
.DefaultValue
:
2360 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2361 except BadExpression
, Value
:
2362 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2365 # check the validation of datum
2366 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2368 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2369 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2370 ToPcd
.validateranges
= FromPcd
.validateranges
2371 ToPcd
.validlists
= FromPcd
.validlists
2372 ToPcd
.expressions
= FromPcd
.expressions
2374 if FromPcd
is not None and ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2375 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2376 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2377 Value
= ToPcd
.DefaultValue
2378 if Value
in [None, '']:
2379 ToPcd
.MaxDatumSize
= '1'
2380 elif Value
[0] == 'L':
2381 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2382 elif Value
[0] == '{':
2383 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2385 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2387 # apply default SKU for dynamic PCDS if specified one is not available
2388 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2389 and ToPcd
.SkuInfoList
in [None, {}, '']:
2390 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2391 SkuName
= self
.Platform
.SkuName
2394 ToPcd
.SkuInfoList
= {
2395 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2398 ## Apply PCD setting defined platform to a module
2400 # @param Module The module from which the PCD setting will be overrided
2402 # @retval PCD_list The list PCDs with settings from platform
2404 def ApplyPcdSetting(self
, Module
, Pcds
):
2405 # for each PCD in module
2406 for Name
, Guid
in Pcds
:
2407 PcdInModule
= Pcds
[Name
, Guid
]
2408 # find out the PCD setting in platform
2409 if (Name
, Guid
) in self
.Platform
.Pcds
:
2410 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2412 PcdInPlatform
= None
2413 # then override the settings if any
2414 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2415 # resolve the VariableGuid value
2416 for SkuId
in PcdInModule
.SkuInfoList
:
2417 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2418 if Sku
.VariableGuid
== '': continue
2419 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2420 if Sku
.VariableGuidValue
is None:
2421 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2424 RESOURCE_NOT_AVAILABLE
,
2425 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2426 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2427 % (Guid
, Name
, str(Module
)),
2431 # override PCD settings with module specific setting
2432 if Module
in self
.Platform
.Modules
:
2433 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2434 for Key
in PlatformModule
.Pcds
:
2439 elif Key
in GlobalData
.MixedPcd
:
2440 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2442 ToPcd
= Pcds
[PcdItem
]
2446 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2447 # use PCD value to calculate the MaxDatumSize when it is not specified
2448 for Name
, Guid
in Pcds
:
2449 Pcd
= Pcds
[Name
, Guid
]
2450 if Pcd
.DatumType
== "VOID*" and Pcd
.MaxDatumSize
in ['', None]:
2451 Pcd
.MaxSizeUserSet
= None
2452 Value
= Pcd
.DefaultValue
2453 if Value
in [None, '']:
2454 Pcd
.MaxDatumSize
= '1'
2455 elif Value
[0] == 'L':
2456 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2457 elif Value
[0] == '{':
2458 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2460 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2461 return Pcds
.values()
2463 ## Resolve library names to library modules
2465 # (for Edk.x modules)
2467 # @param Module The module from which the library names will be resolved
2469 # @retval library_list The list of library modules
2471 def ResolveLibraryReference(self
, Module
):
2472 EdkLogger
.verbose("")
2473 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2474 LibraryConsumerList
= [Module
]
2476 # "CompilerStub" is a must for Edk modules
2477 if Module
.Libraries
:
2478 Module
.Libraries
.append("CompilerStub")
2480 while len(LibraryConsumerList
) > 0:
2481 M
= LibraryConsumerList
.pop()
2482 for LibraryName
in M
.Libraries
:
2483 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2485 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2486 if LibraryName
.upper() == Key
.upper():
2487 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2490 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2491 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2494 if Library
not in LibraryList
:
2495 LibraryList
.append(Library
)
2496 LibraryConsumerList
.append(Library
)
2497 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2500 ## Calculate the priority value of the build option
2502 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2504 # @retval Value Priority value based on the priority list.
2506 def CalculatePriorityValue(self
, Key
):
2507 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2508 PriorityValue
= 0x11111
2510 PriorityValue
&= 0x01111
2511 if ToolChain
== "*":
2512 PriorityValue
&= 0x10111
2514 PriorityValue
&= 0x11011
2515 if CommandType
== "*":
2516 PriorityValue
&= 0x11101
2518 PriorityValue
&= 0x11110
2520 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2523 ## Expand * in build option key
2525 # @param Options Options to be expanded
2527 # @retval options Options expanded
2529 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2536 # Construct a list contain the build options which need override.
2540 # Key[0] -- tool family
2541 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2543 if (Key
[0] == self
.BuildRuleFamily
and
2544 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2545 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2546 if Target
== self
.BuildTarget
or Target
== "*":
2547 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2548 if Arch
== self
.Arch
or Arch
== "*":
2549 if Options
[Key
].startswith("="):
2550 if OverrideList
.get(Key
[1]) is not None:
2551 OverrideList
.pop(Key
[1])
2552 OverrideList
[Key
[1]] = Options
[Key
]
2555 # Use the highest priority value.
2557 if (len(OverrideList
) >= 2):
2558 KeyList
= OverrideList
.keys()
2559 for Index
in range(len(KeyList
)):
2560 NowKey
= KeyList
[Index
]
2561 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2562 for Index1
in range(len(KeyList
) - Index
- 1):
2563 NextKey
= KeyList
[Index1
+ Index
+ 1]
2565 # Compare two Key, if one is included by another, choose the higher priority one
2567 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2568 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2569 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2570 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2571 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2572 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2573 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2574 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2575 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2577 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2578 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2581 if ModuleStyle
is not None and len (Key
) > 2:
2582 # Check Module style is EDK or EDKII.
2583 # Only append build option for the matched style module.
2584 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2586 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2589 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2590 # if tool chain family doesn't match, skip it
2591 if Tool
in self
.ToolDefinition
and Family
!= "":
2592 FamilyIsNull
= False
2593 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2594 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2596 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2599 # expand any wildcard
2600 if Target
== "*" or Target
== self
.BuildTarget
:
2601 if Tag
== "*" or Tag
== self
.ToolChain
:
2602 if Arch
== "*" or Arch
== self
.Arch
:
2603 if Tool
not in BuildOptions
:
2604 BuildOptions
[Tool
] = {}
2605 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2606 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2608 # append options for the same tool except PATH
2610 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2612 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2613 # Build Option Family has been checked, which need't to be checked again for family.
2614 if FamilyMatch
or FamilyIsNull
:
2618 if ModuleStyle
is not None and len (Key
) > 2:
2619 # Check Module style is EDK or EDKII.
2620 # Only append build option for the matched style module.
2621 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2623 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2626 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2627 # if tool chain family doesn't match, skip it
2628 if Tool
not in self
.ToolDefinition
or Family
== "":
2630 # option has been added before
2631 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2634 # expand any wildcard
2635 if Target
== "*" or Target
== self
.BuildTarget
:
2636 if Tag
== "*" or Tag
== self
.ToolChain
:
2637 if Arch
== "*" or Arch
== self
.Arch
:
2638 if Tool
not in BuildOptions
:
2639 BuildOptions
[Tool
] = {}
2640 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2641 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2643 # append options for the same tool except PATH
2645 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2647 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2650 ## Append build options in platform to a module
2652 # @param Module The module to which the build options will be appened
2654 # @retval options The options appended with build options in platform
2656 def ApplyBuildOption(self
, Module
):
2657 # Get the different options for the different style module
2658 if Module
.AutoGenVersion
< 0x00010005:
2659 PlatformOptions
= self
.EdkBuildOption
2660 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2662 PlatformOptions
= self
.EdkIIBuildOption
2663 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2664 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2665 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2666 if Module
in self
.Platform
.Modules
:
2667 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2668 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2670 PlatformModuleOptions
= {}
2672 BuildRuleOrder
= None
2673 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2674 for Tool
in Options
:
2675 for Attr
in Options
[Tool
]:
2676 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2677 BuildRuleOrder
= Options
[Tool
][Attr
]
2679 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2680 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2681 self
.ToolDefinition
.keys())
2682 BuildOptions
= defaultdict(lambda: defaultdict(str))
2683 for Tool
in AllTools
:
2684 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2685 if Tool
not in Options
:
2687 for Attr
in Options
[Tool
]:
2689 # Do not generate it in Makefile
2691 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2693 Value
= Options
[Tool
][Attr
]
2694 # check if override is indicated
2695 if Value
.startswith('='):
2696 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
[1:])
2699 BuildOptions
[Tool
][Attr
] += " " + mws
.handleWsMacro(Value
)
2701 BuildOptions
[Tool
][Attr
] = mws
.handleWsMacro(Value
)
2703 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2705 # Override UNI flag only for EDK module.
2707 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2708 return BuildOptions
, BuildRuleOrder
2710 Platform
= property(_GetPlatform
)
2711 Name
= property(_GetName
)
2712 Guid
= property(_GetGuid
)
2713 Version
= property(_GetVersion
)
2715 OutputDir
= property(_GetOutputDir
)
2716 BuildDir
= property(_GetBuildDir
)
2717 MakeFileDir
= property(_GetMakeFileDir
)
2718 FdfFile
= property(_GetFdfFile
)
2720 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2721 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2722 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2723 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2724 PackageList
= property(_GetPackageList
)
2726 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2727 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2728 ToolChainFamily
= property(_GetToolChainFamily
)
2729 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2730 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2731 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2732 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2734 BuildCommand
= property(_GetBuildCommand
)
2735 BuildRule
= property(_GetBuildRule
)
2736 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2737 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2738 GenFdsCommand
= property(_GenFdsCommand
)
2740 ## ModuleAutoGen class
2742 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2743 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2744 # to the [depex] section in module's inf file.
2746 class ModuleAutoGen(AutoGen
):
2747 # call super().__init__ then call the worker function with different parameter count
2748 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2752 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2753 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2756 ## Cache the timestamps of metafiles of every module in a class variable
2760 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2761 obj
= super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2762 # check if this module is employed by active platform
2763 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2764 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2769 ## Initialize ModuleAutoGen
2771 # @param Workspace EdkIIWorkspaceBuild object
2772 # @param ModuleFile The path of module file
2773 # @param Target Build target (DEBUG, RELEASE)
2774 # @param Toolchain Name of tool chain
2775 # @param Arch The arch the module supports
2776 # @param PlatformFile Platform meta-file
2778 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2779 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2780 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2782 self
.Workspace
= Workspace
2783 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2784 self
._GuidDict
= Workspace
._GuidDict
2785 self
.MetaFile
= ModuleFile
2786 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2788 self
.SourceDir
= self
.MetaFile
.SubDir
2789 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2791 self
.SourceOverrideDir
= None
2792 # use overrided path defined in DSC file
2793 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2794 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2796 self
.ToolChain
= Toolchain
2797 self
.BuildTarget
= Target
2799 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2800 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2802 self
.IsMakeFileCreated
= False
2803 self
.IsCodeFileCreated
= False
2804 self
.IsAsBuiltInfCreated
= False
2805 self
.DepexGenerated
= False
2807 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2808 self
.BuildRuleOrder
= None
2814 self
._Version
= None
2815 self
._ModuleType
= None
2816 self
._ComponentType
= None
2817 self
._PcdIsDriver
= None
2818 self
._AutoGenVersion
= None
2819 self
._LibraryFlag
= None
2820 self
._CustomMakefile
= None
2823 self
._BuildDir
= None
2824 self
._OutputDir
= None
2825 self
._FfsOutputDir
= None
2826 self
._DebugDir
= None
2827 self
._MakeFileDir
= None
2829 self
._IncludePathList
= None
2830 self
._IncludePathLength
= 0
2831 self
._AutoGenFileList
= None
2832 self
._UnicodeFileList
= None
2833 self
._VfrFileList
= None
2834 self
._IdfFileList
= None
2835 self
._SourceFileList
= None
2836 self
._ObjectFileList
= None
2837 self
._BinaryFileList
= None
2839 self
._DependentPackageList
= None
2840 self
._DependentLibraryList
= None
2841 self
._LibraryAutoGenList
= None
2842 self
._DerivedPackageList
= None
2843 self
._ModulePcdList
= None
2844 self
._LibraryPcdList
= None
2845 self
._PcdComments
= OrderedDict()
2846 self
._GuidList
= None
2847 self
._GuidsUsedByPcd
= None
2848 self
._GuidComments
= OrderedDict()
2849 self
._ProtocolList
= None
2850 self
._ProtocolComments
= OrderedDict()
2851 self
._PpiList
= None
2852 self
._PpiComments
= OrderedDict()
2853 self
._DepexList
= None
2854 self
._DepexExpressionList
= None
2855 self
._BuildOption
= None
2856 self
._BuildOptionIncPathList
= None
2857 self
._BuildTargets
= None
2858 self
._IntroBuildTargetList
= None
2859 self
._FinalBuildTargetList
= None
2860 self
._FileTypes
= None
2861 self
._BuildRules
= None
2863 self
._TimeStampPath
= None
2865 self
.AutoGenDepSet
= set()
2868 ## The Modules referenced to this Library
2869 # Only Library has this attribute
2870 self
._ReferenceModules
= []
2872 ## Store the FixedAtBuild Pcds
2874 self
._FixedAtBuildPcds
= []
2879 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2881 # Get FixedAtBuild Pcds of this Module
2882 def _GetFixedAtBuildPcds(self
):
2883 if self
._FixedAtBuildPcds
:
2884 return self
._FixedAtBuildPcds
2885 for Pcd
in self
.ModulePcdList
:
2886 if Pcd
.Type
!= "FixedAtBuild":
2888 if Pcd
not in self
._FixedAtBuildPcds
:
2889 self
._FixedAtBuildPcds
.append(Pcd
)
2891 return self
._FixedAtBuildPcds
2893 def _GetUniqueBaseName(self
):
2894 BaseName
= self
.Name
2895 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2896 if Module
.MetaFile
== self
.MetaFile
:
2898 if Module
.Name
== self
.Name
:
2899 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2900 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2901 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2902 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2905 # Macros could be used in build_rule.txt (also Makefile)
2906 def _GetMacros(self
):
2907 if self
._Macro
is None:
2908 self
._Macro
= OrderedDict()
2909 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2910 self
._Macro
["MODULE_NAME" ] = self
.Name
2911 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2912 self
._Macro
["MODULE_GUID" ] = self
.Guid
2913 self
._Macro
["MODULE_VERSION" ] = self
.Version
2914 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2915 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2916 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2917 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2918 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2920 self
._Macro
["BASE_NAME" ] = self
.Name
2922 self
._Macro
["ARCH" ] = self
.Arch
2923 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2924 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2925 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2926 self
._Macro
["TARGET" ] = self
.BuildTarget
2928 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2929 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2930 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2931 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2932 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2933 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2934 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2935 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2936 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2937 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2938 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2939 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2940 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2941 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2942 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2945 ## Return the module build data object
2946 def _GetModule(self
):
2947 if self
._Module
is None:
2948 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2951 ## Return the module name
2952 def _GetBaseName(self
):
2953 return self
.Module
.BaseName
2955 ## Return the module DxsFile if exist
2956 def _GetDxsFile(self
):
2957 return self
.Module
.DxsFile
2959 ## Return the module SourceOverridePath
2960 def _GetSourceOverridePath(self
):
2961 return self
.Module
.SourceOverridePath
2963 ## Return the module meta-file GUID
2966 # To build same module more than once, the module path with FILE_GUID overridden has
2967 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2968 # in DSC. The overridden GUID can be retrieved from file name
2970 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2972 # Length of GUID is 36
2974 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2975 return self
.Module
.Guid
2977 ## Return the module version
2978 def _GetVersion(self
):
2979 return self
.Module
.Version
2981 ## Return the module type
2982 def _GetModuleType(self
):
2983 return self
.Module
.ModuleType
2985 ## Return the component type (for Edk.x style of module)
2986 def _GetComponentType(self
):
2987 return self
.Module
.ComponentType
2989 ## Return the build type
2990 def _GetBuildType(self
):
2991 return self
.Module
.BuildType
2993 ## Return the PCD_IS_DRIVER setting
2994 def _GetPcdIsDriver(self
):
2995 return self
.Module
.PcdIsDriver
2997 ## Return the autogen version, i.e. module meta-file version
2998 def _GetAutoGenVersion(self
):
2999 return self
.Module
.AutoGenVersion
3001 ## Check if the module is library or not
3002 def _IsLibrary(self
):
3003 if self
._LibraryFlag
is None:
3004 if self
.Module
.LibraryClass
is not None and self
.Module
.LibraryClass
!= []:
3005 self
._LibraryFlag
= True
3007 self
._LibraryFlag
= False
3008 return self
._LibraryFlag
3010 ## Check if the module is binary module or not
3011 def _IsBinaryModule(self
):
3012 return self
.Module
.IsBinaryModule
3014 ## Return the directory to store intermediate files of the module
3015 def _GetBuildDir(self
):
3016 if self
._BuildDir
is None:
3017 self
._BuildDir
= path
.join(
3018 self
.PlatformInfo
.BuildDir
,
3021 self
.MetaFile
.BaseName
3023 CreateDirectory(self
._BuildDir
)
3024 return self
._BuildDir
3026 ## Return the directory to store the intermediate object files of the mdoule
3027 def _GetOutputDir(self
):
3028 if self
._OutputDir
is None:
3029 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3030 CreateDirectory(self
._OutputDir
)
3031 return self
._OutputDir
3033 ## Return the directory to store ffs file
3034 def _GetFfsOutputDir(self
):
3035 if self
._FfsOutputDir
is None:
3036 if GlobalData
.gFdfParser
is not None:
3037 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3039 self
._FfsOutputDir
= ''
3040 return self
._FfsOutputDir
3042 ## Return the directory to store auto-gened source files of the mdoule
3043 def _GetDebugDir(self
):
3044 if self
._DebugDir
is None:
3045 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3046 CreateDirectory(self
._DebugDir
)
3047 return self
._DebugDir
3049 ## Return the path of custom file
3050 def _GetCustomMakefile(self
):
3051 if self
._CustomMakefile
is None:
3052 self
._CustomMakefile
= {}
3053 for Type
in self
.Module
.CustomMakefile
:
3054 if Type
in gMakeTypeMap
:
3055 MakeType
= gMakeTypeMap
[Type
]
3058 if self
.SourceOverrideDir
is not None:
3059 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3060 if not os
.path
.exists(File
):
3061 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3063 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3064 self
._CustomMakefile
[MakeType
] = File
3065 return self
._CustomMakefile
3067 ## Return the directory of the makefile
3069 # @retval string The directory string of module's makefile
3071 def _GetMakeFileDir(self
):
3072 return self
.BuildDir
3074 ## Return build command string
3076 # @retval string Build command string
3078 def _GetBuildCommand(self
):
3079 return self
.PlatformInfo
.BuildCommand
3081 ## Get object list of all packages the module and its dependent libraries belong to
3083 # @retval list The list of package object
3085 def _GetDerivedPackageList(self
):
3087 for M
in [self
.Module
] + self
.DependentLibraryList
:
3088 for Package
in M
.Packages
:
3089 if Package
in PackageList
:
3091 PackageList
.append(Package
)
3094 ## Get the depex string
3096 # @return : a string contain all depex expresion.
3097 def _GetDepexExpresionString(self
):
3100 ## DPX_SOURCE IN Define section.
3101 if self
.Module
.DxsFile
:
3103 for M
in [self
.Module
] + self
.DependentLibraryList
:
3104 Filename
= M
.MetaFile
.Path
3105 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3106 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3107 for DepexExpresion
in DepexExpresionList
:
3108 for key
in DepexExpresion
.keys():
3109 Arch
, ModuleType
= key
3110 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3111 # the type of build module is USER_DEFINED.
3112 # All different DEPEX section tags would be copied into the As Built INF file
3113 # and there would be separate DEPEX section tags
3114 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3115 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3116 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3118 if Arch
.upper() == TAB_ARCH_COMMON
or \
3119 (Arch
.upper() == self
.Arch
.upper() and \
3120 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3121 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3123 #the type of build module is USER_DEFINED.
3124 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3125 for Depex
in DepexList
:
3126 for key
in Depex
.keys():
3127 DepexStr
+= '[Depex.%s.%s]\n' % key
3128 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3131 return '[Depex.%s]\n' % self
.Arch
3134 #the type of build module not is USER_DEFINED.
3136 for Depex
in DepexList
:
3141 for D
in Depex
.values():
3142 DepexStr
+= ' '.join([val
for val
in D
])
3143 Index
= DepexStr
.find('END')
3144 if Index
> -1 and Index
== len(DepexStr
) - 3:
3145 DepexStr
= DepexStr
[:-3]
3146 DepexStr
= DepexStr
.strip()
3149 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3151 return '[Depex.%s]\n' % self
.Arch
3152 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3154 ## Merge dependency expression
3156 # @retval list The token list of the dependency expression after parsed
3158 def _GetDepexTokenList(self
):
3159 if self
._DepexList
is None:
3160 self
._DepexList
= {}
3161 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3162 return self
._DepexList
3164 self
._DepexList
[self
.ModuleType
] = []
3166 for ModuleType
in self
._DepexList
:
3167 DepexList
= self
._DepexList
[ModuleType
]
3169 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3171 for M
in [self
.Module
] + self
.DependentLibraryList
:
3173 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3175 DepexList
.append('AND')
3176 DepexList
.append('(')
3178 if DepexList
[-1] == 'END': # no need of a END at this time
3180 DepexList
.append(')')
3183 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3184 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3186 if len(DepexList
) > 0:
3187 EdkLogger
.verbose('')
3188 return self
._DepexList
3190 ## Merge dependency expression
3192 # @retval list The token list of the dependency expression after parsed
3194 def _GetDepexExpressionTokenList(self
):
3195 if self
._DepexExpressionList
is None:
3196 self
._DepexExpressionList
= {}
3197 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3198 return self
._DepexExpressionList
3200 self
._DepexExpressionList
[self
.ModuleType
] = ''
3202 for ModuleType
in self
._DepexExpressionList
:
3203 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3205 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3207 for M
in [self
.Module
] + self
.DependentLibraryList
:
3209 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3210 if DepexExpressionList
!= '':
3211 DepexExpressionList
+= ' AND '
3212 DepexExpressionList
+= '('
3213 DepexExpressionList
+= D
3214 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3215 DepexExpressionList
+= ')'
3218 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3219 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3221 if len(DepexExpressionList
) > 0:
3222 EdkLogger
.verbose('')
3223 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3224 return self
._DepexExpressionList
3226 # Get the tiano core user extension, it is contain dependent library.
3227 # @retval: a list contain tiano core userextension.
3229 def _GetTianoCoreUserExtensionList(self
):
3230 TianoCoreUserExtentionList
= []
3231 for M
in [self
.Module
] + self
.DependentLibraryList
:
3232 Filename
= M
.MetaFile
.Path
3233 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3234 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3235 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3236 for Section
in TianoCoreUserExtent
.keys():
3237 ItemList
= Section
.split(TAB_SPLIT
)
3239 if len(ItemList
) == 4:
3241 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3243 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3244 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3245 TianoCoreList
.append('\n')
3246 TianoCoreUserExtentionList
.append(TianoCoreList
)
3248 return TianoCoreUserExtentionList
3250 ## Return the list of specification version required for the module
3252 # @retval list The list of specification defined in module file
3254 def _GetSpecification(self
):
3255 return self
.Module
.Specification
3257 ## Tool option for the module build
3259 # @param PlatformInfo The object of PlatformBuildInfo
3260 # @retval dict The dict containing valid options
3262 def _GetModuleBuildOption(self
):
3263 if self
._BuildOption
is None:
3264 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3265 if self
.BuildRuleOrder
:
3266 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3267 return self
._BuildOption
3269 ## Get include path list from tool option for the module build
3271 # @retval list The include path list
3273 def _GetBuildOptionIncPathList(self
):
3274 if self
._BuildOptionIncPathList
is None:
3276 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3277 # is the former use /I , the Latter used -I to specify include directories
3279 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3280 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
3281 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3282 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
3285 # New ToolChainFamily, don't known whether there is option to specify include directories
3287 self
._BuildOptionIncPathList
= []
3288 return self
._BuildOptionIncPathList
3290 BuildOptionIncPathList
= []
3291 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3294 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3298 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3299 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
3302 # RVCT may specify a list of directory seperated by commas
3305 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
3306 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3307 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3310 # EDK II modules must not reference header files outside of the packages they depend on or
3311 # within the module's directory tree. Report error if violation.
3313 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3314 for Path
in IncPathList
:
3315 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3316 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3317 EdkLogger
.error("build",
3320 File
=str(self
.MetaFile
))
3323 BuildOptionIncPathList
+= IncPathList
3325 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3327 return self
._BuildOptionIncPathList
3329 ## Return a list of files which can be built from source
3331 # What kind of files can be built is determined by build rules in
3332 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3334 def _GetSourceFileList(self
):
3335 if self
._SourceFileList
is None:
3336 self
._SourceFileList
= []
3337 for F
in self
.Module
.Sources
:
3339 if F
.TagName
not in ("", "*", self
.ToolChain
):
3340 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3341 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3343 # match tool chain family or build rule family
3344 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3347 "The file [%s] must be built by tools of [%s], " \
3348 "but current toolchain family is [%s], buildrule family is [%s]" \
3349 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3352 # add the file path into search path list for file including
3353 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3354 self
.IncludePathList
.insert(0, F
.Dir
)
3355 self
._SourceFileList
.append(F
)
3357 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3359 for F
in self
._SourceFileList
:
3360 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3361 return self
._SourceFileList
3363 def _MatchBuildRuleOrder(self
, FileList
):
3365 self
._GetModuleBuildOption
()
3366 for SingleFile
in FileList
:
3367 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3368 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3369 if key
in Order_Dict
:
3370 Order_Dict
[key
].append(SingleFile
.Ext
)
3372 Order_Dict
[key
] = [SingleFile
.Ext
]
3375 for F
in Order_Dict
:
3376 if len(Order_Dict
[F
]) > 1:
3377 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3378 for Ext
in Order_Dict
[F
][1:]:
3379 RemoveList
.append(F
+ Ext
)
3381 for item
in RemoveList
:
3382 FileList
.remove(item
)
3386 ## Return the list of unicode files
3387 def _GetUnicodeFileList(self
):
3388 if self
._UnicodeFileList
is None:
3389 if TAB_UNICODE_FILE
in self
.FileTypes
:
3390 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3392 self
._UnicodeFileList
= []
3393 return self
._UnicodeFileList
3395 ## Return the list of vfr files
3396 def _GetVfrFileList(self
):
3397 if self
._VfrFileList
is None:
3398 if TAB_VFR_FILE
in self
.FileTypes
:
3399 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3401 self
._VfrFileList
= []
3402 return self
._VfrFileList
3404 ## Return the list of Image Definition files
3405 def _GetIdfFileList(self
):
3406 if self
._IdfFileList
is None:
3407 if TAB_IMAGE_FILE
in self
.FileTypes
:
3408 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3410 self
._IdfFileList
= []
3411 return self
._IdfFileList
3413 ## Return a list of files which can be built from binary
3415 # "Build" binary files are just to copy them to build directory.
3417 # @retval list The list of files which can be built later
3419 def _GetBinaryFiles(self
):
3420 if self
._BinaryFileList
is None:
3421 self
._BinaryFileList
= []
3422 for F
in self
.Module
.Binaries
:
3423 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3425 self
._BinaryFileList
.append(F
)
3426 self
._ApplyBuildRule
(F
, F
.Type
)
3427 return self
._BinaryFileList
3429 def _GetBuildRules(self
):
3430 if self
._BuildRules
is None:
3432 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3433 for Type
in BuildRuleDatabase
.FileTypeList
:
3434 #first try getting build rule by BuildRuleFamily
3435 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3437 # build type is always module type, but ...
3438 if self
.ModuleType
!= self
.BuildType
:
3439 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3440 #second try getting build rule by ToolChainFamily
3442 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3444 # build type is always module type, but ...
3445 if self
.ModuleType
!= self
.BuildType
:
3446 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3449 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3450 BuildRules
[Type
] = RuleObject
3451 for Ext
in RuleObject
.SourceFileExtList
:
3452 BuildRules
[Ext
] = RuleObject
3453 self
._BuildRules
= BuildRules
3454 return self
._BuildRules
3456 def _ApplyBuildRule(self
, File
, FileType
):
3457 if self
._BuildTargets
is None:
3458 self
._IntroBuildTargetList
= set()
3459 self
._FinalBuildTargetList
= set()
3460 self
._BuildTargets
= defaultdict(set)
3461 self
._FileTypes
= defaultdict(set)
3463 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3464 if not os
.path
.exists(SubDirectory
):
3465 CreateDirectory(SubDirectory
)
3471 # Make sure to get build rule order value
3473 self
._GetModuleBuildOption
()
3475 while Index
< len(SourceList
):
3476 Source
= SourceList
[Index
]
3480 CreateDirectory(Source
.Dir
)
3482 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
is not None and File
in self
._BinaryFileList
:
3483 # Skip all files that are not binary libraries
3484 if not self
.IsLibrary
:
3486 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3487 elif FileType
in self
.BuildRules
:
3488 RuleObject
= self
.BuildRules
[FileType
]
3489 elif Source
.Ext
in self
.BuildRules
:
3490 RuleObject
= self
.BuildRules
[Source
.Ext
]
3492 # stop at no more rules
3494 self
._FinalBuildTargetList
.add(LastTarget
)
3497 FileType
= RuleObject
.SourceFileType
3498 self
._FileTypes
[FileType
].add(Source
)
3500 # stop at STATIC_LIBRARY for library
3501 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3503 self
._FinalBuildTargetList
.add(LastTarget
)
3506 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3509 self
._FinalBuildTargetList
.add(LastTarget
)
3511 elif not Target
.Outputs
:
3512 # Only do build for target with outputs
3513 self
._FinalBuildTargetList
.add(Target
)
3515 self
._BuildTargets
[FileType
].add(Target
)
3517 if not Source
.IsBinary
and Source
== File
:
3518 self
._IntroBuildTargetList
.add(Target
)
3520 # to avoid cyclic rule
3521 if FileType
in RuleChain
:
3524 RuleChain
.append(FileType
)
3525 SourceList
.extend(Target
.Outputs
)
3527 FileType
= TAB_UNKNOWN_FILE
3529 def _GetTargets(self
):
3530 if self
._BuildTargets
is None:
3531 self
._IntroBuildTargetList
= set()
3532 self
._FinalBuildTargetList
= set()
3533 self
._BuildTargets
= defaultdict(set)
3534 self
._FileTypes
= defaultdict(set)
3536 #TRICK: call _GetSourceFileList to apply build rule for source files
3537 if self
.SourceFileList
:
3540 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3541 if self
.BinaryFileList
:
3544 return self
._BuildTargets
3546 def _GetIntroTargetList(self
):
3548 return self
._IntroBuildTargetList
3550 def _GetFinalTargetList(self
):
3552 return self
._FinalBuildTargetList
3554 def _GetFileTypes(self
):
3556 return self
._FileTypes
3558 ## Get the list of package object the module depends on
3560 # @retval list The package object list
3562 def _GetDependentPackageList(self
):
3563 return self
.Module
.Packages
3565 ## Return the list of auto-generated code file
3567 # @retval list The list of auto-generated file
3569 def _GetAutoGenFileList(self
):
3570 UniStringAutoGenC
= True
3571 IdfStringAutoGenC
= True
3572 UniStringBinBuffer
= StringIO()
3573 IdfGenBinBuffer
= StringIO()
3574 if self
.BuildType
== 'UEFI_HII':
3575 UniStringAutoGenC
= False
3576 IdfStringAutoGenC
= False
3577 if self
._AutoGenFileList
is None:
3578 self
._AutoGenFileList
= {}
3579 AutoGenC
= TemplateString()
3580 AutoGenH
= TemplateString()
3581 StringH
= TemplateString()
3582 StringIdf
= TemplateString()
3583 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3585 # AutoGen.c is generated if there are library classes in inf, or there are object files
3587 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3588 or TAB_OBJECT_FILE
in self
.FileTypes
):
3589 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3590 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3591 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3592 if str(AutoGenH
) != "":
3593 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3594 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3595 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3596 if str(StringH
) != "":
3597 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3598 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3599 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3600 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3601 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3602 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3603 AutoFile
.IsBinary
= True
3604 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3605 if UniStringBinBuffer
is not None:
3606 UniStringBinBuffer
.close()
3607 if str(StringIdf
) != "":
3608 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3609 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3610 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3611 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3612 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3613 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3614 AutoFile
.IsBinary
= True
3615 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3616 if IdfGenBinBuffer
is not None:
3617 IdfGenBinBuffer
.close()
3618 return self
._AutoGenFileList
3620 ## Return the list of library modules explicitly or implicityly used by this module
3621 def _GetLibraryList(self
):
3622 if self
._DependentLibraryList
is None:
3623 # only merge library classes and PCD for non-library module
3625 self
._DependentLibraryList
= []
3627 if self
.AutoGenVersion
< 0x00010005:
3628 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3630 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3631 return self
._DependentLibraryList
3634 def UpdateComments(Recver
, Src
):
3636 if Key
not in Recver
:
3638 Recver
[Key
].extend(Src
[Key
])
3639 ## Get the list of PCDs from current module
3641 # @retval list The list of PCD
3643 def _GetModulePcdList(self
):
3644 if self
._ModulePcdList
is None:
3645 # apply PCD settings from platform
3646 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3647 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3648 return self
._ModulePcdList
3650 ## Get the list of PCDs from dependent libraries
3652 # @retval list The list of PCD
3654 def _GetLibraryPcdList(self
):
3655 if self
._LibraryPcdList
is None:
3656 Pcds
= OrderedDict()
3657 if not self
.IsLibrary
:
3658 # get PCDs from dependent libraries
3659 for Library
in self
.DependentLibraryList
:
3660 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3661 for Key
in Library
.Pcds
:
3662 # skip duplicated PCDs
3663 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3665 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3666 # apply PCD settings from platform
3667 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3669 self
._LibraryPcdList
= []
3670 return self
._LibraryPcdList
3672 ## Get the GUID value mapping
3674 # @retval dict The mapping between GUID cname and its value
3676 def _GetGuidList(self
):
3677 if self
._GuidList
is None:
3678 self
._GuidList
= OrderedDict()
3679 self
._GuidList
.update(self
.Module
.Guids
)
3680 for Library
in self
.DependentLibraryList
:
3681 self
._GuidList
.update(Library
.Guids
)
3682 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3683 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3684 return self
._GuidList
3686 def GetGuidsUsedByPcd(self
):
3687 if self
._GuidsUsedByPcd
is None:
3688 self
._GuidsUsedByPcd
= OrderedDict()
3689 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3690 for Library
in self
.DependentLibraryList
:
3691 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3692 return self
._GuidsUsedByPcd
3693 ## Get the protocol value mapping
3695 # @retval dict The mapping between protocol cname and its value
3697 def _GetProtocolList(self
):
3698 if self
._ProtocolList
is None:
3699 self
._ProtocolList
= OrderedDict()
3700 self
._ProtocolList
.update(self
.Module
.Protocols
)
3701 for Library
in self
.DependentLibraryList
:
3702 self
._ProtocolList
.update(Library
.Protocols
)
3703 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3704 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3705 return self
._ProtocolList
3707 ## Get the PPI value mapping
3709 # @retval dict The mapping between PPI cname and its value
3711 def _GetPpiList(self
):
3712 if self
._PpiList
is None:
3713 self
._PpiList
= OrderedDict()
3714 self
._PpiList
.update(self
.Module
.Ppis
)
3715 for Library
in self
.DependentLibraryList
:
3716 self
._PpiList
.update(Library
.Ppis
)
3717 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3718 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3719 return self
._PpiList
3721 ## Get the list of include search path
3723 # @retval list The list path
3725 def _GetIncludePathList(self
):
3726 if self
._IncludePathList
is None:
3727 self
._IncludePathList
= []
3728 if self
.AutoGenVersion
< 0x00010005:
3729 for Inc
in self
.Module
.Includes
:
3730 if Inc
not in self
._IncludePathList
:
3731 self
._IncludePathList
.append(Inc
)
3733 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3734 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3735 self
._IncludePathList
.append(Inc
)
3736 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3737 self
._IncludePathList
.append(self
.DebugDir
)
3739 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3740 self
._IncludePathList
.append(self
.DebugDir
)
3742 for Package
in self
.Module
.Packages
:
3743 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3744 if PackageDir
not in self
._IncludePathList
:
3745 self
._IncludePathList
.append(PackageDir
)
3746 IncludesList
= Package
.Includes
3747 if Package
._PrivateIncludes
:
3748 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3749 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3750 for Inc
in IncludesList
:
3751 if Inc
not in self
._IncludePathList
:
3752 self
._IncludePathList
.append(str(Inc
))
3753 return self
._IncludePathList
3755 def _GetIncludePathLength(self
):
3756 self
._IncludePathLength
= 0
3757 if self
._IncludePathList
:
3758 for inc
in self
._IncludePathList
:
3759 self
._IncludePathLength
+= len(' ' + inc
)
3760 return self
._IncludePathLength
3762 ## Get HII EX PCDs which maybe used by VFR
3764 # efivarstore used by VFR may relate with HII EX PCDs
3765 # Get the variable name and GUID from efivarstore and HII EX PCD
3766 # List the HII EX PCDs in As Built INF if both name and GUID match.
3768 # @retval list HII EX PCDs
3770 def _GetPcdsMaybeUsedByVfr(self
):
3771 if not self
.SourceFileList
:
3775 for SrcFile
in self
.SourceFileList
:
3776 if SrcFile
.Ext
.lower() != '.vfr':
3778 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3779 if not os
.path
.exists(Vfri
):
3781 VfriFile
= open(Vfri
, 'r')
3782 Content
= VfriFile
.read()
3784 Pos
= Content
.find('efivarstore')
3787 # Make sure 'efivarstore' is the start of efivarstore statement
3788 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3791 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3793 if Index
>= 0 and Content
[Index
] != ';':
3794 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3797 # 'efivarstore' must be followed by name and guid
3799 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3802 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3805 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3806 NameGuids
.add((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3807 Pos
= Content
.find('efivarstore', Name
.end())
3811 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3812 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3814 for SkuName
in Pcd
.SkuInfoList
:
3815 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3816 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3817 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3820 Guid
= GuidStructureStringToGuidString(Value
)
3821 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3822 HiiExPcds
.append(Pcd
)
3827 def _GenOffsetBin(self
):
3829 for SourceFile
in self
.Module
.Sources
:
3830 if SourceFile
.Type
.upper() == ".VFR" :
3832 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3834 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3835 if SourceFile
.Type
.upper() == ".UNI" :
3837 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3839 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3841 if len(VfrUniBaseName
) == 0:
3843 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3844 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3845 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3846 if not VfrUniOffsetList
:
3849 OutputName
= '%sOffset.bin' % self
.Name
3850 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3853 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3855 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3857 # Use a instance of StringIO to cache data
3858 fStringIO
= StringIO('')
3860 for Item
in VfrUniOffsetList
:
3861 if (Item
[0].find("Strings") != -1):
3863 # UNI offset in image.
3865 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3867 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3868 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3869 fStringIO
.write(''.join(UniGuid
))
3870 UniValue
= pack ('Q', int (Item
[1], 16))
3871 fStringIO
.write (UniValue
)
3874 # VFR binary offset in image.
3876 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3878 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3879 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3880 fStringIO
.write(''.join(VfrGuid
))
3881 VfrValue
= pack ('Q', int (Item
[1], 16))
3882 fStringIO
.write (VfrValue
)
3884 # write data into file.
3887 fInputfile
.write (fStringIO
.getvalue())
3889 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3890 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3896 ## Create AsBuilt INF file the module
3898 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3899 self
.OutputFile
= set()
3901 if GlobalData
.gBinCacheDest
:
3902 self
.CopyModuleToCache()
3905 if self
.IsAsBuiltInfCreated
:
3908 # Skip the following code for EDK I inf
3909 if self
.AutoGenVersion
< 0x00010005:
3912 # Skip the following code for libraries
3916 # Skip the following code for modules with no source files
3917 if not self
.SourceFileList
:
3920 # Skip the following code for modules without any binary files
3921 if not self
.BinaryFileList
:
3924 ### TODO: How to handles mixed source and binary modules
3926 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3927 # Also find all packages that the DynamicEx PCDs depend on
3932 PcdTokenSpaceList
= []
3933 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3934 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3935 PatchablePcds
+= [Pcd
]
3936 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3937 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3940 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3941 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3942 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3943 GuidList
= OrderedDict()
3944 GuidList
.update(self
.GuidList
)
3945 for TokenSpace
in self
.GetGuidsUsedByPcd():
3946 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3947 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3948 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3949 GuidList
.pop(TokenSpace
)
3950 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3951 for Package
in self
.DerivedPackageList
:
3952 if Package
in Packages
:
3954 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3956 for Index
in range(len(BeChecked
)):
3957 for Item
in CheckList
[Index
]:
3958 if Item
in BeChecked
[Index
]:
3959 Packages
+= [Package
]
3964 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3965 for Pkg
in self
.PlatformInfo
.PackageList
:
3968 for VfrPcd
in VfrPcds
:
3969 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
3970 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
3974 ModuleType
= self
.ModuleType
3975 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
3976 ModuleType
= 'DXE_DRIVER'
3979 if self
.PcdIsDriver
!= '':
3980 DriverType
= self
.PcdIsDriver
3983 MDefs
= self
.Module
.Defines
3986 'module_name' : self
.Name
,
3987 'module_guid' : Guid
,
3988 'module_module_type' : ModuleType
,
3989 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
3990 'pcd_is_driver_string' : [],
3991 'module_uefi_specification_version' : [],
3992 'module_pi_specification_version' : [],
3993 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
3994 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
3995 'module_constructor' : self
.Module
.ConstructorList
,
3996 'module_destructor' : self
.Module
.DestructorList
,
3997 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
3998 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
3999 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4000 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4001 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4002 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4003 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4004 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4005 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4006 'module_arch' : self
.Arch
,
4007 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4009 'patchablepcd_item' : [],
4011 'protocol_item' : [],
4015 'libraryclasses_item' : []
4018 if 'MODULE_UNI_FILE' in MDefs
:
4019 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4020 if os
.path
.isfile(UNIFile
):
4021 shutil
.copy2(UNIFile
, self
.OutputDir
)
4023 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4024 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4026 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4029 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4031 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4032 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4033 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4034 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4036 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4037 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4038 for Item
in self
.CodaTargetList
:
4039 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
4040 self
.OutputFile
.add(File
)
4041 if os
.path
.isabs(File
):
4042 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4043 if Item
.Target
.Ext
.lower() == '.aml':
4044 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4045 elif Item
.Target
.Ext
.lower() == '.acpi':
4046 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4047 elif Item
.Target
.Ext
.lower() == '.efi':
4048 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4050 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4051 if self
.DepexGenerated
:
4052 self
.OutputFile
.add(self
.Name
+ '.depex')
4053 if self
.ModuleType
in ['PEIM']:
4054 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4055 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4056 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4057 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4058 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4060 Bin
= self
._GenOffsetBin
()
4062 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4063 self
.OutputFile
.add(Bin
)
4065 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4067 if File
.lower().endswith('.pdb'):
4068 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4069 self
.OutputFile
.add(File
)
4070 HeaderComments
= self
.Module
.HeaderComments
4072 for Index
in range(len(HeaderComments
)):
4073 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4074 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4077 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4078 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4081 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4082 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4083 (GuidList
, self
._GuidComments
, 'guid_item')
4085 for Item
in GenList
:
4086 for CName
in Item
[0]:
4088 if CName
in Item
[1]:
4089 Comments
= '\n '.join(Item
[1][CName
])
4092 Entry
= Comments
+ '\n ' + CName
4093 AsBuiltInfDict
[Item
[2]].append(Entry
)
4094 PatchList
= parsePcdInfoFromMapFile(
4095 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4096 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4099 for Pcd
in PatchablePcds
:
4100 TokenCName
= Pcd
.TokenCName
4101 for PcdItem
in GlobalData
.MixedPcd
:
4102 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4103 TokenCName
= PcdItem
[0]
4105 for PatchPcd
in PatchList
:
4106 if TokenCName
== PatchPcd
[0]:
4111 if Pcd
.DatumType
== 'BOOLEAN':
4112 BoolValue
= Pcd
.DefaultValue
.upper()
4113 if BoolValue
== 'TRUE':
4114 Pcd
.DefaultValue
= '1'
4115 elif BoolValue
== 'FALSE':
4116 Pcd
.DefaultValue
= '0'
4118 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4119 HexFormat
= '0x%02x'
4120 if Pcd
.DatumType
== 'UINT16':
4121 HexFormat
= '0x%04x'
4122 elif Pcd
.DatumType
== 'UINT32':
4123 HexFormat
= '0x%08x'
4124 elif Pcd
.DatumType
== 'UINT64':
4125 HexFormat
= '0x%016x'
4126 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4128 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
4129 EdkLogger
.error("build", AUTOGEN_ERROR
,
4130 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4132 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4133 PcdValue
= Pcd
.DefaultValue
4134 if PcdValue
[0] != '{':
4136 if PcdValue
[0] == 'L':
4138 PcdValue
= PcdValue
.lstrip('L')
4139 PcdValue
= eval(PcdValue
)
4141 for Index
in range(0, len(PcdValue
)):
4143 CharVal
= ord(PcdValue
[Index
])
4144 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4145 + '0x%02x' % (CharVal
>> 8) + ', '
4147 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4150 Padding
= Padding
* 2
4151 ArraySize
= ArraySize
/ 2
4152 if ArraySize
< (len(PcdValue
) + 1):
4153 if Pcd
.MaxSizeUserSet
:
4154 EdkLogger
.error("build", AUTOGEN_ERROR
,
4155 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4158 ArraySize
= len(PcdValue
) + 1
4159 if ArraySize
> len(PcdValue
) + 1:
4160 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4161 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4162 elif len(PcdValue
.split(',')) <= ArraySize
:
4163 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4166 if Pcd
.MaxSizeUserSet
:
4167 EdkLogger
.error("build", AUTOGEN_ERROR
,
4168 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4171 ArraySize
= len(PcdValue
) + 1
4172 PcdItem
= '%s.%s|%s|0x%X' % \
4173 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4175 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4176 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4178 PcdItem
= PcdComments
+ '\n ' + PcdItem
4179 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4182 for Pcd
in Pcds
+ VfrPcds
:
4187 TokenCName
= Pcd
.TokenCName
4188 for PcdItem
in GlobalData
.MixedPcd
:
4189 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4190 TokenCName
= PcdItem
[0]
4192 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4193 for SkuName
in Pcd
.SkuInfoList
:
4194 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4195 SkuId
= SkuInfo
.SkuId
4196 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4200 # Don't generate duplicated HII PCD
4202 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4204 HiiPcds
.add((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4205 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4206 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4210 for Index
, Comment
in enumerate(PcdCommentList
):
4211 for Usage
in UsageList
:
4212 if Comment
.find(Usage
) != -1:
4216 if UsageIndex
!= -1:
4217 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4219 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4220 PcdComments
= '\n '.join(PcdCommentList
)
4221 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4223 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4224 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4225 for Item
in self
.BuildOption
:
4226 if 'FLAGS' in self
.BuildOption
[Item
]:
4227 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4229 # Generated LibraryClasses section in comments.
4230 for Library
in self
.LibraryAutoGenList
:
4231 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4233 # Generated UserExtensions TianoCore section.
4234 # All tianocore user extensions are copied.
4236 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4237 UserExtStr
+= '\n'.join(TianoCore
)
4238 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4239 if os
.path
.isfile(ExtensionFile
):
4240 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4241 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4243 # Generated depex expression section in comments.
4244 AsBuiltInfDict
['depexsection_item'] = ''
4245 DepexExpresion
= self
._GetDepexExpresionString
()
4247 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4249 AsBuiltInf
= TemplateString()
4250 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4252 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4254 self
.IsAsBuiltInfCreated
= True
4255 if GlobalData
.gBinCacheDest
:
4256 self
.CopyModuleToCache()
4258 def CopyModuleToCache(self
):
4259 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4260 CreateDirectory (FileDir
)
4261 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4262 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4263 if os
.path
.exists(HashFile
):
4264 shutil
.copy2(HashFile
, FileDir
)
4265 if os
.path
.exists(ModuleFile
):
4266 shutil
.copy2(ModuleFile
, FileDir
)
4267 if not self
.OutputFile
:
4268 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4269 self
.OutputFile
= Ma
.Binaries
4271 for File
in self
.OutputFile
:
4273 if not os
.path
.isabs(File
):
4274 File
= os
.path
.join(self
.OutputDir
, File
)
4275 if os
.path
.exists(File
):
4276 shutil
.copy2(File
, FileDir
)
4278 def AttemptModuleCacheCopy(self
):
4279 if self
.IsBinaryModule
:
4281 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4282 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4283 if os
.path
.exists(HashFile
):
4284 f
= open(HashFile
, 'r')
4285 CacheHash
= f
.read()
4287 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4288 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4289 for root
, dir, files
in os
.walk(FileDir
):
4291 if self
.Name
+ '.hash' in f
:
4292 shutil
.copy2(HashFile
, self
.BuildDir
)
4294 File
= path
.join(root
, f
)
4295 shutil
.copy2(File
, self
.OutputDir
)
4296 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4297 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4301 ## Create makefile for the module and its dependent libraries
4303 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4304 # dependent libraries will be created
4306 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4307 # Ignore generating makefile when it is a binary module
4308 if self
.IsBinaryModule
:
4311 if self
.IsMakeFileCreated
:
4313 self
.GenFfsList
= GenFfsList
4314 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4315 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4316 LibraryAutoGen
.CreateMakeFile()
4321 if len(self
.CustomMakefile
) == 0:
4322 Makefile
= GenMake
.ModuleMakefile(self
)
4324 Makefile
= GenMake
.CustomMakefile(self
)
4325 if Makefile
.Generate():
4326 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4327 (self
.Name
, self
.Arch
))
4329 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4330 (self
.Name
, self
.Arch
))
4332 self
.CreateTimeStamp(Makefile
)
4333 self
.IsMakeFileCreated
= True
4335 def CopyBinaryFiles(self
):
4336 for File
in self
.Module
.Binaries
:
4338 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4339 CopyLongFilePath(SrcPath
, DstPath
)
4340 ## Create autogen code for the module and its dependent libraries
4342 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4343 # dependent libraries will be created
4345 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4346 if self
.IsCodeFileCreated
:
4349 # Need to generate PcdDatabase even PcdDriver is binarymodule
4350 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4351 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4353 if self
.IsBinaryModule
:
4355 self
.CopyBinaryFiles()
4358 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4359 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4360 LibraryAutoGen
.CreateCodeFile()
4366 IgoredAutoGenList
= []
4368 for File
in self
.AutoGenFileList
:
4369 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4370 #Ignore Edk AutoGen.c
4371 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4374 AutoGenList
.append(str(File
))
4376 IgoredAutoGenList
.append(str(File
))
4378 # Skip the following code for EDK I inf
4379 if self
.AutoGenVersion
< 0x00010005:
4382 for ModuleType
in self
.DepexList
:
4383 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4384 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4387 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4388 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4390 if len(Dpx
.PostfixNotation
) <> 0:
4391 self
.DepexGenerated
= True
4393 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4394 AutoGenList
.append(str(DpxFile
))
4396 IgoredAutoGenList
.append(str(DpxFile
))
4398 if IgoredAutoGenList
== []:
4399 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4400 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4401 elif AutoGenList
== []:
4402 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4403 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4405 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4406 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4408 self
.IsCodeFileCreated
= True
4411 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4412 def _GetLibraryAutoGenList(self
):
4413 if self
._LibraryAutoGenList
is None:
4414 self
._LibraryAutoGenList
= []
4415 for Library
in self
.DependentLibraryList
:
4422 self
.PlatformInfo
.MetaFile
4424 if La
not in self
._LibraryAutoGenList
:
4425 self
._LibraryAutoGenList
.append(La
)
4426 for Lib
in La
.CodaTargetList
:
4427 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4428 return self
._LibraryAutoGenList
4430 def GenModuleHash(self
):
4431 if self
.Arch
not in GlobalData
.gModuleHash
:
4432 GlobalData
.gModuleHash
[self
.Arch
] = {}
4434 # Add Platform level hash
4435 m
.update(GlobalData
.gPlatformHash
)
4436 # Add Package level hash
4437 if self
.DependentPackageList
:
4438 for Pkg
in self
.DependentPackageList
:
4439 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4440 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4443 if self
.LibraryAutoGenList
:
4444 for Lib
in self
.LibraryAutoGenList
:
4445 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4447 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4450 f
= open(str(self
.MetaFile
), 'r')
4454 # Add Module's source files
4455 if self
.SourceFileList
:
4456 for File
in self
.SourceFileList
:
4457 f
= open(str(File
), 'r')
4462 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4463 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4464 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4465 if GlobalData
.gBinCacheSource
:
4466 CacheValid
= self
.AttemptModuleCacheCopy()
4469 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4471 ## Decide whether we can skip the ModuleAutoGen process
4472 def CanSkipbyHash(self
):
4473 if GlobalData
.gUseHashCache
:
4474 return not self
.GenModuleHash()
4476 ## Decide whether we can skip the ModuleAutoGen process
4477 # If any source file is newer than the module than we cannot skip
4480 if not os
.path
.exists(self
.GetTimeStampPath()):
4482 #last creation time of the module
4483 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4485 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4486 if SrcTimeStamp
> DstTimeStamp
:
4489 with
open(self
.GetTimeStampPath(),'r') as f
:
4491 source
= source
.rstrip('\n')
4492 if not os
.path
.exists(source
):
4494 if source
not in ModuleAutoGen
.TimeDict
:
4495 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4496 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4500 def GetTimeStampPath(self
):
4501 if self
._TimeStampPath
is None:
4502 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4503 return self
._TimeStampPath
4504 def CreateTimeStamp(self
, Makefile
):
4508 FileSet
.add (self
.MetaFile
.Path
)
4510 for SourceFile
in self
.Module
.Sources
:
4511 FileSet
.add (SourceFile
.Path
)
4513 for Lib
in self
.DependentLibraryList
:
4514 FileSet
.add (Lib
.MetaFile
.Path
)
4516 for f
in self
.AutoGenDepSet
:
4517 FileSet
.add (f
.Path
)
4519 if os
.path
.exists (self
.GetTimeStampPath()):
4520 os
.remove (self
.GetTimeStampPath())
4521 with
open(self
.GetTimeStampPath(), 'w+') as file:
4525 Module
= property(_GetModule
)
4526 Name
= property(_GetBaseName
)
4527 Guid
= property(_GetGuid
)
4528 Version
= property(_GetVersion
)
4529 ModuleType
= property(_GetModuleType
)
4530 ComponentType
= property(_GetComponentType
)
4531 BuildType
= property(_GetBuildType
)
4532 PcdIsDriver
= property(_GetPcdIsDriver
)
4533 AutoGenVersion
= property(_GetAutoGenVersion
)
4534 Macros
= property(_GetMacros
)
4535 Specification
= property(_GetSpecification
)
4537 IsLibrary
= property(_IsLibrary
)
4538 IsBinaryModule
= property(_IsBinaryModule
)
4539 BuildDir
= property(_GetBuildDir
)
4540 OutputDir
= property(_GetOutputDir
)
4541 FfsOutputDir
= property(_GetFfsOutputDir
)
4542 DebugDir
= property(_GetDebugDir
)
4543 MakeFileDir
= property(_GetMakeFileDir
)
4544 CustomMakefile
= property(_GetCustomMakefile
)
4546 IncludePathList
= property(_GetIncludePathList
)
4547 IncludePathLength
= property(_GetIncludePathLength
)
4548 AutoGenFileList
= property(_GetAutoGenFileList
)
4549 UnicodeFileList
= property(_GetUnicodeFileList
)
4550 VfrFileList
= property(_GetVfrFileList
)
4551 SourceFileList
= property(_GetSourceFileList
)
4552 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4553 Targets
= property(_GetTargets
)
4554 IntroTargetList
= property(_GetIntroTargetList
)
4555 CodaTargetList
= property(_GetFinalTargetList
)
4556 FileTypes
= property(_GetFileTypes
)
4557 BuildRules
= property(_GetBuildRules
)
4558 IdfFileList
= property(_GetIdfFileList
)
4560 DependentPackageList
= property(_GetDependentPackageList
)
4561 DependentLibraryList
= property(_GetLibraryList
)
4562 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4563 DerivedPackageList
= property(_GetDerivedPackageList
)
4565 ModulePcdList
= property(_GetModulePcdList
)
4566 LibraryPcdList
= property(_GetLibraryPcdList
)
4567 GuidList
= property(_GetGuidList
)
4568 ProtocolList
= property(_GetProtocolList
)
4569 PpiList
= property(_GetPpiList
)
4570 DepexList
= property(_GetDepexTokenList
)
4571 DxsFile
= property(_GetDxsFile
)
4572 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4573 BuildOption
= property(_GetModuleBuildOption
)
4574 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4575 BuildCommand
= property(_GetBuildCommand
)
4577 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4579 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4580 if __name__
== '__main__':