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):
265 self
.BuildDatabase
= MetaFileDb
266 self
.MetaFile
= ActivePlatform
267 self
.WorkspaceDir
= WorkspaceDir
268 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, 'COMMON', Target
, Toolchain
]
269 GlobalData
.gActivePlatform
= self
.Platform
270 self
.BuildTarget
= Target
271 self
.ToolChain
= Toolchain
272 self
.ArchList
= ArchList
274 self
.UniFlag
= UniFlag
276 self
.TargetTxt
= BuildConfig
277 self
.ToolDef
= ToolDefinition
278 self
.FdfFile
= FlashDefinitionFile
279 self
.FdTargetList
= Fds
280 self
.FvTargetList
= Fvs
281 self
.CapTargetList
= Caps
282 self
.AutoGenObjectList
= []
283 self
._BuildDir
= None
285 self
._MakeFileDir
= None
286 self
._BuildCommand
= None
289 # there's many relative directory operations, so ...
290 os
.chdir(self
.WorkspaceDir
)
295 if not self
.ArchList
:
296 ArchList
= set(self
.Platform
.SupArchList
)
298 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
300 EdkLogger
.error("build", PARAMETER_INVALID
,
301 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
302 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
303 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
304 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
305 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
306 self
.ArchList
= tuple(ArchList
)
308 # Validate build target
309 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
310 EdkLogger
.error("build", PARAMETER_INVALID
,
311 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
312 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
315 # parse FDF file to get PCDs in it, if any
317 self
.FdfFile
= self
.Platform
.FlashDefinition
321 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
322 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
323 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
325 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
327 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
330 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
332 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
335 Progress
.Start("\nProcessing meta-data")
339 # Mark now build in AutoGen Phase
341 GlobalData
.gAutoGenPhase
= True
342 Fdf
= FdfParser(self
.FdfFile
.Path
)
344 GlobalData
.gFdfParser
= Fdf
345 GlobalData
.gAutoGenPhase
= False
346 PcdSet
= Fdf
.Profile
.PcdDict
347 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
348 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
349 for FdRegion
in FdDict
.RegionList
:
350 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
351 if int(FdRegion
.Offset
) % 8 != 0:
352 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
353 ModuleList
= Fdf
.Profile
.InfList
354 self
.FdfProfile
= Fdf
.Profile
355 for fvname
in self
.FvTargetList
:
356 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
357 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
358 "No such an FV in FDF file: %s" % fvname
)
360 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
361 # but the path (self.MetaFile.Path) is the real path
362 for key
in self
.FdfProfile
.InfDict
:
366 for Arch
in self
.ArchList
:
367 Platform_cache
[Arch
] = self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
368 MetaFile_cache
[Arch
] = set()
369 for Pkey
in Platform_cache
[Arch
].Modules
:
370 MetaFile_cache
[Arch
].add(Platform_cache
[Arch
].Modules
[Pkey
].MetaFile
)
371 for Inf
in self
.FdfProfile
.InfDict
[key
]:
372 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
373 for Arch
in self
.ArchList
:
374 if ModuleFile
in MetaFile_cache
[Arch
]:
377 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
378 if not ModuleData
.IsBinaryModule
:
379 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
382 for Arch
in self
.ArchList
:
384 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
386 for Pkey
in Platform
.Modules
:
387 MetaFileList
.add(Platform
.Modules
[Pkey
].MetaFile
)
388 for Inf
in self
.FdfProfile
.InfDict
[key
]:
389 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
390 if ModuleFile
in MetaFileList
:
392 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
393 if not ModuleData
.IsBinaryModule
:
394 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
399 self
.FdfProfile
= None
400 if self
.FdTargetList
:
401 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
402 self
.FdTargetList
= []
403 if self
.FvTargetList
:
404 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
405 self
.FvTargetList
= []
406 if self
.CapTargetList
:
407 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
408 self
.CapTargetList
= []
410 # apply SKU and inject PCDs from Flash Definition file
411 for Arch
in self
.ArchList
:
412 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
414 SourcePcdDict
= {'DynamicEx':set(), 'PatchableInModule':set(),'Dynamic':set(),'FixedAtBuild':set()}
415 BinaryPcdDict
= {'DynamicEx':set(), 'PatchableInModule':set()}
416 SourcePcdDict_Keys
= SourcePcdDict
.keys()
417 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
419 # generate the SourcePcdDict and BinaryPcdDict
420 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
421 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
422 if BuildData
.Arch
!= Arch
:
424 if BuildData
.MetaFile
.Ext
== '.inf':
425 for key
in BuildData
.Pcds
:
426 if BuildData
.Pcds
[key
].Pending
:
427 if key
in Platform
.Pcds
:
428 PcdInPlatform
= Platform
.Pcds
[key
]
429 if PcdInPlatform
.Type
not in [None, '']:
430 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
432 if BuildData
.MetaFile
in Platform
.Modules
:
433 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
434 if key
in PlatformModule
.Pcds
:
435 PcdInPlatform
= PlatformModule
.Pcds
[key
]
436 if PcdInPlatform
.Type
not in [None, '']:
437 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
439 if 'DynamicEx' in BuildData
.Pcds
[key
].Type
:
440 if BuildData
.IsBinaryModule
:
441 BinaryPcdDict
['DynamicEx'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
443 SourcePcdDict
['DynamicEx'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
445 elif 'PatchableInModule' in BuildData
.Pcds
[key
].Type
:
446 if BuildData
.MetaFile
.Ext
== '.inf':
447 if BuildData
.IsBinaryModule
:
448 BinaryPcdDict
['PatchableInModule'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
450 SourcePcdDict
['PatchableInModule'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
452 elif 'Dynamic' in BuildData
.Pcds
[key
].Type
:
453 SourcePcdDict
['Dynamic'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
454 elif 'FixedAtBuild' in BuildData
.Pcds
[key
].Type
:
455 SourcePcdDict
['FixedAtBuild'].add((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
459 # A PCD can only use one type for all source modules
461 for i
in SourcePcdDict_Keys
:
462 for j
in SourcePcdDict_Keys
:
464 Intersections
= SourcePcdDict
[i
].intersection(SourcePcdDict
[j
])
465 if len(Intersections
) > 0:
469 "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
),
470 ExtraData
="%s" % '\n\t'.join([str(P
[1]+'.'+P
[0]) for P
in Intersections
])
474 # intersection the BinaryPCD for Mixed PCD
476 for i
in BinaryPcdDict_Keys
:
477 for j
in BinaryPcdDict_Keys
:
479 Intersections
= BinaryPcdDict
[i
].intersection(BinaryPcdDict
[j
])
480 for item
in Intersections
:
481 NewPcd1
= (item
[0] + '_' + i
, item
[1])
482 NewPcd2
= (item
[0] + '_' + j
, item
[1])
483 if item
not in GlobalData
.MixedPcd
:
484 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
486 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
487 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
488 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
489 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
492 # intersection the SourcePCD and BinaryPCD for Mixed PCD
494 for i
in SourcePcdDict_Keys
:
495 for j
in BinaryPcdDict_Keys
:
497 Intersections
= SourcePcdDict
[i
].intersection(BinaryPcdDict
[j
])
498 for item
in Intersections
:
499 NewPcd1
= (item
[0] + '_' + i
, item
[1])
500 NewPcd2
= (item
[0] + '_' + j
, item
[1])
501 if item
not in GlobalData
.MixedPcd
:
502 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
504 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
505 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
506 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
507 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
509 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
510 if BuildData
.Arch
!= Arch
:
512 for key
in BuildData
.Pcds
:
513 for SinglePcd
in GlobalData
.MixedPcd
:
514 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
515 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
516 Pcd_Type
= item
[0].split('_')[-1]
517 if (Pcd_Type
== BuildData
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
518 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
519 Value
= BuildData
.Pcds
[key
]
520 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
522 newkey
= (Value
.TokenCName
, key
[1])
524 newkey
= (Value
.TokenCName
, key
[1], key
[2])
525 del BuildData
.Pcds
[key
]
526 BuildData
.Pcds
[newkey
] = Value
530 # handle the mixed pcd in FDF file
532 if key
in GlobalData
.MixedPcd
:
535 for item
in GlobalData
.MixedPcd
[key
]:
538 #Collect package set information from INF of FDF
540 for Inf
in ModuleList
:
541 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
542 if ModuleFile
in Platform
.Modules
:
544 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
545 PkgSet
.update(ModuleData
.Packages
)
546 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
551 DecPcds
.add((Pcd
[0], Pcd
[1]))
552 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
554 Platform
.SkuName
= self
.SkuId
555 for Name
, Guid
in PcdSet
:
556 if (Name
, Guid
) not in DecPcds
:
560 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
561 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
562 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
565 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
566 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
567 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
568 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
569 Platform
.AddPcd(Name
, Guid
, PcdSet
[Name
, Guid
])
571 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
575 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
576 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
577 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
580 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
582 # Explicitly collect platform's dynamic PCDs
584 Pa
.CollectPlatformDynamicPcds()
585 Pa
.CollectFixedAtBuildPcds()
586 self
.AutoGenObjectList
.append(Pa
)
589 # Generate Package level hash value
591 GlobalData
.gPackageHash
[Arch
] = {}
592 if GlobalData
.gUseHashCache
:
594 self
._GenPkgLevelHash
(Pkg
)
597 # Check PCDs token value conflict in each DEC file.
599 self
._CheckAllPcdsTokenValueConflict
()
602 # Check PCD type and definition between DSC and DEC
604 self
._CheckPcdDefineAndType
()
607 # self._CheckDuplicateInFV(Fdf)
610 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
612 content
= 'gCommandLineDefines: '
613 content
+= str(GlobalData
.gCommandLineDefines
)
614 content
+= os
.linesep
615 content
+= 'BuildOptionPcd: '
616 content
+= str(GlobalData
.BuildOptionPcd
)
617 content
+= os
.linesep
618 content
+= 'Active Platform: '
619 content
+= str(self
.Platform
)
620 content
+= os
.linesep
622 content
+= 'Flash Image Definition: '
623 content
+= str(self
.FdfFile
)
624 content
+= os
.linesep
625 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
628 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
630 PcdTokenNumber
= 'PcdTokenNumber: '
631 if Pa
.PcdTokenNumber
:
632 if Pa
.DynamicPcdList
:
633 for Pcd
in Pa
.DynamicPcdList
:
634 PcdTokenNumber
+= os
.linesep
635 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
636 PcdTokenNumber
+= ' : '
637 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
638 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
641 # Get set of workspace metafiles
643 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
646 # Retrieve latest modified time of all metafiles
649 for f
in AllWorkSpaceMetaFiles
:
650 if os
.stat(f
)[8] > SrcTimeStamp
:
651 SrcTimeStamp
= os
.stat(f
)[8]
652 self
._SrcTimeStamp
= SrcTimeStamp
654 if GlobalData
.gUseHashCache
:
656 for files
in AllWorkSpaceMetaFiles
:
657 if files
.endswith('.dec'):
663 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
664 GlobalData
.gPlatformHash
= m
.hexdigest()
667 # Write metafile list to build directory
669 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
670 if os
.path
.exists (AutoGenFilePath
):
671 os
.remove(AutoGenFilePath
)
672 if not os
.path
.exists(self
.BuildDir
):
673 os
.makedirs(self
.BuildDir
)
674 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
675 for f
in AllWorkSpaceMetaFiles
:
679 def _GenPkgLevelHash(self
, Pkg
):
680 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
681 CreateDirectory(PkgDir
)
682 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
684 # Get .dec file's hash value
685 f
= open(Pkg
.MetaFile
.Path
, 'r')
689 # Get include files hash value
691 for inc
in Pkg
.Includes
:
692 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
694 File_Path
= os
.path
.join(Root
, File
)
695 f
= open(File_Path
, 'r')
699 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
700 if Pkg
.PackageName
not in GlobalData
.gPackageHash
[Pkg
.Arch
]:
701 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
703 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
704 AllWorkSpaceMetaFiles
= set()
709 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
711 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
713 AllWorkSpaceMetaFiles
.add (f
.FileName
)
717 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
720 # add build_rule.txt & tools_def.txt
722 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
723 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
725 # add BuildOption metafile
727 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
729 # add PcdToken Number file for Dynamic/DynamicEx Pcd
731 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
733 for Arch
in self
.ArchList
:
734 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
735 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
740 for Package
in PGen
.PackageList
:
741 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
746 for filePath
in Platform
._RawData
.IncludedFiles
:
747 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
749 return AllWorkSpaceMetaFiles
751 ## _CheckDuplicateInFV() method
753 # Check whether there is duplicate modules/files exist in FV section.
754 # The check base on the file GUID;
756 def _CheckDuplicateInFV(self
, Fdf
):
757 for Fv
in Fdf
.Profile
.FvDict
:
759 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
760 if FfsFile
.InfFileName
and FfsFile
.NameGuid
is None:
765 for Pa
in self
.AutoGenObjectList
:
768 for Module
in Pa
.ModuleAutoGenList
:
769 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
771 if not Module
.Guid
.upper() in _GuidDict
.keys():
772 _GuidDict
[Module
.Guid
.upper()] = FfsFile
775 EdkLogger
.error("build",
777 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
778 FfsFile
.CurrentLineContent
,
779 _GuidDict
[Module
.Guid
.upper()].CurrentLineNum
,
780 _GuidDict
[Module
.Guid
.upper()].CurrentLineContent
,
781 Module
.Guid
.upper()),
782 ExtraData
=self
.FdfFile
)
784 # Some INF files not have entity in DSC file.
787 if FfsFile
.InfFileName
.find('$') == -1:
788 InfPath
= NormPath(FfsFile
.InfFileName
)
789 if not os
.path
.exists(InfPath
):
790 EdkLogger
.error('build', GENFDS_ERROR
, "Non-existant Module %s !" % (FfsFile
.InfFileName
))
792 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
794 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
795 # BuildObject from one of AutoGenObjectList is enough.
797 InfObj
= self
.AutoGenObjectList
[0].BuildDatabase
.WorkspaceDb
.BuildObject
[PathClassObj
, 'COMMON', self
.BuildTarget
, self
.ToolChain
]
798 if not InfObj
.Guid
.upper() in _GuidDict
.keys():
799 _GuidDict
[InfObj
.Guid
.upper()] = FfsFile
801 EdkLogger
.error("build",
803 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
804 FfsFile
.CurrentLineContent
,
805 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineNum
,
806 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineContent
,
807 InfObj
.Guid
.upper()),
808 ExtraData
=self
.FdfFile
)
811 if FfsFile
.NameGuid
is not None:
813 # If the NameGuid reference a PCD name.
814 # The style must match: PCD(xxxx.yyy)
816 if gPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
818 # Replace the PCD value.
820 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
822 for Pa
in self
.AutoGenObjectList
:
824 for PcdItem
in Pa
.AllPcdList
:
825 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
827 # First convert from CFormatGuid to GUID string
829 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
831 if not _PcdGuidString
:
833 # Then try Byte array.
835 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
837 if not _PcdGuidString
:
839 # Not Byte array or CFormat GUID, raise error.
841 EdkLogger
.error("build",
843 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
844 ExtraData
=self
.FdfFile
)
846 if not _PcdGuidString
.upper() in _GuidDict
.keys():
847 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
851 EdkLogger
.error("build",
853 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
854 FfsFile
.CurrentLineContent
,
855 _GuidDict
[_PcdGuidString
.upper()].CurrentLineNum
,
856 _GuidDict
[_PcdGuidString
.upper()].CurrentLineContent
,
857 FfsFile
.NameGuid
.upper()),
858 ExtraData
=self
.FdfFile
)
860 if not FfsFile
.NameGuid
.upper() in _GuidDict
.keys():
861 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
864 # Two raw file GUID conflict.
866 EdkLogger
.error("build",
868 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
869 FfsFile
.CurrentLineContent
,
870 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineNum
,
871 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineContent
,
872 FfsFile
.NameGuid
.upper()),
873 ExtraData
=self
.FdfFile
)
876 def _CheckPcdDefineAndType(self
):
878 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
879 "Dynamic", #"DynamicHii", "DynamicVpd",
880 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
883 # This dict store PCDs which are not used by any modules with specified arches
884 UnusedPcd
= OrderedDict()
885 for Pa
in self
.AutoGenObjectList
:
886 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
887 for Pcd
in Pa
.Platform
.Pcds
:
888 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
890 # If no PCD type, this PCD comes from FDF
894 # Try to remove Hii and Vpd suffix
895 if PcdType
.startswith("DynamicEx"):
896 PcdType
= "DynamicEx"
897 elif PcdType
.startswith("Dynamic"):
900 for Package
in Pa
.PackageList
:
901 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
902 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
904 for Type
in PcdTypeList
:
905 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
909 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
910 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
915 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
917 for Pcd
in UnusedPcd
:
920 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
921 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
922 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
927 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
929 ## Return the directory to store FV files
931 if self
._FvDir
is None:
932 self
._FvDir
= path
.join(self
.BuildDir
, 'FV')
935 ## Return the directory to store all intermediate and final files built
936 def _GetBuildDir(self
):
937 if self
._BuildDir
is None:
938 return self
.AutoGenObjectList
[0].BuildDir
940 ## Return the build output directory platform specifies
941 def _GetOutputDir(self
):
942 return self
.Platform
.OutputDirectory
944 ## Return platform name
946 return self
.Platform
.PlatformName
948 ## Return meta-file GUID
950 return self
.Platform
.Guid
952 ## Return platform version
953 def _GetVersion(self
):
954 return self
.Platform
.Version
956 ## Return paths of tools
957 def _GetToolDefinition(self
):
958 return self
.AutoGenObjectList
[0].ToolDefinition
960 ## Return directory of platform makefile
962 # @retval string Makefile directory
964 def _GetMakeFileDir(self
):
965 if self
._MakeFileDir
is None:
966 self
._MakeFileDir
= self
.BuildDir
967 return self
._MakeFileDir
969 ## Return build command string
971 # @retval string Build command string
973 def _GetBuildCommand(self
):
974 if self
._BuildCommand
is None:
975 # BuildCommand should be all the same. So just get one from platform AutoGen
976 self
._BuildCommand
= self
.AutoGenObjectList
[0].BuildCommand
977 return self
._BuildCommand
979 ## Check the PCDs token value conflict in each DEC file.
981 # Will cause build break and raise error message while two PCDs conflict.
985 def _CheckAllPcdsTokenValueConflict(self
):
986 for Pa
in self
.AutoGenObjectList
:
987 for Package
in Pa
.PackageList
:
988 PcdList
= Package
.Pcds
.values()
989 PcdList
.sort(lambda x
, y
: cmp(int(x
.TokenValue
, 0), int(y
.TokenValue
, 0)))
991 while (Count
< len(PcdList
) - 1) :
992 Item
= PcdList
[Count
]
993 ItemNext
= PcdList
[Count
+ 1]
995 # Make sure in the same token space the TokenValue should be unique
997 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
998 SameTokenValuePcdList
= []
999 SameTokenValuePcdList
.append(Item
)
1000 SameTokenValuePcdList
.append(ItemNext
)
1001 RemainPcdListLength
= len(PcdList
) - Count
- 2
1002 for ValueSameCount
in range(RemainPcdListLength
):
1003 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
1004 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
1008 # Sort same token value PCD list with TokenGuid and TokenCName
1010 SameTokenValuePcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1011 SameTokenValuePcdListCount
= 0
1012 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
1014 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1015 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
1017 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
1018 for PcdItem
in GlobalData
.MixedPcd
:
1019 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
1020 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1026 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1027 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
1030 SameTokenValuePcdListCount
+= 1
1031 Count
+= SameTokenValuePcdListCount
1034 PcdList
= Package
.Pcds
.values()
1035 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1037 while (Count
< len(PcdList
) - 1) :
1038 Item
= PcdList
[Count
]
1039 ItemNext
= PcdList
[Count
+ 1]
1041 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1043 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
1047 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1048 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
1052 ## Generate fds command
1053 def _GenFdsCommand(self
):
1054 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1056 ## Create makefile for the platform and modules in it
1058 # @param CreateDepsMakeFile Flag indicating if the makefile for
1059 # modules will be created as well
1061 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1062 if CreateDepsMakeFile
:
1063 for Pa
in self
.AutoGenObjectList
:
1064 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1066 ## Create autogen code for platform and modules
1068 # Since there's no autogen code for platform, this method will do nothing
1069 # if CreateModuleCodeFile is set to False.
1071 # @param CreateDepsCodeFile Flag indicating if creating module's
1072 # autogen code file or not
1074 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1075 if not CreateDepsCodeFile
:
1077 for Pa
in self
.AutoGenObjectList
:
1078 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1080 ## Create AsBuilt INF file the platform
1082 def CreateAsBuiltInf(self
):
1085 Name
= property(_GetName
)
1086 Guid
= property(_GetGuid
)
1087 Version
= property(_GetVersion
)
1088 OutputDir
= property(_GetOutputDir
)
1090 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1092 BuildDir
= property(_GetBuildDir
)
1093 FvDir
= property(_GetFvDir
)
1094 MakeFileDir
= property(_GetMakeFileDir
)
1095 BuildCommand
= property(_GetBuildCommand
)
1096 GenFdsCommand
= property(_GenFdsCommand
)
1098 ## AutoGen class for platform
1100 # PlatformAutoGen class will process the original information in platform
1101 # file in order to generate makefile for platform.
1103 class PlatformAutoGen(AutoGen
):
1104 # call super().__init__ then call the worker function with different parameter count
1105 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
1109 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
1110 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
1113 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1114 # correct PCD database
1117 _NonDynaPcdList_
= []
1121 # The priority list while override build option
1123 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1124 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1125 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1126 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1127 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1128 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1129 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1130 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1131 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1132 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1133 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1134 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1135 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1136 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1137 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1138 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1140 ## Initialize PlatformAutoGen
1143 # @param Workspace WorkspaceAutoGen object
1144 # @param PlatformFile Platform file (DSC file)
1145 # @param Target Build target (DEBUG, RELEASE)
1146 # @param Toolchain Name of tool chain
1147 # @param Arch arch of the platform supports
1149 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1150 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1151 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1153 self
.MetaFile
= PlatformFile
1154 self
.Workspace
= Workspace
1155 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1156 self
.ToolChain
= Toolchain
1157 self
.BuildTarget
= Target
1159 self
.SourceDir
= PlatformFile
.SubDir
1160 self
.SourceOverrideDir
= None
1161 self
.FdTargetList
= self
.Workspace
.FdTargetList
1162 self
.FvTargetList
= self
.Workspace
.FvTargetList
1163 self
.AllPcdList
= []
1164 # get the original module/package/platform objects
1165 self
.BuildDatabase
= Workspace
.BuildDatabase
1166 self
.DscBuildDataObj
= Workspace
.Platform
1167 self
._GuidDict
= Workspace
._GuidDict
1169 # flag indicating if the makefile/C-code file has been created or not
1170 self
.IsMakeFileCreated
= False
1171 self
.IsCodeFileCreated
= False
1173 self
._Platform
= None
1176 self
._Version
= None
1178 self
._BuildRule
= None
1179 self
._SourceDir
= None
1180 self
._BuildDir
= None
1181 self
._OutputDir
= None
1183 self
._MakeFileDir
= None
1184 self
._FdfFile
= None
1186 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1187 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1188 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1189 self
._NonDynamicPcdDict
= {}
1191 self
._ToolDefinitions
= None
1192 self
._ToolDefFile
= None # toolcode : tool path
1193 self
._ToolChainFamily
= None
1194 self
._BuildRuleFamily
= None
1195 self
._BuildOption
= None # toolcode : option
1196 self
._EdkBuildOption
= None # edktoolcode : option
1197 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1198 self
._PackageList
= None
1199 self
._ModuleAutoGenList
= None
1200 self
._LibraryAutoGenList
= None
1201 self
._BuildCommand
= None
1202 self
._AsBuildInfList
= []
1203 self
._AsBuildModuleList
= []
1205 self
.VariableInfo
= None
1207 if GlobalData
.gFdfParser
is not None:
1208 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1209 for Inf
in self
._AsBuildInfList
:
1210 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1211 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1212 if not M
.IsSupportedArch
:
1214 self
._AsBuildModuleList
.append(InfClass
)
1215 # get library/modules for build
1216 self
.LibraryBuildDirectoryList
= []
1217 self
.ModuleBuildDirectoryList
= []
1222 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1224 ## Create autogen code for platform and modules
1226 # Since there's no autogen code for platform, this method will do nothing
1227 # if CreateModuleCodeFile is set to False.
1229 # @param CreateModuleCodeFile Flag indicating if creating module's
1230 # autogen code file or not
1232 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1233 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1234 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1237 for Ma
in self
.ModuleAutoGenList
:
1238 Ma
.CreateCodeFile(True)
1240 # don't do this twice
1241 self
.IsCodeFileCreated
= True
1243 ## Generate Fds Command
1244 def _GenFdsCommand(self
):
1245 return self
.Workspace
.GenFdsCommand
1247 ## Create makefile for the platform and mdoules in it
1249 # @param CreateModuleMakeFile Flag indicating if the makefile for
1250 # modules will be created as well
1252 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1253 if CreateModuleMakeFile
:
1254 for ModuleFile
in self
.Platform
.Modules
:
1255 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1256 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1257 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1258 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1260 Ma
.CreateMakeFile(True)
1261 #Ma.CreateAsBuiltInf()
1263 # no need to create makefile for the platform more than once
1264 if self
.IsMakeFileCreated
:
1267 # create library/module build dirs for platform
1268 Makefile
= GenMake
.PlatformMakefile(self
)
1269 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1270 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1272 self
.IsMakeFileCreated
= True
1274 ## Deal with Shared FixedAtBuild Pcds
1276 def CollectFixedAtBuildPcds(self
):
1277 for LibAuto
in self
.LibraryAutoGenList
:
1278 FixedAtBuildPcds
= {}
1279 ShareFixedAtBuildPcdsSameValue
= {}
1280 for Module
in LibAuto
._ReferenceModules
:
1281 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1282 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1283 if key
not in FixedAtBuildPcds
:
1284 ShareFixedAtBuildPcdsSameValue
[key
] = True
1285 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1287 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1288 ShareFixedAtBuildPcdsSameValue
[key
] = False
1289 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1290 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1291 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1294 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1295 if DscPcd
.Type
!= "FixedAtBuild":
1297 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1298 LibAuto
.ConstPcd
[key
] = Pcd
.DefaultValue
1300 def CollectVariables(self
, DynamicPcdSet
):
1304 if self
.Workspace
.FdfFile
:
1305 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1306 for FdRegion
in FdDict
.RegionList
:
1307 for item
in FdRegion
.RegionDataList
:
1308 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1309 VpdRegionSize
= FdRegion
.Size
1310 VpdRegionBase
= FdRegion
.Offset
1314 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1315 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1316 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1318 for Pcd
in DynamicPcdSet
:
1319 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1320 for SkuName
in Pcd
.SkuInfoList
:
1321 Sku
= Pcd
.SkuInfoList
[SkuName
]
1323 if SkuId
is None or SkuId
== '':
1325 if len(Sku
.VariableName
) > 0:
1326 VariableGuidStructure
= Sku
.VariableGuidValue
1327 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1328 for StorageName
in Sku
.DefaultStoreDict
:
1329 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1333 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1334 if self
.VariableInfo
:
1335 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1336 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1338 if PcdNvStoreDfBuffer
:
1339 if os
.path
.exists(VpdMapFilePath
):
1340 OrgVpdFile
.Read(VpdMapFilePath
)
1341 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1342 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1344 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1346 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1347 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get("DEFAULT")
1348 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1349 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1351 if var_data
and default_skuobj
:
1352 default_skuobj
.DefaultValue
= var_data
1353 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1354 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1355 PcdNvStoreDfBuffer
[0].SkuInfoList
['DEFAULT'] = default_skuobj
1356 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1360 ## Collect dynamic PCDs
1362 # Gather dynamic PCDs list from each module and their settings from platform
1363 # This interface should be invoked explicitly when platform action is created.
1365 def CollectPlatformDynamicPcds(self
):
1367 for key
in self
.Platform
.Pcds
:
1368 for SinglePcd
in GlobalData
.MixedPcd
:
1369 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1370 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1371 Pcd_Type
= item
[0].split('_')[-1]
1372 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 \
1373 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1374 Value
= self
.Platform
.Pcds
[key
]
1375 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1377 newkey
= (Value
.TokenCName
, key
[1])
1379 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1380 del self
.Platform
.Pcds
[key
]
1381 self
.Platform
.Pcds
[newkey
] = Value
1389 # for gathering error information
1390 NoDatumTypePcdList
= set()
1392 for InfName
in self
._AsBuildInfList
:
1393 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1394 FdfModuleList
.append(os
.path
.normpath(InfName
))
1395 for F
in self
.Platform
.Modules
.keys():
1396 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1397 #GuidValue.update(M.Guids)
1399 self
.Platform
.Modules
[F
].M
= M
1401 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1402 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1403 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1404 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1406 # Check the PCD from Binary INF or Source INF
1407 if M
.IsBinaryModule
== True:
1408 PcdFromModule
.IsFromBinaryInf
= True
1410 # Check the PCD from DSC or not
1411 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1412 PcdFromModule
.IsFromDsc
= True
1414 PcdFromModule
.IsFromDsc
= False
1415 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1416 if F
.Path
not in FdfModuleList
:
1417 # If one of the Source built modules listed in the DSC is not listed
1418 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1419 # access method (it is only listed in the DEC file that declares the
1420 # PCD as PcdsDynamic), then build tool will report warning message
1421 # notify the PI that they are attempting to build a module that must
1422 # be included in a flash image in order to be functional. These Dynamic
1423 # PCD will not be added into the Database unless it is used by other
1424 # modules that are included in the FDF file.
1425 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1426 PcdFromModule
.IsFromBinaryInf
== False:
1427 # Print warning message to let the developer make a determine.
1429 # If one of the Source built modules listed in the DSC is not listed in
1430 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1431 # access method (it is only listed in the DEC file that declares the
1432 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1433 # PCD to the Platform's PCD Database.
1434 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1437 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1438 # it should be stored in Pcd PEI database, If a dynamic only
1439 # used by DXE module, it should be stored in DXE PCD database.
1440 # The default Phase is DXE
1442 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1443 PcdFromModule
.Phase
= "PEI"
1444 if PcdFromModule
not in self
._DynaPcdList
_:
1445 self
._DynaPcdList
_.append(PcdFromModule
)
1446 elif PcdFromModule
.Phase
== 'PEI':
1447 # overwrite any the same PCD existing, if Phase is PEI
1448 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1449 self
._DynaPcdList
_[Index
] = PcdFromModule
1450 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1451 self
._NonDynaPcdList
_.append(PcdFromModule
)
1452 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1453 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1454 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1455 #The PCD from Binary INF will override the same one from source INF
1456 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1457 PcdFromModule
.Pending
= False
1458 self
._NonDynaPcdList
_.append (PcdFromModule
)
1459 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1461 for ModuleInf
in self
.Platform
.Modules
.keys():
1462 DscModuleList
.append (os
.path
.normpath(ModuleInf
.Path
))
1463 # add the PCD from modules that listed in FDF but not in DSC to Database
1464 for InfName
in FdfModuleList
:
1465 if InfName
not in DscModuleList
:
1466 InfClass
= PathClass(InfName
)
1467 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1468 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1469 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1470 # For binary module, if in current arch, we need to list the PCDs into database.
1471 if not M
.IsSupportedArch
:
1473 # Override the module PCD setting by platform setting
1474 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1475 for PcdFromModule
in ModulePcdList
:
1476 PcdFromModule
.IsFromBinaryInf
= True
1477 PcdFromModule
.IsFromDsc
= False
1478 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1479 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1480 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1482 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1483 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1484 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1485 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1486 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1487 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1488 PcdFromModule
.Phase
= "PEI"
1489 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1490 self
._DynaPcdList
_.append(PcdFromModule
)
1491 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1492 self
._NonDynaPcdList
_.append(PcdFromModule
)
1493 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1494 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1495 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1496 # module & DXE module at a same time.
1497 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1498 # INF file as DynamicEx.
1499 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1500 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1501 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1502 for PcdFromModule
in self
._NonDynaPcdList
_:
1503 # If a PCD is not listed in the DSC file, but binary INF files used by
1504 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1505 # section, AND all source INF files used by this platform the build
1506 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1507 # section, then the tools must NOT add the PCD to the Platform's PCD
1508 # Database; the build must assign the access method for this PCD as
1509 # PcdsPatchableInModule.
1510 if PcdFromModule
not in self
._DynaPcdList
_:
1512 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1513 if PcdFromModule
.IsFromDsc
== False and \
1514 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1515 PcdFromModule
.IsFromBinaryInf
== True and \
1516 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1517 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1518 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1520 # print out error information and break the build, if error found
1521 if len(NoDatumTypePcdList
) > 0:
1522 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1523 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1525 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1526 % NoDatumTypePcdListString
)
1527 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1528 self
._DynamicPcdList
= self
._DynaPcdList
_
1530 # Sort dynamic PCD list to:
1531 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1532 # try to be put header of dynamicd List
1533 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1535 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1537 UnicodePcdArray
= set()
1539 OtherPcdArray
= set()
1541 VpdFile
= VpdInfoFile
.VpdInfoFile()
1542 NeedProcessVpdMapFile
= False
1544 for pcd
in self
.Platform
.Pcds
.keys():
1545 if pcd
not in self
._PlatformPcds
.keys():
1546 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1548 for item
in self
._PlatformPcds
:
1549 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1550 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1552 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1553 for Pcd
in self
._DynamicPcdList
:
1554 # just pick the a value to determine whether is unicode string type
1555 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1556 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1558 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1559 Pcd
.DatumType
= "VOID*"
1561 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1562 # if found HII type PCD then insert to right of UnicodeIndex
1563 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1564 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1566 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1567 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1568 if PcdNvStoreDfBuffer
:
1569 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1570 vardump
= self
.VariableInfo
.dump()
1572 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1573 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1574 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1575 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1577 PlatformPcds
= self
._PlatformPcds
.keys()
1580 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1583 for PcdKey
in PlatformPcds
:
1584 Pcd
= self
._PlatformPcds
[PcdKey
]
1585 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1586 PcdKey
in VpdPcdDict
:
1587 Pcd
= VpdPcdDict
[PcdKey
]
1589 DefaultSku
= Pcd
.SkuInfoList
.get('DEFAULT')
1591 PcdValue
= DefaultSku
.DefaultValue
1592 if PcdValue
not in SkuValueMap
:
1593 SkuValueMap
[PcdValue
] = []
1594 VpdFile
.Add(Pcd
, 'DEFAULT',DefaultSku
.VpdOffset
)
1595 SkuValueMap
[PcdValue
].append(DefaultSku
)
1597 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1598 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1599 PcdValue
= Sku
.DefaultValue
1601 PcdValue
= Pcd
.DefaultValue
1602 if Sku
.VpdOffset
!= '*':
1603 if PcdValue
.startswith("{"):
1605 elif PcdValue
.startswith("L"):
1610 VpdOffset
= int(Sku
.VpdOffset
)
1613 VpdOffset
= int(Sku
.VpdOffset
, 16)
1615 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1616 if VpdOffset
% Alignment
!= 0:
1617 if PcdValue
.startswith("{"):
1618 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1620 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1621 if PcdValue
not in SkuValueMap
:
1622 SkuValueMap
[PcdValue
] = []
1623 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1624 SkuValueMap
[PcdValue
].append(Sku
)
1625 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1626 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1627 NeedProcessVpdMapFile
= True
1628 if self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== '':
1629 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1630 "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.")
1632 VpdSkuMap
[PcdKey
] = SkuValueMap
1634 # Fix the PCDs define in VPD PCD section that never referenced by module.
1635 # An example is PCD for signature usage.
1637 for DscPcd
in PlatformPcds
:
1638 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1639 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1640 if not (self
.Platform
.VpdToolGuid
is None or self
.Platform
.VpdToolGuid
== ''):
1642 for VpdPcd
in VpdFile
._VpdArray
.keys():
1643 # This PCD has been referenced by module
1644 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1645 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1648 # Not found, it should be signature
1650 # just pick the a value to determine whether is unicode string type
1652 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1653 DefaultSku
= DscPcdEntry
.SkuInfoList
.get('DEFAULT')
1655 defaultindex
= SkuObjList
.index(('DEFAULT',DefaultSku
))
1656 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1657 for (SkuName
,Sku
) in SkuObjList
:
1658 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1660 # Need to iterate DEC pcd information to get the value & datumtype
1661 for eachDec
in self
.PackageList
:
1662 for DecPcd
in eachDec
.Pcds
:
1663 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1664 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1665 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1666 # Print warning message to let the developer make a determine.
1667 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1668 File
=self
.MetaFile
, \
1669 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1670 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1672 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1673 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1674 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1675 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1676 # Only fix the value while no value provided in DSC file.
1677 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1678 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1680 if DscPcdEntry
not in self
._DynamicPcdList
:
1681 self
._DynamicPcdList
.append(DscPcdEntry
)
1682 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1683 PcdValue
= Sku
.DefaultValue
1685 PcdValue
= DscPcdEntry
.DefaultValue
1686 if Sku
.VpdOffset
!= '*':
1687 if PcdValue
.startswith("{"):
1689 elif PcdValue
.startswith("L"):
1694 VpdOffset
= int(Sku
.VpdOffset
)
1697 VpdOffset
= int(Sku
.VpdOffset
, 16)
1699 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1700 if VpdOffset
% Alignment
!= 0:
1701 if PcdValue
.startswith("{"):
1702 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1704 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1705 if PcdValue
not in SkuValueMap
:
1706 SkuValueMap
[PcdValue
] = []
1707 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1708 SkuValueMap
[PcdValue
].append(Sku
)
1709 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1710 NeedProcessVpdMapFile
= True
1711 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1712 UnicodePcdArray
.add(DscPcdEntry
)
1713 elif len(Sku
.VariableName
) > 0:
1714 HiiPcdArray
.add(DscPcdEntry
)
1716 OtherPcdArray
.add(DscPcdEntry
)
1718 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1719 VpdSkuMap
[DscPcd
] = SkuValueMap
1720 if (self
.Platform
.FlashDefinition
is None or self
.Platform
.FlashDefinition
== '') and \
1721 VpdFile
.GetCount() != 0:
1722 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1723 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1725 if VpdFile
.GetCount() != 0:
1727 self
.FixVpdOffset(VpdFile
)
1729 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1731 # Process VPD map file generated by third party BPDG tool
1732 if NeedProcessVpdMapFile
:
1733 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1734 if os
.path
.exists(VpdMapFilePath
):
1735 VpdFile
.Read(VpdMapFilePath
)
1738 for pcd
in VpdSkuMap
:
1739 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1741 # just pick the a value to determine whether is unicode string type
1743 for pcdvalue
in VpdSkuMap
[pcd
]:
1744 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1745 for item
in vpdinfo
:
1746 if item
[2] == pcdvalue
:
1747 sku
.VpdOffset
= item
[1]
1749 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1751 # Delete the DynamicPcdList At the last time enter into this function
1752 for Pcd
in self
._DynamicPcdList
:
1753 # just pick the a value to determine whether is unicode string type
1754 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1755 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1757 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1758 Pcd
.DatumType
= "VOID*"
1760 PcdValue
= Sku
.DefaultValue
1761 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1762 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1763 UnicodePcdArray
.add(Pcd
)
1764 elif len(Sku
.VariableName
) > 0:
1765 # if found HII type PCD then insert to right of UnicodeIndex
1766 HiiPcdArray
.add(Pcd
)
1768 OtherPcdArray
.add(Pcd
)
1769 del self
._DynamicPcdList
[:]
1770 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1771 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1772 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1773 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1774 for pcd
in self
._DynamicPcdList
:
1775 if len(pcd
.SkuInfoList
) == 1:
1776 for (SkuName
,SkuId
) in allskuset
:
1777 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1779 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
['DEFAULT'])
1780 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1781 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1783 def FixVpdOffset(self
,VpdFile
):
1784 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1785 if not os
.path
.exists(FvPath
):
1789 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1791 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1793 if VpdFile
.Write(VpdFilePath
):
1794 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1796 for ToolDef
in self
.ToolDefinition
.values():
1797 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1798 if not ToolDef
.has_key("PATH"):
1799 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1800 BPDGToolName
= ToolDef
["PATH"]
1802 # Call third party GUID BPDG tool.
1803 if BPDGToolName
is not None:
1804 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1806 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.")
1808 ## Return the platform build data object
1809 def _GetPlatform(self
):
1810 if self
._Platform
is None:
1811 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1812 return self
._Platform
1814 ## Return platform name
1816 return self
.Platform
.PlatformName
1818 ## Return the meta file GUID
1820 return self
.Platform
.Guid
1822 ## Return the platform version
1823 def _GetVersion(self
):
1824 return self
.Platform
.Version
1826 ## Return the FDF file name
1827 def _GetFdfFile(self
):
1828 if self
._FdfFile
is None:
1829 if self
.Workspace
.FdfFile
!= "":
1830 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1833 return self
._FdfFile
1835 ## Return the build output directory platform specifies
1836 def _GetOutputDir(self
):
1837 return self
.Platform
.OutputDirectory
1839 ## Return the directory to store all intermediate and final files built
1840 def _GetBuildDir(self
):
1841 if self
._BuildDir
is None:
1842 if os
.path
.isabs(self
.OutputDir
):
1843 self
._BuildDir
= path
.join(
1844 path
.abspath(self
.OutputDir
),
1845 self
.BuildTarget
+ "_" + self
.ToolChain
,
1848 self
._BuildDir
= path
.join(
1851 self
.BuildTarget
+ "_" + self
.ToolChain
,
1853 GlobalData
.gBuildDirectory
= self
._BuildDir
1854 return self
._BuildDir
1856 ## Return directory of platform makefile
1858 # @retval string Makefile directory
1860 def _GetMakeFileDir(self
):
1861 if self
._MakeFileDir
is None:
1862 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1863 return self
._MakeFileDir
1865 ## Return build command string
1867 # @retval string Build command string
1869 def _GetBuildCommand(self
):
1870 if self
._BuildCommand
is None:
1871 self
._BuildCommand
= []
1872 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1873 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1874 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1875 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1877 self
._BuildCommand
+= SplitOption(NewOption
)
1878 if "MAKE" in self
.EdkIIBuildOption
:
1879 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1880 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1881 if Flags
.startswith('='):
1882 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1884 self
._BuildCommand
+= [Flags
]
1885 return self
._BuildCommand
1887 ## Get tool chain definition
1889 # Get each tool defition for given tool chain from tools_def.txt and platform
1891 def _GetToolDefinition(self
):
1892 if self
._ToolDefinitions
is None:
1893 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1894 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1895 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1896 ExtraData
="[%s]" % self
.MetaFile
)
1897 self
._ToolDefinitions
= {}
1899 for Def
in ToolDefinition
:
1900 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1901 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1904 Value
= ToolDefinition
[Def
]
1905 # don't record the DLL
1907 DllPathList
.add(Value
)
1910 if Tool
not in self
._ToolDefinitions
:
1911 self
._ToolDefinitions
[Tool
] = {}
1912 self
._ToolDefinitions
[Tool
][Attr
] = Value
1915 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1916 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1917 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1918 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1920 for Tool
in self
._ToolDefinitions
:
1921 for Attr
in self
._ToolDefinitions
[Tool
]:
1922 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1923 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1924 # check if override is indicated
1925 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1926 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1929 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1931 Value
= self
.BuildOption
[Tool
][Attr
]
1934 # Don't put MAKE definition in the file
1936 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1938 # Don't put MAKE definition in the file
1943 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1946 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1947 for DllPath
in DllPathList
:
1948 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1949 os
.environ
["MAKE_FLAGS"] = MakeFlags
1951 return self
._ToolDefinitions
1953 ## Return the paths of tools
1954 def _GetToolDefFile(self
):
1955 if self
._ToolDefFile
is None:
1956 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1957 return self
._ToolDefFile
1959 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1960 def _GetToolChainFamily(self
):
1961 if self
._ToolChainFamily
is None:
1962 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1963 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1964 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1965 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1966 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1968 self
._ToolChainFamily
= "MSFT"
1970 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1971 return self
._ToolChainFamily
1973 def _GetBuildRuleFamily(self
):
1974 if self
._BuildRuleFamily
is None:
1975 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1976 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1977 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1978 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1979 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1981 self
._BuildRuleFamily
= "MSFT"
1983 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1984 return self
._BuildRuleFamily
1986 ## Return the build options specific for all modules in this platform
1987 def _GetBuildOptions(self
):
1988 if self
._BuildOption
is None:
1989 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
1990 return self
._BuildOption
1992 ## Return the build options specific for EDK modules in this platform
1993 def _GetEdkBuildOptions(self
):
1994 if self
._EdkBuildOption
is None:
1995 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
1996 return self
._EdkBuildOption
1998 ## Return the build options specific for EDKII modules in this platform
1999 def _GetEdkIIBuildOptions(self
):
2000 if self
._EdkIIBuildOption
is None:
2001 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
2002 return self
._EdkIIBuildOption
2004 ## Parse build_rule.txt in Conf Directory.
2006 # @retval BuildRule object
2008 def _GetBuildRule(self
):
2009 if self
._BuildRule
is None:
2010 BuildRuleFile
= None
2011 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2012 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2013 if BuildRuleFile
in [None, '']:
2014 BuildRuleFile
= gDefaultBuildRuleFile
2015 self
._BuildRule
= BuildRule(BuildRuleFile
)
2016 if self
._BuildRule
._FileVersion
== "":
2017 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2019 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2020 # If Build Rule's version is less than the version number required by the tools, halting the build.
2021 EdkLogger
.error("build", AUTOGEN_ERROR
,
2022 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])"\
2023 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2025 return self
._BuildRule
2027 ## Summarize the packages used by modules in this platform
2028 def _GetPackageList(self
):
2029 if self
._PackageList
is None:
2030 self
._PackageList
= set()
2031 for La
in self
.LibraryAutoGenList
:
2032 self
._PackageList
.update(La
.DependentPackageList
)
2033 for Ma
in self
.ModuleAutoGenList
:
2034 self
._PackageList
.update(Ma
.DependentPackageList
)
2035 #Collect package set information from INF of FDF
2037 for ModuleFile
in self
._AsBuildModuleList
:
2038 if ModuleFile
in self
.Platform
.Modules
:
2040 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2041 PkgSet
.update(ModuleData
.Packages
)
2042 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2043 return self
._PackageList
2045 def _GetNonDynamicPcdDict(self
):
2046 if self
._NonDynamicPcdDict
:
2047 return self
._NonDynamicPcdDict
2048 for Pcd
in self
.NonDynamicPcdList
:
2049 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2050 return self
._NonDynamicPcdDict
2052 ## Get list of non-dynamic PCDs
2053 def _GetNonDynamicPcdList(self
):
2054 if self
._NonDynamicPcdList
is None:
2055 self
.CollectPlatformDynamicPcds()
2056 return self
._NonDynamicPcdList
2058 ## Get list of dynamic PCDs
2059 def _GetDynamicPcdList(self
):
2060 if self
._DynamicPcdList
is None:
2061 self
.CollectPlatformDynamicPcds()
2062 return self
._DynamicPcdList
2064 ## Generate Token Number for all PCD
2065 def _GetPcdTokenNumbers(self
):
2066 if self
._PcdTokenNumber
is None:
2067 self
._PcdTokenNumber
= OrderedDict()
2070 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2074 # TokenNumber 0 ~ 10
2076 # TokeNumber 11 ~ 20
2078 for Pcd
in self
.DynamicPcdList
:
2079 if Pcd
.Phase
== "PEI":
2080 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2081 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2082 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2085 for Pcd
in self
.DynamicPcdList
:
2086 if Pcd
.Phase
== "PEI":
2087 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2088 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2089 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2092 for Pcd
in self
.DynamicPcdList
:
2093 if Pcd
.Phase
== "DXE":
2094 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2095 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2096 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2099 for Pcd
in self
.DynamicPcdList
:
2100 if Pcd
.Phase
== "DXE":
2101 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2102 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2103 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2106 for Pcd
in self
.NonDynamicPcdList
:
2107 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2109 return self
._PcdTokenNumber
2111 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2112 def _GetAutoGenObjectList(self
):
2113 self
._ModuleAutoGenList
= []
2114 self
._LibraryAutoGenList
= []
2115 for ModuleFile
in self
.Platform
.Modules
:
2124 if Ma
not in self
._ModuleAutoGenList
:
2125 self
._ModuleAutoGenList
.append(Ma
)
2126 for La
in Ma
.LibraryAutoGenList
:
2127 if La
not in self
._LibraryAutoGenList
:
2128 self
._LibraryAutoGenList
.append(La
)
2129 if Ma
not in La
._ReferenceModules
:
2130 La
._ReferenceModules
.append(Ma
)
2132 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2133 def _GetModuleAutoGenList(self
):
2134 if self
._ModuleAutoGenList
is None:
2135 self
._GetAutoGenObjectList
()
2136 return self
._ModuleAutoGenList
2138 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2139 def _GetLibraryAutoGenList(self
):
2140 if self
._LibraryAutoGenList
is None:
2141 self
._GetAutoGenObjectList
()
2142 return self
._LibraryAutoGenList
2144 ## Test if a module is supported by the platform
2146 # An error will be raised directly if the module or its arch is not supported
2147 # by the platform or current configuration
2149 def ValidModule(self
, Module
):
2150 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2151 or Module
in self
._AsBuildModuleList
2153 ## Resolve the library classes in a module to library instances
2155 # This method will not only resolve library classes but also sort the library
2156 # instances according to the dependency-ship.
2158 # @param Module The module from which the library classes will be resolved
2160 # @retval library_list List of library instances sorted
2162 def ApplyLibraryInstance(self
, Module
):
2163 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2164 if str(Module
) not in self
.Platform
.Modules
:
2167 ModuleType
= Module
.ModuleType
2169 # for overridding library instances with module specific setting
2170 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2172 # add forced library instances (specified under LibraryClasses sections)
2174 # If a module has a MODULE_TYPE of USER_DEFINED,
2175 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2177 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2178 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2179 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2180 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2182 # add forced library instances (specified in module overrides)
2183 for LibraryClass
in PlatformModule
.LibraryClasses
:
2184 if LibraryClass
.startswith("NULL"):
2185 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2188 LibraryConsumerList
= [Module
]
2190 ConsumedByList
= OrderedDict()
2191 LibraryInstance
= OrderedDict()
2193 EdkLogger
.verbose("")
2194 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2195 while len(LibraryConsumerList
) > 0:
2196 M
= LibraryConsumerList
.pop()
2197 for LibraryClassName
in M
.LibraryClasses
:
2198 if LibraryClassName
not in LibraryInstance
:
2199 # override library instance for this module
2200 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2201 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2203 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2204 if LibraryPath
is None or LibraryPath
== "":
2205 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2206 if LibraryPath
is None or LibraryPath
== "":
2207 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2208 "Instance of library class [%s] is not found" % LibraryClassName
,
2210 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2212 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2213 # for those forced library instance (NULL library), add a fake library class
2214 if LibraryClassName
.startswith("NULL"):
2215 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2216 elif LibraryModule
.LibraryClass
is None \
2217 or len(LibraryModule
.LibraryClass
) == 0 \
2218 or (ModuleType
!= 'USER_DEFINED'
2219 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2220 # only USER_DEFINED can link against any library instance despite of its SupModList
2221 EdkLogger
.error("build", OPTION_MISSING
,
2222 "Module type [%s] is not supported by library instance [%s]" \
2223 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2224 ExtraData
="consumed by [%s]" % str(Module
))
2226 LibraryInstance
[LibraryClassName
] = LibraryModule
2227 LibraryConsumerList
.append(LibraryModule
)
2228 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2230 LibraryModule
= LibraryInstance
[LibraryClassName
]
2232 if LibraryModule
is None:
2235 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2236 Constructor
.append(LibraryModule
)
2238 if LibraryModule
not in ConsumedByList
:
2239 ConsumedByList
[LibraryModule
] = []
2240 # don't add current module itself to consumer list
2242 if M
in ConsumedByList
[LibraryModule
]:
2244 ConsumedByList
[LibraryModule
].append(M
)
2246 # Initialize the sorted output list to the empty set
2248 SortedLibraryList
= []
2250 # Q <- Set of all nodes with no incoming edges
2252 LibraryList
= [] #LibraryInstance.values()
2254 for LibraryClassName
in LibraryInstance
:
2255 M
= LibraryInstance
[LibraryClassName
]
2256 LibraryList
.append(M
)
2257 if ConsumedByList
[M
] == []:
2261 # start the DAG algorithm
2265 while Q
== [] and EdgeRemoved
:
2267 # for each node Item with a Constructor
2268 for Item
in LibraryList
:
2269 if Item
not in Constructor
:
2271 # for each Node without a constructor with an edge e from Item to Node
2272 for Node
in ConsumedByList
[Item
]:
2273 if Node
in Constructor
:
2275 # remove edge e from the graph if Node has no constructor
2276 ConsumedByList
[Item
].remove(Node
)
2278 if ConsumedByList
[Item
] == []:
2279 # insert Item into Q
2284 # DAG is done if there's no more incoming edge for all nodes
2288 # remove node from Q
2291 SortedLibraryList
.append(Node
)
2293 # for each node Item with an edge e from Node to Item do
2294 for Item
in LibraryList
:
2295 if Node
not in ConsumedByList
[Item
]:
2297 # remove edge e from the graph
2298 ConsumedByList
[Item
].remove(Node
)
2300 if ConsumedByList
[Item
] != []:
2302 # insert Item into Q, if Item has no other incoming edges
2306 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2308 for Item
in LibraryList
:
2309 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2310 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2311 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2312 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2313 if Item
not in SortedLibraryList
:
2314 SortedLibraryList
.append(Item
)
2317 # Build the list of constructor and destructir names
2318 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2320 SortedLibraryList
.reverse()
2321 return SortedLibraryList
2324 ## Override PCD setting (type, value, ...)
2326 # @param ToPcd The PCD to be overrided
2327 # @param FromPcd The PCD overrideing from
2329 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2331 # in case there's PCDs coming from FDF file, which have no type given.
2332 # at this point, ToPcd.Type has the type found from dependent
2335 TokenCName
= ToPcd
.TokenCName
2336 for PcdItem
in GlobalData
.MixedPcd
:
2337 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2338 TokenCName
= PcdItem
[0]
2340 if FromPcd
is not None:
2341 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2342 ToPcd
.Type
= FromPcd
.Type
2343 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2344 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2345 if ToPcd
.Type
.strip() == "DynamicEx":
2346 ToPcd
.Type
= FromPcd
.Type
2347 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2348 and ToPcd
.Type
!= FromPcd
.Type
:
2349 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2350 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2351 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2352 ToPcd
.Type
, Module
, FromPcd
.Type
),
2355 if FromPcd
.MaxDatumSize
not in [None, '']:
2356 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2357 if FromPcd
.DefaultValue
not in [None, '']:
2358 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2359 if FromPcd
.TokenValue
not in [None, '']:
2360 ToPcd
.TokenValue
= FromPcd
.TokenValue
2361 if FromPcd
.MaxDatumSize
not in [None, '']:
2362 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2363 if FromPcd
.DatumType
not in [None, '']:
2364 ToPcd
.DatumType
= FromPcd
.DatumType
2365 if FromPcd
.SkuInfoList
not in [None, '', []]:
2366 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2367 # Add Flexible PCD format parse
2368 if ToPcd
.DefaultValue
:
2370 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2371 except BadExpression
, Value
:
2372 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2375 # check the validation of datum
2376 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2378 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2379 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2380 ToPcd
.validateranges
= FromPcd
.validateranges
2381 ToPcd
.validlists
= FromPcd
.validlists
2382 ToPcd
.expressions
= FromPcd
.expressions
2384 if FromPcd
is not None and ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2385 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2386 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2387 Value
= ToPcd
.DefaultValue
2388 if Value
in [None, '']:
2389 ToPcd
.MaxDatumSize
= '1'
2390 elif Value
[0] == 'L':
2391 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2392 elif Value
[0] == '{':
2393 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2395 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2397 # apply default SKU for dynamic PCDS if specified one is not available
2398 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2399 and ToPcd
.SkuInfoList
in [None, {}, '']:
2400 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2401 SkuName
= self
.Platform
.SkuName
2404 ToPcd
.SkuInfoList
= {
2405 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2408 ## Apply PCD setting defined platform to a module
2410 # @param Module The module from which the PCD setting will be overrided
2412 # @retval PCD_list The list PCDs with settings from platform
2414 def ApplyPcdSetting(self
, Module
, Pcds
):
2415 # for each PCD in module
2416 for Name
, Guid
in Pcds
:
2417 PcdInModule
= Pcds
[Name
, Guid
]
2418 # find out the PCD setting in platform
2419 if (Name
, Guid
) in self
.Platform
.Pcds
:
2420 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2422 PcdInPlatform
= None
2423 # then override the settings if any
2424 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2425 # resolve the VariableGuid value
2426 for SkuId
in PcdInModule
.SkuInfoList
:
2427 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2428 if Sku
.VariableGuid
== '': continue
2429 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2430 if Sku
.VariableGuidValue
is None:
2431 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2434 RESOURCE_NOT_AVAILABLE
,
2435 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2436 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2437 % (Guid
, Name
, str(Module
)),
2441 # override PCD settings with module specific setting
2442 if Module
in self
.Platform
.Modules
:
2443 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2444 for Key
in PlatformModule
.Pcds
:
2449 elif Key
in GlobalData
.MixedPcd
:
2450 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2452 ToPcd
= Pcds
[PcdItem
]
2456 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2457 # use PCD value to calculate the MaxDatumSize when it is not specified
2458 for Name
, Guid
in Pcds
:
2459 Pcd
= Pcds
[Name
, Guid
]
2460 if Pcd
.DatumType
== "VOID*" and Pcd
.MaxDatumSize
in ['', None]:
2461 Value
= Pcd
.DefaultValue
2462 if Value
in [None, '']:
2463 Pcd
.MaxDatumSize
= '1'
2464 elif Value
[0] == 'L':
2465 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2466 elif Value
[0] == '{':
2467 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2469 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2470 return Pcds
.values()
2472 ## Resolve library names to library modules
2474 # (for Edk.x modules)
2476 # @param Module The module from which the library names will be resolved
2478 # @retval library_list The list of library modules
2480 def ResolveLibraryReference(self
, Module
):
2481 EdkLogger
.verbose("")
2482 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2483 LibraryConsumerList
= [Module
]
2485 # "CompilerStub" is a must for Edk modules
2486 if Module
.Libraries
:
2487 Module
.Libraries
.append("CompilerStub")
2489 while len(LibraryConsumerList
) > 0:
2490 M
= LibraryConsumerList
.pop()
2491 for LibraryName
in M
.Libraries
:
2492 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2494 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2495 if LibraryName
.upper() == Key
.upper():
2496 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2499 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2500 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2503 if Library
not in LibraryList
:
2504 LibraryList
.append(Library
)
2505 LibraryConsumerList
.append(Library
)
2506 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2509 ## Calculate the priority value of the build option
2511 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2513 # @retval Value Priority value based on the priority list.
2515 def CalculatePriorityValue(self
, Key
):
2516 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2517 PriorityValue
= 0x11111
2519 PriorityValue
&= 0x01111
2520 if ToolChain
== "*":
2521 PriorityValue
&= 0x10111
2523 PriorityValue
&= 0x11011
2524 if CommandType
== "*":
2525 PriorityValue
&= 0x11101
2527 PriorityValue
&= 0x11110
2529 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2532 ## Expand * in build option key
2534 # @param Options Options to be expanded
2536 # @retval options Options expanded
2538 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2545 # Construct a list contain the build options which need override.
2549 # Key[0] -- tool family
2550 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2552 if (Key
[0] == self
.BuildRuleFamily
and
2553 (ModuleStyle
is None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2554 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2555 if Target
== self
.BuildTarget
or Target
== "*":
2556 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2557 if Arch
== self
.Arch
or Arch
== "*":
2558 if Options
[Key
].startswith("="):
2559 if OverrideList
.get(Key
[1]) is not None:
2560 OverrideList
.pop(Key
[1])
2561 OverrideList
[Key
[1]] = Options
[Key
]
2564 # Use the highest priority value.
2566 if (len(OverrideList
) >= 2):
2567 KeyList
= OverrideList
.keys()
2568 for Index
in range(len(KeyList
)):
2569 NowKey
= KeyList
[Index
]
2570 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2571 for Index1
in range(len(KeyList
) - Index
- 1):
2572 NextKey
= KeyList
[Index1
+ Index
+ 1]
2574 # Compare two Key, if one is included by another, choose the higher priority one
2576 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2577 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2578 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2579 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2580 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2581 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2582 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2583 if Options
.get((self
.BuildRuleFamily
, NextKey
)) is not None:
2584 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2586 if Options
.get((self
.BuildRuleFamily
, NowKey
)) is not None:
2587 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2590 if ModuleStyle
is not None and len (Key
) > 2:
2591 # Check Module style is EDK or EDKII.
2592 # Only append build option for the matched style module.
2593 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2595 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2598 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2599 # if tool chain family doesn't match, skip it
2600 if Tool
in self
.ToolDefinition
and Family
!= "":
2601 FamilyIsNull
= False
2602 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2603 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2605 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2608 # expand any wildcard
2609 if Target
== "*" or Target
== self
.BuildTarget
:
2610 if Tag
== "*" or Tag
== self
.ToolChain
:
2611 if Arch
== "*" or Arch
== self
.Arch
:
2612 if Tool
not in BuildOptions
:
2613 BuildOptions
[Tool
] = {}
2614 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2615 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2617 # append options for the same tool except PATH
2619 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2621 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2622 # Build Option Family has been checked, which need't to be checked again for family.
2623 if FamilyMatch
or FamilyIsNull
:
2627 if ModuleStyle
is not None and len (Key
) > 2:
2628 # Check Module style is EDK or EDKII.
2629 # Only append build option for the matched style module.
2630 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2632 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2635 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2636 # if tool chain family doesn't match, skip it
2637 if Tool
not in self
.ToolDefinition
or Family
== "":
2639 # option has been added before
2640 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2643 # expand any wildcard
2644 if Target
== "*" or Target
== self
.BuildTarget
:
2645 if Tag
== "*" or Tag
== self
.ToolChain
:
2646 if Arch
== "*" or Arch
== self
.Arch
:
2647 if Tool
not in BuildOptions
:
2648 BuildOptions
[Tool
] = {}
2649 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2650 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2652 # append options for the same tool except PATH
2654 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2656 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2659 ## Append build options in platform to a module
2661 # @param Module The module to which the build options will be appened
2663 # @retval options The options appended with build options in platform
2665 def ApplyBuildOption(self
, Module
):
2666 # Get the different options for the different style module
2667 if Module
.AutoGenVersion
< 0x00010005:
2668 PlatformOptions
= self
.EdkBuildOption
2669 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2671 PlatformOptions
= self
.EdkIIBuildOption
2672 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2673 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2674 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2675 if Module
in self
.Platform
.Modules
:
2676 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2677 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2679 PlatformModuleOptions
= {}
2681 BuildRuleOrder
= None
2682 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2683 for Tool
in Options
:
2684 for Attr
in Options
[Tool
]:
2685 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2686 BuildRuleOrder
= Options
[Tool
][Attr
]
2688 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2689 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2690 self
.ToolDefinition
.keys())
2692 for Tool
in AllTools
:
2693 if Tool
not in BuildOptions
:
2694 BuildOptions
[Tool
] = {}
2696 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2697 if Tool
not in Options
:
2699 for Attr
in Options
[Tool
]:
2700 Value
= Options
[Tool
][Attr
]
2702 # Do not generate it in Makefile
2704 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2706 if Attr
not in BuildOptions
[Tool
]:
2707 BuildOptions
[Tool
][Attr
] = ""
2708 # check if override is indicated
2709 if Value
.startswith('='):
2710 ToolPath
= Value
[1:]
2711 ToolPath
= mws
.handleWsMacro(ToolPath
)
2712 BuildOptions
[Tool
][Attr
] = ToolPath
2714 Value
= mws
.handleWsMacro(Value
)
2716 BuildOptions
[Tool
][Attr
] += " " + Value
2718 BuildOptions
[Tool
][Attr
] = Value
2719 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
is not None:
2721 # Override UNI flag only for EDK module.
2723 if 'BUILD' not in BuildOptions
:
2724 BuildOptions
['BUILD'] = {}
2725 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2726 return BuildOptions
, BuildRuleOrder
2728 Platform
= property(_GetPlatform
)
2729 Name
= property(_GetName
)
2730 Guid
= property(_GetGuid
)
2731 Version
= property(_GetVersion
)
2733 OutputDir
= property(_GetOutputDir
)
2734 BuildDir
= property(_GetBuildDir
)
2735 MakeFileDir
= property(_GetMakeFileDir
)
2736 FdfFile
= property(_GetFdfFile
)
2738 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2739 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2740 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2741 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2742 PackageList
= property(_GetPackageList
)
2744 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2745 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2746 ToolChainFamily
= property(_GetToolChainFamily
)
2747 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2748 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2749 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2750 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2752 BuildCommand
= property(_GetBuildCommand
)
2753 BuildRule
= property(_GetBuildRule
)
2754 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2755 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2756 GenFdsCommand
= property(_GenFdsCommand
)
2758 ## ModuleAutoGen class
2760 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2761 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2762 # to the [depex] section in module's inf file.
2764 class ModuleAutoGen(AutoGen
):
2765 # call super().__init__ then call the worker function with different parameter count
2766 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2770 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2771 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2774 ## Cache the timestamps of metafiles of every module in a class variable
2778 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2779 obj
= super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2780 # check if this module is employed by active platform
2781 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2782 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2787 ## Initialize ModuleAutoGen
2789 # @param Workspace EdkIIWorkspaceBuild object
2790 # @param ModuleFile The path of module file
2791 # @param Target Build target (DEBUG, RELEASE)
2792 # @param Toolchain Name of tool chain
2793 # @param Arch The arch the module supports
2794 # @param PlatformFile Platform meta-file
2796 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2797 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2798 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2800 self
.Workspace
= Workspace
2801 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2803 self
.MetaFile
= ModuleFile
2804 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2806 self
.SourceDir
= self
.MetaFile
.SubDir
2807 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2809 self
.SourceOverrideDir
= None
2810 # use overrided path defined in DSC file
2811 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2812 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2814 self
.ToolChain
= Toolchain
2815 self
.BuildTarget
= Target
2817 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2818 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2820 self
.IsMakeFileCreated
= False
2821 self
.IsCodeFileCreated
= False
2822 self
.IsAsBuiltInfCreated
= False
2823 self
.DepexGenerated
= False
2825 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2826 self
.BuildRuleOrder
= None
2832 self
._Version
= None
2833 self
._ModuleType
= None
2834 self
._ComponentType
= None
2835 self
._PcdIsDriver
= None
2836 self
._AutoGenVersion
= None
2837 self
._LibraryFlag
= None
2838 self
._CustomMakefile
= None
2841 self
._BuildDir
= None
2842 self
._OutputDir
= None
2843 self
._FfsOutputDir
= None
2844 self
._DebugDir
= None
2845 self
._MakeFileDir
= None
2847 self
._IncludePathList
= None
2848 self
._IncludePathLength
= 0
2849 self
._AutoGenFileList
= None
2850 self
._UnicodeFileList
= None
2851 self
._VfrFileList
= None
2852 self
._IdfFileList
= None
2853 self
._SourceFileList
= None
2854 self
._ObjectFileList
= None
2855 self
._BinaryFileList
= None
2857 self
._DependentPackageList
= None
2858 self
._DependentLibraryList
= None
2859 self
._LibraryAutoGenList
= None
2860 self
._DerivedPackageList
= None
2861 self
._ModulePcdList
= None
2862 self
._LibraryPcdList
= None
2863 self
._PcdComments
= OrderedDict()
2864 self
._GuidList
= None
2865 self
._GuidsUsedByPcd
= None
2866 self
._GuidComments
= OrderedDict()
2867 self
._ProtocolList
= None
2868 self
._ProtocolComments
= OrderedDict()
2869 self
._PpiList
= None
2870 self
._PpiComments
= OrderedDict()
2871 self
._DepexList
= None
2872 self
._DepexExpressionList
= None
2873 self
._BuildOption
= None
2874 self
._BuildOptionIncPathList
= None
2875 self
._BuildTargets
= None
2876 self
._IntroBuildTargetList
= None
2877 self
._FinalBuildTargetList
= None
2878 self
._FileTypes
= None
2879 self
._BuildRules
= None
2881 self
._TimeStampPath
= None
2883 self
.AutoGenDepSet
= set()
2886 ## The Modules referenced to this Library
2887 # Only Library has this attribute
2888 self
._ReferenceModules
= []
2890 ## Store the FixedAtBuild Pcds
2892 self
._FixedAtBuildPcds
= []
2897 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2899 # Get FixedAtBuild Pcds of this Module
2900 def _GetFixedAtBuildPcds(self
):
2901 if self
._FixedAtBuildPcds
:
2902 return self
._FixedAtBuildPcds
2903 for Pcd
in self
.ModulePcdList
:
2904 if Pcd
.Type
!= "FixedAtBuild":
2906 if Pcd
not in self
._FixedAtBuildPcds
:
2907 self
._FixedAtBuildPcds
.append(Pcd
)
2909 return self
._FixedAtBuildPcds
2911 def _GetUniqueBaseName(self
):
2912 BaseName
= self
.Name
2913 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2914 if Module
.MetaFile
== self
.MetaFile
:
2916 if Module
.Name
== self
.Name
:
2917 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2918 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2919 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2920 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2923 # Macros could be used in build_rule.txt (also Makefile)
2924 def _GetMacros(self
):
2925 if self
._Macro
is None:
2926 self
._Macro
= OrderedDict()
2927 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2928 self
._Macro
["MODULE_NAME" ] = self
.Name
2929 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2930 self
._Macro
["MODULE_GUID" ] = self
.Guid
2931 self
._Macro
["MODULE_VERSION" ] = self
.Version
2932 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2933 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2934 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2935 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2936 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2938 self
._Macro
["BASE_NAME" ] = self
.Name
2940 self
._Macro
["ARCH" ] = self
.Arch
2941 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2942 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2943 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2944 self
._Macro
["TARGET" ] = self
.BuildTarget
2946 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2947 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2948 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2949 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2950 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2951 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2952 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2953 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2954 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2955 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2956 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2957 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2958 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2959 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2960 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2963 ## Return the module build data object
2964 def _GetModule(self
):
2965 if self
._Module
is None:
2966 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2969 ## Return the module name
2970 def _GetBaseName(self
):
2971 return self
.Module
.BaseName
2973 ## Return the module DxsFile if exist
2974 def _GetDxsFile(self
):
2975 return self
.Module
.DxsFile
2977 ## Return the module SourceOverridePath
2978 def _GetSourceOverridePath(self
):
2979 return self
.Module
.SourceOverridePath
2981 ## Return the module meta-file GUID
2984 # To build same module more than once, the module path with FILE_GUID overridden has
2985 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2986 # in DSC. The overridden GUID can be retrieved from file name
2988 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2990 # Length of GUID is 36
2992 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2993 return self
.Module
.Guid
2995 ## Return the module version
2996 def _GetVersion(self
):
2997 return self
.Module
.Version
2999 ## Return the module type
3000 def _GetModuleType(self
):
3001 return self
.Module
.ModuleType
3003 ## Return the component type (for Edk.x style of module)
3004 def _GetComponentType(self
):
3005 return self
.Module
.ComponentType
3007 ## Return the build type
3008 def _GetBuildType(self
):
3009 return self
.Module
.BuildType
3011 ## Return the PCD_IS_DRIVER setting
3012 def _GetPcdIsDriver(self
):
3013 return self
.Module
.PcdIsDriver
3015 ## Return the autogen version, i.e. module meta-file version
3016 def _GetAutoGenVersion(self
):
3017 return self
.Module
.AutoGenVersion
3019 ## Check if the module is library or not
3020 def _IsLibrary(self
):
3021 if self
._LibraryFlag
is None:
3022 if self
.Module
.LibraryClass
is not None and self
.Module
.LibraryClass
!= []:
3023 self
._LibraryFlag
= True
3025 self
._LibraryFlag
= False
3026 return self
._LibraryFlag
3028 ## Check if the module is binary module or not
3029 def _IsBinaryModule(self
):
3030 return self
.Module
.IsBinaryModule
3032 ## Return the directory to store intermediate files of the module
3033 def _GetBuildDir(self
):
3034 if self
._BuildDir
is None:
3035 self
._BuildDir
= path
.join(
3036 self
.PlatformInfo
.BuildDir
,
3039 self
.MetaFile
.BaseName
3041 CreateDirectory(self
._BuildDir
)
3042 return self
._BuildDir
3044 ## Return the directory to store the intermediate object files of the mdoule
3045 def _GetOutputDir(self
):
3046 if self
._OutputDir
is None:
3047 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3048 CreateDirectory(self
._OutputDir
)
3049 return self
._OutputDir
3051 ## Return the directory to store ffs file
3052 def _GetFfsOutputDir(self
):
3053 if self
._FfsOutputDir
is None:
3054 if GlobalData
.gFdfParser
is not None:
3055 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3057 self
._FfsOutputDir
= ''
3058 return self
._FfsOutputDir
3060 ## Return the directory to store auto-gened source files of the mdoule
3061 def _GetDebugDir(self
):
3062 if self
._DebugDir
is None:
3063 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3064 CreateDirectory(self
._DebugDir
)
3065 return self
._DebugDir
3067 ## Return the path of custom file
3068 def _GetCustomMakefile(self
):
3069 if self
._CustomMakefile
is None:
3070 self
._CustomMakefile
= {}
3071 for Type
in self
.Module
.CustomMakefile
:
3072 if Type
in gMakeTypeMap
:
3073 MakeType
= gMakeTypeMap
[Type
]
3076 if self
.SourceOverrideDir
is not None:
3077 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3078 if not os
.path
.exists(File
):
3079 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3081 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3082 self
._CustomMakefile
[MakeType
] = File
3083 return self
._CustomMakefile
3085 ## Return the directory of the makefile
3087 # @retval string The directory string of module's makefile
3089 def _GetMakeFileDir(self
):
3090 return self
.BuildDir
3092 ## Return build command string
3094 # @retval string Build command string
3096 def _GetBuildCommand(self
):
3097 return self
.PlatformInfo
.BuildCommand
3099 ## Get object list of all packages the module and its dependent libraries belong to
3101 # @retval list The list of package object
3103 def _GetDerivedPackageList(self
):
3105 for M
in [self
.Module
] + self
.DependentLibraryList
:
3106 for Package
in M
.Packages
:
3107 if Package
in PackageList
:
3109 PackageList
.append(Package
)
3112 ## Get the depex string
3114 # @return : a string contain all depex expresion.
3115 def _GetDepexExpresionString(self
):
3118 ## DPX_SOURCE IN Define section.
3119 if self
.Module
.DxsFile
:
3121 for M
in [self
.Module
] + self
.DependentLibraryList
:
3122 Filename
= M
.MetaFile
.Path
3123 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3124 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3125 for DepexExpresion
in DepexExpresionList
:
3126 for key
in DepexExpresion
.keys():
3127 Arch
, ModuleType
= key
3128 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3129 # the type of build module is USER_DEFINED.
3130 # All different DEPEX section tags would be copied into the As Built INF file
3131 # and there would be separate DEPEX section tags
3132 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3133 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3134 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3136 if Arch
.upper() == TAB_ARCH_COMMON
or \
3137 (Arch
.upper() == self
.Arch
.upper() and \
3138 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3139 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3141 #the type of build module is USER_DEFINED.
3142 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3143 for Depex
in DepexList
:
3144 for key
in Depex
.keys():
3145 DepexStr
+= '[Depex.%s.%s]\n' % key
3146 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3149 return '[Depex.%s]\n' % self
.Arch
3152 #the type of build module not is USER_DEFINED.
3154 for Depex
in DepexList
:
3159 for D
in Depex
.values():
3160 DepexStr
+= ' '.join([val
for val
in D
])
3161 Index
= DepexStr
.find('END')
3162 if Index
> -1 and Index
== len(DepexStr
) - 3:
3163 DepexStr
= DepexStr
[:-3]
3164 DepexStr
= DepexStr
.strip()
3167 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3169 return '[Depex.%s]\n' % self
.Arch
3170 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3172 ## Merge dependency expression
3174 # @retval list The token list of the dependency expression after parsed
3176 def _GetDepexTokenList(self
):
3177 if self
._DepexList
is None:
3178 self
._DepexList
= {}
3179 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3180 return self
._DepexList
3182 self
._DepexList
[self
.ModuleType
] = []
3184 for ModuleType
in self
._DepexList
:
3185 DepexList
= self
._DepexList
[ModuleType
]
3187 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3189 for M
in [self
.Module
] + self
.DependentLibraryList
:
3191 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3193 DepexList
.append('AND')
3194 DepexList
.append('(')
3196 if DepexList
[-1] == 'END': # no need of a END at this time
3198 DepexList
.append(')')
3201 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3202 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3204 if len(DepexList
) > 0:
3205 EdkLogger
.verbose('')
3206 return self
._DepexList
3208 ## Merge dependency expression
3210 # @retval list The token list of the dependency expression after parsed
3212 def _GetDepexExpressionTokenList(self
):
3213 if self
._DepexExpressionList
is None:
3214 self
._DepexExpressionList
= {}
3215 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3216 return self
._DepexExpressionList
3218 self
._DepexExpressionList
[self
.ModuleType
] = ''
3220 for ModuleType
in self
._DepexExpressionList
:
3221 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3223 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3225 for M
in [self
.Module
] + self
.DependentLibraryList
:
3227 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3228 if DepexExpressionList
!= '':
3229 DepexExpressionList
+= ' AND '
3230 DepexExpressionList
+= '('
3231 DepexExpressionList
+= D
3232 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3233 DepexExpressionList
+= ')'
3236 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3237 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3239 if len(DepexExpressionList
) > 0:
3240 EdkLogger
.verbose('')
3241 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3242 return self
._DepexExpressionList
3244 # Get the tiano core user extension, it is contain dependent library.
3245 # @retval: a list contain tiano core userextension.
3247 def _GetTianoCoreUserExtensionList(self
):
3248 TianoCoreUserExtentionList
= []
3249 for M
in [self
.Module
] + self
.DependentLibraryList
:
3250 Filename
= M
.MetaFile
.Path
3251 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3252 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3253 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3254 for Section
in TianoCoreUserExtent
.keys():
3255 ItemList
= Section
.split(TAB_SPLIT
)
3257 if len(ItemList
) == 4:
3259 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3261 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3262 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3263 TianoCoreList
.append('\n')
3264 TianoCoreUserExtentionList
.append(TianoCoreList
)
3266 return TianoCoreUserExtentionList
3268 ## Return the list of specification version required for the module
3270 # @retval list The list of specification defined in module file
3272 def _GetSpecification(self
):
3273 return self
.Module
.Specification
3275 ## Tool option for the module build
3277 # @param PlatformInfo The object of PlatformBuildInfo
3278 # @retval dict The dict containing valid options
3280 def _GetModuleBuildOption(self
):
3281 if self
._BuildOption
is None:
3282 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3283 if self
.BuildRuleOrder
:
3284 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3285 return self
._BuildOption
3287 ## Get include path list from tool option for the module build
3289 # @retval list The include path list
3291 def _GetBuildOptionIncPathList(self
):
3292 if self
._BuildOptionIncPathList
is None:
3294 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3295 # is the former use /I , the Latter used -I to specify include directories
3297 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3298 BuildOptIncludeRegEx
= gBuildOptIncludePatternMsft
3299 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3300 BuildOptIncludeRegEx
= gBuildOptIncludePatternOther
3303 # New ToolChainFamily, don't known whether there is option to specify include directories
3305 self
._BuildOptionIncPathList
= []
3306 return self
._BuildOptionIncPathList
3308 BuildOptionIncPathList
= []
3309 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3312 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3316 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3317 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in BuildOptIncludeRegEx
.findall(FlagOption
)]
3320 # RVCT may specify a list of directory seperated by commas
3323 for Path
in BuildOptIncludeRegEx
.findall(FlagOption
):
3324 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3325 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3328 # EDK II modules must not reference header files outside of the packages they depend on or
3329 # within the module's directory tree. Report error if violation.
3331 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3332 for Path
in IncPathList
:
3333 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3334 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3335 EdkLogger
.error("build",
3338 File
=str(self
.MetaFile
))
3341 BuildOptionIncPathList
+= IncPathList
3343 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3345 return self
._BuildOptionIncPathList
3347 ## Return a list of files which can be built from source
3349 # What kind of files can be built is determined by build rules in
3350 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3352 def _GetSourceFileList(self
):
3353 if self
._SourceFileList
is None:
3354 self
._SourceFileList
= []
3355 for F
in self
.Module
.Sources
:
3357 if F
.TagName
not in ("", "*", self
.ToolChain
):
3358 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3359 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3361 # match tool chain family or build rule family
3362 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3365 "The file [%s] must be built by tools of [%s], " \
3366 "but current toolchain family is [%s], buildrule family is [%s]" \
3367 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3370 # add the file path into search path list for file including
3371 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3372 self
.IncludePathList
.insert(0, F
.Dir
)
3373 self
._SourceFileList
.append(F
)
3375 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3377 for F
in self
._SourceFileList
:
3378 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3379 return self
._SourceFileList
3381 def _MatchBuildRuleOrder(self
, FileList
):
3383 self
._GetModuleBuildOption
()
3384 for SingleFile
in FileList
:
3385 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3386 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3387 if key
in Order_Dict
:
3388 Order_Dict
[key
].append(SingleFile
.Ext
)
3390 Order_Dict
[key
] = [SingleFile
.Ext
]
3393 for F
in Order_Dict
:
3394 if len(Order_Dict
[F
]) > 1:
3395 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3396 for Ext
in Order_Dict
[F
][1:]:
3397 RemoveList
.append(F
+ Ext
)
3399 for item
in RemoveList
:
3400 FileList
.remove(item
)
3404 ## Return the list of unicode files
3405 def _GetUnicodeFileList(self
):
3406 if self
._UnicodeFileList
is None:
3407 if TAB_UNICODE_FILE
in self
.FileTypes
:
3408 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3410 self
._UnicodeFileList
= []
3411 return self
._UnicodeFileList
3413 ## Return the list of vfr files
3414 def _GetVfrFileList(self
):
3415 if self
._VfrFileList
is None:
3416 if TAB_VFR_FILE
in self
.FileTypes
:
3417 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3419 self
._VfrFileList
= []
3420 return self
._VfrFileList
3422 ## Return the list of Image Definition files
3423 def _GetIdfFileList(self
):
3424 if self
._IdfFileList
is None:
3425 if TAB_IMAGE_FILE
in self
.FileTypes
:
3426 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3428 self
._IdfFileList
= []
3429 return self
._IdfFileList
3431 ## Return a list of files which can be built from binary
3433 # "Build" binary files are just to copy them to build directory.
3435 # @retval list The list of files which can be built later
3437 def _GetBinaryFiles(self
):
3438 if self
._BinaryFileList
is None:
3439 self
._BinaryFileList
= []
3440 for F
in self
.Module
.Binaries
:
3441 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3443 self
._BinaryFileList
.append(F
)
3444 self
._ApplyBuildRule
(F
, F
.Type
)
3445 return self
._BinaryFileList
3447 def _GetBuildRules(self
):
3448 if self
._BuildRules
is None:
3450 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3451 for Type
in BuildRuleDatabase
.FileTypeList
:
3452 #first try getting build rule by BuildRuleFamily
3453 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3455 # build type is always module type, but ...
3456 if self
.ModuleType
!= self
.BuildType
:
3457 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3458 #second try getting build rule by ToolChainFamily
3460 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3462 # build type is always module type, but ...
3463 if self
.ModuleType
!= self
.BuildType
:
3464 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3467 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3468 BuildRules
[Type
] = RuleObject
3469 for Ext
in RuleObject
.SourceFileExtList
:
3470 BuildRules
[Ext
] = RuleObject
3471 self
._BuildRules
= BuildRules
3472 return self
._BuildRules
3474 def _ApplyBuildRule(self
, File
, FileType
):
3475 if self
._BuildTargets
is None:
3476 self
._IntroBuildTargetList
= set()
3477 self
._FinalBuildTargetList
= set()
3478 self
._BuildTargets
= defaultdict(set)
3479 self
._FileTypes
= defaultdict(set)
3481 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3482 if not os
.path
.exists(SubDirectory
):
3483 CreateDirectory(SubDirectory
)
3489 # Make sure to get build rule order value
3491 self
._GetModuleBuildOption
()
3493 while Index
< len(SourceList
):
3494 Source
= SourceList
[Index
]
3498 CreateDirectory(Source
.Dir
)
3500 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
is not None and File
in self
._BinaryFileList
:
3501 # Skip all files that are not binary libraries
3502 if not self
.IsLibrary
:
3504 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3505 elif FileType
in self
.BuildRules
:
3506 RuleObject
= self
.BuildRules
[FileType
]
3507 elif Source
.Ext
in self
.BuildRules
:
3508 RuleObject
= self
.BuildRules
[Source
.Ext
]
3510 # stop at no more rules
3512 self
._FinalBuildTargetList
.add(LastTarget
)
3515 FileType
= RuleObject
.SourceFileType
3516 self
._FileTypes
[FileType
].add(Source
)
3518 # stop at STATIC_LIBRARY for library
3519 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3521 self
._FinalBuildTargetList
.add(LastTarget
)
3524 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3527 self
._FinalBuildTargetList
.add(LastTarget
)
3529 elif not Target
.Outputs
:
3530 # Only do build for target with outputs
3531 self
._FinalBuildTargetList
.add(Target
)
3533 self
._BuildTargets
[FileType
].add(Target
)
3535 if not Source
.IsBinary
and Source
== File
:
3536 self
._IntroBuildTargetList
.add(Target
)
3538 # to avoid cyclic rule
3539 if FileType
in RuleChain
:
3542 RuleChain
.append(FileType
)
3543 SourceList
.extend(Target
.Outputs
)
3545 FileType
= TAB_UNKNOWN_FILE
3547 def _GetTargets(self
):
3548 if self
._BuildTargets
is None:
3549 self
._IntroBuildTargetList
= set()
3550 self
._FinalBuildTargetList
= set()
3551 self
._BuildTargets
= defaultdict(set)
3552 self
._FileTypes
= defaultdict(set)
3554 #TRICK: call _GetSourceFileList to apply build rule for source files
3555 if self
.SourceFileList
:
3558 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3559 if self
.BinaryFileList
:
3562 return self
._BuildTargets
3564 def _GetIntroTargetList(self
):
3566 return self
._IntroBuildTargetList
3568 def _GetFinalTargetList(self
):
3570 return self
._FinalBuildTargetList
3572 def _GetFileTypes(self
):
3574 return self
._FileTypes
3576 ## Get the list of package object the module depends on
3578 # @retval list The package object list
3580 def _GetDependentPackageList(self
):
3581 return self
.Module
.Packages
3583 ## Return the list of auto-generated code file
3585 # @retval list The list of auto-generated file
3587 def _GetAutoGenFileList(self
):
3588 UniStringAutoGenC
= True
3589 IdfStringAutoGenC
= True
3590 UniStringBinBuffer
= StringIO()
3591 IdfGenBinBuffer
= StringIO()
3592 if self
.BuildType
== 'UEFI_HII':
3593 UniStringAutoGenC
= False
3594 IdfStringAutoGenC
= False
3595 if self
._AutoGenFileList
is None:
3596 self
._AutoGenFileList
= {}
3597 AutoGenC
= TemplateString()
3598 AutoGenH
= TemplateString()
3599 StringH
= TemplateString()
3600 StringIdf
= TemplateString()
3601 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3603 # AutoGen.c is generated if there are library classes in inf, or there are object files
3605 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3606 or TAB_OBJECT_FILE
in self
.FileTypes
):
3607 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3608 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3609 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3610 if str(AutoGenH
) != "":
3611 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3612 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3613 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3614 if str(StringH
) != "":
3615 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3616 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3617 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3618 if UniStringBinBuffer
is not None and UniStringBinBuffer
.getvalue() != "":
3619 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3620 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3621 AutoFile
.IsBinary
= True
3622 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3623 if UniStringBinBuffer
is not None:
3624 UniStringBinBuffer
.close()
3625 if str(StringIdf
) != "":
3626 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3627 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3628 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3629 if IdfGenBinBuffer
is not None and IdfGenBinBuffer
.getvalue() != "":
3630 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3631 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3632 AutoFile
.IsBinary
= True
3633 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3634 if IdfGenBinBuffer
is not None:
3635 IdfGenBinBuffer
.close()
3636 return self
._AutoGenFileList
3638 ## Return the list of library modules explicitly or implicityly used by this module
3639 def _GetLibraryList(self
):
3640 if self
._DependentLibraryList
is None:
3641 # only merge library classes and PCD for non-library module
3643 self
._DependentLibraryList
= []
3645 if self
.AutoGenVersion
< 0x00010005:
3646 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3648 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3649 return self
._DependentLibraryList
3652 def UpdateComments(Recver
, Src
):
3654 if Key
not in Recver
:
3656 Recver
[Key
].extend(Src
[Key
])
3657 ## Get the list of PCDs from current module
3659 # @retval list The list of PCD
3661 def _GetModulePcdList(self
):
3662 if self
._ModulePcdList
is None:
3663 # apply PCD settings from platform
3664 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3665 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3666 return self
._ModulePcdList
3668 ## Get the list of PCDs from dependent libraries
3670 # @retval list The list of PCD
3672 def _GetLibraryPcdList(self
):
3673 if self
._LibraryPcdList
is None:
3674 Pcds
= OrderedDict()
3675 if not self
.IsLibrary
:
3676 # get PCDs from dependent libraries
3677 for Library
in self
.DependentLibraryList
:
3678 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3679 for Key
in Library
.Pcds
:
3680 # skip duplicated PCDs
3681 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3683 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3684 # apply PCD settings from platform
3685 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3687 self
._LibraryPcdList
= []
3688 return self
._LibraryPcdList
3690 ## Get the GUID value mapping
3692 # @retval dict The mapping between GUID cname and its value
3694 def _GetGuidList(self
):
3695 if self
._GuidList
is None:
3696 self
._GuidList
= OrderedDict()
3697 self
._GuidList
.update(self
.Module
.Guids
)
3698 for Library
in self
.DependentLibraryList
:
3699 self
._GuidList
.update(Library
.Guids
)
3700 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3701 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3702 return self
._GuidList
3704 def GetGuidsUsedByPcd(self
):
3705 if self
._GuidsUsedByPcd
is None:
3706 self
._GuidsUsedByPcd
= OrderedDict()
3707 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3708 for Library
in self
.DependentLibraryList
:
3709 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3710 return self
._GuidsUsedByPcd
3711 ## Get the protocol value mapping
3713 # @retval dict The mapping between protocol cname and its value
3715 def _GetProtocolList(self
):
3716 if self
._ProtocolList
is None:
3717 self
._ProtocolList
= OrderedDict()
3718 self
._ProtocolList
.update(self
.Module
.Protocols
)
3719 for Library
in self
.DependentLibraryList
:
3720 self
._ProtocolList
.update(Library
.Protocols
)
3721 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3722 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3723 return self
._ProtocolList
3725 ## Get the PPI value mapping
3727 # @retval dict The mapping between PPI cname and its value
3729 def _GetPpiList(self
):
3730 if self
._PpiList
is None:
3731 self
._PpiList
= OrderedDict()
3732 self
._PpiList
.update(self
.Module
.Ppis
)
3733 for Library
in self
.DependentLibraryList
:
3734 self
._PpiList
.update(Library
.Ppis
)
3735 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3736 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3737 return self
._PpiList
3739 ## Get the list of include search path
3741 # @retval list The list path
3743 def _GetIncludePathList(self
):
3744 if self
._IncludePathList
is None:
3745 self
._IncludePathList
= []
3746 if self
.AutoGenVersion
< 0x00010005:
3747 for Inc
in self
.Module
.Includes
:
3748 if Inc
not in self
._IncludePathList
:
3749 self
._IncludePathList
.append(Inc
)
3751 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3752 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3753 self
._IncludePathList
.append(Inc
)
3754 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3755 self
._IncludePathList
.append(self
.DebugDir
)
3757 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3758 self
._IncludePathList
.append(self
.DebugDir
)
3760 for Package
in self
.Module
.Packages
:
3761 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3762 if PackageDir
not in self
._IncludePathList
:
3763 self
._IncludePathList
.append(PackageDir
)
3764 IncludesList
= Package
.Includes
3765 if Package
._PrivateIncludes
:
3766 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3767 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3768 for Inc
in IncludesList
:
3769 if Inc
not in self
._IncludePathList
:
3770 self
._IncludePathList
.append(str(Inc
))
3771 return self
._IncludePathList
3773 def _GetIncludePathLength(self
):
3774 self
._IncludePathLength
= 0
3775 if self
._IncludePathList
:
3776 for inc
in self
._IncludePathList
:
3777 self
._IncludePathLength
+= len(' ' + inc
)
3778 return self
._IncludePathLength
3780 ## Get HII EX PCDs which maybe used by VFR
3782 # efivarstore used by VFR may relate with HII EX PCDs
3783 # Get the variable name and GUID from efivarstore and HII EX PCD
3784 # List the HII EX PCDs in As Built INF if both name and GUID match.
3786 # @retval list HII EX PCDs
3788 def _GetPcdsMaybeUsedByVfr(self
):
3789 if not self
.SourceFileList
:
3793 for SrcFile
in self
.SourceFileList
:
3794 if SrcFile
.Ext
.lower() != '.vfr':
3796 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3797 if not os
.path
.exists(Vfri
):
3799 VfriFile
= open(Vfri
, 'r')
3800 Content
= VfriFile
.read()
3802 Pos
= Content
.find('efivarstore')
3805 # Make sure 'efivarstore' is the start of efivarstore statement
3806 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3809 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3811 if Index
>= 0 and Content
[Index
] != ';':
3812 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3815 # 'efivarstore' must be followed by name and guid
3817 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3820 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3823 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3824 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3825 Pos
= Content
.find('efivarstore', Name
.end())
3829 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3830 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3832 for SkuName
in Pcd
.SkuInfoList
:
3833 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3834 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3835 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3838 Guid
= GuidStructureStringToGuidString(Value
)
3839 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3840 HiiExPcds
.append(Pcd
)
3845 def _GenOffsetBin(self
):
3847 for SourceFile
in self
.Module
.Sources
:
3848 if SourceFile
.Type
.upper() == ".VFR" :
3850 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3852 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3853 if SourceFile
.Type
.upper() == ".UNI" :
3855 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3857 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3859 if len(VfrUniBaseName
) == 0:
3861 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3862 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3863 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3864 if not VfrUniOffsetList
:
3867 OutputName
= '%sOffset.bin' % self
.Name
3868 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3871 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3873 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3875 # Use a instance of StringIO to cache data
3876 fStringIO
= StringIO('')
3878 for Item
in VfrUniOffsetList
:
3879 if (Item
[0].find("Strings") != -1):
3881 # UNI offset in image.
3883 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3885 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3886 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3887 fStringIO
.write(''.join(UniGuid
))
3888 UniValue
= pack ('Q', int (Item
[1], 16))
3889 fStringIO
.write (UniValue
)
3892 # VFR binary offset in image.
3894 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3896 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3897 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3898 fStringIO
.write(''.join(VfrGuid
))
3900 VfrValue
= pack ('Q', int (Item
[1], 16))
3901 fStringIO
.write (VfrValue
)
3903 # write data into file.
3906 fInputfile
.write (fStringIO
.getvalue())
3908 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3909 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3915 ## Create AsBuilt INF file the module
3917 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3918 self
.OutputFile
= set()
3920 if GlobalData
.gBinCacheDest
:
3921 self
.CopyModuleToCache()
3924 if self
.IsAsBuiltInfCreated
:
3927 # Skip the following code for EDK I inf
3928 if self
.AutoGenVersion
< 0x00010005:
3931 # Skip the following code for libraries
3935 # Skip the following code for modules with no source files
3936 if self
.SourceFileList
is None or self
.SourceFileList
== []:
3939 # Skip the following code for modules without any binary files
3940 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3943 ### TODO: How to handles mixed source and binary modules
3945 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3946 # Also find all packages that the DynamicEx PCDs depend on
3951 PcdTokenSpaceList
= []
3952 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3953 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3954 PatchablePcds
+= [Pcd
]
3955 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3956 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3959 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3960 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3961 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3962 GuidList
= OrderedDict()
3963 GuidList
.update(self
.GuidList
)
3964 for TokenSpace
in self
.GetGuidsUsedByPcd():
3965 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3966 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3967 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3968 GuidList
.pop(TokenSpace
)
3969 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3970 for Package
in self
.DerivedPackageList
:
3971 if Package
in Packages
:
3973 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3975 for Index
in range(len(BeChecked
)):
3976 for Item
in CheckList
[Index
]:
3977 if Item
in BeChecked
[Index
]:
3978 Packages
+= [Package
]
3983 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3984 for Pkg
in self
.PlatformInfo
.PackageList
:
3987 for VfrPcd
in VfrPcds
:
3988 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
3989 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
3993 ModuleType
= self
.ModuleType
3994 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
3995 ModuleType
= 'DXE_DRIVER'
3998 if self
.PcdIsDriver
!= '':
3999 DriverType
= self
.PcdIsDriver
4002 MDefs
= self
.Module
.Defines
4005 'module_name' : self
.Name
,
4006 'module_guid' : Guid
,
4007 'module_module_type' : ModuleType
,
4008 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
4009 'pcd_is_driver_string' : [],
4010 'module_uefi_specification_version' : [],
4011 'module_pi_specification_version' : [],
4012 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
4013 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
4014 'module_constructor' : self
.Module
.ConstructorList
,
4015 'module_destructor' : self
.Module
.DestructorList
,
4016 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4017 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4018 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4019 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4020 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4021 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4022 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4023 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4024 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4025 'module_arch' : self
.Arch
,
4026 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4028 'patchablepcd_item' : [],
4030 'protocol_item' : [],
4034 'libraryclasses_item' : []
4037 if 'MODULE_UNI_FILE' in MDefs
:
4038 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4039 if os
.path
.isfile(UNIFile
):
4040 shutil
.copy2(UNIFile
, self
.OutputDir
)
4042 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4043 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4045 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4048 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4050 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4051 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4052 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4053 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4055 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4056 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4057 for Item
in self
.CodaTargetList
:
4058 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
4059 self
.OutputFile
.add(File
)
4060 if os
.path
.isabs(File
):
4061 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4062 if Item
.Target
.Ext
.lower() == '.aml':
4063 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4064 elif Item
.Target
.Ext
.lower() == '.acpi':
4065 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4066 elif Item
.Target
.Ext
.lower() == '.efi':
4067 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4069 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4070 if self
.DepexGenerated
:
4071 self
.OutputFile
.add(self
.Name
+ '.depex')
4072 if self
.ModuleType
in ['PEIM']:
4073 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4074 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4075 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4076 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4077 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4079 Bin
= self
._GenOffsetBin
()
4081 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4082 self
.OutputFile
.add(Bin
)
4084 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4086 if File
.lower().endswith('.pdb'):
4087 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4088 self
.OutputFile
.add(File
)
4089 HeaderComments
= self
.Module
.HeaderComments
4091 for Index
in range(len(HeaderComments
)):
4092 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4093 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4096 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4097 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4100 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4101 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4102 (GuidList
, self
._GuidComments
, 'guid_item')
4104 for Item
in GenList
:
4105 for CName
in Item
[0]:
4107 if CName
in Item
[1]:
4108 Comments
= '\n '.join(Item
[1][CName
])
4111 Entry
= Comments
+ '\n ' + CName
4112 AsBuiltInfDict
[Item
[2]].append(Entry
)
4113 PatchList
= parsePcdInfoFromMapFile(
4114 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4115 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4118 for Pcd
in PatchablePcds
:
4119 TokenCName
= Pcd
.TokenCName
4120 for PcdItem
in GlobalData
.MixedPcd
:
4121 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4122 TokenCName
= PcdItem
[0]
4124 for PatchPcd
in PatchList
:
4125 if TokenCName
== PatchPcd
[0]:
4130 if Pcd
.DatumType
== 'BOOLEAN':
4131 BoolValue
= Pcd
.DefaultValue
.upper()
4132 if BoolValue
== 'TRUE':
4133 Pcd
.DefaultValue
= '1'
4134 elif BoolValue
== 'FALSE':
4135 Pcd
.DefaultValue
= '0'
4137 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4138 HexFormat
= '0x%02x'
4139 if Pcd
.DatumType
== 'UINT16':
4140 HexFormat
= '0x%04x'
4141 elif Pcd
.DatumType
== 'UINT32':
4142 HexFormat
= '0x%08x'
4143 elif Pcd
.DatumType
== 'UINT64':
4144 HexFormat
= '0x%016x'
4145 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4147 if Pcd
.MaxDatumSize
is None or Pcd
.MaxDatumSize
== '':
4148 EdkLogger
.error("build", AUTOGEN_ERROR
,
4149 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4151 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4152 PcdValue
= Pcd
.DefaultValue
4153 if PcdValue
[0] != '{':
4155 if PcdValue
[0] == 'L':
4157 PcdValue
= PcdValue
.lstrip('L')
4158 PcdValue
= eval(PcdValue
)
4160 for Index
in range(0, len(PcdValue
)):
4162 CharVal
= ord(PcdValue
[Index
])
4163 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4164 + '0x%02x' % (CharVal
>> 8) + ', '
4166 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4169 Padding
= Padding
* 2
4170 ArraySize
= ArraySize
/ 2
4171 if ArraySize
< (len(PcdValue
) + 1):
4172 EdkLogger
.error("build", AUTOGEN_ERROR
,
4173 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4175 if ArraySize
> len(PcdValue
) + 1:
4176 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4177 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4178 elif len(PcdValue
.split(',')) <= ArraySize
:
4179 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4182 EdkLogger
.error("build", AUTOGEN_ERROR
,
4183 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4185 PcdItem
= '%s.%s|%s|0x%X' % \
4186 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4188 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4189 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4191 PcdItem
= PcdComments
+ '\n ' + PcdItem
4192 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4195 for Pcd
in Pcds
+ VfrPcds
:
4200 TokenCName
= Pcd
.TokenCName
4201 for PcdItem
in GlobalData
.MixedPcd
:
4202 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4203 TokenCName
= PcdItem
[0]
4205 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4206 for SkuName
in Pcd
.SkuInfoList
:
4207 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4208 SkuId
= SkuInfo
.SkuId
4209 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4213 # Don't generate duplicated HII PCD
4215 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4218 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4219 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4220 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4224 for Index
, Comment
in enumerate(PcdCommentList
):
4225 for Usage
in UsageList
:
4226 if Comment
.find(Usage
) != -1:
4230 if UsageIndex
!= -1:
4231 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4233 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4234 PcdComments
= '\n '.join(PcdCommentList
)
4235 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4237 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4238 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4239 for Item
in self
.BuildOption
:
4240 if 'FLAGS' in self
.BuildOption
[Item
]:
4241 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4243 # Generated LibraryClasses section in comments.
4244 for Library
in self
.LibraryAutoGenList
:
4245 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4247 # Generated UserExtensions TianoCore section.
4248 # All tianocore user extensions are copied.
4250 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4251 UserExtStr
+= '\n'.join(TianoCore
)
4252 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4253 if os
.path
.isfile(ExtensionFile
):
4254 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4255 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4257 # Generated depex expression section in comments.
4258 AsBuiltInfDict
['depexsection_item'] = ''
4259 DepexExpresion
= self
._GetDepexExpresionString
()
4261 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4263 AsBuiltInf
= TemplateString()
4264 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4266 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4268 self
.IsAsBuiltInfCreated
= True
4269 if GlobalData
.gBinCacheDest
:
4270 self
.CopyModuleToCache()
4272 def CopyModuleToCache(self
):
4273 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4274 CreateDirectory (FileDir
)
4275 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4276 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4277 if os
.path
.exists(HashFile
):
4278 shutil
.copy2(HashFile
, FileDir
)
4279 if os
.path
.exists(ModuleFile
):
4280 shutil
.copy2(ModuleFile
, FileDir
)
4281 if not self
.OutputFile
:
4282 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4283 self
.OutputFile
= Ma
.Binaries
4285 for File
in self
.OutputFile
:
4287 if not os
.path
.isabs(File
):
4288 File
= os
.path
.join(self
.OutputDir
, File
)
4289 if os
.path
.exists(File
):
4290 shutil
.copy2(File
, FileDir
)
4292 def AttemptModuleCacheCopy(self
):
4293 if self
.IsBinaryModule
:
4295 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4296 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4297 if os
.path
.exists(HashFile
):
4298 f
= open(HashFile
, 'r')
4299 CacheHash
= f
.read()
4301 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4302 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4303 for root
, dir, files
in os
.walk(FileDir
):
4305 if self
.Name
+ '.hash' in f
:
4306 shutil
.copy2(HashFile
, self
.BuildDir
)
4308 File
= path
.join(root
, f
)
4309 shutil
.copy2(File
, self
.OutputDir
)
4310 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4311 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4315 ## Create makefile for the module and its dependent libraries
4317 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4318 # dependent libraries will be created
4320 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4321 # Ignore generating makefile when it is a binary module
4322 if self
.IsBinaryModule
:
4325 if self
.IsMakeFileCreated
:
4327 self
.GenFfsList
= GenFfsList
4328 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4329 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4330 LibraryAutoGen
.CreateMakeFile()
4335 if len(self
.CustomMakefile
) == 0:
4336 Makefile
= GenMake
.ModuleMakefile(self
)
4338 Makefile
= GenMake
.CustomMakefile(self
)
4339 if Makefile
.Generate():
4340 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4341 (self
.Name
, self
.Arch
))
4343 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4344 (self
.Name
, self
.Arch
))
4346 self
.CreateTimeStamp(Makefile
)
4347 self
.IsMakeFileCreated
= True
4349 def CopyBinaryFiles(self
):
4350 for File
in self
.Module
.Binaries
:
4352 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4353 CopyLongFilePath(SrcPath
, DstPath
)
4354 ## Create autogen code for the module and its dependent libraries
4356 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4357 # dependent libraries will be created
4359 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4360 if self
.IsCodeFileCreated
:
4363 # Need to generate PcdDatabase even PcdDriver is binarymodule
4364 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4365 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4367 if self
.IsBinaryModule
:
4369 self
.CopyBinaryFiles()
4372 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4373 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4374 LibraryAutoGen
.CreateCodeFile()
4380 IgoredAutoGenList
= []
4382 for File
in self
.AutoGenFileList
:
4383 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4384 #Ignore Edk AutoGen.c
4385 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4388 AutoGenList
.append(str(File
))
4390 IgoredAutoGenList
.append(str(File
))
4392 # Skip the following code for EDK I inf
4393 if self
.AutoGenVersion
< 0x00010005:
4396 for ModuleType
in self
.DepexList
:
4397 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4398 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4401 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4402 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4404 if len(Dpx
.PostfixNotation
) <> 0:
4405 self
.DepexGenerated
= True
4407 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4408 AutoGenList
.append(str(DpxFile
))
4410 IgoredAutoGenList
.append(str(DpxFile
))
4412 if IgoredAutoGenList
== []:
4413 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4414 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4415 elif AutoGenList
== []:
4416 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4417 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4419 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4420 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4422 self
.IsCodeFileCreated
= True
4425 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4426 def _GetLibraryAutoGenList(self
):
4427 if self
._LibraryAutoGenList
is None:
4428 self
._LibraryAutoGenList
= []
4429 for Library
in self
.DependentLibraryList
:
4436 self
.PlatformInfo
.MetaFile
4438 if La
not in self
._LibraryAutoGenList
:
4439 self
._LibraryAutoGenList
.append(La
)
4440 for Lib
in La
.CodaTargetList
:
4441 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4442 return self
._LibraryAutoGenList
4444 def GenModuleHash(self
):
4445 if self
.Arch
not in GlobalData
.gModuleHash
:
4446 GlobalData
.gModuleHash
[self
.Arch
] = {}
4448 # Add Platform level hash
4449 m
.update(GlobalData
.gPlatformHash
)
4450 # Add Package level hash
4451 if self
.DependentPackageList
:
4452 for Pkg
in self
.DependentPackageList
:
4453 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4454 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4457 if self
.LibraryAutoGenList
:
4458 for Lib
in self
.LibraryAutoGenList
:
4459 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4461 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4464 f
= open(str(self
.MetaFile
), 'r')
4468 # Add Module's source files
4469 if self
.SourceFileList
:
4470 for File
in self
.SourceFileList
:
4471 f
= open(str(File
), 'r')
4476 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4477 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4478 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4479 if GlobalData
.gBinCacheSource
:
4480 CacheValid
= self
.AttemptModuleCacheCopy()
4483 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4485 ## Decide whether we can skip the ModuleAutoGen process
4486 def CanSkipbyHash(self
):
4487 if GlobalData
.gUseHashCache
:
4488 return not self
.GenModuleHash()
4490 ## Decide whether we can skip the ModuleAutoGen process
4491 # If any source file is newer than the module than we cannot skip
4494 if not os
.path
.exists(self
.GetTimeStampPath()):
4496 #last creation time of the module
4497 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4499 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4500 if SrcTimeStamp
> DstTimeStamp
:
4503 with
open(self
.GetTimeStampPath(),'r') as f
:
4505 source
= source
.rstrip('\n')
4506 if not os
.path
.exists(source
):
4508 if source
not in ModuleAutoGen
.TimeDict
:
4509 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4510 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4514 def GetTimeStampPath(self
):
4515 if self
._TimeStampPath
is None:
4516 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4517 return self
._TimeStampPath
4518 def CreateTimeStamp(self
, Makefile
):
4522 FileSet
.add (self
.MetaFile
.Path
)
4524 for SourceFile
in self
.Module
.Sources
:
4525 FileSet
.add (SourceFile
.Path
)
4527 for Lib
in self
.DependentLibraryList
:
4528 FileSet
.add (Lib
.MetaFile
.Path
)
4530 for f
in self
.AutoGenDepSet
:
4531 FileSet
.add (f
.Path
)
4533 if os
.path
.exists (self
.GetTimeStampPath()):
4534 os
.remove (self
.GetTimeStampPath())
4535 with
open(self
.GetTimeStampPath(), 'w+') as file:
4539 Module
= property(_GetModule
)
4540 Name
= property(_GetBaseName
)
4541 Guid
= property(_GetGuid
)
4542 Version
= property(_GetVersion
)
4543 ModuleType
= property(_GetModuleType
)
4544 ComponentType
= property(_GetComponentType
)
4545 BuildType
= property(_GetBuildType
)
4546 PcdIsDriver
= property(_GetPcdIsDriver
)
4547 AutoGenVersion
= property(_GetAutoGenVersion
)
4548 Macros
= property(_GetMacros
)
4549 Specification
= property(_GetSpecification
)
4551 IsLibrary
= property(_IsLibrary
)
4552 IsBinaryModule
= property(_IsBinaryModule
)
4553 BuildDir
= property(_GetBuildDir
)
4554 OutputDir
= property(_GetOutputDir
)
4555 FfsOutputDir
= property(_GetFfsOutputDir
)
4556 DebugDir
= property(_GetDebugDir
)
4557 MakeFileDir
= property(_GetMakeFileDir
)
4558 CustomMakefile
= property(_GetCustomMakefile
)
4560 IncludePathList
= property(_GetIncludePathList
)
4561 IncludePathLength
= property(_GetIncludePathLength
)
4562 AutoGenFileList
= property(_GetAutoGenFileList
)
4563 UnicodeFileList
= property(_GetUnicodeFileList
)
4564 VfrFileList
= property(_GetVfrFileList
)
4565 SourceFileList
= property(_GetSourceFileList
)
4566 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4567 Targets
= property(_GetTargets
)
4568 IntroTargetList
= property(_GetIntroTargetList
)
4569 CodaTargetList
= property(_GetFinalTargetList
)
4570 FileTypes
= property(_GetFileTypes
)
4571 BuildRules
= property(_GetBuildRules
)
4572 IdfFileList
= property(_GetIdfFileList
)
4574 DependentPackageList
= property(_GetDependentPackageList
)
4575 DependentLibraryList
= property(_GetLibraryList
)
4576 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4577 DerivedPackageList
= property(_GetDerivedPackageList
)
4579 ModulePcdList
= property(_GetModulePcdList
)
4580 LibraryPcdList
= property(_GetLibraryPcdList
)
4581 GuidList
= property(_GetGuidList
)
4582 ProtocolList
= property(_GetProtocolList
)
4583 PpiList
= property(_GetPpiList
)
4584 DepexList
= property(_GetDepexTokenList
)
4585 DxsFile
= property(_GetDxsFile
)
4586 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4587 BuildOption
= property(_GetModuleBuildOption
)
4588 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4589 BuildCommand
= property(_GetBuildCommand
)
4591 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4593 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4594 if __name__
== '__main__':