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
49 ## Regular expression for splitting Dependency Expression string into tokens
50 gDepexTokenPattern
= re
.compile("(\(|\)|\w+| \S+\.inf)")
53 # Match name = variable
55 gEfiVarStoreNamePattern
= re
.compile("\s*name\s*=\s*(\w+)")
57 # The format of guid in efivarstore statement likes following and must be correct:
58 # guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}
60 gEfiVarStoreGuidPattern
= re
.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")
62 ## Mapping Makefile type
63 gMakeTypeMap
= {"MSFT":"nmake", "GCC":"gmake"}
66 ## Build rule configuration file
67 gDefaultBuildRuleFile
= 'build_rule.txt'
69 ## Tools definition configuration file
70 gDefaultToolsDefFile
= 'tools_def.txt'
72 ## Build rule default version
73 AutoGenReqBuildRuleVerNum
= "0.1"
75 ## default file name for AutoGen
76 gAutoGenCodeFileName
= "AutoGen.c"
77 gAutoGenHeaderFileName
= "AutoGen.h"
78 gAutoGenStringFileName
= "%(module_name)sStrDefs.h"
79 gAutoGenStringFormFileName
= "%(module_name)sStrDefs.hpk"
80 gAutoGenDepexFileName
= "%(module_name)s.depex"
81 gAutoGenImageDefFileName
= "%(module_name)sImgDefs.h"
82 gAutoGenIdfFileName
= "%(module_name)sIdf.hpk"
83 gInfSpecVersion
= "0x00010017"
86 # Template string to generic AsBuilt INF
88 gAsBuiltInfHeaderString
= TemplateString("""${header_comments}
94 INF_VERSION = ${module_inf_version}
95 BASE_NAME = ${module_name}
96 FILE_GUID = ${module_guid}
97 MODULE_TYPE = ${module_module_type}${BEGIN}
98 VERSION_STRING = ${module_version_string}${END}${BEGIN}
99 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}
100 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}
101 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}
102 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}
103 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}
104 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}
105 DESTRUCTOR = ${module_destructor}${END}${BEGIN}
106 SHADOW = ${module_shadow}${END}${BEGIN}
107 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}
108 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}
109 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}
110 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}
111 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}
112 SPEC = ${module_spec}${END}${BEGIN}
113 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}
114 MODULE_UNI_FILE = ${module_uni_file}${END}
116 [Packages.${module_arch}]${BEGIN}
117 ${package_item}${END}
119 [Binaries.${module_arch}]${BEGIN}
122 [PatchPcd.${module_arch}]${BEGIN}
126 [Protocols.${module_arch}]${BEGIN}
130 [Ppis.${module_arch}]${BEGIN}
134 [Guids.${module_arch}]${BEGIN}
138 [PcdEx.${module_arch}]${BEGIN}
142 [LibraryClasses.${module_arch}]
143 ## @LIB_INSTANCES${BEGIN}
144 # ${libraryclasses_item}${END}
148 ${userextension_tianocore_item}
152 [BuildOptions.${module_arch}]
154 ## ${flags_item}${END}
157 ## Base class for AutoGen
159 # This class just implements the cache mechanism of AutoGen objects.
161 class AutoGen(object):
162 # database to maintain the objects of xxxAutoGen
163 _CACHE_
= {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}
167 # @param Class class object of real AutoGen class
168 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)
169 # @param Workspace Workspace directory or WorkspaceAutoGen object
170 # @param MetaFile The path of meta file
171 # @param Target Build target
172 # @param Toolchain Tool chain name
173 # @param Arch Target arch
174 # @param *args The specific class related parameters
175 # @param **kwargs The specific class related dict parameters
177 def __new__(Class
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
178 # check if the object has been created
179 Key
= (Target
, Toolchain
)
180 if Key
not in Class
._CACHE
_ or Arch
not in Class
._CACHE
_[Key
] \
181 or MetaFile
not in Class
._CACHE
_[Key
][Arch
]:
182 AutoGenObject
= super(AutoGen
, Class
).__new
__(Class
)
183 # call real constructor
184 if not AutoGenObject
._Init
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
186 if Key
not in Class
._CACHE
_:
187 Class
._CACHE
_[Key
] = {}
188 if Arch
not in Class
._CACHE
_[Key
]:
189 Class
._CACHE
_[Key
][Arch
] = {}
190 Class
._CACHE
_[Key
][Arch
][MetaFile
] = AutoGenObject
192 AutoGenObject
= Class
._CACHE
_[Key
][Arch
][MetaFile
]
198 # The file path of platform file will be used to represent hash value of this object
200 # @retval int Hash value of the file path of platform file
203 return hash(self
.MetaFile
)
207 # The file path of platform file will be used to represent this object
209 # @retval string String of platform file path
212 return str(self
.MetaFile
)
215 def __eq__(self
, Other
):
216 return Other
and self
.MetaFile
== Other
218 ## Workspace AutoGen class
220 # This class is used mainly to control the whole platform build for different
221 # architecture. This class will generate top level makefile.
223 class WorkspaceAutoGen(AutoGen
):
224 ## Real constructor of WorkspaceAutoGen
226 # This method behaves the same as __init__ except that it needs explicit invoke
227 # (in super class's __new__ method)
229 # @param WorkspaceDir Root directory of workspace
230 # @param ActivePlatform Meta-file of active platform
231 # @param Target Build target
232 # @param Toolchain Tool chain name
233 # @param ArchList List of architecture of current build
234 # @param MetaFileDb Database containing meta-files
235 # @param BuildConfig Configuration of build
236 # @param ToolDefinition Tool chain definitions
237 # @param FlashDefinitionFile File of flash definition
238 # @param Fds FD list to be generated
239 # @param Fvs FV list to be generated
240 # @param Caps Capsule list to be generated
241 # @param SkuId SKU id from command line
243 def _Init(self
, WorkspaceDir
, ActivePlatform
, Target
, Toolchain
, ArchList
, MetaFileDb
,
244 BuildConfig
, ToolDefinition
, FlashDefinitionFile
='', Fds
=None, Fvs
=None, Caps
=None, SkuId
='', UniFlag
=None,
245 Progress
=None, BuildModule
=None):
252 self
.BuildDatabase
= MetaFileDb
253 self
.MetaFile
= ActivePlatform
254 self
.WorkspaceDir
= WorkspaceDir
255 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, 'COMMON', Target
, Toolchain
]
256 GlobalData
.gActivePlatform
= self
.Platform
257 self
.BuildTarget
= Target
258 self
.ToolChain
= Toolchain
259 self
.ArchList
= ArchList
261 self
.UniFlag
= UniFlag
263 self
.TargetTxt
= BuildConfig
264 self
.ToolDef
= ToolDefinition
265 self
.FdfFile
= FlashDefinitionFile
266 self
.FdTargetList
= Fds
267 self
.FvTargetList
= Fvs
268 self
.CapTargetList
= Caps
269 self
.AutoGenObjectList
= []
270 self
._BuildDir
= None
272 self
._MakeFileDir
= None
273 self
._BuildCommand
= None
276 # there's many relative directory operations, so ...
277 os
.chdir(self
.WorkspaceDir
)
282 if not self
.ArchList
:
283 ArchList
= set(self
.Platform
.SupArchList
)
285 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
287 EdkLogger
.error("build", PARAMETER_INVALID
,
288 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
289 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
290 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
291 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
292 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
293 self
.ArchList
= tuple(ArchList
)
295 # Validate build target
296 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
297 EdkLogger
.error("build", PARAMETER_INVALID
,
298 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
299 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
302 # parse FDF file to get PCDs in it, if any
304 self
.FdfFile
= self
.Platform
.FlashDefinition
308 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
309 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
310 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
312 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
314 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
317 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
319 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
322 Progress
.Start("\nProcessing meta-data")
326 # Mark now build in AutoGen Phase
328 GlobalData
.gAutoGenPhase
= True
329 Fdf
= FdfParser(self
.FdfFile
.Path
)
331 GlobalData
.gFdfParser
= Fdf
332 GlobalData
.gAutoGenPhase
= False
333 PcdSet
= Fdf
.Profile
.PcdDict
334 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
335 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
336 for FdRegion
in FdDict
.RegionList
:
337 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
338 if int(FdRegion
.Offset
) % 8 != 0:
339 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
340 ModuleList
= Fdf
.Profile
.InfList
341 self
.FdfProfile
= Fdf
.Profile
342 for fvname
in self
.FvTargetList
:
343 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
344 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
345 "No such an FV in FDF file: %s" % fvname
)
347 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
348 # but the path (self.MetaFile.Path) is the real path
349 for key
in self
.FdfProfile
.InfDict
:
353 for Arch
in self
.ArchList
:
354 Platform_cache
[Arch
] = self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
355 MetaFile_cache
[Arch
] = []
356 for Pkey
in Platform_cache
[Arch
].Modules
.keys():
357 MetaFile_cache
[Arch
].append(Platform_cache
[Arch
].Modules
[Pkey
].MetaFile
)
358 for Inf
in self
.FdfProfile
.InfDict
[key
]:
359 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
360 for Arch
in self
.ArchList
:
361 if ModuleFile
in MetaFile_cache
[Arch
]:
364 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
365 if not ModuleData
.IsBinaryModule
:
366 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
369 for Arch
in self
.ArchList
:
371 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
373 for Pkey
in Platform
.Modules
.keys():
374 MetaFileList
.append(Platform
.Modules
[Pkey
].MetaFile
)
375 for Inf
in self
.FdfProfile
.InfDict
[key
]:
376 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
377 if ModuleFile
in MetaFileList
:
379 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
380 if not ModuleData
.IsBinaryModule
:
381 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
386 self
.FdfProfile
= None
387 if self
.FdTargetList
:
388 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
389 self
.FdTargetList
= []
390 if self
.FvTargetList
:
391 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
392 self
.FvTargetList
= []
393 if self
.CapTargetList
:
394 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
395 self
.CapTargetList
= []
397 # apply SKU and inject PCDs from Flash Definition file
398 for Arch
in self
.ArchList
:
399 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
406 SourcePcdDict
= {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}
407 BinaryPcdDict
= {'DynamicEx':[], 'PatchableInModule':[]}
408 SourcePcdDict_Keys
= SourcePcdDict
.keys()
409 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
411 # generate the SourcePcdDict and BinaryPcdDict
412 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
413 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
414 if BuildData
.Arch
!= Arch
:
416 if BuildData
.MetaFile
.Ext
== '.inf':
417 for key
in BuildData
.Pcds
:
418 if BuildData
.Pcds
[key
].Pending
:
419 if key
in Platform
.Pcds
:
420 PcdInPlatform
= Platform
.Pcds
[key
]
421 if PcdInPlatform
.Type
not in [None, '']:
422 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
424 if BuildData
.MetaFile
in Platform
.Modules
:
425 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
426 if key
in PlatformModule
.Pcds
:
427 PcdInPlatform
= PlatformModule
.Pcds
[key
]
428 if PcdInPlatform
.Type
not in [None, '']:
429 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
431 if 'DynamicEx' in BuildData
.Pcds
[key
].Type
:
432 if BuildData
.IsBinaryModule
:
433 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in BinaryPcdDict
['DynamicEx']:
434 BinaryPcdDict
['DynamicEx'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
436 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['DynamicEx']:
437 SourcePcdDict
['DynamicEx'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
439 elif 'PatchableInModule' in BuildData
.Pcds
[key
].Type
:
440 if BuildData
.MetaFile
.Ext
== '.inf':
441 if BuildData
.IsBinaryModule
:
442 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in BinaryPcdDict
['PatchableInModule']:
443 BinaryPcdDict
['PatchableInModule'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
445 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['PatchableInModule']:
446 SourcePcdDict
['PatchableInModule'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
448 elif 'Dynamic' in BuildData
.Pcds
[key
].Type
:
449 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['Dynamic']:
450 SourcePcdDict
['Dynamic'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
451 elif 'FixedAtBuild' in BuildData
.Pcds
[key
].Type
:
452 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['FixedAtBuild']:
453 SourcePcdDict
['FixedAtBuild'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
457 # A PCD can only use one type for all source modules
459 for i
in SourcePcdDict_Keys
:
460 for j
in SourcePcdDict_Keys
:
462 IntersectionList
= list(set(SourcePcdDict
[i
]).intersection(set(SourcePcdDict
[j
])))
463 if len(IntersectionList
) > 0:
467 "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
),
468 ExtraData
="%s" % '\n\t'.join([str(P
[1]+'.'+P
[0]) for P
in IntersectionList
])
474 # intersection the BinaryPCD for Mixed PCD
476 for i
in BinaryPcdDict_Keys
:
477 for j
in BinaryPcdDict_Keys
:
479 IntersectionList
= list(set(BinaryPcdDict
[i
]).intersection(set(BinaryPcdDict
[j
])))
480 for item
in IntersectionList
:
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
)
494 # intersection the SourcePCD and BinaryPCD for Mixed PCD
496 for i
in SourcePcdDict_Keys
:
497 for j
in BinaryPcdDict_Keys
:
499 IntersectionList
= list(set(SourcePcdDict
[i
]).intersection(set(BinaryPcdDict
[j
])))
500 for item
in IntersectionList
:
501 NewPcd1
= (item
[0] + '_' + i
, item
[1])
502 NewPcd2
= (item
[0] + '_' + j
, item
[1])
503 if item
not in GlobalData
.MixedPcd
:
504 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
506 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
507 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
508 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
509 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
513 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
514 if BuildData
.Arch
!= Arch
:
516 for key
in BuildData
.Pcds
:
517 for SinglePcd
in GlobalData
.MixedPcd
:
518 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
519 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
520 Pcd_Type
= item
[0].split('_')[-1]
521 if (Pcd_Type
== BuildData
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
522 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
523 Value
= BuildData
.Pcds
[key
]
524 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
526 newkey
= (Value
.TokenCName
, key
[1])
528 newkey
= (Value
.TokenCName
, key
[1], key
[2])
529 del BuildData
.Pcds
[key
]
530 BuildData
.Pcds
[newkey
] = Value
538 # handle the mixed pcd in FDF file
540 if key
in GlobalData
.MixedPcd
:
543 for item
in GlobalData
.MixedPcd
[key
]:
546 #Collect package set information from INF of FDF
548 for Inf
in ModuleList
:
549 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
550 if ModuleFile
in Platform
.Modules
:
552 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
553 PkgSet
.update(ModuleData
.Packages
)
554 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
559 DecPcds
[Pcd
[0], Pcd
[1]] = Pkg
.Pcds
[Pcd
]
560 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
562 Platform
.SkuName
= self
.SkuId
563 for Name
, Guid
in PcdSet
:
564 if (Name
, Guid
) not in DecPcds
:
568 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
569 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
570 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
573 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
574 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
575 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
576 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
577 Platform
.AddPcd(Name
, Guid
, PcdSet
[Name
, Guid
])
579 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
583 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
584 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
585 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
588 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
590 # Explicitly collect platform's dynamic PCDs
592 Pa
.CollectPlatformDynamicPcds()
593 Pa
.CollectFixedAtBuildPcds()
594 self
.AutoGenObjectList
.append(Pa
)
597 # Generate Package level hash value
599 GlobalData
.gPackageHash
[Arch
] = {}
600 if GlobalData
.gUseHashCache
:
602 self
._GenPkgLevelHash
(Pkg
)
605 # Check PCDs token value conflict in each DEC file.
607 self
._CheckAllPcdsTokenValueConflict
()
610 # Check PCD type and definition between DSC and DEC
612 self
._CheckPcdDefineAndType
()
615 # self._CheckDuplicateInFV(Fdf)
618 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
620 content
= 'gCommandLineDefines: '
621 content
+= str(GlobalData
.gCommandLineDefines
)
622 content
+= os
.linesep
623 content
+= 'BuildOptionPcd: '
624 content
+= str(GlobalData
.BuildOptionPcd
)
625 content
+= os
.linesep
626 content
+= 'Active Platform: '
627 content
+= str(self
.Platform
)
628 content
+= os
.linesep
630 content
+= 'Flash Image Definition: '
631 content
+= str(self
.FdfFile
)
632 content
+= os
.linesep
633 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
636 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
638 PcdTokenNumber
= 'PcdTokenNumber: '
639 if Pa
.PcdTokenNumber
:
640 if Pa
.DynamicPcdList
:
641 for Pcd
in Pa
.DynamicPcdList
:
642 PcdTokenNumber
+= os
.linesep
643 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
644 PcdTokenNumber
+= ' : '
645 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
646 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
649 # Get set of workspace metafiles
651 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
654 # Retrieve latest modified time of all metafiles
657 for f
in AllWorkSpaceMetaFiles
:
658 if os
.stat(f
)[8] > SrcTimeStamp
:
659 SrcTimeStamp
= os
.stat(f
)[8]
660 self
._SrcTimeStamp
= SrcTimeStamp
662 if GlobalData
.gUseHashCache
:
664 for files
in AllWorkSpaceMetaFiles
:
665 if files
.endswith('.dec'):
671 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
672 GlobalData
.gPlatformHash
= m
.hexdigest()
675 # Write metafile list to build directory
677 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
678 if os
.path
.exists (AutoGenFilePath
):
679 os
.remove(AutoGenFilePath
)
680 if not os
.path
.exists(self
.BuildDir
):
681 os
.makedirs(self
.BuildDir
)
682 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
683 for f
in AllWorkSpaceMetaFiles
:
687 def _GenPkgLevelHash(self
, Pkg
):
688 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
689 CreateDirectory(PkgDir
)
690 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
692 # Get .dec file's hash value
693 f
= open(Pkg
.MetaFile
.Path
, 'r')
697 # Get include files hash value
699 for inc
in Pkg
.Includes
:
700 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
702 File_Path
= os
.path
.join(Root
, File
)
703 f
= open(File_Path
, 'r')
707 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
708 if Pkg
.PackageName
not in GlobalData
.gPackageHash
[Pkg
.Arch
]:
709 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
711 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
712 AllWorkSpaceMetaFiles
= set()
717 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
719 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
721 AllWorkSpaceMetaFiles
.add (f
.FileName
)
725 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
728 # add build_rule.txt & tools_def.txt
730 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
731 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
733 # add BuildOption metafile
735 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
737 # add PcdToken Number file for Dynamic/DynamicEx Pcd
739 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
741 for Arch
in self
.ArchList
:
742 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
743 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
748 for Package
in PGen
.PackageList
:
749 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
754 for filePath
in Platform
._RawData
.IncludedFiles
:
755 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
757 return AllWorkSpaceMetaFiles
759 ## _CheckDuplicateInFV() method
761 # Check whether there is duplicate modules/files exist in FV section.
762 # The check base on the file GUID;
764 def _CheckDuplicateInFV(self
, Fdf
):
765 for Fv
in Fdf
.Profile
.FvDict
:
767 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
768 if FfsFile
.InfFileName
and FfsFile
.NameGuid
== None:
773 for Pa
in self
.AutoGenObjectList
:
776 for Module
in Pa
.ModuleAutoGenList
:
777 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
779 if not Module
.Guid
.upper() in _GuidDict
.keys():
780 _GuidDict
[Module
.Guid
.upper()] = FfsFile
783 EdkLogger
.error("build",
785 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
786 FfsFile
.CurrentLineContent
,
787 _GuidDict
[Module
.Guid
.upper()].CurrentLineNum
,
788 _GuidDict
[Module
.Guid
.upper()].CurrentLineContent
,
789 Module
.Guid
.upper()),
790 ExtraData
=self
.FdfFile
)
792 # Some INF files not have entity in DSC file.
795 if FfsFile
.InfFileName
.find('$') == -1:
796 InfPath
= NormPath(FfsFile
.InfFileName
)
797 if not os
.path
.exists(InfPath
):
798 EdkLogger
.error('build', GENFDS_ERROR
, "Non-existant Module %s !" % (FfsFile
.InfFileName
))
800 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
802 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
803 # BuildObject from one of AutoGenObjectList is enough.
805 InfObj
= self
.AutoGenObjectList
[0].BuildDatabase
.WorkspaceDb
.BuildObject
[PathClassObj
, 'COMMON', self
.BuildTarget
, self
.ToolChain
]
806 if not InfObj
.Guid
.upper() in _GuidDict
.keys():
807 _GuidDict
[InfObj
.Guid
.upper()] = FfsFile
809 EdkLogger
.error("build",
811 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
812 FfsFile
.CurrentLineContent
,
813 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineNum
,
814 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineContent
,
815 InfObj
.Guid
.upper()),
816 ExtraData
=self
.FdfFile
)
819 if FfsFile
.NameGuid
!= None:
820 _CheckPCDAsGuidPattern
= re
.compile("^PCD\(.+\..+\)$")
823 # If the NameGuid reference a PCD name.
824 # The style must match: PCD(xxxx.yyy)
826 if _CheckPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
828 # Replace the PCD value.
830 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
832 for Pa
in self
.AutoGenObjectList
:
834 for PcdItem
in Pa
.AllPcdList
:
835 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
837 # First convert from CFormatGuid to GUID string
839 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
841 if not _PcdGuidString
:
843 # Then try Byte array.
845 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
847 if not _PcdGuidString
:
849 # Not Byte array or CFormat GUID, raise error.
851 EdkLogger
.error("build",
853 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
854 ExtraData
=self
.FdfFile
)
856 if not _PcdGuidString
.upper() in _GuidDict
.keys():
857 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
861 EdkLogger
.error("build",
863 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
864 FfsFile
.CurrentLineContent
,
865 _GuidDict
[_PcdGuidString
.upper()].CurrentLineNum
,
866 _GuidDict
[_PcdGuidString
.upper()].CurrentLineContent
,
867 FfsFile
.NameGuid
.upper()),
868 ExtraData
=self
.FdfFile
)
870 if not FfsFile
.NameGuid
.upper() in _GuidDict
.keys():
871 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
874 # Two raw file GUID conflict.
876 EdkLogger
.error("build",
878 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
879 FfsFile
.CurrentLineContent
,
880 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineNum
,
881 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineContent
,
882 FfsFile
.NameGuid
.upper()),
883 ExtraData
=self
.FdfFile
)
886 def _CheckPcdDefineAndType(self
):
888 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
889 "Dynamic", #"DynamicHii", "DynamicVpd",
890 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
893 # This dict store PCDs which are not used by any modules with specified arches
895 for Pa
in self
.AutoGenObjectList
:
896 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
897 for Pcd
in Pa
.Platform
.Pcds
:
898 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
900 # If no PCD type, this PCD comes from FDF
904 # Try to remove Hii and Vpd suffix
905 if PcdType
.startswith("DynamicEx"):
906 PcdType
= "DynamicEx"
907 elif PcdType
.startswith("Dynamic"):
910 for Package
in Pa
.PackageList
:
911 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
912 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
914 for Type
in PcdTypeList
:
915 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
919 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
920 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
925 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
927 for Pcd
in UnusedPcd
:
930 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
931 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
932 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
937 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
939 ## Return the directory to store FV files
941 if self
._FvDir
== None:
942 self
._FvDir
= path
.join(self
.BuildDir
, 'FV')
945 ## Return the directory to store all intermediate and final files built
946 def _GetBuildDir(self
):
947 if self
._BuildDir
== None:
948 return self
.AutoGenObjectList
[0].BuildDir
950 ## Return the build output directory platform specifies
951 def _GetOutputDir(self
):
952 return self
.Platform
.OutputDirectory
954 ## Return platform name
956 return self
.Platform
.PlatformName
958 ## Return meta-file GUID
960 return self
.Platform
.Guid
962 ## Return platform version
963 def _GetVersion(self
):
964 return self
.Platform
.Version
966 ## Return paths of tools
967 def _GetToolDefinition(self
):
968 return self
.AutoGenObjectList
[0].ToolDefinition
970 ## Return directory of platform makefile
972 # @retval string Makefile directory
974 def _GetMakeFileDir(self
):
975 if self
._MakeFileDir
== None:
976 self
._MakeFileDir
= self
.BuildDir
977 return self
._MakeFileDir
979 ## Return build command string
981 # @retval string Build command string
983 def _GetBuildCommand(self
):
984 if self
._BuildCommand
== None:
985 # BuildCommand should be all the same. So just get one from platform AutoGen
986 self
._BuildCommand
= self
.AutoGenObjectList
[0].BuildCommand
987 return self
._BuildCommand
989 ## Check the PCDs token value conflict in each DEC file.
991 # Will cause build break and raise error message while two PCDs conflict.
995 def _CheckAllPcdsTokenValueConflict(self
):
996 for Pa
in self
.AutoGenObjectList
:
997 for Package
in Pa
.PackageList
:
998 PcdList
= Package
.Pcds
.values()
999 PcdList
.sort(lambda x
, y
: cmp(int(x
.TokenValue
, 0), int(y
.TokenValue
, 0)))
1001 while (Count
< len(PcdList
) - 1) :
1002 Item
= PcdList
[Count
]
1003 ItemNext
= PcdList
[Count
+ 1]
1005 # Make sure in the same token space the TokenValue should be unique
1007 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
1008 SameTokenValuePcdList
= []
1009 SameTokenValuePcdList
.append(Item
)
1010 SameTokenValuePcdList
.append(ItemNext
)
1011 RemainPcdListLength
= len(PcdList
) - Count
- 2
1012 for ValueSameCount
in range(RemainPcdListLength
):
1013 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
1014 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
1018 # Sort same token value PCD list with TokenGuid and TokenCName
1020 SameTokenValuePcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1021 SameTokenValuePcdListCount
= 0
1022 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
1024 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1025 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
1027 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
1028 for PcdItem
in GlobalData
.MixedPcd
:
1029 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
1030 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1036 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1037 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
1040 SameTokenValuePcdListCount
+= 1
1041 Count
+= SameTokenValuePcdListCount
1044 PcdList
= Package
.Pcds
.values()
1045 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1047 while (Count
< len(PcdList
) - 1) :
1048 Item
= PcdList
[Count
]
1049 ItemNext
= PcdList
[Count
+ 1]
1051 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1053 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
1057 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1058 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
1062 ## Generate fds command
1063 def _GenFdsCommand(self
):
1064 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1066 ## Create makefile for the platform and modules in it
1068 # @param CreateDepsMakeFile Flag indicating if the makefile for
1069 # modules will be created as well
1071 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1072 if CreateDepsMakeFile
:
1073 for Pa
in self
.AutoGenObjectList
:
1074 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1076 ## Create autogen code for platform and modules
1078 # Since there's no autogen code for platform, this method will do nothing
1079 # if CreateModuleCodeFile is set to False.
1081 # @param CreateDepsCodeFile Flag indicating if creating module's
1082 # autogen code file or not
1084 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1085 if not CreateDepsCodeFile
:
1087 for Pa
in self
.AutoGenObjectList
:
1088 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1090 ## Create AsBuilt INF file the platform
1092 def CreateAsBuiltInf(self
):
1095 Name
= property(_GetName
)
1096 Guid
= property(_GetGuid
)
1097 Version
= property(_GetVersion
)
1098 OutputDir
= property(_GetOutputDir
)
1100 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1102 BuildDir
= property(_GetBuildDir
)
1103 FvDir
= property(_GetFvDir
)
1104 MakeFileDir
= property(_GetMakeFileDir
)
1105 BuildCommand
= property(_GetBuildCommand
)
1106 GenFdsCommand
= property(_GenFdsCommand
)
1108 ## AutoGen class for platform
1110 # PlatformAutoGen class will process the original information in platform
1111 # file in order to generate makefile for platform.
1113 class PlatformAutoGen(AutoGen
):
1115 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1116 # correct PCD database
1119 _NonDynaPcdList_
= []
1123 # The priority list while override build option
1125 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1126 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1127 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1128 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1129 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1130 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1131 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1132 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1133 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1134 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1135 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1136 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1137 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1138 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1139 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1140 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1142 ## The real constructor of PlatformAutoGen
1144 # This method is not supposed to be called by users of PlatformAutoGen. It's
1145 # only used by factory method __new__() to do real initialization work for an
1146 # object of PlatformAutoGen
1148 # @param Workspace WorkspaceAutoGen object
1149 # @param PlatformFile Platform file (DSC file)
1150 # @param Target Build target (DEBUG, RELEASE)
1151 # @param Toolchain Name of tool chain
1152 # @param Arch arch of the platform supports
1154 def _Init(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1155 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1156 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1158 self
.MetaFile
= PlatformFile
1159 self
.Workspace
= Workspace
1160 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1161 self
.ToolChain
= Toolchain
1162 self
.BuildTarget
= Target
1164 self
.SourceDir
= PlatformFile
.SubDir
1165 self
.SourceOverrideDir
= None
1166 self
.FdTargetList
= self
.Workspace
.FdTargetList
1167 self
.FvTargetList
= self
.Workspace
.FvTargetList
1168 self
.AllPcdList
= []
1169 # get the original module/package/platform objects
1170 self
.BuildDatabase
= Workspace
.BuildDatabase
1171 self
.DscBuildDataObj
= Workspace
.Platform
1172 self
._GuidDict
= Workspace
._GuidDict
1174 # flag indicating if the makefile/C-code file has been created or not
1175 self
.IsMakeFileCreated
= False
1176 self
.IsCodeFileCreated
= False
1178 self
._Platform
= None
1181 self
._Version
= None
1183 self
._BuildRule
= None
1184 self
._SourceDir
= None
1185 self
._BuildDir
= None
1186 self
._OutputDir
= None
1188 self
._MakeFileDir
= None
1189 self
._FdfFile
= None
1191 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1192 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1193 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1194 self
._NonDynamicPcdDict
= {}
1196 self
._ToolDefinitions
= None
1197 self
._ToolDefFile
= None # toolcode : tool path
1198 self
._ToolChainFamily
= None
1199 self
._BuildRuleFamily
= None
1200 self
._BuildOption
= None # toolcode : option
1201 self
._EdkBuildOption
= None # edktoolcode : option
1202 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1203 self
._PackageList
= None
1204 self
._ModuleAutoGenList
= None
1205 self
._LibraryAutoGenList
= None
1206 self
._BuildCommand
= None
1207 self
._AsBuildInfList
= []
1208 self
._AsBuildModuleList
= []
1210 self
.VariableInfo
= None
1212 if GlobalData
.gFdfParser
!= None:
1213 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1214 for Inf
in self
._AsBuildInfList
:
1215 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1216 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1217 if not M
.IsSupportedArch
:
1219 self
._AsBuildModuleList
.append(InfClass
)
1220 # get library/modules for build
1221 self
.LibraryBuildDirectoryList
= []
1222 self
.ModuleBuildDirectoryList
= []
1227 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1229 ## Create autogen code for platform and modules
1231 # Since there's no autogen code for platform, this method will do nothing
1232 # if CreateModuleCodeFile is set to False.
1234 # @param CreateModuleCodeFile Flag indicating if creating module's
1235 # autogen code file or not
1237 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1238 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1239 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1242 for Ma
in self
.ModuleAutoGenList
:
1243 Ma
.CreateCodeFile(True)
1245 # don't do this twice
1246 self
.IsCodeFileCreated
= True
1248 ## Generate Fds Command
1249 def _GenFdsCommand(self
):
1250 return self
.Workspace
.GenFdsCommand
1252 ## Create makefile for the platform and mdoules in it
1254 # @param CreateModuleMakeFile Flag indicating if the makefile for
1255 # modules will be created as well
1257 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1258 if CreateModuleMakeFile
:
1259 for ModuleFile
in self
.Platform
.Modules
:
1260 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1261 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1262 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1263 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1265 Ma
.CreateMakeFile(True)
1266 #Ma.CreateAsBuiltInf()
1268 # no need to create makefile for the platform more than once
1269 if self
.IsMakeFileCreated
:
1272 # create library/module build dirs for platform
1273 Makefile
= GenMake
.PlatformMakefile(self
)
1274 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1275 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1277 self
.IsMakeFileCreated
= True
1279 ## Deal with Shared FixedAtBuild Pcds
1281 def CollectFixedAtBuildPcds(self
):
1282 for LibAuto
in self
.LibraryAutoGenList
:
1283 FixedAtBuildPcds
= {}
1284 ShareFixedAtBuildPcdsSameValue
= {}
1285 for Module
in LibAuto
._ReferenceModules
:
1286 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1287 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1288 if key
not in FixedAtBuildPcds
:
1289 ShareFixedAtBuildPcdsSameValue
[key
] = True
1290 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1292 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1293 ShareFixedAtBuildPcdsSameValue
[key
] = False
1294 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1295 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1296 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1299 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1300 if DscPcd
.Type
!= "FixedAtBuild":
1302 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1303 LibAuto
.ConstPcd
[key
] = Pcd
.DefaultValue
1305 def CollectVariables(self
, DynamicPcdSet
):
1309 if self
.Workspace
.FdfFile
:
1310 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1311 for FdRegion
in FdDict
.RegionList
:
1312 for item
in FdRegion
.RegionDataList
:
1313 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1314 VpdRegionSize
= FdRegion
.Size
1315 VpdRegionBase
= FdRegion
.Offset
1319 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1320 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1321 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1323 for Pcd
in DynamicPcdSet
:
1324 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1325 for SkuName
in Pcd
.SkuInfoList
:
1326 Sku
= Pcd
.SkuInfoList
[SkuName
]
1328 if SkuId
== None or SkuId
== '':
1330 if len(Sku
.VariableName
) > 0:
1331 VariableGuidStructure
= Sku
.VariableGuidValue
1332 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1333 for StorageName
in Sku
.DefaultStoreDict
:
1334 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1338 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1339 if self
.VariableInfo
:
1340 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1341 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1343 if PcdNvStoreDfBuffer
:
1344 if os
.path
.exists(VpdMapFilePath
):
1345 OrgVpdFile
.Read(VpdMapFilePath
)
1346 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1347 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1349 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1351 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1352 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get("DEFAULT")
1353 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1354 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1356 if var_data
and default_skuobj
:
1357 default_skuobj
.DefaultValue
= var_data
1358 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1359 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1360 PcdNvStoreDfBuffer
[0].SkuInfoList
['DEFAULT'] = default_skuobj
1361 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1365 ## Collect dynamic PCDs
1367 # Gather dynamic PCDs list from each module and their settings from platform
1368 # This interface should be invoked explicitly when platform action is created.
1370 def CollectPlatformDynamicPcds(self
):
1372 for key
in self
.Platform
.Pcds
:
1373 for SinglePcd
in GlobalData
.MixedPcd
:
1374 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1375 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1376 Pcd_Type
= item
[0].split('_')[-1]
1377 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 \
1378 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1379 Value
= self
.Platform
.Pcds
[key
]
1380 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1382 newkey
= (Value
.TokenCName
, key
[1])
1384 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1385 del self
.Platform
.Pcds
[key
]
1386 self
.Platform
.Pcds
[newkey
] = Value
1394 # for gathering error information
1395 NoDatumTypePcdList
= set()
1397 self
._GuidValue
= {}
1399 for InfName
in self
._AsBuildInfList
:
1400 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1401 FdfModuleList
.append(os
.path
.normpath(InfName
))
1402 for F
in self
.Platform
.Modules
.keys():
1403 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1404 #GuidValue.update(M.Guids)
1406 self
.Platform
.Modules
[F
].M
= M
1408 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1409 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1410 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1411 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1413 # Check the PCD from Binary INF or Source INF
1414 if M
.IsBinaryModule
== True:
1415 PcdFromModule
.IsFromBinaryInf
= True
1417 # Check the PCD from DSC or not
1418 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1419 PcdFromModule
.IsFromDsc
= True
1421 PcdFromModule
.IsFromDsc
= False
1422 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1423 if F
.Path
not in FdfModuleList
:
1424 # If one of the Source built modules listed in the DSC is not listed
1425 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1426 # access method (it is only listed in the DEC file that declares the
1427 # PCD as PcdsDynamic), then build tool will report warning message
1428 # notify the PI that they are attempting to build a module that must
1429 # be included in a flash image in order to be functional. These Dynamic
1430 # PCD will not be added into the Database unless it is used by other
1431 # modules that are included in the FDF file.
1432 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1433 PcdFromModule
.IsFromBinaryInf
== False:
1434 # Print warning message to let the developer make a determine.
1435 if PcdFromModule
not in PcdNotInDb
:
1436 PcdNotInDb
.append(PcdFromModule
)
1438 # If one of the Source built modules listed in the DSC is not listed in
1439 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1440 # access method (it is only listed in the DEC file that declares the
1441 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1442 # PCD to the Platform's PCD Database.
1443 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1444 if PcdFromModule
not in PcdNotInDb
:
1445 PcdNotInDb
.append(PcdFromModule
)
1448 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1449 # it should be stored in Pcd PEI database, If a dynamic only
1450 # used by DXE module, it should be stored in DXE PCD database.
1451 # The default Phase is DXE
1453 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1454 PcdFromModule
.Phase
= "PEI"
1455 if PcdFromModule
not in self
._DynaPcdList
_:
1456 self
._DynaPcdList
_.append(PcdFromModule
)
1457 elif PcdFromModule
.Phase
== 'PEI':
1458 # overwrite any the same PCD existing, if Phase is PEI
1459 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1460 self
._DynaPcdList
_[Index
] = PcdFromModule
1461 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1462 self
._NonDynaPcdList
_.append(PcdFromModule
)
1463 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1464 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1465 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1466 #The PCD from Binary INF will override the same one from source INF
1467 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1468 PcdFromModule
.Pending
= False
1469 self
._NonDynaPcdList
_.append (PcdFromModule
)
1470 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1472 for ModuleInf
in self
.Platform
.Modules
.keys():
1473 DscModuleList
.append (os
.path
.normpath(ModuleInf
.Path
))
1474 # add the PCD from modules that listed in FDF but not in DSC to Database
1475 for InfName
in FdfModuleList
:
1476 if InfName
not in DscModuleList
:
1477 InfClass
= PathClass(InfName
)
1478 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1479 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1480 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1481 # For binary module, if in current arch, we need to list the PCDs into database.
1482 if not M
.IsSupportedArch
:
1484 # Override the module PCD setting by platform setting
1485 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1486 for PcdFromModule
in ModulePcdList
:
1487 PcdFromModule
.IsFromBinaryInf
= True
1488 PcdFromModule
.IsFromDsc
= False
1489 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1490 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1491 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1493 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1494 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1495 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1496 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1497 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1498 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1499 PcdFromModule
.Phase
= "PEI"
1500 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1501 self
._DynaPcdList
_.append(PcdFromModule
)
1502 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1503 self
._NonDynaPcdList
_.append(PcdFromModule
)
1504 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1505 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1506 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1507 # module & DXE module at a same time.
1508 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1509 # INF file as DynamicEx.
1510 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1511 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1512 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1513 for PcdFromModule
in self
._NonDynaPcdList
_:
1514 # If a PCD is not listed in the DSC file, but binary INF files used by
1515 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1516 # section, AND all source INF files used by this platform the build
1517 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1518 # section, then the tools must NOT add the PCD to the Platform's PCD
1519 # Database; the build must assign the access method for this PCD as
1520 # PcdsPatchableInModule.
1521 if PcdFromModule
not in self
._DynaPcdList
_:
1523 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1524 if PcdFromModule
.IsFromDsc
== False and \
1525 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1526 PcdFromModule
.IsFromBinaryInf
== True and \
1527 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1528 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1529 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1531 # print out error information and break the build, if error found
1532 if len(NoDatumTypePcdList
) > 0:
1533 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1534 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1536 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1537 % NoDatumTypePcdListString
)
1538 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1539 self
._DynamicPcdList
= self
._DynaPcdList
_
1541 # Sort dynamic PCD list to:
1542 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1543 # try to be put header of dynamicd List
1544 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1546 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1548 UnicodePcdArray
= set()
1550 OtherPcdArray
= set()
1552 VpdFile
= VpdInfoFile
.VpdInfoFile()
1553 NeedProcessVpdMapFile
= False
1555 for pcd
in self
.Platform
.Pcds
.keys():
1556 if pcd
not in self
._PlatformPcds
.keys():
1557 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1559 for item
in self
._PlatformPcds
:
1560 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1561 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1563 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1564 for Pcd
in self
._DynamicPcdList
:
1565 # just pick the a value to determine whether is unicode string type
1566 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1567 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1569 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1570 Pcd
.DatumType
= "VOID*"
1572 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1573 # if found HII type PCD then insert to right of UnicodeIndex
1574 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1575 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1577 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1578 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1579 if PcdNvStoreDfBuffer
:
1580 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1581 vardump
= self
.VariableInfo
.dump()
1583 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1584 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1585 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1586 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1588 PlatformPcds
= self
._PlatformPcds
.keys()
1591 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1594 for PcdKey
in PlatformPcds
:
1595 Pcd
= self
._PlatformPcds
[PcdKey
]
1596 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1597 PcdKey
in VpdPcdDict
:
1598 Pcd
= VpdPcdDict
[PcdKey
]
1600 DefaultSku
= Pcd
.SkuInfoList
.get('DEFAULT')
1602 PcdValue
= DefaultSku
.DefaultValue
1603 if PcdValue
not in SkuValueMap
:
1604 SkuValueMap
[PcdValue
] = []
1605 VpdFile
.Add(Pcd
, 'DEFAULT',DefaultSku
.VpdOffset
)
1606 SkuValueMap
[PcdValue
].append(DefaultSku
)
1608 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1609 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1610 PcdValue
= Sku
.DefaultValue
1612 PcdValue
= Pcd
.DefaultValue
1613 if Sku
.VpdOffset
!= '*':
1614 if PcdValue
.startswith("{"):
1616 elif PcdValue
.startswith("L"):
1621 VpdOffset
= int(Sku
.VpdOffset
)
1624 VpdOffset
= int(Sku
.VpdOffset
, 16)
1626 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1627 if VpdOffset
% Alignment
!= 0:
1628 if PcdValue
.startswith("{"):
1629 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1631 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1632 if PcdValue
not in SkuValueMap
:
1633 SkuValueMap
[PcdValue
] = []
1634 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1635 SkuValueMap
[PcdValue
].append(Sku
)
1636 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1637 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1638 NeedProcessVpdMapFile
= True
1639 if self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== '':
1640 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1641 "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.")
1643 VpdSkuMap
[PcdKey
] = SkuValueMap
1645 # Fix the PCDs define in VPD PCD section that never referenced by module.
1646 # An example is PCD for signature usage.
1648 for DscPcd
in PlatformPcds
:
1649 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1650 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1651 if not (self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== ''):
1653 for VpdPcd
in VpdFile
._VpdArray
.keys():
1654 # This PCD has been referenced by module
1655 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1656 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1659 # Not found, it should be signature
1661 # just pick the a value to determine whether is unicode string type
1663 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1664 DefaultSku
= DscPcdEntry
.SkuInfoList
.get('DEFAULT')
1666 defaultindex
= SkuObjList
.index(('DEFAULT',DefaultSku
))
1667 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1668 for (SkuName
,Sku
) in SkuObjList
:
1669 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1671 # Need to iterate DEC pcd information to get the value & datumtype
1672 for eachDec
in self
.PackageList
:
1673 for DecPcd
in eachDec
.Pcds
:
1674 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1675 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1676 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1677 # Print warning message to let the developer make a determine.
1678 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1679 File
=self
.MetaFile
, \
1680 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1681 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1683 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1684 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1685 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1686 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1687 # Only fix the value while no value provided in DSC file.
1688 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1689 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1691 if DscPcdEntry
not in self
._DynamicPcdList
:
1692 self
._DynamicPcdList
.append(DscPcdEntry
)
1693 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1694 PcdValue
= Sku
.DefaultValue
1696 PcdValue
= DscPcdEntry
.DefaultValue
1697 if Sku
.VpdOffset
!= '*':
1698 if PcdValue
.startswith("{"):
1700 elif PcdValue
.startswith("L"):
1705 VpdOffset
= int(Sku
.VpdOffset
)
1708 VpdOffset
= int(Sku
.VpdOffset
, 16)
1710 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1711 if VpdOffset
% Alignment
!= 0:
1712 if PcdValue
.startswith("{"):
1713 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1715 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1716 if PcdValue
not in SkuValueMap
:
1717 SkuValueMap
[PcdValue
] = []
1718 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1719 SkuValueMap
[PcdValue
].append(Sku
)
1720 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1721 NeedProcessVpdMapFile
= True
1722 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1723 UnicodePcdArray
.add(DscPcdEntry
)
1724 elif len(Sku
.VariableName
) > 0:
1725 HiiPcdArray
.add(DscPcdEntry
)
1727 OtherPcdArray
.add(DscPcdEntry
)
1729 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1730 VpdSkuMap
[DscPcd
] = SkuValueMap
1731 if (self
.Platform
.FlashDefinition
== None or self
.Platform
.FlashDefinition
== '') and \
1732 VpdFile
.GetCount() != 0:
1733 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1734 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1736 if VpdFile
.GetCount() != 0:
1738 self
.FixVpdOffset(VpdFile
)
1740 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1742 # Process VPD map file generated by third party BPDG tool
1743 if NeedProcessVpdMapFile
:
1744 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1745 if os
.path
.exists(VpdMapFilePath
):
1746 VpdFile
.Read(VpdMapFilePath
)
1749 for pcd
in VpdSkuMap
:
1750 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1752 # just pick the a value to determine whether is unicode string type
1754 for pcdvalue
in VpdSkuMap
[pcd
]:
1755 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1756 for item
in vpdinfo
:
1757 if item
[2] == pcdvalue
:
1758 sku
.VpdOffset
= item
[1]
1760 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1762 # Delete the DynamicPcdList At the last time enter into this function
1763 for Pcd
in self
._DynamicPcdList
:
1764 # just pick the a value to determine whether is unicode string type
1765 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1766 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1768 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1769 Pcd
.DatumType
= "VOID*"
1771 PcdValue
= Sku
.DefaultValue
1772 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1773 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1774 UnicodePcdArray
.add(Pcd
)
1775 elif len(Sku
.VariableName
) > 0:
1776 # if found HII type PCD then insert to right of UnicodeIndex
1777 HiiPcdArray
.add(Pcd
)
1779 OtherPcdArray
.add(Pcd
)
1780 del self
._DynamicPcdList
[:]
1781 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1782 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1783 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1784 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1785 for pcd
in self
._DynamicPcdList
:
1786 if len(pcd
.SkuInfoList
) == 1:
1787 for (SkuName
,SkuId
) in allskuset
:
1788 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1790 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
['DEFAULT'])
1791 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1792 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1794 def FixVpdOffset(self
,VpdFile
):
1795 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1796 if not os
.path
.exists(FvPath
):
1800 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1802 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1804 if VpdFile
.Write(VpdFilePath
):
1805 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1807 for ToolDef
in self
.ToolDefinition
.values():
1808 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1809 if not ToolDef
.has_key("PATH"):
1810 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1811 BPDGToolName
= ToolDef
["PATH"]
1813 # Call third party GUID BPDG tool.
1814 if BPDGToolName
!= None:
1815 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1817 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.")
1819 ## Return the platform build data object
1820 def _GetPlatform(self
):
1821 if self
._Platform
== None:
1822 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1823 return self
._Platform
1825 ## Return platform name
1827 return self
.Platform
.PlatformName
1829 ## Return the meta file GUID
1831 return self
.Platform
.Guid
1833 ## Return the platform version
1834 def _GetVersion(self
):
1835 return self
.Platform
.Version
1837 ## Return the FDF file name
1838 def _GetFdfFile(self
):
1839 if self
._FdfFile
== None:
1840 if self
.Workspace
.FdfFile
!= "":
1841 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1844 return self
._FdfFile
1846 ## Return the build output directory platform specifies
1847 def _GetOutputDir(self
):
1848 return self
.Platform
.OutputDirectory
1850 ## Return the directory to store all intermediate and final files built
1851 def _GetBuildDir(self
):
1852 if self
._BuildDir
== None:
1853 if os
.path
.isabs(self
.OutputDir
):
1854 self
._BuildDir
= path
.join(
1855 path
.abspath(self
.OutputDir
),
1856 self
.BuildTarget
+ "_" + self
.ToolChain
,
1859 self
._BuildDir
= path
.join(
1862 self
.BuildTarget
+ "_" + self
.ToolChain
,
1864 GlobalData
.gBuildDirectory
= self
._BuildDir
1865 return self
._BuildDir
1867 ## Return directory of platform makefile
1869 # @retval string Makefile directory
1871 def _GetMakeFileDir(self
):
1872 if self
._MakeFileDir
== None:
1873 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1874 return self
._MakeFileDir
1876 ## Return build command string
1878 # @retval string Build command string
1880 def _GetBuildCommand(self
):
1881 if self
._BuildCommand
== None:
1882 self
._BuildCommand
= []
1883 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1884 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1885 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1886 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1888 self
._BuildCommand
+= SplitOption(NewOption
)
1889 if "MAKE" in self
.EdkIIBuildOption
:
1890 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1891 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1892 if Flags
.startswith('='):
1893 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1895 self
._BuildCommand
+= [Flags
]
1896 return self
._BuildCommand
1898 ## Get tool chain definition
1900 # Get each tool defition for given tool chain from tools_def.txt and platform
1902 def _GetToolDefinition(self
):
1903 if self
._ToolDefinitions
== None:
1904 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1905 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1906 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1907 ExtraData
="[%s]" % self
.MetaFile
)
1908 self
._ToolDefinitions
= {}
1910 for Def
in ToolDefinition
:
1911 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1912 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1915 Value
= ToolDefinition
[Def
]
1916 # don't record the DLL
1918 DllPathList
.add(Value
)
1921 if Tool
not in self
._ToolDefinitions
:
1922 self
._ToolDefinitions
[Tool
] = {}
1923 self
._ToolDefinitions
[Tool
][Attr
] = Value
1927 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1928 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1929 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1930 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1932 for Tool
in self
._ToolDefinitions
:
1933 for Attr
in self
._ToolDefinitions
[Tool
]:
1934 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1935 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1936 # check if override is indicated
1937 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1938 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1941 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1943 Value
= self
.BuildOption
[Tool
][Attr
]
1946 # Don't put MAKE definition in the file
1950 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1952 # Don't put MAKE definition in the file
1957 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1960 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1961 for DllPath
in DllPathList
:
1962 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1963 os
.environ
["MAKE_FLAGS"] = MakeFlags
1965 return self
._ToolDefinitions
1967 ## Return the paths of tools
1968 def _GetToolDefFile(self
):
1969 if self
._ToolDefFile
== None:
1970 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1971 return self
._ToolDefFile
1973 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1974 def _GetToolChainFamily(self
):
1975 if self
._ToolChainFamily
== None:
1976 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1977 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1978 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1979 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1980 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1982 self
._ToolChainFamily
= "MSFT"
1984 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1985 return self
._ToolChainFamily
1987 def _GetBuildRuleFamily(self
):
1988 if self
._BuildRuleFamily
== None:
1989 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1990 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1991 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1992 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1993 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1995 self
._BuildRuleFamily
= "MSFT"
1997 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
1998 return self
._BuildRuleFamily
2000 ## Return the build options specific for all modules in this platform
2001 def _GetBuildOptions(self
):
2002 if self
._BuildOption
== None:
2003 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
2004 return self
._BuildOption
2006 ## Return the build options specific for EDK modules in this platform
2007 def _GetEdkBuildOptions(self
):
2008 if self
._EdkBuildOption
== None:
2009 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
2010 return self
._EdkBuildOption
2012 ## Return the build options specific for EDKII modules in this platform
2013 def _GetEdkIIBuildOptions(self
):
2014 if self
._EdkIIBuildOption
== None:
2015 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
2016 return self
._EdkIIBuildOption
2018 ## Parse build_rule.txt in Conf Directory.
2020 # @retval BuildRule object
2022 def _GetBuildRule(self
):
2023 if self
._BuildRule
== None:
2024 BuildRuleFile
= None
2025 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2026 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2027 if BuildRuleFile
in [None, '']:
2028 BuildRuleFile
= gDefaultBuildRuleFile
2029 self
._BuildRule
= BuildRule(BuildRuleFile
)
2030 if self
._BuildRule
._FileVersion
== "":
2031 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2033 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2034 # If Build Rule's version is less than the version number required by the tools, halting the build.
2035 EdkLogger
.error("build", AUTOGEN_ERROR
,
2036 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])"\
2037 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2039 return self
._BuildRule
2041 ## Summarize the packages used by modules in this platform
2042 def _GetPackageList(self
):
2043 if self
._PackageList
== None:
2044 self
._PackageList
= set()
2045 for La
in self
.LibraryAutoGenList
:
2046 self
._PackageList
.update(La
.DependentPackageList
)
2047 for Ma
in self
.ModuleAutoGenList
:
2048 self
._PackageList
.update(Ma
.DependentPackageList
)
2049 #Collect package set information from INF of FDF
2051 for ModuleFile
in self
._AsBuildModuleList
:
2052 if ModuleFile
in self
.Platform
.Modules
:
2054 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2055 PkgSet
.update(ModuleData
.Packages
)
2056 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2057 return self
._PackageList
2059 def _GetNonDynamicPcdDict(self
):
2060 if self
._NonDynamicPcdDict
:
2061 return self
._NonDynamicPcdDict
2062 for Pcd
in self
.NonDynamicPcdList
:
2063 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2064 return self
._NonDynamicPcdDict
2066 ## Get list of non-dynamic PCDs
2067 def _GetNonDynamicPcdList(self
):
2068 if self
._NonDynamicPcdList
== None:
2069 self
.CollectPlatformDynamicPcds()
2070 return self
._NonDynamicPcdList
2072 ## Get list of dynamic PCDs
2073 def _GetDynamicPcdList(self
):
2074 if self
._DynamicPcdList
== None:
2075 self
.CollectPlatformDynamicPcds()
2076 return self
._DynamicPcdList
2078 ## Generate Token Number for all PCD
2079 def _GetPcdTokenNumbers(self
):
2080 if self
._PcdTokenNumber
== None:
2081 self
._PcdTokenNumber
= sdict()
2084 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2088 # TokenNumber 0 ~ 10
2090 # TokeNumber 11 ~ 20
2092 for Pcd
in self
.DynamicPcdList
:
2093 if Pcd
.Phase
== "PEI":
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
== "PEI":
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
.DynamicPcdList
:
2107 if Pcd
.Phase
== "DXE":
2108 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2109 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2110 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2113 for Pcd
in self
.DynamicPcdList
:
2114 if Pcd
.Phase
== "DXE":
2115 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2116 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2117 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2120 for Pcd
in self
.NonDynamicPcdList
:
2121 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2123 return self
._PcdTokenNumber
2125 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2126 def _GetAutoGenObjectList(self
):
2127 self
._ModuleAutoGenList
= []
2128 self
._LibraryAutoGenList
= []
2129 for ModuleFile
in self
.Platform
.Modules
:
2138 if Ma
not in self
._ModuleAutoGenList
:
2139 self
._ModuleAutoGenList
.append(Ma
)
2140 for La
in Ma
.LibraryAutoGenList
:
2141 if La
not in self
._LibraryAutoGenList
:
2142 self
._LibraryAutoGenList
.append(La
)
2143 if Ma
not in La
._ReferenceModules
:
2144 La
._ReferenceModules
.append(Ma
)
2146 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2147 def _GetModuleAutoGenList(self
):
2148 if self
._ModuleAutoGenList
== None:
2149 self
._GetAutoGenObjectList
()
2150 return self
._ModuleAutoGenList
2152 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2153 def _GetLibraryAutoGenList(self
):
2154 if self
._LibraryAutoGenList
== None:
2155 self
._GetAutoGenObjectList
()
2156 return self
._LibraryAutoGenList
2158 ## Test if a module is supported by the platform
2160 # An error will be raised directly if the module or its arch is not supported
2161 # by the platform or current configuration
2163 def ValidModule(self
, Module
):
2164 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2165 or Module
in self
._AsBuildModuleList
2167 ## Resolve the library classes in a module to library instances
2169 # This method will not only resolve library classes but also sort the library
2170 # instances according to the dependency-ship.
2172 # @param Module The module from which the library classes will be resolved
2174 # @retval library_list List of library instances sorted
2176 def ApplyLibraryInstance(self
, Module
):
2177 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2178 if str(Module
) not in self
.Platform
.Modules
:
2181 ModuleType
= Module
.ModuleType
2183 # for overridding library instances with module specific setting
2184 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2186 # add forced library instances (specified under LibraryClasses sections)
2188 # If a module has a MODULE_TYPE of USER_DEFINED,
2189 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2191 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2192 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2193 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2194 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2196 # add forced library instances (specified in module overrides)
2197 for LibraryClass
in PlatformModule
.LibraryClasses
:
2198 if LibraryClass
.startswith("NULL"):
2199 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2202 LibraryConsumerList
= [Module
]
2204 ConsumedByList
= sdict()
2205 LibraryInstance
= sdict()
2207 EdkLogger
.verbose("")
2208 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2209 while len(LibraryConsumerList
) > 0:
2210 M
= LibraryConsumerList
.pop()
2211 for LibraryClassName
in M
.LibraryClasses
:
2212 if LibraryClassName
not in LibraryInstance
:
2213 # override library instance for this module
2214 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2215 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2217 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2218 if LibraryPath
== None or LibraryPath
== "":
2219 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2220 if LibraryPath
== None or LibraryPath
== "":
2221 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2222 "Instance of library class [%s] is not found" % LibraryClassName
,
2224 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2226 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2227 # for those forced library instance (NULL library), add a fake library class
2228 if LibraryClassName
.startswith("NULL"):
2229 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2230 elif LibraryModule
.LibraryClass
== None \
2231 or len(LibraryModule
.LibraryClass
) == 0 \
2232 or (ModuleType
!= 'USER_DEFINED'
2233 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2234 # only USER_DEFINED can link against any library instance despite of its SupModList
2235 EdkLogger
.error("build", OPTION_MISSING
,
2236 "Module type [%s] is not supported by library instance [%s]" \
2237 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2238 ExtraData
="consumed by [%s]" % str(Module
))
2240 LibraryInstance
[LibraryClassName
] = LibraryModule
2241 LibraryConsumerList
.append(LibraryModule
)
2242 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2244 LibraryModule
= LibraryInstance
[LibraryClassName
]
2246 if LibraryModule
== None:
2249 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2250 Constructor
.append(LibraryModule
)
2252 if LibraryModule
not in ConsumedByList
:
2253 ConsumedByList
[LibraryModule
] = []
2254 # don't add current module itself to consumer list
2256 if M
in ConsumedByList
[LibraryModule
]:
2258 ConsumedByList
[LibraryModule
].append(M
)
2260 # Initialize the sorted output list to the empty set
2262 SortedLibraryList
= []
2264 # Q <- Set of all nodes with no incoming edges
2266 LibraryList
= [] #LibraryInstance.values()
2268 for LibraryClassName
in LibraryInstance
:
2269 M
= LibraryInstance
[LibraryClassName
]
2270 LibraryList
.append(M
)
2271 if ConsumedByList
[M
] == []:
2275 # start the DAG algorithm
2279 while Q
== [] and EdgeRemoved
:
2281 # for each node Item with a Constructor
2282 for Item
in LibraryList
:
2283 if Item
not in Constructor
:
2285 # for each Node without a constructor with an edge e from Item to Node
2286 for Node
in ConsumedByList
[Item
]:
2287 if Node
in Constructor
:
2289 # remove edge e from the graph if Node has no constructor
2290 ConsumedByList
[Item
].remove(Node
)
2292 if ConsumedByList
[Item
] == []:
2293 # insert Item into Q
2298 # DAG is done if there's no more incoming edge for all nodes
2302 # remove node from Q
2305 SortedLibraryList
.append(Node
)
2307 # for each node Item with an edge e from Node to Item do
2308 for Item
in LibraryList
:
2309 if Node
not in ConsumedByList
[Item
]:
2311 # remove edge e from the graph
2312 ConsumedByList
[Item
].remove(Node
)
2314 if ConsumedByList
[Item
] != []:
2316 # insert Item into Q, if Item has no other incoming edges
2320 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2322 for Item
in LibraryList
:
2323 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2324 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2325 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2326 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2327 if Item
not in SortedLibraryList
:
2328 SortedLibraryList
.append(Item
)
2331 # Build the list of constructor and destructir names
2332 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2334 SortedLibraryList
.reverse()
2335 return SortedLibraryList
2338 ## Override PCD setting (type, value, ...)
2340 # @param ToPcd The PCD to be overrided
2341 # @param FromPcd The PCD overrideing from
2343 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2345 # in case there's PCDs coming from FDF file, which have no type given.
2346 # at this point, ToPcd.Type has the type found from dependent
2349 TokenCName
= ToPcd
.TokenCName
2350 for PcdItem
in GlobalData
.MixedPcd
:
2351 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2352 TokenCName
= PcdItem
[0]
2355 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2356 ToPcd
.Type
= FromPcd
.Type
2357 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2358 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2359 if ToPcd
.Type
.strip() == "DynamicEx":
2360 ToPcd
.Type
= FromPcd
.Type
2361 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2362 and ToPcd
.Type
!= FromPcd
.Type
:
2363 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2364 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2365 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2366 ToPcd
.Type
, Module
, FromPcd
.Type
),
2369 if FromPcd
.MaxDatumSize
not in [None, '']:
2370 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2371 if FromPcd
.DefaultValue
not in [None, '']:
2372 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2373 if FromPcd
.TokenValue
not in [None, '']:
2374 ToPcd
.TokenValue
= FromPcd
.TokenValue
2375 if FromPcd
.MaxDatumSize
not in [None, '']:
2376 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2377 if FromPcd
.DatumType
not in [None, '']:
2378 ToPcd
.DatumType
= FromPcd
.DatumType
2379 if FromPcd
.SkuInfoList
not in [None, '', []]:
2380 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2381 # Add Flexible PCD format parse
2382 if ToPcd
.DefaultValue
:
2384 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2385 except BadExpression
, Value
:
2386 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2389 # check the validation of datum
2390 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2392 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2393 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2394 ToPcd
.validateranges
= FromPcd
.validateranges
2395 ToPcd
.validlists
= FromPcd
.validlists
2396 ToPcd
.expressions
= FromPcd
.expressions
2398 if FromPcd
!= None and ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2399 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2400 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2401 Value
= ToPcd
.DefaultValue
2402 if Value
in [None, '']:
2403 ToPcd
.MaxDatumSize
= '1'
2404 elif Value
[0] == 'L':
2405 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2406 elif Value
[0] == '{':
2407 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2409 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2411 # apply default SKU for dynamic PCDS if specified one is not available
2412 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2413 and ToPcd
.SkuInfoList
in [None, {}, '']:
2414 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2415 SkuName
= self
.Platform
.SkuName
2418 ToPcd
.SkuInfoList
= {
2419 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2422 ## Apply PCD setting defined platform to a module
2424 # @param Module The module from which the PCD setting will be overrided
2426 # @retval PCD_list The list PCDs with settings from platform
2428 def ApplyPcdSetting(self
, Module
, Pcds
):
2429 # for each PCD in module
2430 for Name
, Guid
in Pcds
:
2431 PcdInModule
= Pcds
[Name
, Guid
]
2432 # find out the PCD setting in platform
2433 if (Name
, Guid
) in self
.Platform
.Pcds
:
2434 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2436 PcdInPlatform
= None
2437 # then override the settings if any
2438 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2439 # resolve the VariableGuid value
2440 for SkuId
in PcdInModule
.SkuInfoList
:
2441 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2442 if Sku
.VariableGuid
== '': continue
2443 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2444 if Sku
.VariableGuidValue
== None:
2445 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2448 RESOURCE_NOT_AVAILABLE
,
2449 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2450 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2451 % (Guid
, Name
, str(Module
)),
2455 # override PCD settings with module specific setting
2456 if Module
in self
.Platform
.Modules
:
2457 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2458 for Key
in PlatformModule
.Pcds
:
2463 elif Key
in GlobalData
.MixedPcd
:
2464 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2466 ToPcd
= Pcds
[PcdItem
]
2470 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2471 # use PCD value to calculate the MaxDatumSize when it is not specified
2472 for Name
, Guid
in Pcds
:
2473 Pcd
= Pcds
[Name
, Guid
]
2474 if Pcd
.DatumType
== "VOID*" and Pcd
.MaxDatumSize
in ['', None]:
2475 Value
= Pcd
.DefaultValue
2476 if Value
in [None, '']:
2477 Pcd
.MaxDatumSize
= '1'
2478 elif Value
[0] == 'L':
2479 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2480 elif Value
[0] == '{':
2481 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2483 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2484 return Pcds
.values()
2486 ## Resolve library names to library modules
2488 # (for Edk.x modules)
2490 # @param Module The module from which the library names will be resolved
2492 # @retval library_list The list of library modules
2494 def ResolveLibraryReference(self
, Module
):
2495 EdkLogger
.verbose("")
2496 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2497 LibraryConsumerList
= [Module
]
2499 # "CompilerStub" is a must for Edk modules
2500 if Module
.Libraries
:
2501 Module
.Libraries
.append("CompilerStub")
2503 while len(LibraryConsumerList
) > 0:
2504 M
= LibraryConsumerList
.pop()
2505 for LibraryName
in M
.Libraries
:
2506 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2508 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2509 if LibraryName
.upper() == Key
.upper():
2510 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2513 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2514 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2517 if Library
not in LibraryList
:
2518 LibraryList
.append(Library
)
2519 LibraryConsumerList
.append(Library
)
2520 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2523 ## Calculate the priority value of the build option
2525 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2527 # @retval Value Priority value based on the priority list.
2529 def CalculatePriorityValue(self
, Key
):
2530 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2531 PriorityValue
= 0x11111
2533 PriorityValue
&= 0x01111
2534 if ToolChain
== "*":
2535 PriorityValue
&= 0x10111
2537 PriorityValue
&= 0x11011
2538 if CommandType
== "*":
2539 PriorityValue
&= 0x11101
2541 PriorityValue
&= 0x11110
2543 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2546 ## Expand * in build option key
2548 # @param Options Options to be expanded
2550 # @retval options Options expanded
2552 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2559 # Construct a list contain the build options which need override.
2563 # Key[0] -- tool family
2564 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2566 if (Key
[0] == self
.BuildRuleFamily
and
2567 (ModuleStyle
== None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2568 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2569 if Target
== self
.BuildTarget
or Target
== "*":
2570 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2571 if Arch
== self
.Arch
or Arch
== "*":
2572 if Options
[Key
].startswith("="):
2573 if OverrideList
.get(Key
[1]) != None:
2574 OverrideList
.pop(Key
[1])
2575 OverrideList
[Key
[1]] = Options
[Key
]
2578 # Use the highest priority value.
2580 if (len(OverrideList
) >= 2):
2581 KeyList
= OverrideList
.keys()
2582 for Index
in range(len(KeyList
)):
2583 NowKey
= KeyList
[Index
]
2584 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2585 for Index1
in range(len(KeyList
) - Index
- 1):
2586 NextKey
= KeyList
[Index1
+ Index
+ 1]
2588 # Compare two Key, if one is included by another, choose the higher priority one
2590 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2591 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2592 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2593 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2594 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2595 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2596 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2597 if Options
.get((self
.BuildRuleFamily
, NextKey
)) != None:
2598 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2600 if Options
.get((self
.BuildRuleFamily
, NowKey
)) != None:
2601 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2604 if ModuleStyle
!= None and len (Key
) > 2:
2605 # Check Module style is EDK or EDKII.
2606 # Only append build option for the matched style module.
2607 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2609 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2612 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2613 # if tool chain family doesn't match, skip it
2614 if Tool
in self
.ToolDefinition
and Family
!= "":
2615 FamilyIsNull
= False
2616 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2617 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2619 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2622 # expand any wildcard
2623 if Target
== "*" or Target
== self
.BuildTarget
:
2624 if Tag
== "*" or Tag
== self
.ToolChain
:
2625 if Arch
== "*" or Arch
== self
.Arch
:
2626 if Tool
not in BuildOptions
:
2627 BuildOptions
[Tool
] = {}
2628 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2629 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2631 # append options for the same tool except PATH
2633 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2635 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2636 # Build Option Family has been checked, which need't to be checked again for family.
2637 if FamilyMatch
or FamilyIsNull
:
2641 if ModuleStyle
!= None and len (Key
) > 2:
2642 # Check Module style is EDK or EDKII.
2643 # Only append build option for the matched style module.
2644 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2646 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2649 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2650 # if tool chain family doesn't match, skip it
2651 if Tool
not in self
.ToolDefinition
or Family
== "":
2653 # option has been added before
2654 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2657 # expand any wildcard
2658 if Target
== "*" or Target
== self
.BuildTarget
:
2659 if Tag
== "*" or Tag
== self
.ToolChain
:
2660 if Arch
== "*" or Arch
== self
.Arch
:
2661 if Tool
not in BuildOptions
:
2662 BuildOptions
[Tool
] = {}
2663 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2664 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2666 # append options for the same tool except PATH
2668 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2670 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2673 ## Append build options in platform to a module
2675 # @param Module The module to which the build options will be appened
2677 # @retval options The options appended with build options in platform
2679 def ApplyBuildOption(self
, Module
):
2680 # Get the different options for the different style module
2681 if Module
.AutoGenVersion
< 0x00010005:
2682 PlatformOptions
= self
.EdkBuildOption
2683 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2685 PlatformOptions
= self
.EdkIIBuildOption
2686 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2687 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2688 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2689 if Module
in self
.Platform
.Modules
:
2690 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2691 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2693 PlatformModuleOptions
= {}
2695 BuildRuleOrder
= None
2696 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2697 for Tool
in Options
:
2698 for Attr
in Options
[Tool
]:
2699 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2700 BuildRuleOrder
= Options
[Tool
][Attr
]
2702 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2703 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2704 self
.ToolDefinition
.keys())
2706 for Tool
in AllTools
:
2707 if Tool
not in BuildOptions
:
2708 BuildOptions
[Tool
] = {}
2710 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2711 if Tool
not in Options
:
2713 for Attr
in Options
[Tool
]:
2714 Value
= Options
[Tool
][Attr
]
2716 # Do not generate it in Makefile
2718 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2720 if Attr
not in BuildOptions
[Tool
]:
2721 BuildOptions
[Tool
][Attr
] = ""
2722 # check if override is indicated
2723 if Value
.startswith('='):
2724 ToolPath
= Value
[1:]
2725 ToolPath
= mws
.handleWsMacro(ToolPath
)
2726 BuildOptions
[Tool
][Attr
] = ToolPath
2728 Value
= mws
.handleWsMacro(Value
)
2730 BuildOptions
[Tool
][Attr
] += " " + Value
2732 BuildOptions
[Tool
][Attr
] = Value
2733 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
!= None:
2735 # Override UNI flag only for EDK module.
2737 if 'BUILD' not in BuildOptions
:
2738 BuildOptions
['BUILD'] = {}
2739 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2740 return BuildOptions
, BuildRuleOrder
2742 Platform
= property(_GetPlatform
)
2743 Name
= property(_GetName
)
2744 Guid
= property(_GetGuid
)
2745 Version
= property(_GetVersion
)
2747 OutputDir
= property(_GetOutputDir
)
2748 BuildDir
= property(_GetBuildDir
)
2749 MakeFileDir
= property(_GetMakeFileDir
)
2750 FdfFile
= property(_GetFdfFile
)
2752 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2753 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2754 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2755 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2756 PackageList
= property(_GetPackageList
)
2758 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2759 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2760 ToolChainFamily
= property(_GetToolChainFamily
)
2761 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2762 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2763 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2764 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2766 BuildCommand
= property(_GetBuildCommand
)
2767 BuildRule
= property(_GetBuildRule
)
2768 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2769 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2770 GenFdsCommand
= property(_GenFdsCommand
)
2772 ## ModuleAutoGen class
2774 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2775 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2776 # to the [depex] section in module's inf file.
2778 class ModuleAutoGen(AutoGen
):
2779 ## Cache the timestamps of metafiles of every module in a class variable
2783 ## The real constructor of ModuleAutoGen
2785 # This method is not supposed to be called by users of ModuleAutoGen. It's
2786 # only used by factory method __new__() to do real initialization work for an
2787 # object of 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 _Init(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
)
2805 # check if this module is employed by active platform
2806 if not self
.PlatformInfo
.ValidModule(self
.MetaFile
):
2807 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2808 % (self
.MetaFile
, Arch
))
2811 self
.SourceDir
= self
.MetaFile
.SubDir
2812 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2814 self
.SourceOverrideDir
= None
2815 # use overrided path defined in DSC file
2816 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2817 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2819 self
.ToolChain
= Toolchain
2820 self
.BuildTarget
= Target
2822 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2823 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2825 self
.IsMakeFileCreated
= False
2826 self
.IsCodeFileCreated
= False
2827 self
.IsAsBuiltInfCreated
= False
2828 self
.DepexGenerated
= False
2830 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2831 self
.BuildRuleOrder
= None
2837 self
._Version
= None
2838 self
._ModuleType
= None
2839 self
._ComponentType
= None
2840 self
._PcdIsDriver
= None
2841 self
._AutoGenVersion
= None
2842 self
._LibraryFlag
= None
2843 self
._CustomMakefile
= None
2846 self
._BuildDir
= None
2847 self
._OutputDir
= None
2848 self
._FfsOutputDir
= None
2849 self
._DebugDir
= None
2850 self
._MakeFileDir
= None
2852 self
._IncludePathList
= None
2853 self
._IncludePathLength
= 0
2854 self
._AutoGenFileList
= None
2855 self
._UnicodeFileList
= None
2856 self
._VfrFileList
= None
2857 self
._IdfFileList
= None
2858 self
._SourceFileList
= None
2859 self
._ObjectFileList
= None
2860 self
._BinaryFileList
= None
2862 self
._DependentPackageList
= None
2863 self
._DependentLibraryList
= None
2864 self
._LibraryAutoGenList
= None
2865 self
._DerivedPackageList
= None
2866 self
._ModulePcdList
= None
2867 self
._LibraryPcdList
= None
2868 self
._PcdComments
= sdict()
2869 self
._GuidList
= None
2870 self
._GuidsUsedByPcd
= None
2871 self
._GuidComments
= sdict()
2872 self
._ProtocolList
= None
2873 self
._ProtocolComments
= sdict()
2874 self
._PpiList
= None
2875 self
._PpiComments
= sdict()
2876 self
._DepexList
= None
2877 self
._DepexExpressionList
= None
2878 self
._BuildOption
= None
2879 self
._BuildOptionIncPathList
= None
2880 self
._BuildTargets
= None
2881 self
._IntroBuildTargetList
= None
2882 self
._FinalBuildTargetList
= None
2883 self
._FileTypes
= None
2884 self
._BuildRules
= None
2886 self
._TimeStampPath
= None
2888 self
.AutoGenDepSet
= set()
2891 ## The Modules referenced to this Library
2892 # Only Library has this attribute
2893 self
._ReferenceModules
= []
2895 ## Store the FixedAtBuild Pcds
2897 self
._FixedAtBuildPcds
= []
2902 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2904 # Get FixedAtBuild Pcds of this Module
2905 def _GetFixedAtBuildPcds(self
):
2906 if self
._FixedAtBuildPcds
:
2907 return self
._FixedAtBuildPcds
2908 for Pcd
in self
.ModulePcdList
:
2909 if Pcd
.Type
!= "FixedAtBuild":
2911 if Pcd
not in self
._FixedAtBuildPcds
:
2912 self
._FixedAtBuildPcds
.append(Pcd
)
2914 return self
._FixedAtBuildPcds
2916 def _GetUniqueBaseName(self
):
2917 BaseName
= self
.Name
2918 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2919 if Module
.MetaFile
== self
.MetaFile
:
2921 if Module
.Name
== self
.Name
:
2922 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2923 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2924 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2925 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2928 # Macros could be used in build_rule.txt (also Makefile)
2929 def _GetMacros(self
):
2930 if self
._Macro
== None:
2931 self
._Macro
= sdict()
2932 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2933 self
._Macro
["MODULE_NAME" ] = self
.Name
2934 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2935 self
._Macro
["MODULE_GUID" ] = self
.Guid
2936 self
._Macro
["MODULE_VERSION" ] = self
.Version
2937 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2938 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2939 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2940 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2941 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2943 self
._Macro
["BASE_NAME" ] = self
.Name
2945 self
._Macro
["ARCH" ] = self
.Arch
2946 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2947 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2948 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2949 self
._Macro
["TARGET" ] = self
.BuildTarget
2951 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2952 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2953 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2954 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2955 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2956 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2957 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2958 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2959 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2960 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2961 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2962 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2963 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2964 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2965 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2968 ## Return the module build data object
2969 def _GetModule(self
):
2970 if self
._Module
== None:
2971 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2974 ## Return the module name
2975 def _GetBaseName(self
):
2976 return self
.Module
.BaseName
2978 ## Return the module DxsFile if exist
2979 def _GetDxsFile(self
):
2980 return self
.Module
.DxsFile
2982 ## Return the module SourceOverridePath
2983 def _GetSourceOverridePath(self
):
2984 return self
.Module
.SourceOverridePath
2986 ## Return the module meta-file GUID
2989 # To build same module more than once, the module path with FILE_GUID overridden has
2990 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
2991 # in DSC. The overridden GUID can be retrieved from file name
2993 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
2995 # Length of GUID is 36
2997 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
2998 return self
.Module
.Guid
3000 ## Return the module version
3001 def _GetVersion(self
):
3002 return self
.Module
.Version
3004 ## Return the module type
3005 def _GetModuleType(self
):
3006 return self
.Module
.ModuleType
3008 ## Return the component type (for Edk.x style of module)
3009 def _GetComponentType(self
):
3010 return self
.Module
.ComponentType
3012 ## Return the build type
3013 def _GetBuildType(self
):
3014 return self
.Module
.BuildType
3016 ## Return the PCD_IS_DRIVER setting
3017 def _GetPcdIsDriver(self
):
3018 return self
.Module
.PcdIsDriver
3020 ## Return the autogen version, i.e. module meta-file version
3021 def _GetAutoGenVersion(self
):
3022 return self
.Module
.AutoGenVersion
3024 ## Check if the module is library or not
3025 def _IsLibrary(self
):
3026 if self
._LibraryFlag
== None:
3027 if self
.Module
.LibraryClass
!= None and self
.Module
.LibraryClass
!= []:
3028 self
._LibraryFlag
= True
3030 self
._LibraryFlag
= False
3031 return self
._LibraryFlag
3033 ## Check if the module is binary module or not
3034 def _IsBinaryModule(self
):
3035 return self
.Module
.IsBinaryModule
3037 ## Return the directory to store intermediate files of the module
3038 def _GetBuildDir(self
):
3039 if self
._BuildDir
== None:
3040 self
._BuildDir
= path
.join(
3041 self
.PlatformInfo
.BuildDir
,
3044 self
.MetaFile
.BaseName
3046 CreateDirectory(self
._BuildDir
)
3047 return self
._BuildDir
3049 ## Return the directory to store the intermediate object files of the mdoule
3050 def _GetOutputDir(self
):
3051 if self
._OutputDir
== None:
3052 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3053 CreateDirectory(self
._OutputDir
)
3054 return self
._OutputDir
3056 ## Return the directory to store ffs file
3057 def _GetFfsOutputDir(self
):
3058 if self
._FfsOutputDir
== None:
3059 if GlobalData
.gFdfParser
!= None:
3060 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3062 self
._FfsOutputDir
= ''
3063 return self
._FfsOutputDir
3065 ## Return the directory to store auto-gened source files of the mdoule
3066 def _GetDebugDir(self
):
3067 if self
._DebugDir
== None:
3068 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3069 CreateDirectory(self
._DebugDir
)
3070 return self
._DebugDir
3072 ## Return the path of custom file
3073 def _GetCustomMakefile(self
):
3074 if self
._CustomMakefile
== None:
3075 self
._CustomMakefile
= {}
3076 for Type
in self
.Module
.CustomMakefile
:
3077 if Type
in gMakeTypeMap
:
3078 MakeType
= gMakeTypeMap
[Type
]
3081 if self
.SourceOverrideDir
!= None:
3082 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3083 if not os
.path
.exists(File
):
3084 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3086 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3087 self
._CustomMakefile
[MakeType
] = File
3088 return self
._CustomMakefile
3090 ## Return the directory of the makefile
3092 # @retval string The directory string of module's makefile
3094 def _GetMakeFileDir(self
):
3095 return self
.BuildDir
3097 ## Return build command string
3099 # @retval string Build command string
3101 def _GetBuildCommand(self
):
3102 return self
.PlatformInfo
.BuildCommand
3104 ## Get object list of all packages the module and its dependent libraries belong to
3106 # @retval list The list of package object
3108 def _GetDerivedPackageList(self
):
3110 for M
in [self
.Module
] + self
.DependentLibraryList
:
3111 for Package
in M
.Packages
:
3112 if Package
in PackageList
:
3114 PackageList
.append(Package
)
3117 ## Get the depex string
3119 # @return : a string contain all depex expresion.
3120 def _GetDepexExpresionString(self
):
3123 ## DPX_SOURCE IN Define section.
3124 if self
.Module
.DxsFile
:
3126 for M
in [self
.Module
] + self
.DependentLibraryList
:
3127 Filename
= M
.MetaFile
.Path
3128 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3129 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3130 for DepexExpresion
in DepexExpresionList
:
3131 for key
in DepexExpresion
.keys():
3132 Arch
, ModuleType
= key
3133 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3134 # the type of build module is USER_DEFINED.
3135 # All different DEPEX section tags would be copied into the As Built INF file
3136 # and there would be separate DEPEX section tags
3137 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3138 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3139 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3141 if Arch
.upper() == TAB_ARCH_COMMON
or \
3142 (Arch
.upper() == self
.Arch
.upper() and \
3143 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3144 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3146 #the type of build module is USER_DEFINED.
3147 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3148 for Depex
in DepexList
:
3149 for key
in Depex
.keys():
3150 DepexStr
+= '[Depex.%s.%s]\n' % key
3151 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3154 return '[Depex.%s]\n' % self
.Arch
3157 #the type of build module not is USER_DEFINED.
3159 for Depex
in DepexList
:
3164 for D
in Depex
.values():
3165 DepexStr
+= ' '.join([val
for val
in D
])
3166 Index
= DepexStr
.find('END')
3167 if Index
> -1 and Index
== len(DepexStr
) - 3:
3168 DepexStr
= DepexStr
[:-3]
3169 DepexStr
= DepexStr
.strip()
3172 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3174 return '[Depex.%s]\n' % self
.Arch
3175 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3177 ## Merge dependency expression
3179 # @retval list The token list of the dependency expression after parsed
3181 def _GetDepexTokenList(self
):
3182 if self
._DepexList
== None:
3183 self
._DepexList
= {}
3184 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3185 return self
._DepexList
3187 self
._DepexList
[self
.ModuleType
] = []
3189 for ModuleType
in self
._DepexList
:
3190 DepexList
= self
._DepexList
[ModuleType
]
3192 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3194 for M
in [self
.Module
] + self
.DependentLibraryList
:
3196 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3198 DepexList
.append('AND')
3199 DepexList
.append('(')
3201 if DepexList
[-1] == 'END': # no need of a END at this time
3203 DepexList
.append(')')
3206 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3207 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3209 if len(DepexList
) > 0:
3210 EdkLogger
.verbose('')
3211 return self
._DepexList
3213 ## Merge dependency expression
3215 # @retval list The token list of the dependency expression after parsed
3217 def _GetDepexExpressionTokenList(self
):
3218 if self
._DepexExpressionList
== None:
3219 self
._DepexExpressionList
= {}
3220 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3221 return self
._DepexExpressionList
3223 self
._DepexExpressionList
[self
.ModuleType
] = ''
3225 for ModuleType
in self
._DepexExpressionList
:
3226 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3228 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3230 for M
in [self
.Module
] + self
.DependentLibraryList
:
3232 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3233 if DepexExpressionList
!= '':
3234 DepexExpressionList
+= ' AND '
3235 DepexExpressionList
+= '('
3236 DepexExpressionList
+= D
3237 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3238 DepexExpressionList
+= ')'
3241 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3242 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3244 if len(DepexExpressionList
) > 0:
3245 EdkLogger
.verbose('')
3246 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3247 return self
._DepexExpressionList
3249 # Get the tiano core user extension, it is contain dependent library.
3250 # @retval: a list contain tiano core userextension.
3252 def _GetTianoCoreUserExtensionList(self
):
3253 TianoCoreUserExtentionList
= []
3254 for M
in [self
.Module
] + self
.DependentLibraryList
:
3255 Filename
= M
.MetaFile
.Path
3256 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3257 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3258 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3259 for Section
in TianoCoreUserExtent
.keys():
3260 ItemList
= Section
.split(TAB_SPLIT
)
3262 if len(ItemList
) == 4:
3264 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3266 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3267 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3268 TianoCoreList
.append('\n')
3269 TianoCoreUserExtentionList
.append(TianoCoreList
)
3271 return TianoCoreUserExtentionList
3273 ## Return the list of specification version required for the module
3275 # @retval list The list of specification defined in module file
3277 def _GetSpecification(self
):
3278 return self
.Module
.Specification
3280 ## Tool option for the module build
3282 # @param PlatformInfo The object of PlatformBuildInfo
3283 # @retval dict The dict containing valid options
3285 def _GetModuleBuildOption(self
):
3286 if self
._BuildOption
== None:
3287 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3288 if self
.BuildRuleOrder
:
3289 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3290 return self
._BuildOption
3292 ## Get include path list from tool option for the module build
3294 # @retval list The include path list
3296 def _GetBuildOptionIncPathList(self
):
3297 if self
._BuildOptionIncPathList
== None:
3299 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3300 # is the former use /I , the Latter used -I to specify include directories
3302 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3303 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3304 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3305 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3308 # New ToolChainFamily, don't known whether there is option to specify include directories
3310 self
._BuildOptionIncPathList
= []
3311 return self
._BuildOptionIncPathList
3313 BuildOptionIncPathList
= []
3314 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3317 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3321 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3322 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in gBuildOptIncludePattern
.findall(FlagOption
)]
3325 # RVCT may specify a list of directory seperated by commas
3328 for Path
in gBuildOptIncludePattern
.findall(FlagOption
):
3329 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3330 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3333 # EDK II modules must not reference header files outside of the packages they depend on or
3334 # within the module's directory tree. Report error if violation.
3336 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3337 for Path
in IncPathList
:
3338 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3339 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3340 EdkLogger
.error("build",
3343 File
=str(self
.MetaFile
))
3346 BuildOptionIncPathList
+= IncPathList
3348 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3350 return self
._BuildOptionIncPathList
3352 ## Return a list of files which can be built from source
3354 # What kind of files can be built is determined by build rules in
3355 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3357 def _GetSourceFileList(self
):
3358 if self
._SourceFileList
== None:
3359 self
._SourceFileList
= []
3360 for F
in self
.Module
.Sources
:
3362 if F
.TagName
not in ("", "*", self
.ToolChain
):
3363 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3364 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3366 # match tool chain family or build rule family
3367 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3370 "The file [%s] must be built by tools of [%s], " \
3371 "but current toolchain family is [%s], buildrule family is [%s]" \
3372 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3375 # add the file path into search path list for file including
3376 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3377 self
.IncludePathList
.insert(0, F
.Dir
)
3378 self
._SourceFileList
.append(F
)
3380 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3382 for F
in self
._SourceFileList
:
3383 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3384 return self
._SourceFileList
3386 def _MatchBuildRuleOrder(self
, FileList
):
3388 self
._GetModuleBuildOption
()
3389 for SingleFile
in FileList
:
3390 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3391 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3392 if key
in Order_Dict
:
3393 Order_Dict
[key
].append(SingleFile
.Ext
)
3395 Order_Dict
[key
] = [SingleFile
.Ext
]
3398 for F
in Order_Dict
:
3399 if len(Order_Dict
[F
]) > 1:
3400 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3401 for Ext
in Order_Dict
[F
][1:]:
3402 RemoveList
.append(F
+ Ext
)
3404 for item
in RemoveList
:
3405 FileList
.remove(item
)
3409 ## Return the list of unicode files
3410 def _GetUnicodeFileList(self
):
3411 if self
._UnicodeFileList
== None:
3412 if TAB_UNICODE_FILE
in self
.FileTypes
:
3413 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3415 self
._UnicodeFileList
= []
3416 return self
._UnicodeFileList
3418 ## Return the list of vfr files
3419 def _GetVfrFileList(self
):
3420 if self
._VfrFileList
== None:
3421 if TAB_VFR_FILE
in self
.FileTypes
:
3422 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3424 self
._VfrFileList
= []
3425 return self
._VfrFileList
3427 ## Return the list of Image Definition files
3428 def _GetIdfFileList(self
):
3429 if self
._IdfFileList
== None:
3430 if TAB_IMAGE_FILE
in self
.FileTypes
:
3431 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3433 self
._IdfFileList
= []
3434 return self
._IdfFileList
3436 ## Return a list of files which can be built from binary
3438 # "Build" binary files are just to copy them to build directory.
3440 # @retval list The list of files which can be built later
3442 def _GetBinaryFiles(self
):
3443 if self
._BinaryFileList
== None:
3444 self
._BinaryFileList
= []
3445 for F
in self
.Module
.Binaries
:
3446 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3448 self
._BinaryFileList
.append(F
)
3449 self
._ApplyBuildRule
(F
, F
.Type
)
3450 return self
._BinaryFileList
3452 def _GetBuildRules(self
):
3453 if self
._BuildRules
== None:
3455 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3456 for Type
in BuildRuleDatabase
.FileTypeList
:
3457 #first try getting build rule by BuildRuleFamily
3458 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3460 # build type is always module type, but ...
3461 if self
.ModuleType
!= self
.BuildType
:
3462 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3463 #second try getting build rule by ToolChainFamily
3465 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3467 # build type is always module type, but ...
3468 if self
.ModuleType
!= self
.BuildType
:
3469 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3472 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3473 BuildRules
[Type
] = RuleObject
3474 for Ext
in RuleObject
.SourceFileExtList
:
3475 BuildRules
[Ext
] = RuleObject
3476 self
._BuildRules
= BuildRules
3477 return self
._BuildRules
3479 def _ApplyBuildRule(self
, File
, FileType
):
3480 if self
._BuildTargets
== None:
3481 self
._IntroBuildTargetList
= set()
3482 self
._FinalBuildTargetList
= set()
3483 self
._BuildTargets
= {}
3484 self
._FileTypes
= {}
3486 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3487 if not os
.path
.exists(SubDirectory
):
3488 CreateDirectory(SubDirectory
)
3494 # Make sure to get build rule order value
3496 self
._GetModuleBuildOption
()
3498 while Index
< len(SourceList
):
3499 Source
= SourceList
[Index
]
3503 CreateDirectory(Source
.Dir
)
3505 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
!= None and File
in self
._BinaryFileList
:
3506 # Skip all files that are not binary libraries
3507 if not self
.IsLibrary
:
3509 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3510 elif FileType
in self
.BuildRules
:
3511 RuleObject
= self
.BuildRules
[FileType
]
3512 elif Source
.Ext
in self
.BuildRules
:
3513 RuleObject
= self
.BuildRules
[Source
.Ext
]
3515 # stop at no more rules
3517 self
._FinalBuildTargetList
.add(LastTarget
)
3520 FileType
= RuleObject
.SourceFileType
3521 if FileType
not in self
._FileTypes
:
3522 self
._FileTypes
[FileType
] = set()
3523 self
._FileTypes
[FileType
].add(Source
)
3525 # stop at STATIC_LIBRARY for library
3526 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3528 self
._FinalBuildTargetList
.add(LastTarget
)
3531 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3534 self
._FinalBuildTargetList
.add(LastTarget
)
3536 elif not Target
.Outputs
:
3537 # Only do build for target with outputs
3538 self
._FinalBuildTargetList
.add(Target
)
3540 if FileType
not in self
._BuildTargets
:
3541 self
._BuildTargets
[FileType
] = set()
3542 self
._BuildTargets
[FileType
].add(Target
)
3544 if not Source
.IsBinary
and Source
== File
:
3545 self
._IntroBuildTargetList
.add(Target
)
3547 # to avoid cyclic rule
3548 if FileType
in RuleChain
:
3551 RuleChain
.append(FileType
)
3552 SourceList
.extend(Target
.Outputs
)
3554 FileType
= TAB_UNKNOWN_FILE
3556 def _GetTargets(self
):
3557 if self
._BuildTargets
== None:
3558 self
._IntroBuildTargetList
= set()
3559 self
._FinalBuildTargetList
= set()
3560 self
._BuildTargets
= {}
3561 self
._FileTypes
= {}
3563 #TRICK: call _GetSourceFileList to apply build rule for source files
3564 if self
.SourceFileList
:
3567 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3568 if self
.BinaryFileList
:
3571 return self
._BuildTargets
3573 def _GetIntroTargetList(self
):
3575 return self
._IntroBuildTargetList
3577 def _GetFinalTargetList(self
):
3579 return self
._FinalBuildTargetList
3581 def _GetFileTypes(self
):
3583 return self
._FileTypes
3585 ## Get the list of package object the module depends on
3587 # @retval list The package object list
3589 def _GetDependentPackageList(self
):
3590 return self
.Module
.Packages
3592 ## Return the list of auto-generated code file
3594 # @retval list The list of auto-generated file
3596 def _GetAutoGenFileList(self
):
3597 UniStringAutoGenC
= True
3598 IdfStringAutoGenC
= True
3599 UniStringBinBuffer
= StringIO()
3600 IdfGenBinBuffer
= StringIO()
3601 if self
.BuildType
== 'UEFI_HII':
3602 UniStringAutoGenC
= False
3603 IdfStringAutoGenC
= False
3604 if self
._AutoGenFileList
== None:
3605 self
._AutoGenFileList
= {}
3606 AutoGenC
= TemplateString()
3607 AutoGenH
= TemplateString()
3608 StringH
= TemplateString()
3609 StringIdf
= TemplateString()
3610 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3612 # AutoGen.c is generated if there are library classes in inf, or there are object files
3614 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3615 or TAB_OBJECT_FILE
in self
.FileTypes
):
3616 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3617 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3618 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3619 if str(AutoGenH
) != "":
3620 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3621 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3622 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3623 if str(StringH
) != "":
3624 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3625 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3626 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3627 if UniStringBinBuffer
!= None and UniStringBinBuffer
.getvalue() != "":
3628 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3629 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3630 AutoFile
.IsBinary
= True
3631 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3632 if UniStringBinBuffer
!= None:
3633 UniStringBinBuffer
.close()
3634 if str(StringIdf
) != "":
3635 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3636 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3637 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3638 if IdfGenBinBuffer
!= None and IdfGenBinBuffer
.getvalue() != "":
3639 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3640 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3641 AutoFile
.IsBinary
= True
3642 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3643 if IdfGenBinBuffer
!= None:
3644 IdfGenBinBuffer
.close()
3645 return self
._AutoGenFileList
3647 ## Return the list of library modules explicitly or implicityly used by this module
3648 def _GetLibraryList(self
):
3649 if self
._DependentLibraryList
== None:
3650 # only merge library classes and PCD for non-library module
3652 self
._DependentLibraryList
= []
3654 if self
.AutoGenVersion
< 0x00010005:
3655 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3657 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3658 return self
._DependentLibraryList
3661 def UpdateComments(Recver
, Src
):
3663 if Key
not in Recver
:
3665 Recver
[Key
].extend(Src
[Key
])
3666 ## Get the list of PCDs from current module
3668 # @retval list The list of PCD
3670 def _GetModulePcdList(self
):
3671 if self
._ModulePcdList
== None:
3672 # apply PCD settings from platform
3673 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3674 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3675 return self
._ModulePcdList
3677 ## Get the list of PCDs from dependent libraries
3679 # @retval list The list of PCD
3681 def _GetLibraryPcdList(self
):
3682 if self
._LibraryPcdList
== None:
3684 if not self
.IsLibrary
:
3685 # get PCDs from dependent libraries
3686 for Library
in self
.DependentLibraryList
:
3687 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3688 for Key
in Library
.Pcds
:
3689 # skip duplicated PCDs
3690 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3692 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3693 # apply PCD settings from platform
3694 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3696 self
._LibraryPcdList
= []
3697 return self
._LibraryPcdList
3699 ## Get the GUID value mapping
3701 # @retval dict The mapping between GUID cname and its value
3703 def _GetGuidList(self
):
3704 if self
._GuidList
== None:
3705 self
._GuidList
= sdict()
3706 self
._GuidList
.update(self
.Module
.Guids
)
3707 for Library
in self
.DependentLibraryList
:
3708 self
._GuidList
.update(Library
.Guids
)
3709 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3710 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3711 return self
._GuidList
3713 def GetGuidsUsedByPcd(self
):
3714 if self
._GuidsUsedByPcd
== None:
3715 self
._GuidsUsedByPcd
= sdict()
3716 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3717 for Library
in self
.DependentLibraryList
:
3718 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3719 return self
._GuidsUsedByPcd
3720 ## Get the protocol value mapping
3722 # @retval dict The mapping between protocol cname and its value
3724 def _GetProtocolList(self
):
3725 if self
._ProtocolList
== None:
3726 self
._ProtocolList
= sdict()
3727 self
._ProtocolList
.update(self
.Module
.Protocols
)
3728 for Library
in self
.DependentLibraryList
:
3729 self
._ProtocolList
.update(Library
.Protocols
)
3730 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3731 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3732 return self
._ProtocolList
3734 ## Get the PPI value mapping
3736 # @retval dict The mapping between PPI cname and its value
3738 def _GetPpiList(self
):
3739 if self
._PpiList
== None:
3740 self
._PpiList
= sdict()
3741 self
._PpiList
.update(self
.Module
.Ppis
)
3742 for Library
in self
.DependentLibraryList
:
3743 self
._PpiList
.update(Library
.Ppis
)
3744 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3745 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3746 return self
._PpiList
3748 ## Get the list of include search path
3750 # @retval list The list path
3752 def _GetIncludePathList(self
):
3753 if self
._IncludePathList
== None:
3754 self
._IncludePathList
= []
3755 if self
.AutoGenVersion
< 0x00010005:
3756 for Inc
in self
.Module
.Includes
:
3757 if Inc
not in self
._IncludePathList
:
3758 self
._IncludePathList
.append(Inc
)
3760 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3761 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3762 self
._IncludePathList
.append(Inc
)
3763 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3764 self
._IncludePathList
.append(self
.DebugDir
)
3766 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3767 self
._IncludePathList
.append(self
.DebugDir
)
3769 for Package
in self
.Module
.Packages
:
3770 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3771 if PackageDir
not in self
._IncludePathList
:
3772 self
._IncludePathList
.append(PackageDir
)
3773 IncludesList
= Package
.Includes
3774 if Package
._PrivateIncludes
:
3775 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3776 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3777 for Inc
in IncludesList
:
3778 if Inc
not in self
._IncludePathList
:
3779 self
._IncludePathList
.append(str(Inc
))
3780 return self
._IncludePathList
3782 def _GetIncludePathLength(self
):
3783 self
._IncludePathLength
= 0
3784 if self
._IncludePathList
:
3785 for inc
in self
._IncludePathList
:
3786 self
._IncludePathLength
+= len(' ' + inc
)
3787 return self
._IncludePathLength
3789 ## Get HII EX PCDs which maybe used by VFR
3791 # efivarstore used by VFR may relate with HII EX PCDs
3792 # Get the variable name and GUID from efivarstore and HII EX PCD
3793 # List the HII EX PCDs in As Built INF if both name and GUID match.
3795 # @retval list HII EX PCDs
3797 def _GetPcdsMaybeUsedByVfr(self
):
3798 if not self
.SourceFileList
:
3802 for SrcFile
in self
.SourceFileList
:
3803 if SrcFile
.Ext
.lower() != '.vfr':
3805 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3806 if not os
.path
.exists(Vfri
):
3808 VfriFile
= open(Vfri
, 'r')
3809 Content
= VfriFile
.read()
3811 Pos
= Content
.find('efivarstore')
3814 # Make sure 'efivarstore' is the start of efivarstore statement
3815 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3818 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3820 if Index
>= 0 and Content
[Index
] != ';':
3821 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3824 # 'efivarstore' must be followed by name and guid
3826 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3829 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3832 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3833 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3834 Pos
= Content
.find('efivarstore', Name
.end())
3838 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3839 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3841 for SkuName
in Pcd
.SkuInfoList
:
3842 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3843 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3844 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3847 Guid
= GuidStructureStringToGuidString(Value
)
3848 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3849 HiiExPcds
.append(Pcd
)
3854 def _GenOffsetBin(self
):
3856 for SourceFile
in self
.Module
.Sources
:
3857 if SourceFile
.Type
.upper() == ".VFR" :
3859 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3861 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3862 if SourceFile
.Type
.upper() == ".UNI" :
3864 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3866 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3868 if len(VfrUniBaseName
) == 0:
3870 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3871 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3872 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3873 if not VfrUniOffsetList
:
3876 OutputName
= '%sOffset.bin' % self
.Name
3877 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3880 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3882 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3884 # Use a instance of StringIO to cache data
3885 fStringIO
= StringIO('')
3887 for Item
in VfrUniOffsetList
:
3888 if (Item
[0].find("Strings") != -1):
3890 # UNI offset in image.
3892 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3894 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3895 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3896 fStringIO
.write(''.join(UniGuid
))
3897 UniValue
= pack ('Q', int (Item
[1], 16))
3898 fStringIO
.write (UniValue
)
3901 # VFR binary offset in image.
3903 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3905 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3906 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3907 fStringIO
.write(''.join(VfrGuid
))
3909 VfrValue
= pack ('Q', int (Item
[1], 16))
3910 fStringIO
.write (VfrValue
)
3912 # write data into file.
3915 fInputfile
.write (fStringIO
.getvalue())
3917 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3918 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3924 ## Create AsBuilt INF file the module
3926 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3927 self
.OutputFile
= []
3929 if GlobalData
.gBinCacheDest
:
3930 self
.CopyModuleToCache()
3933 if self
.IsAsBuiltInfCreated
:
3936 # Skip the following code for EDK I inf
3937 if self
.AutoGenVersion
< 0x00010005:
3940 # Skip the following code for libraries
3944 # Skip the following code for modules with no source files
3945 if self
.SourceFileList
== None or self
.SourceFileList
== []:
3948 # Skip the following code for modules without any binary files
3949 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3952 ### TODO: How to handles mixed source and binary modules
3954 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3955 # Also find all packages that the DynamicEx PCDs depend on
3960 PcdTokenSpaceList
= []
3961 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3962 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3963 PatchablePcds
+= [Pcd
]
3964 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3965 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3968 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3969 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3970 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3972 GuidList
.update(self
.GuidList
)
3973 for TokenSpace
in self
.GetGuidsUsedByPcd():
3974 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3975 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3976 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3977 GuidList
.pop(TokenSpace
)
3978 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3979 for Package
in self
.DerivedPackageList
:
3980 if Package
in Packages
:
3982 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3984 for Index
in range(len(BeChecked
)):
3985 for Item
in CheckList
[Index
]:
3986 if Item
in BeChecked
[Index
]:
3987 Packages
+= [Package
]
3992 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
3993 for Pkg
in self
.PlatformInfo
.PackageList
:
3996 for VfrPcd
in VfrPcds
:
3997 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
3998 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
4002 ModuleType
= self
.ModuleType
4003 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
4004 ModuleType
= 'DXE_DRIVER'
4007 if self
.PcdIsDriver
!= '':
4008 DriverType
= self
.PcdIsDriver
4011 MDefs
= self
.Module
.Defines
4014 'module_name' : self
.Name
,
4015 'module_guid' : Guid
,
4016 'module_module_type' : ModuleType
,
4017 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
4018 'pcd_is_driver_string' : [],
4019 'module_uefi_specification_version' : [],
4020 'module_pi_specification_version' : [],
4021 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
4022 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
4023 'module_constructor' : self
.Module
.ConstructorList
,
4024 'module_destructor' : self
.Module
.DestructorList
,
4025 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4026 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4027 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4028 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4029 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4030 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4031 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4032 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4033 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4034 'module_arch' : self
.Arch
,
4035 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4037 'patchablepcd_item' : [],
4039 'protocol_item' : [],
4043 'libraryclasses_item' : []
4046 if 'MODULE_UNI_FILE' in MDefs
:
4047 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4048 if os
.path
.isfile(UNIFile
):
4049 shutil
.copy2(UNIFile
, self
.OutputDir
)
4051 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4052 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4054 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4057 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4059 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4060 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4061 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4062 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4064 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4065 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4066 for Item
in self
.CodaTargetList
:
4067 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').strip('/')
4068 if File
not in self
.OutputFile
:
4069 self
.OutputFile
.append(File
)
4070 if os
.path
.isabs(File
):
4071 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4072 if Item
.Target
.Ext
.lower() == '.aml':
4073 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4074 elif Item
.Target
.Ext
.lower() == '.acpi':
4075 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4076 elif Item
.Target
.Ext
.lower() == '.efi':
4077 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4079 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4080 if self
.DepexGenerated
:
4081 if self
.Name
+ '.depex' not in self
.OutputFile
:
4082 self
.OutputFile
.append(self
.Name
+ '.depex')
4083 if self
.ModuleType
in ['PEIM']:
4084 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4085 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4086 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4087 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4088 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4090 Bin
= self
._GenOffsetBin
()
4092 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4093 if Bin
not in self
.OutputFile
:
4094 self
.OutputFile
.append(Bin
)
4096 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4098 if File
.lower().endswith('.pdb'):
4099 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4100 if File
not in self
.OutputFile
:
4101 self
.OutputFile
.append(File
)
4102 HeaderComments
= self
.Module
.HeaderComments
4104 for Index
in range(len(HeaderComments
)):
4105 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4106 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4109 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4110 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4113 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4114 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4115 (GuidList
, self
._GuidComments
, 'guid_item')
4117 for Item
in GenList
:
4118 for CName
in Item
[0]:
4120 if CName
in Item
[1]:
4121 Comments
= '\n '.join(Item
[1][CName
])
4124 Entry
= Comments
+ '\n ' + CName
4125 AsBuiltInfDict
[Item
[2]].append(Entry
)
4126 PatchList
= parsePcdInfoFromMapFile(
4127 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4128 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4131 for Pcd
in PatchablePcds
:
4132 TokenCName
= Pcd
.TokenCName
4133 for PcdItem
in GlobalData
.MixedPcd
:
4134 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4135 TokenCName
= PcdItem
[0]
4137 for PatchPcd
in PatchList
:
4138 if TokenCName
== PatchPcd
[0]:
4143 if Pcd
.DatumType
== 'BOOLEAN':
4144 BoolValue
= Pcd
.DefaultValue
.upper()
4145 if BoolValue
== 'TRUE':
4146 Pcd
.DefaultValue
= '1'
4147 elif BoolValue
== 'FALSE':
4148 Pcd
.DefaultValue
= '0'
4150 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4151 HexFormat
= '0x%02x'
4152 if Pcd
.DatumType
== 'UINT16':
4153 HexFormat
= '0x%04x'
4154 elif Pcd
.DatumType
== 'UINT32':
4155 HexFormat
= '0x%08x'
4156 elif Pcd
.DatumType
== 'UINT64':
4157 HexFormat
= '0x%016x'
4158 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4160 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
4161 EdkLogger
.error("build", AUTOGEN_ERROR
,
4162 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4164 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4165 PcdValue
= Pcd
.DefaultValue
4166 if PcdValue
[0] != '{':
4168 if PcdValue
[0] == 'L':
4170 PcdValue
= PcdValue
.lstrip('L')
4171 PcdValue
= eval(PcdValue
)
4173 for Index
in range(0, len(PcdValue
)):
4175 CharVal
= ord(PcdValue
[Index
])
4176 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4177 + '0x%02x' % (CharVal
>> 8) + ', '
4179 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4182 Padding
= Padding
* 2
4183 ArraySize
= ArraySize
/ 2
4184 if ArraySize
< (len(PcdValue
) + 1):
4185 EdkLogger
.error("build", AUTOGEN_ERROR
,
4186 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4188 if ArraySize
> len(PcdValue
) + 1:
4189 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4190 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4191 elif len(PcdValue
.split(',')) <= ArraySize
:
4192 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4195 EdkLogger
.error("build", AUTOGEN_ERROR
,
4196 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4198 PcdItem
= '%s.%s|%s|0x%X' % \
4199 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4201 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4202 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4204 PcdItem
= PcdComments
+ '\n ' + PcdItem
4205 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4208 for Pcd
in Pcds
+ VfrPcds
:
4213 TokenCName
= Pcd
.TokenCName
4214 for PcdItem
in GlobalData
.MixedPcd
:
4215 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4216 TokenCName
= PcdItem
[0]
4218 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4219 for SkuName
in Pcd
.SkuInfoList
:
4220 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4221 SkuId
= SkuInfo
.SkuId
4222 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4226 # Don't generate duplicated HII PCD
4228 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4231 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4232 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4233 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4237 for Index
, Comment
in enumerate(PcdCommentList
):
4238 for Usage
in UsageList
:
4239 if Comment
.find(Usage
) != -1:
4243 if UsageIndex
!= -1:
4244 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4246 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4247 PcdComments
= '\n '.join(PcdCommentList
)
4248 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4250 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4251 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4252 for Item
in self
.BuildOption
:
4253 if 'FLAGS' in self
.BuildOption
[Item
]:
4254 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4256 # Generated LibraryClasses section in comments.
4257 for Library
in self
.LibraryAutoGenList
:
4258 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4260 # Generated UserExtensions TianoCore section.
4261 # All tianocore user extensions are copied.
4263 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4264 UserExtStr
+= '\n'.join(TianoCore
)
4265 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4266 if os
.path
.isfile(ExtensionFile
):
4267 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4268 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4270 # Generated depex expression section in comments.
4271 AsBuiltInfDict
['depexsection_item'] = ''
4272 DepexExpresion
= self
._GetDepexExpresionString
()
4274 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4276 AsBuiltInf
= TemplateString()
4277 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4279 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4281 self
.IsAsBuiltInfCreated
= True
4282 if GlobalData
.gBinCacheDest
:
4283 self
.CopyModuleToCache()
4285 def CopyModuleToCache(self
):
4286 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4287 CreateDirectory (FileDir
)
4288 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4289 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4290 if os
.path
.exists(HashFile
):
4291 shutil
.copy2(HashFile
, FileDir
)
4292 if os
.path
.exists(ModuleFile
):
4293 shutil
.copy2(ModuleFile
, FileDir
)
4294 if not self
.OutputFile
:
4295 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4296 self
.OutputFile
= Ma
.Binaries
4298 for File
in self
.OutputFile
:
4300 if not os
.path
.isabs(File
):
4301 File
= os
.path
.join(self
.OutputDir
, File
)
4302 if os
.path
.exists(File
):
4303 shutil
.copy2(File
, FileDir
)
4305 def AttemptModuleCacheCopy(self
):
4306 if self
.IsBinaryModule
:
4308 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4309 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4310 if os
.path
.exists(HashFile
):
4311 f
= open(HashFile
, 'r')
4312 CacheHash
= f
.read()
4314 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4315 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4316 for root
, dir, files
in os
.walk(FileDir
):
4318 if self
.Name
+ '.hash' in f
:
4319 shutil
.copy2(HashFile
, self
.BuildDir
)
4321 File
= path
.join(root
, f
)
4322 shutil
.copy2(File
, self
.OutputDir
)
4323 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4324 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4328 ## Create makefile for the module and its dependent libraries
4330 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4331 # dependent libraries will be created
4333 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4334 # Ignore generating makefile when it is a binary module
4335 if self
.IsBinaryModule
:
4338 if self
.IsMakeFileCreated
:
4340 self
.GenFfsList
= GenFfsList
4341 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4342 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4343 LibraryAutoGen
.CreateMakeFile()
4348 if len(self
.CustomMakefile
) == 0:
4349 Makefile
= GenMake
.ModuleMakefile(self
)
4351 Makefile
= GenMake
.CustomMakefile(self
)
4352 if Makefile
.Generate():
4353 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4354 (self
.Name
, self
.Arch
))
4356 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4357 (self
.Name
, self
.Arch
))
4359 self
.CreateTimeStamp(Makefile
)
4360 self
.IsMakeFileCreated
= True
4362 def CopyBinaryFiles(self
):
4363 for File
in self
.Module
.Binaries
:
4365 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4366 CopyLongFilePath(SrcPath
, DstPath
)
4367 ## Create autogen code for the module and its dependent libraries
4369 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4370 # dependent libraries will be created
4372 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4373 if self
.IsCodeFileCreated
:
4376 # Need to generate PcdDatabase even PcdDriver is binarymodule
4377 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4378 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4380 if self
.IsBinaryModule
:
4382 self
.CopyBinaryFiles()
4385 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4386 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4387 LibraryAutoGen
.CreateCodeFile()
4393 IgoredAutoGenList
= []
4395 for File
in self
.AutoGenFileList
:
4396 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4397 #Ignore Edk AutoGen.c
4398 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4401 AutoGenList
.append(str(File
))
4403 IgoredAutoGenList
.append(str(File
))
4405 # Skip the following code for EDK I inf
4406 if self
.AutoGenVersion
< 0x00010005:
4409 for ModuleType
in self
.DepexList
:
4410 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4411 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4414 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4415 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4417 if len(Dpx
.PostfixNotation
) <> 0:
4418 self
.DepexGenerated
= True
4420 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4421 AutoGenList
.append(str(DpxFile
))
4423 IgoredAutoGenList
.append(str(DpxFile
))
4425 if IgoredAutoGenList
== []:
4426 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4427 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4428 elif AutoGenList
== []:
4429 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4430 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4432 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4433 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4435 self
.IsCodeFileCreated
= True
4438 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4439 def _GetLibraryAutoGenList(self
):
4440 if self
._LibraryAutoGenList
== None:
4441 self
._LibraryAutoGenList
= []
4442 for Library
in self
.DependentLibraryList
:
4449 self
.PlatformInfo
.MetaFile
4451 if La
not in self
._LibraryAutoGenList
:
4452 self
._LibraryAutoGenList
.append(La
)
4453 for Lib
in La
.CodaTargetList
:
4454 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4455 return self
._LibraryAutoGenList
4457 def GenModuleHash(self
):
4458 if self
.Arch
not in GlobalData
.gModuleHash
:
4459 GlobalData
.gModuleHash
[self
.Arch
] = {}
4461 # Add Platform level hash
4462 m
.update(GlobalData
.gPlatformHash
)
4463 # Add Package level hash
4464 if self
.DependentPackageList
:
4465 for Pkg
in self
.DependentPackageList
:
4466 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4467 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4470 if self
.LibraryAutoGenList
:
4471 for Lib
in self
.LibraryAutoGenList
:
4472 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4474 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4477 f
= open(str(self
.MetaFile
), 'r')
4481 # Add Module's source files
4482 if self
.SourceFileList
:
4483 for File
in self
.SourceFileList
:
4484 f
= open(str(File
), 'r')
4489 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4490 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4491 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4492 if GlobalData
.gBinCacheSource
:
4493 CacheValid
= self
.AttemptModuleCacheCopy()
4496 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4498 ## Decide whether we can skip the ModuleAutoGen process
4499 def CanSkipbyHash(self
):
4500 if GlobalData
.gUseHashCache
:
4501 return not self
.GenModuleHash()
4503 ## Decide whether we can skip the ModuleAutoGen process
4504 # If any source file is newer than the module than we cannot skip
4507 if not os
.path
.exists(self
.GetTimeStampPath()):
4509 #last creation time of the module
4510 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4512 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4513 if SrcTimeStamp
> DstTimeStamp
:
4516 with
open(self
.GetTimeStampPath(),'r') as f
:
4518 source
= source
.rstrip('\n')
4519 if not os
.path
.exists(source
):
4521 if source
not in ModuleAutoGen
.TimeDict
:
4522 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4523 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4527 def GetTimeStampPath(self
):
4528 if self
._TimeStampPath
== None:
4529 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4530 return self
._TimeStampPath
4531 def CreateTimeStamp(self
, Makefile
):
4535 FileSet
.add (self
.MetaFile
.Path
)
4537 for SourceFile
in self
.Module
.Sources
:
4538 FileSet
.add (SourceFile
.Path
)
4540 for Lib
in self
.DependentLibraryList
:
4541 FileSet
.add (Lib
.MetaFile
.Path
)
4543 for f
in self
.AutoGenDepSet
:
4544 FileSet
.add (f
.Path
)
4546 if os
.path
.exists (self
.GetTimeStampPath()):
4547 os
.remove (self
.GetTimeStampPath())
4548 with
open(self
.GetTimeStampPath(), 'w+') as file:
4552 Module
= property(_GetModule
)
4553 Name
= property(_GetBaseName
)
4554 Guid
= property(_GetGuid
)
4555 Version
= property(_GetVersion
)
4556 ModuleType
= property(_GetModuleType
)
4557 ComponentType
= property(_GetComponentType
)
4558 BuildType
= property(_GetBuildType
)
4559 PcdIsDriver
= property(_GetPcdIsDriver
)
4560 AutoGenVersion
= property(_GetAutoGenVersion
)
4561 Macros
= property(_GetMacros
)
4562 Specification
= property(_GetSpecification
)
4564 IsLibrary
= property(_IsLibrary
)
4565 IsBinaryModule
= property(_IsBinaryModule
)
4566 BuildDir
= property(_GetBuildDir
)
4567 OutputDir
= property(_GetOutputDir
)
4568 FfsOutputDir
= property(_GetFfsOutputDir
)
4569 DebugDir
= property(_GetDebugDir
)
4570 MakeFileDir
= property(_GetMakeFileDir
)
4571 CustomMakefile
= property(_GetCustomMakefile
)
4573 IncludePathList
= property(_GetIncludePathList
)
4574 IncludePathLength
= property(_GetIncludePathLength
)
4575 AutoGenFileList
= property(_GetAutoGenFileList
)
4576 UnicodeFileList
= property(_GetUnicodeFileList
)
4577 VfrFileList
= property(_GetVfrFileList
)
4578 SourceFileList
= property(_GetSourceFileList
)
4579 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4580 Targets
= property(_GetTargets
)
4581 IntroTargetList
= property(_GetIntroTargetList
)
4582 CodaTargetList
= property(_GetFinalTargetList
)
4583 FileTypes
= property(_GetFileTypes
)
4584 BuildRules
= property(_GetBuildRules
)
4585 IdfFileList
= property(_GetIdfFileList
)
4587 DependentPackageList
= property(_GetDependentPackageList
)
4588 DependentLibraryList
= property(_GetLibraryList
)
4589 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4590 DerivedPackageList
= property(_GetDerivedPackageList
)
4592 ModulePcdList
= property(_GetModulePcdList
)
4593 LibraryPcdList
= property(_GetLibraryPcdList
)
4594 GuidList
= property(_GetGuidList
)
4595 ProtocolList
= property(_GetProtocolList
)
4596 PpiList
= property(_GetPpiList
)
4597 DepexList
= property(_GetDepexTokenList
)
4598 DxsFile
= property(_GetDxsFile
)
4599 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4600 BuildOption
= property(_GetModuleBuildOption
)
4601 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4602 BuildCommand
= property(_GetBuildCommand
)
4604 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4606 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4607 if __name__
== '__main__':