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 in each child class
163 __ObjectCache
= {} # (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__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
178 # check if the object has been created
179 Key
= (Target
, Toolchain
, Arch
, MetaFile
)
181 # if it exists, just return it directly
182 return cls
.__ObjectCache
[Key
]
184 # it didnt exist. create it, cache it, then return it
185 cls
.__ObjectCache
[Key
] = super(AutoGen
, cls
).__new
__(cls
)
186 return cls
.__ObjectCache
[Key
]
188 def __init__ (self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
189 super(AutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
193 # The file path of platform file will be used to represent hash value of this object
195 # @retval int Hash value of the file path of platform file
198 return hash(self
.MetaFile
)
202 # The file path of platform file will be used to represent this object
204 # @retval string String of platform file path
207 return str(self
.MetaFile
)
210 def __eq__(self
, Other
):
211 return Other
and self
.MetaFile
== Other
213 ## Workspace AutoGen class
215 # This class is used mainly to control the whole platform build for different
216 # architecture. This class will generate top level makefile.
218 class WorkspaceAutoGen(AutoGen
):
219 # call super().__init__ then call the worker function with different parameter count
220 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
224 super(WorkspaceAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
225 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
228 ## Initialize WorkspaceAutoGen
230 # @param WorkspaceDir Root directory of workspace
231 # @param ActivePlatform Meta-file of active platform
232 # @param Target Build target
233 # @param Toolchain Tool chain name
234 # @param ArchList List of architecture of current build
235 # @param MetaFileDb Database containing meta-files
236 # @param BuildConfig Configuration of build
237 # @param ToolDefinition Tool chain definitions
238 # @param FlashDefinitionFile File of flash definition
239 # @param Fds FD list to be generated
240 # @param Fvs FV list to be generated
241 # @param Caps Capsule list to be generated
242 # @param SkuId SKU id from command line
244 def _InitWorker(self
, WorkspaceDir
, ActivePlatform
, Target
, Toolchain
, ArchList
, MetaFileDb
,
245 BuildConfig
, ToolDefinition
, FlashDefinitionFile
='', Fds
=None, Fvs
=None, Caps
=None, SkuId
='', UniFlag
=None,
246 Progress
=None, BuildModule
=None):
253 self
.BuildDatabase
= MetaFileDb
254 self
.MetaFile
= ActivePlatform
255 self
.WorkspaceDir
= WorkspaceDir
256 self
.Platform
= self
.BuildDatabase
[self
.MetaFile
, 'COMMON', Target
, Toolchain
]
257 GlobalData
.gActivePlatform
= self
.Platform
258 self
.BuildTarget
= Target
259 self
.ToolChain
= Toolchain
260 self
.ArchList
= ArchList
262 self
.UniFlag
= UniFlag
264 self
.TargetTxt
= BuildConfig
265 self
.ToolDef
= ToolDefinition
266 self
.FdfFile
= FlashDefinitionFile
267 self
.FdTargetList
= Fds
268 self
.FvTargetList
= Fvs
269 self
.CapTargetList
= Caps
270 self
.AutoGenObjectList
= []
271 self
._BuildDir
= None
273 self
._MakeFileDir
= None
274 self
._BuildCommand
= None
277 # there's many relative directory operations, so ...
278 os
.chdir(self
.WorkspaceDir
)
283 if not self
.ArchList
:
284 ArchList
= set(self
.Platform
.SupArchList
)
286 ArchList
= set(self
.ArchList
) & set(self
.Platform
.SupArchList
)
288 EdkLogger
.error("build", PARAMETER_INVALID
,
289 ExtraData
= "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self
.Platform
.SupArchList
)))
290 elif self
.ArchList
and len(ArchList
) != len(self
.ArchList
):
291 SkippedArchList
= set(self
.ArchList
).symmetric_difference(set(self
.Platform
.SupArchList
))
292 EdkLogger
.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"
293 % (" ".join(SkippedArchList
), " ".join(self
.Platform
.SupArchList
)))
294 self
.ArchList
= tuple(ArchList
)
296 # Validate build target
297 if self
.BuildTarget
not in self
.Platform
.BuildTargets
:
298 EdkLogger
.error("build", PARAMETER_INVALID
,
299 ExtraData
="Build target [%s] is not supported by the platform. [Valid target: %s]"
300 % (self
.BuildTarget
, " ".join(self
.Platform
.BuildTargets
)))
303 # parse FDF file to get PCDs in it, if any
305 self
.FdfFile
= self
.Platform
.FlashDefinition
309 EdkLogger
.info('%-16s = %s' % ("Architecture(s)", ' '.join(self
.ArchList
)))
310 EdkLogger
.info('%-16s = %s' % ("Build target", self
.BuildTarget
))
311 EdkLogger
.info('%-16s = %s' % ("Toolchain", self
.ToolChain
))
313 EdkLogger
.info('\n%-24s = %s' % ("Active Platform", self
.Platform
))
315 EdkLogger
.info('%-24s = %s' % ("Active Module", BuildModule
))
318 EdkLogger
.info('%-24s = %s' % ("Flash Image Definition", self
.FdfFile
))
320 EdkLogger
.verbose("\nFLASH_DEFINITION = %s" % self
.FdfFile
)
323 Progress
.Start("\nProcessing meta-data")
327 # Mark now build in AutoGen Phase
329 GlobalData
.gAutoGenPhase
= True
330 Fdf
= FdfParser(self
.FdfFile
.Path
)
332 GlobalData
.gFdfParser
= Fdf
333 GlobalData
.gAutoGenPhase
= False
334 PcdSet
= Fdf
.Profile
.PcdDict
335 if Fdf
.CurrentFdName
and Fdf
.CurrentFdName
in Fdf
.Profile
.FdDict
:
336 FdDict
= Fdf
.Profile
.FdDict
[Fdf
.CurrentFdName
]
337 for FdRegion
in FdDict
.RegionList
:
338 if str(FdRegion
.RegionType
) is 'FILE' and self
.Platform
.VpdToolGuid
in str(FdRegion
.RegionDataList
):
339 if int(FdRegion
.Offset
) % 8 != 0:
340 EdkLogger
.error("build", FORMAT_INVALID
, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion
.Offset
))
341 ModuleList
= Fdf
.Profile
.InfList
342 self
.FdfProfile
= Fdf
.Profile
343 for fvname
in self
.FvTargetList
:
344 if fvname
.upper() not in self
.FdfProfile
.FvDict
:
345 EdkLogger
.error("build", OPTION_VALUE_INVALID
,
346 "No such an FV in FDF file: %s" % fvname
)
348 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,
349 # but the path (self.MetaFile.Path) is the real path
350 for key
in self
.FdfProfile
.InfDict
:
354 for Arch
in self
.ArchList
:
355 Platform_cache
[Arch
] = self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
356 MetaFile_cache
[Arch
] = []
357 for Pkey
in Platform_cache
[Arch
].Modules
.keys():
358 MetaFile_cache
[Arch
].append(Platform_cache
[Arch
].Modules
[Pkey
].MetaFile
)
359 for Inf
in self
.FdfProfile
.InfDict
[key
]:
360 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
361 for Arch
in self
.ArchList
:
362 if ModuleFile
in MetaFile_cache
[Arch
]:
365 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
366 if not ModuleData
.IsBinaryModule
:
367 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
370 for Arch
in self
.ArchList
:
372 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
374 for Pkey
in Platform
.Modules
.keys():
375 MetaFileList
.append(Platform
.Modules
[Pkey
].MetaFile
)
376 for Inf
in self
.FdfProfile
.InfDict
[key
]:
377 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
378 if ModuleFile
in MetaFileList
:
380 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
381 if not ModuleData
.IsBinaryModule
:
382 EdkLogger
.error('build', PARSER_ERROR
, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile
)
387 self
.FdfProfile
= None
388 if self
.FdTargetList
:
389 EdkLogger
.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self
.FdTargetList
))
390 self
.FdTargetList
= []
391 if self
.FvTargetList
:
392 EdkLogger
.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self
.FvTargetList
))
393 self
.FvTargetList
= []
394 if self
.CapTargetList
:
395 EdkLogger
.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self
.CapTargetList
))
396 self
.CapTargetList
= []
398 # apply SKU and inject PCDs from Flash Definition file
399 for Arch
in self
.ArchList
:
400 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
407 SourcePcdDict
= {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}
408 BinaryPcdDict
= {'DynamicEx':[], 'PatchableInModule':[]}
409 SourcePcdDict_Keys
= SourcePcdDict
.keys()
410 BinaryPcdDict_Keys
= BinaryPcdDict
.keys()
412 # generate the SourcePcdDict and BinaryPcdDict
413 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
414 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
415 if BuildData
.Arch
!= Arch
:
417 if BuildData
.MetaFile
.Ext
== '.inf':
418 for key
in BuildData
.Pcds
:
419 if BuildData
.Pcds
[key
].Pending
:
420 if key
in Platform
.Pcds
:
421 PcdInPlatform
= Platform
.Pcds
[key
]
422 if PcdInPlatform
.Type
not in [None, '']:
423 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
425 if BuildData
.MetaFile
in Platform
.Modules
:
426 PlatformModule
= Platform
.Modules
[str(BuildData
.MetaFile
)]
427 if key
in PlatformModule
.Pcds
:
428 PcdInPlatform
= PlatformModule
.Pcds
[key
]
429 if PcdInPlatform
.Type
not in [None, '']:
430 BuildData
.Pcds
[key
].Type
= PcdInPlatform
.Type
432 if 'DynamicEx' in BuildData
.Pcds
[key
].Type
:
433 if BuildData
.IsBinaryModule
:
434 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in BinaryPcdDict
['DynamicEx']:
435 BinaryPcdDict
['DynamicEx'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
437 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['DynamicEx']:
438 SourcePcdDict
['DynamicEx'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
440 elif 'PatchableInModule' in BuildData
.Pcds
[key
].Type
:
441 if BuildData
.MetaFile
.Ext
== '.inf':
442 if BuildData
.IsBinaryModule
:
443 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in BinaryPcdDict
['PatchableInModule']:
444 BinaryPcdDict
['PatchableInModule'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
446 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['PatchableInModule']:
447 SourcePcdDict
['PatchableInModule'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
449 elif 'Dynamic' in BuildData
.Pcds
[key
].Type
:
450 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['Dynamic']:
451 SourcePcdDict
['Dynamic'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
452 elif 'FixedAtBuild' in BuildData
.Pcds
[key
].Type
:
453 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) not in SourcePcdDict
['FixedAtBuild']:
454 SourcePcdDict
['FixedAtBuild'].append((BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
))
458 # A PCD can only use one type for all source modules
460 for i
in SourcePcdDict_Keys
:
461 for j
in SourcePcdDict_Keys
:
463 IntersectionList
= list(set(SourcePcdDict
[i
]).intersection(set(SourcePcdDict
[j
])))
464 if len(IntersectionList
) > 0:
468 "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
),
469 ExtraData
="%s" % '\n\t'.join([str(P
[1]+'.'+P
[0]) for P
in IntersectionList
])
475 # intersection the BinaryPCD for Mixed PCD
477 for i
in BinaryPcdDict_Keys
:
478 for j
in BinaryPcdDict_Keys
:
480 IntersectionList
= list(set(BinaryPcdDict
[i
]).intersection(set(BinaryPcdDict
[j
])))
481 for item
in IntersectionList
:
482 NewPcd1
= (item
[0] + '_' + i
, item
[1])
483 NewPcd2
= (item
[0] + '_' + j
, item
[1])
484 if item
not in GlobalData
.MixedPcd
:
485 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
487 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
488 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
489 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
490 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
495 # intersection the SourcePCD and BinaryPCD for Mixed PCD
497 for i
in SourcePcdDict_Keys
:
498 for j
in BinaryPcdDict_Keys
:
500 IntersectionList
= list(set(SourcePcdDict
[i
]).intersection(set(BinaryPcdDict
[j
])))
501 for item
in IntersectionList
:
502 NewPcd1
= (item
[0] + '_' + i
, item
[1])
503 NewPcd2
= (item
[0] + '_' + j
, item
[1])
504 if item
not in GlobalData
.MixedPcd
:
505 GlobalData
.MixedPcd
[item
] = [NewPcd1
, NewPcd2
]
507 if NewPcd1
not in GlobalData
.MixedPcd
[item
]:
508 GlobalData
.MixedPcd
[item
].append(NewPcd1
)
509 if NewPcd2
not in GlobalData
.MixedPcd
[item
]:
510 GlobalData
.MixedPcd
[item
].append(NewPcd2
)
514 for BuildData
in PGen
.BuildDatabase
._CACHE
_.values():
515 if BuildData
.Arch
!= Arch
:
517 for key
in BuildData
.Pcds
:
518 for SinglePcd
in GlobalData
.MixedPcd
:
519 if (BuildData
.Pcds
[key
].TokenCName
, BuildData
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
520 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
521 Pcd_Type
= item
[0].split('_')[-1]
522 if (Pcd_Type
== BuildData
.Pcds
[key
].Type
) or (Pcd_Type
== TAB_PCDS_DYNAMIC_EX
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicExPcd
) or \
523 (Pcd_Type
== TAB_PCDS_DYNAMIC
and BuildData
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
524 Value
= BuildData
.Pcds
[key
]
525 Value
.TokenCName
= BuildData
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
527 newkey
= (Value
.TokenCName
, key
[1])
529 newkey
= (Value
.TokenCName
, key
[1], key
[2])
530 del BuildData
.Pcds
[key
]
531 BuildData
.Pcds
[newkey
] = Value
539 # handle the mixed pcd in FDF file
541 if key
in GlobalData
.MixedPcd
:
544 for item
in GlobalData
.MixedPcd
[key
]:
547 #Collect package set information from INF of FDF
549 for Inf
in ModuleList
:
550 ModuleFile
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, Arch
)
551 if ModuleFile
in Platform
.Modules
:
553 ModuleData
= self
.BuildDatabase
[ModuleFile
, Arch
, Target
, Toolchain
]
554 PkgSet
.update(ModuleData
.Packages
)
555 Pkgs
= list(PkgSet
) + list(PGen
.PackageList
)
560 DecPcds
[Pcd
[0], Pcd
[1]] = Pkg
.Pcds
[Pcd
]
561 DecPcdsKey
.add((Pcd
[0], Pcd
[1], Pcd
[2]))
563 Platform
.SkuName
= self
.SkuId
564 for Name
, Guid
in PcdSet
:
565 if (Name
, Guid
) not in DecPcds
:
569 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid
, Name
),
570 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
571 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
574 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.
575 if (Name
, Guid
, TAB_PCDS_FIXED_AT_BUILD
) in DecPcdsKey \
576 or (Name
, Guid
, TAB_PCDS_PATCHABLE_IN_MODULE
) in DecPcdsKey \
577 or (Name
, Guid
, TAB_PCDS_FEATURE_FLAG
) in DecPcdsKey
:
578 Platform
.AddPcd(Name
, Guid
, PcdSet
[Name
, Guid
])
580 elif (Name
, Guid
, TAB_PCDS_DYNAMIC
) in DecPcdsKey
or (Name
, Guid
, TAB_PCDS_DYNAMIC_EX
) in DecPcdsKey
:
584 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid
, Name
),
585 File
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][0],
586 Line
= self
.FdfProfile
.PcdFileLineDict
[Name
, Guid
][1]
589 Pa
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
591 # Explicitly collect platform's dynamic PCDs
593 Pa
.CollectPlatformDynamicPcds()
594 Pa
.CollectFixedAtBuildPcds()
595 self
.AutoGenObjectList
.append(Pa
)
598 # Generate Package level hash value
600 GlobalData
.gPackageHash
[Arch
] = {}
601 if GlobalData
.gUseHashCache
:
603 self
._GenPkgLevelHash
(Pkg
)
606 # Check PCDs token value conflict in each DEC file.
608 self
._CheckAllPcdsTokenValueConflict
()
611 # Check PCD type and definition between DSC and DEC
613 self
._CheckPcdDefineAndType
()
616 # self._CheckDuplicateInFV(Fdf)
619 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.
621 content
= 'gCommandLineDefines: '
622 content
+= str(GlobalData
.gCommandLineDefines
)
623 content
+= os
.linesep
624 content
+= 'BuildOptionPcd: '
625 content
+= str(GlobalData
.BuildOptionPcd
)
626 content
+= os
.linesep
627 content
+= 'Active Platform: '
628 content
+= str(self
.Platform
)
629 content
+= os
.linesep
631 content
+= 'Flash Image Definition: '
632 content
+= str(self
.FdfFile
)
633 content
+= os
.linesep
634 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'BuildOptions'), content
, False)
637 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.
639 PcdTokenNumber
= 'PcdTokenNumber: '
640 if Pa
.PcdTokenNumber
:
641 if Pa
.DynamicPcdList
:
642 for Pcd
in Pa
.DynamicPcdList
:
643 PcdTokenNumber
+= os
.linesep
644 PcdTokenNumber
+= str((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
))
645 PcdTokenNumber
+= ' : '
646 PcdTokenNumber
+= str(Pa
.PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
])
647 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'), PcdTokenNumber
, False)
650 # Get set of workspace metafiles
652 AllWorkSpaceMetaFiles
= self
._GetMetaFiles
(Target
, Toolchain
, Arch
)
655 # Retrieve latest modified time of all metafiles
658 for f
in AllWorkSpaceMetaFiles
:
659 if os
.stat(f
)[8] > SrcTimeStamp
:
660 SrcTimeStamp
= os
.stat(f
)[8]
661 self
._SrcTimeStamp
= SrcTimeStamp
663 if GlobalData
.gUseHashCache
:
665 for files
in AllWorkSpaceMetaFiles
:
666 if files
.endswith('.dec'):
672 SaveFileOnChange(os
.path
.join(self
.BuildDir
, 'AutoGen.hash'), m
.hexdigest(), True)
673 GlobalData
.gPlatformHash
= m
.hexdigest()
676 # Write metafile list to build directory
678 AutoGenFilePath
= os
.path
.join(self
.BuildDir
, 'AutoGen')
679 if os
.path
.exists (AutoGenFilePath
):
680 os
.remove(AutoGenFilePath
)
681 if not os
.path
.exists(self
.BuildDir
):
682 os
.makedirs(self
.BuildDir
)
683 with
open(os
.path
.join(self
.BuildDir
, 'AutoGen'), 'w+') as file:
684 for f
in AllWorkSpaceMetaFiles
:
688 def _GenPkgLevelHash(self
, Pkg
):
689 PkgDir
= os
.path
.join(self
.BuildDir
, Pkg
.Arch
, Pkg
.PackageName
)
690 CreateDirectory(PkgDir
)
691 HashFile
= os
.path
.join(PkgDir
, Pkg
.PackageName
+ '.hash')
693 # Get .dec file's hash value
694 f
= open(Pkg
.MetaFile
.Path
, 'r')
698 # Get include files hash value
700 for inc
in Pkg
.Includes
:
701 for Root
, Dirs
, Files
in os
.walk(str(inc
)):
703 File_Path
= os
.path
.join(Root
, File
)
704 f
= open(File_Path
, 'r')
708 SaveFileOnChange(HashFile
, m
.hexdigest(), True)
709 if Pkg
.PackageName
not in GlobalData
.gPackageHash
[Pkg
.Arch
]:
710 GlobalData
.gPackageHash
[Pkg
.Arch
][Pkg
.PackageName
] = m
.hexdigest()
712 def _GetMetaFiles(self
, Target
, Toolchain
, Arch
):
713 AllWorkSpaceMetaFiles
= set()
718 AllWorkSpaceMetaFiles
.add (self
.FdfFile
.Path
)
720 FdfFiles
= GlobalData
.gFdfParser
.GetAllIncludedFile()
722 AllWorkSpaceMetaFiles
.add (f
.FileName
)
726 AllWorkSpaceMetaFiles
.add(self
.MetaFile
.Path
)
729 # add build_rule.txt & tools_def.txt
731 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultBuildRuleFile
))
732 AllWorkSpaceMetaFiles
.add(os
.path
.join(GlobalData
.gConfDirectory
, gDefaultToolsDefFile
))
734 # add BuildOption metafile
736 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'BuildOptions'))
738 # add PcdToken Number file for Dynamic/DynamicEx Pcd
740 AllWorkSpaceMetaFiles
.add(os
.path
.join(self
.BuildDir
, 'PcdTokenNumber'))
742 for Arch
in self
.ArchList
:
743 Platform
= self
.BuildDatabase
[self
.MetaFile
, Arch
, Target
, Toolchain
]
744 PGen
= PlatformAutoGen(self
, self
.MetaFile
, Target
, Toolchain
, Arch
)
749 for Package
in PGen
.PackageList
:
750 AllWorkSpaceMetaFiles
.add(Package
.MetaFile
.Path
)
755 for filePath
in Platform
._RawData
.IncludedFiles
:
756 AllWorkSpaceMetaFiles
.add(filePath
.Path
)
758 return AllWorkSpaceMetaFiles
760 ## _CheckDuplicateInFV() method
762 # Check whether there is duplicate modules/files exist in FV section.
763 # The check base on the file GUID;
765 def _CheckDuplicateInFV(self
, Fdf
):
766 for Fv
in Fdf
.Profile
.FvDict
:
768 for FfsFile
in Fdf
.Profile
.FvDict
[Fv
].FfsList
:
769 if FfsFile
.InfFileName
and FfsFile
.NameGuid
== None:
774 for Pa
in self
.AutoGenObjectList
:
777 for Module
in Pa
.ModuleAutoGenList
:
778 if path
.normpath(Module
.MetaFile
.File
) == path
.normpath(FfsFile
.InfFileName
):
780 if not Module
.Guid
.upper() in _GuidDict
.keys():
781 _GuidDict
[Module
.Guid
.upper()] = FfsFile
784 EdkLogger
.error("build",
786 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
787 FfsFile
.CurrentLineContent
,
788 _GuidDict
[Module
.Guid
.upper()].CurrentLineNum
,
789 _GuidDict
[Module
.Guid
.upper()].CurrentLineContent
,
790 Module
.Guid
.upper()),
791 ExtraData
=self
.FdfFile
)
793 # Some INF files not have entity in DSC file.
796 if FfsFile
.InfFileName
.find('$') == -1:
797 InfPath
= NormPath(FfsFile
.InfFileName
)
798 if not os
.path
.exists(InfPath
):
799 EdkLogger
.error('build', GENFDS_ERROR
, "Non-existant Module %s !" % (FfsFile
.InfFileName
))
801 PathClassObj
= PathClass(FfsFile
.InfFileName
, self
.WorkspaceDir
)
803 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use
804 # BuildObject from one of AutoGenObjectList is enough.
806 InfObj
= self
.AutoGenObjectList
[0].BuildDatabase
.WorkspaceDb
.BuildObject
[PathClassObj
, 'COMMON', self
.BuildTarget
, self
.ToolChain
]
807 if not InfObj
.Guid
.upper() in _GuidDict
.keys():
808 _GuidDict
[InfObj
.Guid
.upper()] = FfsFile
810 EdkLogger
.error("build",
812 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
813 FfsFile
.CurrentLineContent
,
814 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineNum
,
815 _GuidDict
[InfObj
.Guid
.upper()].CurrentLineContent
,
816 InfObj
.Guid
.upper()),
817 ExtraData
=self
.FdfFile
)
820 if FfsFile
.NameGuid
!= None:
821 _CheckPCDAsGuidPattern
= re
.compile("^PCD\(.+\..+\)$")
824 # If the NameGuid reference a PCD name.
825 # The style must match: PCD(xxxx.yyy)
827 if _CheckPCDAsGuidPattern
.match(FfsFile
.NameGuid
):
829 # Replace the PCD value.
831 _PcdName
= FfsFile
.NameGuid
.lstrip("PCD(").rstrip(")")
833 for Pa
in self
.AutoGenObjectList
:
835 for PcdItem
in Pa
.AllPcdList
:
836 if (PcdItem
.TokenSpaceGuidCName
+ "." + PcdItem
.TokenCName
) == _PcdName
:
838 # First convert from CFormatGuid to GUID string
840 _PcdGuidString
= GuidStructureStringToGuidString(PcdItem
.DefaultValue
)
842 if not _PcdGuidString
:
844 # Then try Byte array.
846 _PcdGuidString
= GuidStructureByteArrayToGuidString(PcdItem
.DefaultValue
)
848 if not _PcdGuidString
:
850 # Not Byte array or CFormat GUID, raise error.
852 EdkLogger
.error("build",
854 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName
, PcdItem
.DefaultValue
),
855 ExtraData
=self
.FdfFile
)
857 if not _PcdGuidString
.upper() in _GuidDict
.keys():
858 _GuidDict
[_PcdGuidString
.upper()] = FfsFile
862 EdkLogger
.error("build",
864 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
865 FfsFile
.CurrentLineContent
,
866 _GuidDict
[_PcdGuidString
.upper()].CurrentLineNum
,
867 _GuidDict
[_PcdGuidString
.upper()].CurrentLineContent
,
868 FfsFile
.NameGuid
.upper()),
869 ExtraData
=self
.FdfFile
)
871 if not FfsFile
.NameGuid
.upper() in _GuidDict
.keys():
872 _GuidDict
[FfsFile
.NameGuid
.upper()] = FfsFile
875 # Two raw file GUID conflict.
877 EdkLogger
.error("build",
879 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile
.CurrentLineNum
,
880 FfsFile
.CurrentLineContent
,
881 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineNum
,
882 _GuidDict
[FfsFile
.NameGuid
.upper()].CurrentLineContent
,
883 FfsFile
.NameGuid
.upper()),
884 ExtraData
=self
.FdfFile
)
887 def _CheckPcdDefineAndType(self
):
889 "FixedAtBuild", "PatchableInModule", "FeatureFlag",
890 "Dynamic", #"DynamicHii", "DynamicVpd",
891 "DynamicEx", # "DynamicExHii", "DynamicExVpd"
894 # This dict store PCDs which are not used by any modules with specified arches
896 for Pa
in self
.AutoGenObjectList
:
897 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid
898 for Pcd
in Pa
.Platform
.Pcds
:
899 PcdType
= Pa
.Platform
.Pcds
[Pcd
].Type
901 # If no PCD type, this PCD comes from FDF
905 # Try to remove Hii and Vpd suffix
906 if PcdType
.startswith("DynamicEx"):
907 PcdType
= "DynamicEx"
908 elif PcdType
.startswith("Dynamic"):
911 for Package
in Pa
.PackageList
:
912 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType
913 if (Pcd
[0], Pcd
[1], PcdType
) in Package
.Pcds
:
915 for Type
in PcdTypeList
:
916 if (Pcd
[0], Pcd
[1], Type
) in Package
.Pcds
:
920 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \
921 % (Pa
.Platform
.Pcds
[Pcd
].Type
, Pcd
[1], Pcd
[0], Type
),
926 UnusedPcd
.setdefault(Pcd
, []).append(Pa
.Arch
)
928 for Pcd
in UnusedPcd
:
931 "The PCD was not specified by any INF module in the platform for the given architecture.\n"
932 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"
933 % (Pcd
[1], Pcd
[0], os
.path
.basename(str(self
.MetaFile
)), str(UnusedPcd
[Pcd
])),
938 return "%s [%s]" % (self
.MetaFile
, ", ".join(self
.ArchList
))
940 ## Return the directory to store FV files
942 if self
._FvDir
== None:
943 self
._FvDir
= path
.join(self
.BuildDir
, 'FV')
946 ## Return the directory to store all intermediate and final files built
947 def _GetBuildDir(self
):
948 if self
._BuildDir
== None:
949 return self
.AutoGenObjectList
[0].BuildDir
951 ## Return the build output directory platform specifies
952 def _GetOutputDir(self
):
953 return self
.Platform
.OutputDirectory
955 ## Return platform name
957 return self
.Platform
.PlatformName
959 ## Return meta-file GUID
961 return self
.Platform
.Guid
963 ## Return platform version
964 def _GetVersion(self
):
965 return self
.Platform
.Version
967 ## Return paths of tools
968 def _GetToolDefinition(self
):
969 return self
.AutoGenObjectList
[0].ToolDefinition
971 ## Return directory of platform makefile
973 # @retval string Makefile directory
975 def _GetMakeFileDir(self
):
976 if self
._MakeFileDir
== None:
977 self
._MakeFileDir
= self
.BuildDir
978 return self
._MakeFileDir
980 ## Return build command string
982 # @retval string Build command string
984 def _GetBuildCommand(self
):
985 if self
._BuildCommand
== None:
986 # BuildCommand should be all the same. So just get one from platform AutoGen
987 self
._BuildCommand
= self
.AutoGenObjectList
[0].BuildCommand
988 return self
._BuildCommand
990 ## Check the PCDs token value conflict in each DEC file.
992 # Will cause build break and raise error message while two PCDs conflict.
996 def _CheckAllPcdsTokenValueConflict(self
):
997 for Pa
in self
.AutoGenObjectList
:
998 for Package
in Pa
.PackageList
:
999 PcdList
= Package
.Pcds
.values()
1000 PcdList
.sort(lambda x
, y
: cmp(int(x
.TokenValue
, 0), int(y
.TokenValue
, 0)))
1002 while (Count
< len(PcdList
) - 1) :
1003 Item
= PcdList
[Count
]
1004 ItemNext
= PcdList
[Count
+ 1]
1006 # Make sure in the same token space the TokenValue should be unique
1008 if (int(Item
.TokenValue
, 0) == int(ItemNext
.TokenValue
, 0)):
1009 SameTokenValuePcdList
= []
1010 SameTokenValuePcdList
.append(Item
)
1011 SameTokenValuePcdList
.append(ItemNext
)
1012 RemainPcdListLength
= len(PcdList
) - Count
- 2
1013 for ValueSameCount
in range(RemainPcdListLength
):
1014 if int(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
].TokenValue
, 0) == int(Item
.TokenValue
, 0):
1015 SameTokenValuePcdList
.append(PcdList
[len(PcdList
) - RemainPcdListLength
+ ValueSameCount
])
1019 # Sort same token value PCD list with TokenGuid and TokenCName
1021 SameTokenValuePcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1022 SameTokenValuePcdListCount
= 0
1023 while (SameTokenValuePcdListCount
< len(SameTokenValuePcdList
) - 1):
1025 TemListItem
= SameTokenValuePcdList
[SameTokenValuePcdListCount
]
1026 TemListItemNext
= SameTokenValuePcdList
[SameTokenValuePcdListCount
+ 1]
1028 if (TemListItem
.TokenSpaceGuidCName
== TemListItemNext
.TokenSpaceGuidCName
) and (TemListItem
.TokenCName
!= TemListItemNext
.TokenCName
):
1029 for PcdItem
in GlobalData
.MixedPcd
:
1030 if (TemListItem
.TokenCName
, TemListItem
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
] or \
1031 (TemListItemNext
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1037 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\
1038 % (TemListItem
.TokenValue
, TemListItem
.TokenSpaceGuidCName
, TemListItem
.TokenCName
, TemListItemNext
.TokenSpaceGuidCName
, TemListItemNext
.TokenCName
, Package
),
1041 SameTokenValuePcdListCount
+= 1
1042 Count
+= SameTokenValuePcdListCount
1045 PcdList
= Package
.Pcds
.values()
1046 PcdList
.sort(lambda x
, y
: cmp("%s.%s" % (x
.TokenSpaceGuidCName
, x
.TokenCName
), "%s.%s" % (y
.TokenSpaceGuidCName
, y
.TokenCName
)))
1048 while (Count
< len(PcdList
) - 1) :
1049 Item
= PcdList
[Count
]
1050 ItemNext
= PcdList
[Count
+ 1]
1052 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.
1054 if (Item
.TokenSpaceGuidCName
== ItemNext
.TokenSpaceGuidCName
) and (Item
.TokenCName
== ItemNext
.TokenCName
) and (int(Item
.TokenValue
, 0) != int(ItemNext
.TokenValue
, 0)):
1058 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\
1059 % (Item
.TokenValue
, Item
.TokenSpaceGuidCName
, Item
.TokenCName
, Package
),
1063 ## Generate fds command
1064 def _GenFdsCommand(self
):
1065 return (GenMake
.TopLevelMakefile(self
)._TEMPLATE
_.Replace(GenMake
.TopLevelMakefile(self
)._TemplateDict
)).strip()
1067 ## Create makefile for the platform and modules in it
1069 # @param CreateDepsMakeFile Flag indicating if the makefile for
1070 # modules will be created as well
1072 def CreateMakeFile(self
, CreateDepsMakeFile
=False):
1073 if CreateDepsMakeFile
:
1074 for Pa
in self
.AutoGenObjectList
:
1075 Pa
.CreateMakeFile(CreateDepsMakeFile
)
1077 ## Create autogen code for platform and modules
1079 # Since there's no autogen code for platform, this method will do nothing
1080 # if CreateModuleCodeFile is set to False.
1082 # @param CreateDepsCodeFile Flag indicating if creating module's
1083 # autogen code file or not
1085 def CreateCodeFile(self
, CreateDepsCodeFile
=False):
1086 if not CreateDepsCodeFile
:
1088 for Pa
in self
.AutoGenObjectList
:
1089 Pa
.CreateCodeFile(CreateDepsCodeFile
)
1091 ## Create AsBuilt INF file the platform
1093 def CreateAsBuiltInf(self
):
1096 Name
= property(_GetName
)
1097 Guid
= property(_GetGuid
)
1098 Version
= property(_GetVersion
)
1099 OutputDir
= property(_GetOutputDir
)
1101 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
1103 BuildDir
= property(_GetBuildDir
)
1104 FvDir
= property(_GetFvDir
)
1105 MakeFileDir
= property(_GetMakeFileDir
)
1106 BuildCommand
= property(_GetBuildCommand
)
1107 GenFdsCommand
= property(_GenFdsCommand
)
1109 ## AutoGen class for platform
1111 # PlatformAutoGen class will process the original information in platform
1112 # file in order to generate makefile for platform.
1114 class PlatformAutoGen(AutoGen
):
1115 # call super().__init__ then call the worker function with different parameter count
1116 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
1120 super(PlatformAutoGen
, self
).__init
__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
1121 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
)
1124 # Used to store all PCDs for both PEI and DXE phase, in order to generate
1125 # correct PCD database
1128 _NonDynaPcdList_
= []
1132 # The priority list while override build option
1134 PrioList
= {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)
1135 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
1136 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1137 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE
1138 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1139 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE
1140 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE
1141 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE
1142 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1143 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE
1144 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE
1145 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE
1146 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE
1147 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE
1148 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE
1149 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)
1151 ## Initialize PlatformAutoGen
1154 # @param Workspace WorkspaceAutoGen object
1155 # @param PlatformFile Platform file (DSC file)
1156 # @param Target Build target (DEBUG, RELEASE)
1157 # @param Toolchain Name of tool chain
1158 # @param Arch arch of the platform supports
1160 def _InitWorker(self
, Workspace
, PlatformFile
, Target
, Toolchain
, Arch
):
1161 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen platform [%s] [%s]" % (PlatformFile
, Arch
))
1162 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (PlatformFile
, Arch
, Toolchain
, Target
)
1164 self
.MetaFile
= PlatformFile
1165 self
.Workspace
= Workspace
1166 self
.WorkspaceDir
= Workspace
.WorkspaceDir
1167 self
.ToolChain
= Toolchain
1168 self
.BuildTarget
= Target
1170 self
.SourceDir
= PlatformFile
.SubDir
1171 self
.SourceOverrideDir
= None
1172 self
.FdTargetList
= self
.Workspace
.FdTargetList
1173 self
.FvTargetList
= self
.Workspace
.FvTargetList
1174 self
.AllPcdList
= []
1175 # get the original module/package/platform objects
1176 self
.BuildDatabase
= Workspace
.BuildDatabase
1177 self
.DscBuildDataObj
= Workspace
.Platform
1178 self
._GuidDict
= Workspace
._GuidDict
1180 # flag indicating if the makefile/C-code file has been created or not
1181 self
.IsMakeFileCreated
= False
1182 self
.IsCodeFileCreated
= False
1184 self
._Platform
= None
1187 self
._Version
= None
1189 self
._BuildRule
= None
1190 self
._SourceDir
= None
1191 self
._BuildDir
= None
1192 self
._OutputDir
= None
1194 self
._MakeFileDir
= None
1195 self
._FdfFile
= None
1197 self
._PcdTokenNumber
= None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
1198 self
._DynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1199 self
._NonDynamicPcdList
= None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
1200 self
._NonDynamicPcdDict
= {}
1202 self
._ToolDefinitions
= None
1203 self
._ToolDefFile
= None # toolcode : tool path
1204 self
._ToolChainFamily
= None
1205 self
._BuildRuleFamily
= None
1206 self
._BuildOption
= None # toolcode : option
1207 self
._EdkBuildOption
= None # edktoolcode : option
1208 self
._EdkIIBuildOption
= None # edkiitoolcode : option
1209 self
._PackageList
= None
1210 self
._ModuleAutoGenList
= None
1211 self
._LibraryAutoGenList
= None
1212 self
._BuildCommand
= None
1213 self
._AsBuildInfList
= []
1214 self
._AsBuildModuleList
= []
1216 self
.VariableInfo
= None
1218 if GlobalData
.gFdfParser
!= None:
1219 self
._AsBuildInfList
= GlobalData
.gFdfParser
.Profile
.InfList
1220 for Inf
in self
._AsBuildInfList
:
1221 InfClass
= PathClass(NormPath(Inf
), GlobalData
.gWorkspace
, self
.Arch
)
1222 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1223 if not M
.IsSupportedArch
:
1225 self
._AsBuildModuleList
.append(InfClass
)
1226 # get library/modules for build
1227 self
.LibraryBuildDirectoryList
= []
1228 self
.ModuleBuildDirectoryList
= []
1233 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
1235 ## Create autogen code for platform and modules
1237 # Since there's no autogen code for platform, this method will do nothing
1238 # if CreateModuleCodeFile is set to False.
1240 # @param CreateModuleCodeFile Flag indicating if creating module's
1241 # autogen code file or not
1243 def CreateCodeFile(self
, CreateModuleCodeFile
=False):
1244 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False
1245 if self
.IsCodeFileCreated
or not CreateModuleCodeFile
:
1248 for Ma
in self
.ModuleAutoGenList
:
1249 Ma
.CreateCodeFile(True)
1251 # don't do this twice
1252 self
.IsCodeFileCreated
= True
1254 ## Generate Fds Command
1255 def _GenFdsCommand(self
):
1256 return self
.Workspace
.GenFdsCommand
1258 ## Create makefile for the platform and mdoules in it
1260 # @param CreateModuleMakeFile Flag indicating if the makefile for
1261 # modules will be created as well
1263 def CreateMakeFile(self
, CreateModuleMakeFile
=False, FfsCommand
= {}):
1264 if CreateModuleMakeFile
:
1265 for ModuleFile
in self
.Platform
.Modules
:
1266 Ma
= ModuleAutoGen(self
.Workspace
, ModuleFile
, self
.BuildTarget
,
1267 self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1268 if (ModuleFile
.File
, self
.Arch
) in FfsCommand
:
1269 Ma
.CreateMakeFile(True, FfsCommand
[ModuleFile
.File
, self
.Arch
])
1271 Ma
.CreateMakeFile(True)
1272 #Ma.CreateAsBuiltInf()
1274 # no need to create makefile for the platform more than once
1275 if self
.IsMakeFileCreated
:
1278 # create library/module build dirs for platform
1279 Makefile
= GenMake
.PlatformMakefile(self
)
1280 self
.LibraryBuildDirectoryList
= Makefile
.GetLibraryBuildDirectoryList()
1281 self
.ModuleBuildDirectoryList
= Makefile
.GetModuleBuildDirectoryList()
1283 self
.IsMakeFileCreated
= True
1285 ## Deal with Shared FixedAtBuild Pcds
1287 def CollectFixedAtBuildPcds(self
):
1288 for LibAuto
in self
.LibraryAutoGenList
:
1289 FixedAtBuildPcds
= {}
1290 ShareFixedAtBuildPcdsSameValue
= {}
1291 for Module
in LibAuto
._ReferenceModules
:
1292 for Pcd
in Module
.FixedAtBuildPcds
+ LibAuto
.FixedAtBuildPcds
:
1293 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1294 if key
not in FixedAtBuildPcds
:
1295 ShareFixedAtBuildPcdsSameValue
[key
] = True
1296 FixedAtBuildPcds
[key
] = Pcd
.DefaultValue
1298 if FixedAtBuildPcds
[key
] != Pcd
.DefaultValue
:
1299 ShareFixedAtBuildPcdsSameValue
[key
] = False
1300 for Pcd
in LibAuto
.FixedAtBuildPcds
:
1301 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1302 if (Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
) not in self
.NonDynamicPcdDict
:
1305 DscPcd
= self
.NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)]
1306 if DscPcd
.Type
!= "FixedAtBuild":
1308 if key
in ShareFixedAtBuildPcdsSameValue
and ShareFixedAtBuildPcdsSameValue
[key
]:
1309 LibAuto
.ConstPcd
[key
] = Pcd
.DefaultValue
1311 def CollectVariables(self
, DynamicPcdSet
):
1315 if self
.Workspace
.FdfFile
:
1316 FdDict
= self
.Workspace
.FdfProfile
.FdDict
[GlobalData
.gFdfParser
.CurrentFdName
]
1317 for FdRegion
in FdDict
.RegionList
:
1318 for item
in FdRegion
.RegionDataList
:
1319 if self
.Platform
.VpdToolGuid
.strip() and self
.Platform
.VpdToolGuid
in item
:
1320 VpdRegionSize
= FdRegion
.Size
1321 VpdRegionBase
= FdRegion
.Offset
1325 VariableInfo
= VariableMgr(self
.DscBuildDataObj
._GetDefaultStores
(),self
.DscBuildDataObj
._GetSkuIds
())
1326 VariableInfo
.SetVpdRegionMaxSize(VpdRegionSize
)
1327 VariableInfo
.SetVpdRegionOffset(VpdRegionBase
)
1329 for Pcd
in DynamicPcdSet
:
1330 pcdname
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1331 for SkuName
in Pcd
.SkuInfoList
:
1332 Sku
= Pcd
.SkuInfoList
[SkuName
]
1334 if SkuId
== None or SkuId
== '':
1336 if len(Sku
.VariableName
) > 0:
1337 VariableGuidStructure
= Sku
.VariableGuidValue
1338 VariableGuid
= GuidStructureStringToGuidString(VariableGuidStructure
)
1339 for StorageName
in Sku
.DefaultStoreDict
:
1340 VariableInfo
.append_variable(var_info(Index
,pcdname
,StorageName
,SkuName
, StringToArray(Sku
.VariableName
),VariableGuid
, Sku
.VariableOffset
, Sku
.VariableAttribute
, Sku
.HiiDefaultValue
,Sku
.DefaultStoreDict
[StorageName
],Pcd
.DatumType
))
1344 def UpdateNVStoreMaxSize(self
,OrgVpdFile
):
1345 if self
.VariableInfo
:
1346 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1347 PcdNvStoreDfBuffer
= [item
for item
in self
._DynamicPcdList
if item
.TokenCName
== "PcdNvStoreDefaultValueBuffer" and item
.TokenSpaceGuidCName
== "gEfiMdeModulePkgTokenSpaceGuid"]
1349 if PcdNvStoreDfBuffer
:
1350 if os
.path
.exists(VpdMapFilePath
):
1351 OrgVpdFile
.Read(VpdMapFilePath
)
1352 PcdItems
= OrgVpdFile
.GetOffset(PcdNvStoreDfBuffer
[0])
1353 NvStoreOffset
= PcdItems
.values()[0].strip() if PcdItems
else '0'
1355 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1357 NvStoreOffset
= int(NvStoreOffset
,16) if NvStoreOffset
.upper().startswith("0X") else int(NvStoreOffset
)
1358 default_skuobj
= PcdNvStoreDfBuffer
[0].SkuInfoList
.get("DEFAULT")
1359 maxsize
= self
.VariableInfo
.VpdRegionSize
- NvStoreOffset
if self
.VariableInfo
.VpdRegionSize
else len(default_skuobj
.DefaultValue
.split(","))
1360 var_data
= self
.VariableInfo
.PatchNVStoreDefaultMaxSize(maxsize
)
1362 if var_data
and default_skuobj
:
1363 default_skuobj
.DefaultValue
= var_data
1364 PcdNvStoreDfBuffer
[0].DefaultValue
= var_data
1365 PcdNvStoreDfBuffer
[0].SkuInfoList
.clear()
1366 PcdNvStoreDfBuffer
[0].SkuInfoList
['DEFAULT'] = default_skuobj
1367 PcdNvStoreDfBuffer
[0].MaxDatumSize
= str(len(default_skuobj
.DefaultValue
.split(",")))
1371 ## Collect dynamic PCDs
1373 # Gather dynamic PCDs list from each module and their settings from platform
1374 # This interface should be invoked explicitly when platform action is created.
1376 def CollectPlatformDynamicPcds(self
):
1378 for key
in self
.Platform
.Pcds
:
1379 for SinglePcd
in GlobalData
.MixedPcd
:
1380 if (self
.Platform
.Pcds
[key
].TokenCName
, self
.Platform
.Pcds
[key
].TokenSpaceGuidCName
) == SinglePcd
:
1381 for item
in GlobalData
.MixedPcd
[SinglePcd
]:
1382 Pcd_Type
= item
[0].split('_')[-1]
1383 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 \
1384 (Pcd_Type
== TAB_PCDS_DYNAMIC
and self
.Platform
.Pcds
[key
].Type
in GenC
.gDynamicPcd
):
1385 Value
= self
.Platform
.Pcds
[key
]
1386 Value
.TokenCName
= self
.Platform
.Pcds
[key
].TokenCName
+ '_' + Pcd_Type
1388 newkey
= (Value
.TokenCName
, key
[1])
1390 newkey
= (Value
.TokenCName
, key
[1], key
[2])
1391 del self
.Platform
.Pcds
[key
]
1392 self
.Platform
.Pcds
[newkey
] = Value
1400 # for gathering error information
1401 NoDatumTypePcdList
= set()
1403 self
._GuidValue
= {}
1405 for InfName
in self
._AsBuildInfList
:
1406 InfName
= mws
.join(self
.WorkspaceDir
, InfName
)
1407 FdfModuleList
.append(os
.path
.normpath(InfName
))
1408 for F
in self
.Platform
.Modules
.keys():
1409 M
= ModuleAutoGen(self
.Workspace
, F
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, self
.MetaFile
)
1410 #GuidValue.update(M.Guids)
1412 self
.Platform
.Modules
[F
].M
= M
1414 for PcdFromModule
in M
.ModulePcdList
+ M
.LibraryPcdList
:
1415 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1416 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1417 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, F
))
1419 # Check the PCD from Binary INF or Source INF
1420 if M
.IsBinaryModule
== True:
1421 PcdFromModule
.IsFromBinaryInf
= True
1423 # Check the PCD from DSC or not
1424 if (PcdFromModule
.TokenCName
, PcdFromModule
.TokenSpaceGuidCName
) in self
.Platform
.Pcds
.keys():
1425 PcdFromModule
.IsFromDsc
= True
1427 PcdFromModule
.IsFromDsc
= False
1428 if PcdFromModule
.Type
in GenC
.gDynamicPcd
or PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1429 if F
.Path
not in FdfModuleList
:
1430 # If one of the Source built modules listed in the DSC is not listed
1431 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic
1432 # access method (it is only listed in the DEC file that declares the
1433 # PCD as PcdsDynamic), then build tool will report warning message
1434 # notify the PI that they are attempting to build a module that must
1435 # be included in a flash image in order to be functional. These Dynamic
1436 # PCD will not be added into the Database unless it is used by other
1437 # modules that are included in the FDF file.
1438 if PcdFromModule
.Type
in GenC
.gDynamicPcd
and \
1439 PcdFromModule
.IsFromBinaryInf
== False:
1440 # Print warning message to let the developer make a determine.
1441 if PcdFromModule
not in PcdNotInDb
:
1442 PcdNotInDb
.append(PcdFromModule
)
1444 # If one of the Source built modules listed in the DSC is not listed in
1445 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx
1446 # access method (it is only listed in the DEC file that declares the
1447 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the
1448 # PCD to the Platform's PCD Database.
1449 if PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1450 if PcdFromModule
not in PcdNotInDb
:
1451 PcdNotInDb
.append(PcdFromModule
)
1454 # If a dynamic PCD used by a PEM module/PEI module & DXE module,
1455 # it should be stored in Pcd PEI database, If a dynamic only
1456 # used by DXE module, it should be stored in DXE PCD database.
1457 # The default Phase is DXE
1459 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1460 PcdFromModule
.Phase
= "PEI"
1461 if PcdFromModule
not in self
._DynaPcdList
_:
1462 self
._DynaPcdList
_.append(PcdFromModule
)
1463 elif PcdFromModule
.Phase
== 'PEI':
1464 # overwrite any the same PCD existing, if Phase is PEI
1465 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1466 self
._DynaPcdList
_[Index
] = PcdFromModule
1467 elif PcdFromModule
not in self
._NonDynaPcdList
_:
1468 self
._NonDynaPcdList
_.append(PcdFromModule
)
1469 elif PcdFromModule
in self
._NonDynaPcdList
_ and PcdFromModule
.IsFromBinaryInf
== True:
1470 Index
= self
._NonDynaPcdList
_.index(PcdFromModule
)
1471 if self
._NonDynaPcdList
_[Index
].IsFromBinaryInf
== False:
1472 #The PCD from Binary INF will override the same one from source INF
1473 self
._NonDynaPcdList
_.remove (self
._NonDynaPcdList
_[Index
])
1474 PcdFromModule
.Pending
= False
1475 self
._NonDynaPcdList
_.append (PcdFromModule
)
1476 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.
1478 for ModuleInf
in self
.Platform
.Modules
.keys():
1479 DscModuleList
.append (os
.path
.normpath(ModuleInf
.Path
))
1480 # add the PCD from modules that listed in FDF but not in DSC to Database
1481 for InfName
in FdfModuleList
:
1482 if InfName
not in DscModuleList
:
1483 InfClass
= PathClass(InfName
)
1484 M
= self
.BuildDatabase
[InfClass
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1485 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)
1486 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.
1487 # For binary module, if in current arch, we need to list the PCDs into database.
1488 if not M
.IsSupportedArch
:
1490 # Override the module PCD setting by platform setting
1491 ModulePcdList
= self
.ApplyPcdSetting(M
, M
.Pcds
)
1492 for PcdFromModule
in ModulePcdList
:
1493 PcdFromModule
.IsFromBinaryInf
= True
1494 PcdFromModule
.IsFromDsc
= False
1495 # Only allow the DynamicEx and Patchable PCD in AsBuild INF
1496 if PcdFromModule
.Type
not in GenC
.gDynamicExPcd
and PcdFromModule
.Type
not in TAB_PCDS_PATCHABLE_IN_MODULE
:
1497 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1499 ExtraData
="\n\tExisted %s PCD %s in:\n\t\t%s\n"
1500 % (PcdFromModule
.Type
, PcdFromModule
.TokenCName
, InfName
))
1501 # make sure that the "VOID*" kind of datum has MaxDatumSize set
1502 if PcdFromModule
.DatumType
== "VOID*" and PcdFromModule
.MaxDatumSize
in [None, '']:
1503 NoDatumTypePcdList
.add("%s.%s [%s]" % (PcdFromModule
.TokenSpaceGuidCName
, PcdFromModule
.TokenCName
, InfName
))
1504 if M
.ModuleType
in ["PEIM", "PEI_CORE"]:
1505 PcdFromModule
.Phase
= "PEI"
1506 if PcdFromModule
not in self
._DynaPcdList
_ and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1507 self
._DynaPcdList
_.append(PcdFromModule
)
1508 elif PcdFromModule
not in self
._NonDynaPcdList
_ and PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
:
1509 self
._NonDynaPcdList
_.append(PcdFromModule
)
1510 if PcdFromModule
in self
._DynaPcdList
_ and PcdFromModule
.Phase
== 'PEI' and PcdFromModule
.Type
in GenC
.gDynamicExPcd
:
1511 # Overwrite the phase of any the same PCD existing, if Phase is PEI.
1512 # It is to solve the case that a dynamic PCD used by a PEM module/PEI
1513 # module & DXE module at a same time.
1514 # Overwrite the type of the PCDs in source INF by the type of AsBuild
1515 # INF file as DynamicEx.
1516 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1517 self
._DynaPcdList
_[Index
].Phase
= PcdFromModule
.Phase
1518 self
._DynaPcdList
_[Index
].Type
= PcdFromModule
.Type
1519 for PcdFromModule
in self
._NonDynaPcdList
_:
1520 # If a PCD is not listed in the DSC file, but binary INF files used by
1521 # this platform all (that use this PCD) list the PCD in a [PatchPcds]
1522 # section, AND all source INF files used by this platform the build
1523 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]
1524 # section, then the tools must NOT add the PCD to the Platform's PCD
1525 # Database; the build must assign the access method for this PCD as
1526 # PcdsPatchableInModule.
1527 if PcdFromModule
not in self
._DynaPcdList
_:
1529 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1530 if PcdFromModule
.IsFromDsc
== False and \
1531 PcdFromModule
.Type
in TAB_PCDS_PATCHABLE_IN_MODULE
and \
1532 PcdFromModule
.IsFromBinaryInf
== True and \
1533 self
._DynaPcdList
_[Index
].IsFromBinaryInf
== False:
1534 Index
= self
._DynaPcdList
_.index(PcdFromModule
)
1535 self
._DynaPcdList
_.remove (self
._DynaPcdList
_[Index
])
1537 # print out error information and break the build, if error found
1538 if len(NoDatumTypePcdList
) > 0:
1539 NoDatumTypePcdListString
= "\n\t\t".join(NoDatumTypePcdList
)
1540 EdkLogger
.error("build", AUTOGEN_ERROR
, "PCD setting error",
1542 ExtraData
="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"
1543 % NoDatumTypePcdListString
)
1544 self
._NonDynamicPcdList
= self
._NonDynaPcdList
_
1545 self
._DynamicPcdList
= self
._DynaPcdList
_
1547 # Sort dynamic PCD list to:
1548 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should
1549 # try to be put header of dynamicd List
1550 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD
1552 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.
1554 UnicodePcdArray
= set()
1556 OtherPcdArray
= set()
1558 VpdFile
= VpdInfoFile
.VpdInfoFile()
1559 NeedProcessVpdMapFile
= False
1561 for pcd
in self
.Platform
.Pcds
.keys():
1562 if pcd
not in self
._PlatformPcds
.keys():
1563 self
._PlatformPcds
[pcd
] = self
.Platform
.Pcds
[pcd
]
1565 for item
in self
._PlatformPcds
:
1566 if self
._PlatformPcds
[item
].DatumType
and self
._PlatformPcds
[item
].DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1567 self
._PlatformPcds
[item
].DatumType
= "VOID*"
1569 if (self
.Workspace
.ArchList
[-1] == self
.Arch
):
1570 for Pcd
in self
._DynamicPcdList
:
1571 # just pick the a value to determine whether is unicode string type
1572 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1573 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1575 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1576 Pcd
.DatumType
= "VOID*"
1578 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1579 # if found HII type PCD then insert to right of UnicodeIndex
1580 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1581 VpdPcdDict
[(Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
)] = Pcd
1583 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer
1584 PcdNvStoreDfBuffer
= VpdPcdDict
.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))
1585 if PcdNvStoreDfBuffer
:
1586 self
.VariableInfo
= self
.CollectVariables(self
._DynamicPcdList
)
1587 vardump
= self
.VariableInfo
.dump()
1589 PcdNvStoreDfBuffer
.DefaultValue
= vardump
1590 for skuname
in PcdNvStoreDfBuffer
.SkuInfoList
:
1591 PcdNvStoreDfBuffer
.SkuInfoList
[skuname
].DefaultValue
= vardump
1592 PcdNvStoreDfBuffer
.MaxDatumSize
= str(len(vardump
.split(",")))
1594 PlatformPcds
= self
._PlatformPcds
.keys()
1597 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.
1600 for PcdKey
in PlatformPcds
:
1601 Pcd
= self
._PlatformPcds
[PcdKey
]
1602 if Pcd
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
] and \
1603 PcdKey
in VpdPcdDict
:
1604 Pcd
= VpdPcdDict
[PcdKey
]
1606 DefaultSku
= Pcd
.SkuInfoList
.get('DEFAULT')
1608 PcdValue
= DefaultSku
.DefaultValue
1609 if PcdValue
not in SkuValueMap
:
1610 SkuValueMap
[PcdValue
] = []
1611 VpdFile
.Add(Pcd
, 'DEFAULT',DefaultSku
.VpdOffset
)
1612 SkuValueMap
[PcdValue
].append(DefaultSku
)
1614 for (SkuName
,Sku
) in Pcd
.SkuInfoList
.items():
1615 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1616 PcdValue
= Sku
.DefaultValue
1618 PcdValue
= Pcd
.DefaultValue
1619 if Sku
.VpdOffset
!= '*':
1620 if PcdValue
.startswith("{"):
1622 elif PcdValue
.startswith("L"):
1627 VpdOffset
= int(Sku
.VpdOffset
)
1630 VpdOffset
= int(Sku
.VpdOffset
, 16)
1632 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1633 if VpdOffset
% Alignment
!= 0:
1634 if PcdValue
.startswith("{"):
1635 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
), File
=self
.MetaFile
)
1637 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, Alignment
))
1638 if PcdValue
not in SkuValueMap
:
1639 SkuValueMap
[PcdValue
] = []
1640 VpdFile
.Add(Pcd
, SkuName
,Sku
.VpdOffset
)
1641 SkuValueMap
[PcdValue
].append(Sku
)
1642 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1643 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1644 NeedProcessVpdMapFile
= True
1645 if self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== '':
1646 EdkLogger
.error("Build", FILE_NOT_FOUND
, \
1647 "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.")
1649 VpdSkuMap
[PcdKey
] = SkuValueMap
1651 # Fix the PCDs define in VPD PCD section that never referenced by module.
1652 # An example is PCD for signature usage.
1654 for DscPcd
in PlatformPcds
:
1655 DscPcdEntry
= self
._PlatformPcds
[DscPcd
]
1656 if DscPcdEntry
.Type
in [TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_EX_VPD
]:
1657 if not (self
.Platform
.VpdToolGuid
== None or self
.Platform
.VpdToolGuid
== ''):
1659 for VpdPcd
in VpdFile
._VpdArray
.keys():
1660 # This PCD has been referenced by module
1661 if (VpdPcd
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1662 (VpdPcd
.TokenCName
== DscPcdEntry
.TokenCName
):
1665 # Not found, it should be signature
1667 # just pick the a value to determine whether is unicode string type
1669 SkuObjList
= DscPcdEntry
.SkuInfoList
.items()
1670 DefaultSku
= DscPcdEntry
.SkuInfoList
.get('DEFAULT')
1672 defaultindex
= SkuObjList
.index(('DEFAULT',DefaultSku
))
1673 SkuObjList
[0],SkuObjList
[defaultindex
] = SkuObjList
[defaultindex
],SkuObjList
[0]
1674 for (SkuName
,Sku
) in SkuObjList
:
1675 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1677 # Need to iterate DEC pcd information to get the value & datumtype
1678 for eachDec
in self
.PackageList
:
1679 for DecPcd
in eachDec
.Pcds
:
1680 DecPcdEntry
= eachDec
.Pcds
[DecPcd
]
1681 if (DecPcdEntry
.TokenSpaceGuidCName
== DscPcdEntry
.TokenSpaceGuidCName
) and \
1682 (DecPcdEntry
.TokenCName
== DscPcdEntry
.TokenCName
):
1683 # Print warning message to let the developer make a determine.
1684 EdkLogger
.warn("build", "Unreferenced vpd pcd used!",
1685 File
=self
.MetaFile
, \
1686 ExtraData
= "PCD: %s.%s used in the DSC file %s is unreferenced." \
1687 %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, self
.Platform
.MetaFile
.Path
))
1689 DscPcdEntry
.DatumType
= DecPcdEntry
.DatumType
1690 DscPcdEntry
.DefaultValue
= DecPcdEntry
.DefaultValue
1691 DscPcdEntry
.TokenValue
= DecPcdEntry
.TokenValue
1692 DscPcdEntry
.TokenSpaceGuidValue
= eachDec
.Guids
[DecPcdEntry
.TokenSpaceGuidCName
]
1693 # Only fix the value while no value provided in DSC file.
1694 if (Sku
.DefaultValue
== "" or Sku
.DefaultValue
==None):
1695 DscPcdEntry
.SkuInfoList
[DscPcdEntry
.SkuInfoList
.keys()[0]].DefaultValue
= DecPcdEntry
.DefaultValue
1697 if DscPcdEntry
not in self
._DynamicPcdList
:
1698 self
._DynamicPcdList
.append(DscPcdEntry
)
1699 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1700 PcdValue
= Sku
.DefaultValue
1702 PcdValue
= DscPcdEntry
.DefaultValue
1703 if Sku
.VpdOffset
!= '*':
1704 if PcdValue
.startswith("{"):
1706 elif PcdValue
.startswith("L"):
1711 VpdOffset
= int(Sku
.VpdOffset
)
1714 VpdOffset
= int(Sku
.VpdOffset
, 16)
1716 EdkLogger
.error("build", FORMAT_INVALID
, "Invalid offset value %s for PCD %s.%s." % (Sku
.VpdOffset
, DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
))
1717 if VpdOffset
% Alignment
!= 0:
1718 if PcdValue
.startswith("{"):
1719 EdkLogger
.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
), File
=self
.MetaFile
)
1721 EdkLogger
.error("build", FORMAT_INVALID
, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry
.TokenSpaceGuidCName
, DscPcdEntry
.TokenCName
, Alignment
))
1722 if PcdValue
not in SkuValueMap
:
1723 SkuValueMap
[PcdValue
] = []
1724 VpdFile
.Add(DscPcdEntry
, SkuName
,Sku
.VpdOffset
)
1725 SkuValueMap
[PcdValue
].append(Sku
)
1726 if not NeedProcessVpdMapFile
and Sku
.VpdOffset
== "*":
1727 NeedProcessVpdMapFile
= True
1728 if DscPcdEntry
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1729 UnicodePcdArray
.add(DscPcdEntry
)
1730 elif len(Sku
.VariableName
) > 0:
1731 HiiPcdArray
.add(DscPcdEntry
)
1733 OtherPcdArray
.add(DscPcdEntry
)
1735 # if the offset of a VPD is *, then it need to be fixed up by third party tool.
1736 VpdSkuMap
[DscPcd
] = SkuValueMap
1737 if (self
.Platform
.FlashDefinition
== None or self
.Platform
.FlashDefinition
== '') and \
1738 VpdFile
.GetCount() != 0:
1739 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
,
1740 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self
.Platform
.MetaFile
))
1742 if VpdFile
.GetCount() != 0:
1744 self
.FixVpdOffset(VpdFile
)
1746 self
.FixVpdOffset(self
.UpdateNVStoreMaxSize(VpdFile
))
1748 # Process VPD map file generated by third party BPDG tool
1749 if NeedProcessVpdMapFile
:
1750 VpdMapFilePath
= os
.path
.join(self
.BuildDir
, "FV", "%s.map" % self
.Platform
.VpdToolGuid
)
1751 if os
.path
.exists(VpdMapFilePath
):
1752 VpdFile
.Read(VpdMapFilePath
)
1755 for pcd
in VpdSkuMap
:
1756 vpdinfo
= VpdFile
.GetVpdInfo(pcd
)
1758 # just pick the a value to determine whether is unicode string type
1760 for pcdvalue
in VpdSkuMap
[pcd
]:
1761 for sku
in VpdSkuMap
[pcd
][pcdvalue
]:
1762 for item
in vpdinfo
:
1763 if item
[2] == pcdvalue
:
1764 sku
.VpdOffset
= item
[1]
1766 EdkLogger
.error("build", FILE_READ_FAILURE
, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath
)
1768 # Delete the DynamicPcdList At the last time enter into this function
1769 for Pcd
in self
._DynamicPcdList
:
1770 # just pick the a value to determine whether is unicode string type
1771 Sku
= Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[0]]
1772 Sku
.VpdOffset
= Sku
.VpdOffset
.strip()
1774 if Pcd
.DatumType
not in [TAB_UINT8
, TAB_UINT16
, TAB_UINT32
, TAB_UINT64
, TAB_VOID
, "BOOLEAN"]:
1775 Pcd
.DatumType
= "VOID*"
1777 PcdValue
= Sku
.DefaultValue
1778 if Pcd
.DatumType
== 'VOID*' and PcdValue
.startswith("L"):
1779 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex
1780 UnicodePcdArray
.add(Pcd
)
1781 elif len(Sku
.VariableName
) > 0:
1782 # if found HII type PCD then insert to right of UnicodeIndex
1783 HiiPcdArray
.add(Pcd
)
1785 OtherPcdArray
.add(Pcd
)
1786 del self
._DynamicPcdList
[:]
1787 self
._DynamicPcdList
.extend(list(UnicodePcdArray
))
1788 self
._DynamicPcdList
.extend(list(HiiPcdArray
))
1789 self
._DynamicPcdList
.extend(list(OtherPcdArray
))
1790 allskuset
= [(SkuName
,Sku
.SkuId
) for pcd
in self
._DynamicPcdList
for (SkuName
,Sku
) in pcd
.SkuInfoList
.items()]
1791 for pcd
in self
._DynamicPcdList
:
1792 if len(pcd
.SkuInfoList
) == 1:
1793 for (SkuName
,SkuId
) in allskuset
:
1794 if type(SkuId
) in (str,unicode) and eval(SkuId
) == 0 or SkuId
== 0:
1796 pcd
.SkuInfoList
[SkuName
] = copy
.deepcopy(pcd
.SkuInfoList
['DEFAULT'])
1797 pcd
.SkuInfoList
[SkuName
].SkuId
= SkuId
1798 self
.AllPcdList
= self
._NonDynamicPcdList
+ self
._DynamicPcdList
1800 def FixVpdOffset(self
,VpdFile
):
1801 FvPath
= os
.path
.join(self
.BuildDir
, "FV")
1802 if not os
.path
.exists(FvPath
):
1806 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Fail to create FV folder under %s" % self
.BuildDir
)
1808 VpdFilePath
= os
.path
.join(FvPath
, "%s.txt" % self
.Platform
.VpdToolGuid
)
1810 if VpdFile
.Write(VpdFilePath
):
1811 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.
1813 for ToolDef
in self
.ToolDefinition
.values():
1814 if ToolDef
.has_key("GUID") and ToolDef
["GUID"] == self
.Platform
.VpdToolGuid
:
1815 if not ToolDef
.has_key("PATH"):
1816 EdkLogger
.error("build", ATTRIBUTE_NOT_AVAILABLE
, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self
.Platform
.VpdToolGuid
)
1817 BPDGToolName
= ToolDef
["PATH"]
1819 # Call third party GUID BPDG tool.
1820 if BPDGToolName
!= None:
1821 VpdInfoFile
.CallExtenalBPDGTool(BPDGToolName
, VpdFilePath
)
1823 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.")
1825 ## Return the platform build data object
1826 def _GetPlatform(self
):
1827 if self
._Platform
== None:
1828 self
._Platform
= self
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
1829 return self
._Platform
1831 ## Return platform name
1833 return self
.Platform
.PlatformName
1835 ## Return the meta file GUID
1837 return self
.Platform
.Guid
1839 ## Return the platform version
1840 def _GetVersion(self
):
1841 return self
.Platform
.Version
1843 ## Return the FDF file name
1844 def _GetFdfFile(self
):
1845 if self
._FdfFile
== None:
1846 if self
.Workspace
.FdfFile
!= "":
1847 self
._FdfFile
= mws
.join(self
.WorkspaceDir
, self
.Workspace
.FdfFile
)
1850 return self
._FdfFile
1852 ## Return the build output directory platform specifies
1853 def _GetOutputDir(self
):
1854 return self
.Platform
.OutputDirectory
1856 ## Return the directory to store all intermediate and final files built
1857 def _GetBuildDir(self
):
1858 if self
._BuildDir
== None:
1859 if os
.path
.isabs(self
.OutputDir
):
1860 self
._BuildDir
= path
.join(
1861 path
.abspath(self
.OutputDir
),
1862 self
.BuildTarget
+ "_" + self
.ToolChain
,
1865 self
._BuildDir
= path
.join(
1868 self
.BuildTarget
+ "_" + self
.ToolChain
,
1870 GlobalData
.gBuildDirectory
= self
._BuildDir
1871 return self
._BuildDir
1873 ## Return directory of platform makefile
1875 # @retval string Makefile directory
1877 def _GetMakeFileDir(self
):
1878 if self
._MakeFileDir
== None:
1879 self
._MakeFileDir
= path
.join(self
.BuildDir
, self
.Arch
)
1880 return self
._MakeFileDir
1882 ## Return build command string
1884 # @retval string Build command string
1886 def _GetBuildCommand(self
):
1887 if self
._BuildCommand
== None:
1888 self
._BuildCommand
= []
1889 if "MAKE" in self
.ToolDefinition
and "PATH" in self
.ToolDefinition
["MAKE"]:
1890 self
._BuildCommand
+= SplitOption(self
.ToolDefinition
["MAKE"]["PATH"])
1891 if "FLAGS" in self
.ToolDefinition
["MAKE"]:
1892 NewOption
= self
.ToolDefinition
["MAKE"]["FLAGS"].strip()
1894 self
._BuildCommand
+= SplitOption(NewOption
)
1895 if "MAKE" in self
.EdkIIBuildOption
:
1896 if "FLAGS" in self
.EdkIIBuildOption
["MAKE"]:
1897 Flags
= self
.EdkIIBuildOption
["MAKE"]["FLAGS"]
1898 if Flags
.startswith('='):
1899 self
._BuildCommand
= [self
._BuildCommand
[0]] + [Flags
[1:]]
1901 self
._BuildCommand
+= [Flags
]
1902 return self
._BuildCommand
1904 ## Get tool chain definition
1906 # Get each tool defition for given tool chain from tools_def.txt and platform
1908 def _GetToolDefinition(self
):
1909 if self
._ToolDefinitions
== None:
1910 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDictionary
1911 if TAB_TOD_DEFINES_COMMAND_TYPE
not in self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
:
1912 EdkLogger
.error('build', RESOURCE_NOT_AVAILABLE
, "No tools found in configuration",
1913 ExtraData
="[%s]" % self
.MetaFile
)
1914 self
._ToolDefinitions
= {}
1916 for Def
in ToolDefinition
:
1917 Target
, Tag
, Arch
, Tool
, Attr
= Def
.split("_")
1918 if Target
!= self
.BuildTarget
or Tag
!= self
.ToolChain
or Arch
!= self
.Arch
:
1921 Value
= ToolDefinition
[Def
]
1922 # don't record the DLL
1924 DllPathList
.add(Value
)
1927 if Tool
not in self
._ToolDefinitions
:
1928 self
._ToolDefinitions
[Tool
] = {}
1929 self
._ToolDefinitions
[Tool
][Attr
] = Value
1933 if GlobalData
.gOptions
.SilentMode
and "MAKE" in self
._ToolDefinitions
:
1934 if "FLAGS" not in self
._ToolDefinitions
["MAKE"]:
1935 self
._ToolDefinitions
["MAKE"]["FLAGS"] = ""
1936 self
._ToolDefinitions
["MAKE"]["FLAGS"] += " -s"
1938 for Tool
in self
._ToolDefinitions
:
1939 for Attr
in self
._ToolDefinitions
[Tool
]:
1940 Value
= self
._ToolDefinitions
[Tool
][Attr
]
1941 if Tool
in self
.BuildOption
and Attr
in self
.BuildOption
[Tool
]:
1942 # check if override is indicated
1943 if self
.BuildOption
[Tool
][Attr
].startswith('='):
1944 Value
= self
.BuildOption
[Tool
][Attr
][1:]
1947 Value
+= " " + self
.BuildOption
[Tool
][Attr
]
1949 Value
= self
.BuildOption
[Tool
][Attr
]
1952 # Don't put MAKE definition in the file
1956 ToolsDef
+= "%s = %s\n" % (Tool
, Value
)
1958 # Don't put MAKE definition in the file
1963 ToolsDef
+= "%s_%s = %s\n" % (Tool
, Attr
, Value
)
1966 SaveFileOnChange(self
.ToolDefinitionFile
, ToolsDef
)
1967 for DllPath
in DllPathList
:
1968 os
.environ
["PATH"] = DllPath
+ os
.pathsep
+ os
.environ
["PATH"]
1969 os
.environ
["MAKE_FLAGS"] = MakeFlags
1971 return self
._ToolDefinitions
1973 ## Return the paths of tools
1974 def _GetToolDefFile(self
):
1975 if self
._ToolDefFile
== None:
1976 self
._ToolDefFile
= os
.path
.join(self
.MakeFileDir
, "TOOLS_DEF." + self
.Arch
)
1977 return self
._ToolDefFile
1979 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.
1980 def _GetToolChainFamily(self
):
1981 if self
._ToolChainFamily
== None:
1982 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1983 if TAB_TOD_DEFINES_FAMILY
not in ToolDefinition \
1984 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_FAMILY
] \
1985 or not ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]:
1986 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
1988 self
._ToolChainFamily
= "MSFT"
1990 self
._ToolChainFamily
= ToolDefinition
[TAB_TOD_DEFINES_FAMILY
][self
.ToolChain
]
1991 return self
._ToolChainFamily
1993 def _GetBuildRuleFamily(self
):
1994 if self
._BuildRuleFamily
== None:
1995 ToolDefinition
= self
.Workspace
.ToolDef
.ToolsDefTxtDatabase
1996 if TAB_TOD_DEFINES_BUILDRULEFAMILY
not in ToolDefinition \
1997 or self
.ToolChain
not in ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
] \
1998 or not ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]:
1999 EdkLogger
.verbose("No tool chain family found in configuration for %s. Default to MSFT." \
2001 self
._BuildRuleFamily
= "MSFT"
2003 self
._BuildRuleFamily
= ToolDefinition
[TAB_TOD_DEFINES_BUILDRULEFAMILY
][self
.ToolChain
]
2004 return self
._BuildRuleFamily
2006 ## Return the build options specific for all modules in this platform
2007 def _GetBuildOptions(self
):
2008 if self
._BuildOption
== None:
2009 self
._BuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
)
2010 return self
._BuildOption
2012 ## Return the build options specific for EDK modules in this platform
2013 def _GetEdkBuildOptions(self
):
2014 if self
._EdkBuildOption
== None:
2015 self
._EdkBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDK_NAME
)
2016 return self
._EdkBuildOption
2018 ## Return the build options specific for EDKII modules in this platform
2019 def _GetEdkIIBuildOptions(self
):
2020 if self
._EdkIIBuildOption
== None:
2021 self
._EdkIIBuildOption
= self
._ExpandBuildOption
(self
.Platform
.BuildOptions
, EDKII_NAME
)
2022 return self
._EdkIIBuildOption
2024 ## Parse build_rule.txt in Conf Directory.
2026 # @retval BuildRule object
2028 def _GetBuildRule(self
):
2029 if self
._BuildRule
== None:
2030 BuildRuleFile
= None
2031 if TAB_TAT_DEFINES_BUILD_RULE_CONF
in self
.Workspace
.TargetTxt
.TargetTxtDictionary
:
2032 BuildRuleFile
= self
.Workspace
.TargetTxt
.TargetTxtDictionary
[TAB_TAT_DEFINES_BUILD_RULE_CONF
]
2033 if BuildRuleFile
in [None, '']:
2034 BuildRuleFile
= gDefaultBuildRuleFile
2035 self
._BuildRule
= BuildRule(BuildRuleFile
)
2036 if self
._BuildRule
._FileVersion
== "":
2037 self
._BuildRule
._FileVersion
= AutoGenReqBuildRuleVerNum
2039 if self
._BuildRule
._FileVersion
< AutoGenReqBuildRuleVerNum
:
2040 # If Build Rule's version is less than the version number required by the tools, halting the build.
2041 EdkLogger
.error("build", AUTOGEN_ERROR
,
2042 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])"\
2043 % (self
._BuildRule
._FileVersion
, AutoGenReqBuildRuleVerNum
))
2045 return self
._BuildRule
2047 ## Summarize the packages used by modules in this platform
2048 def _GetPackageList(self
):
2049 if self
._PackageList
== None:
2050 self
._PackageList
= set()
2051 for La
in self
.LibraryAutoGenList
:
2052 self
._PackageList
.update(La
.DependentPackageList
)
2053 for Ma
in self
.ModuleAutoGenList
:
2054 self
._PackageList
.update(Ma
.DependentPackageList
)
2055 #Collect package set information from INF of FDF
2057 for ModuleFile
in self
._AsBuildModuleList
:
2058 if ModuleFile
in self
.Platform
.Modules
:
2060 ModuleData
= self
.BuildDatabase
[ModuleFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2061 PkgSet
.update(ModuleData
.Packages
)
2062 self
._PackageList
= list(self
._PackageList
) + list (PkgSet
)
2063 return self
._PackageList
2065 def _GetNonDynamicPcdDict(self
):
2066 if self
._NonDynamicPcdDict
:
2067 return self
._NonDynamicPcdDict
2068 for Pcd
in self
.NonDynamicPcdList
:
2069 self
._NonDynamicPcdDict
[(Pcd
.TokenCName
,Pcd
.TokenSpaceGuidCName
)] = Pcd
2070 return self
._NonDynamicPcdDict
2072 ## Get list of non-dynamic PCDs
2073 def _GetNonDynamicPcdList(self
):
2074 if self
._NonDynamicPcdList
== None:
2075 self
.CollectPlatformDynamicPcds()
2076 return self
._NonDynamicPcdList
2078 ## Get list of dynamic PCDs
2079 def _GetDynamicPcdList(self
):
2080 if self
._DynamicPcdList
== None:
2081 self
.CollectPlatformDynamicPcds()
2082 return self
._DynamicPcdList
2084 ## Generate Token Number for all PCD
2085 def _GetPcdTokenNumbers(self
):
2086 if self
._PcdTokenNumber
== None:
2087 self
._PcdTokenNumber
= sdict()
2090 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.
2094 # TokenNumber 0 ~ 10
2096 # TokeNumber 11 ~ 20
2098 for Pcd
in self
.DynamicPcdList
:
2099 if Pcd
.Phase
== "PEI":
2100 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2101 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2102 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2105 for Pcd
in self
.DynamicPcdList
:
2106 if Pcd
.Phase
== "PEI":
2107 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2108 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2109 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2112 for Pcd
in self
.DynamicPcdList
:
2113 if Pcd
.Phase
== "DXE":
2114 if Pcd
.Type
in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:
2115 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2116 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2119 for Pcd
in self
.DynamicPcdList
:
2120 if Pcd
.Phase
== "DXE":
2121 if Pcd
.Type
in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:
2122 EdkLogger
.debug(EdkLogger
.DEBUG_5
, "%s %s (%s) -> %d" % (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.Phase
, TokenNumber
))
2123 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2126 for Pcd
in self
.NonDynamicPcdList
:
2127 self
._PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
] = TokenNumber
2129 return self
._PcdTokenNumber
2131 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform
2132 def _GetAutoGenObjectList(self
):
2133 self
._ModuleAutoGenList
= []
2134 self
._LibraryAutoGenList
= []
2135 for ModuleFile
in self
.Platform
.Modules
:
2144 if Ma
not in self
._ModuleAutoGenList
:
2145 self
._ModuleAutoGenList
.append(Ma
)
2146 for La
in Ma
.LibraryAutoGenList
:
2147 if La
not in self
._LibraryAutoGenList
:
2148 self
._LibraryAutoGenList
.append(La
)
2149 if Ma
not in La
._ReferenceModules
:
2150 La
._ReferenceModules
.append(Ma
)
2152 ## Summarize ModuleAutoGen objects of all modules to be built for this platform
2153 def _GetModuleAutoGenList(self
):
2154 if self
._ModuleAutoGenList
== None:
2155 self
._GetAutoGenObjectList
()
2156 return self
._ModuleAutoGenList
2158 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform
2159 def _GetLibraryAutoGenList(self
):
2160 if self
._LibraryAutoGenList
== None:
2161 self
._GetAutoGenObjectList
()
2162 return self
._LibraryAutoGenList
2164 ## Test if a module is supported by the platform
2166 # An error will be raised directly if the module or its arch is not supported
2167 # by the platform or current configuration
2169 def ValidModule(self
, Module
):
2170 return Module
in self
.Platform
.Modules
or Module
in self
.Platform
.LibraryInstances \
2171 or Module
in self
._AsBuildModuleList
2173 ## Resolve the library classes in a module to library instances
2175 # This method will not only resolve library classes but also sort the library
2176 # instances according to the dependency-ship.
2178 # @param Module The module from which the library classes will be resolved
2180 # @retval library_list List of library instances sorted
2182 def ApplyLibraryInstance(self
, Module
):
2183 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly
2184 if str(Module
) not in self
.Platform
.Modules
:
2187 ModuleType
= Module
.ModuleType
2189 # for overridding library instances with module specific setting
2190 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2192 # add forced library instances (specified under LibraryClasses sections)
2194 # If a module has a MODULE_TYPE of USER_DEFINED,
2195 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.
2197 if Module
.ModuleType
!= SUP_MODULE_USER_DEFINED
:
2198 for LibraryClass
in self
.Platform
.LibraryClasses
.GetKeys():
2199 if LibraryClass
.startswith("NULL") and self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]:
2200 Module
.LibraryClasses
[LibraryClass
] = self
.Platform
.LibraryClasses
[LibraryClass
, Module
.ModuleType
]
2202 # add forced library instances (specified in module overrides)
2203 for LibraryClass
in PlatformModule
.LibraryClasses
:
2204 if LibraryClass
.startswith("NULL"):
2205 Module
.LibraryClasses
[LibraryClass
] = PlatformModule
.LibraryClasses
[LibraryClass
]
2208 LibraryConsumerList
= [Module
]
2210 ConsumedByList
= sdict()
2211 LibraryInstance
= sdict()
2213 EdkLogger
.verbose("")
2214 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2215 while len(LibraryConsumerList
) > 0:
2216 M
= LibraryConsumerList
.pop()
2217 for LibraryClassName
in M
.LibraryClasses
:
2218 if LibraryClassName
not in LibraryInstance
:
2219 # override library instance for this module
2220 if LibraryClassName
in PlatformModule
.LibraryClasses
:
2221 LibraryPath
= PlatformModule
.LibraryClasses
[LibraryClassName
]
2223 LibraryPath
= self
.Platform
.LibraryClasses
[LibraryClassName
, ModuleType
]
2224 if LibraryPath
== None or LibraryPath
== "":
2225 LibraryPath
= M
.LibraryClasses
[LibraryClassName
]
2226 if LibraryPath
== None or LibraryPath
== "":
2227 EdkLogger
.error("build", RESOURCE_NOT_AVAILABLE
,
2228 "Instance of library class [%s] is not found" % LibraryClassName
,
2230 ExtraData
="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M
), self
.Arch
, str(Module
)))
2232 LibraryModule
= self
.BuildDatabase
[LibraryPath
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2233 # for those forced library instance (NULL library), add a fake library class
2234 if LibraryClassName
.startswith("NULL"):
2235 LibraryModule
.LibraryClass
.append(LibraryClassObject(LibraryClassName
, [ModuleType
]))
2236 elif LibraryModule
.LibraryClass
== None \
2237 or len(LibraryModule
.LibraryClass
) == 0 \
2238 or (ModuleType
!= 'USER_DEFINED'
2239 and ModuleType
not in LibraryModule
.LibraryClass
[0].SupModList
):
2240 # only USER_DEFINED can link against any library instance despite of its SupModList
2241 EdkLogger
.error("build", OPTION_MISSING
,
2242 "Module type [%s] is not supported by library instance [%s]" \
2243 % (ModuleType
, LibraryPath
), File
=self
.MetaFile
,
2244 ExtraData
="consumed by [%s]" % str(Module
))
2246 LibraryInstance
[LibraryClassName
] = LibraryModule
2247 LibraryConsumerList
.append(LibraryModule
)
2248 EdkLogger
.verbose("\t" + str(LibraryClassName
) + " : " + str(LibraryModule
))
2250 LibraryModule
= LibraryInstance
[LibraryClassName
]
2252 if LibraryModule
== None:
2255 if LibraryModule
.ConstructorList
!= [] and LibraryModule
not in Constructor
:
2256 Constructor
.append(LibraryModule
)
2258 if LibraryModule
not in ConsumedByList
:
2259 ConsumedByList
[LibraryModule
] = []
2260 # don't add current module itself to consumer list
2262 if M
in ConsumedByList
[LibraryModule
]:
2264 ConsumedByList
[LibraryModule
].append(M
)
2266 # Initialize the sorted output list to the empty set
2268 SortedLibraryList
= []
2270 # Q <- Set of all nodes with no incoming edges
2272 LibraryList
= [] #LibraryInstance.values()
2274 for LibraryClassName
in LibraryInstance
:
2275 M
= LibraryInstance
[LibraryClassName
]
2276 LibraryList
.append(M
)
2277 if ConsumedByList
[M
] == []:
2281 # start the DAG algorithm
2285 while Q
== [] and EdgeRemoved
:
2287 # for each node Item with a Constructor
2288 for Item
in LibraryList
:
2289 if Item
not in Constructor
:
2291 # for each Node without a constructor with an edge e from Item to Node
2292 for Node
in ConsumedByList
[Item
]:
2293 if Node
in Constructor
:
2295 # remove edge e from the graph if Node has no constructor
2296 ConsumedByList
[Item
].remove(Node
)
2298 if ConsumedByList
[Item
] == []:
2299 # insert Item into Q
2304 # DAG is done if there's no more incoming edge for all nodes
2308 # remove node from Q
2311 SortedLibraryList
.append(Node
)
2313 # for each node Item with an edge e from Node to Item do
2314 for Item
in LibraryList
:
2315 if Node
not in ConsumedByList
[Item
]:
2317 # remove edge e from the graph
2318 ConsumedByList
[Item
].remove(Node
)
2320 if ConsumedByList
[Item
] != []:
2322 # insert Item into Q, if Item has no other incoming edges
2326 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle
2328 for Item
in LibraryList
:
2329 if ConsumedByList
[Item
] != [] and Item
in Constructor
and len(Constructor
) > 1:
2330 ErrorMessage
= "\tconsumed by " + "\n\tconsumed by ".join([str(L
) for L
in ConsumedByList
[Item
]])
2331 EdkLogger
.error("build", BUILD_ERROR
, 'Library [%s] with constructors has a cycle' % str(Item
),
2332 ExtraData
=ErrorMessage
, File
=self
.MetaFile
)
2333 if Item
not in SortedLibraryList
:
2334 SortedLibraryList
.append(Item
)
2337 # Build the list of constructor and destructir names
2338 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order
2340 SortedLibraryList
.reverse()
2341 return SortedLibraryList
2344 ## Override PCD setting (type, value, ...)
2346 # @param ToPcd The PCD to be overrided
2347 # @param FromPcd The PCD overrideing from
2349 def _OverridePcd(self
, ToPcd
, FromPcd
, Module
=""):
2351 # in case there's PCDs coming from FDF file, which have no type given.
2352 # at this point, ToPcd.Type has the type found from dependent
2355 TokenCName
= ToPcd
.TokenCName
2356 for PcdItem
in GlobalData
.MixedPcd
:
2357 if (ToPcd
.TokenCName
, ToPcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2358 TokenCName
= PcdItem
[0]
2361 if ToPcd
.Pending
and FromPcd
.Type
not in [None, '']:
2362 ToPcd
.Type
= FromPcd
.Type
2363 elif (ToPcd
.Type
not in [None, '']) and (FromPcd
.Type
not in [None, ''])\
2364 and (ToPcd
.Type
!= FromPcd
.Type
) and (ToPcd
.Type
in FromPcd
.Type
):
2365 if ToPcd
.Type
.strip() == "DynamicEx":
2366 ToPcd
.Type
= FromPcd
.Type
2367 elif ToPcd
.Type
not in [None, ''] and FromPcd
.Type
not in [None, ''] \
2368 and ToPcd
.Type
!= FromPcd
.Type
:
2369 EdkLogger
.error("build", OPTION_CONFLICT
, "Mismatched PCD type",
2370 ExtraData
="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\
2371 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
,
2372 ToPcd
.Type
, Module
, FromPcd
.Type
),
2375 if FromPcd
.MaxDatumSize
not in [None, '']:
2376 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2377 if FromPcd
.DefaultValue
not in [None, '']:
2378 ToPcd
.DefaultValue
= FromPcd
.DefaultValue
2379 if FromPcd
.TokenValue
not in [None, '']:
2380 ToPcd
.TokenValue
= FromPcd
.TokenValue
2381 if FromPcd
.MaxDatumSize
not in [None, '']:
2382 ToPcd
.MaxDatumSize
= FromPcd
.MaxDatumSize
2383 if FromPcd
.DatumType
not in [None, '']:
2384 ToPcd
.DatumType
= FromPcd
.DatumType
2385 if FromPcd
.SkuInfoList
not in [None, '', []]:
2386 ToPcd
.SkuInfoList
= FromPcd
.SkuInfoList
2387 # Add Flexible PCD format parse
2388 if ToPcd
.DefaultValue
:
2390 ToPcd
.DefaultValue
= ValueExpressionEx(ToPcd
.DefaultValue
, ToPcd
.DatumType
, self
._GuidDict
)(True)
2391 except BadExpression
, Value
:
2392 EdkLogger
.error('Parser', FORMAT_INVALID
, 'PCD [%s.%s] Value "%s", %s' %(ToPcd
.TokenSpaceGuidCName
, ToPcd
.TokenCName
, ToPcd
.DefaultValue
, Value
),
2395 # check the validation of datum
2396 IsValid
, Cause
= CheckPcdDatum(ToPcd
.DatumType
, ToPcd
.DefaultValue
)
2398 EdkLogger
.error('build', FORMAT_INVALID
, Cause
, File
=self
.MetaFile
,
2399 ExtraData
="%s.%s" % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2400 ToPcd
.validateranges
= FromPcd
.validateranges
2401 ToPcd
.validlists
= FromPcd
.validlists
2402 ToPcd
.expressions
= FromPcd
.expressions
2404 if FromPcd
!= None and ToPcd
.DatumType
== "VOID*" and ToPcd
.MaxDatumSize
in ['', None]:
2405 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "No MaxDatumSize specified for PCD %s.%s" \
2406 % (ToPcd
.TokenSpaceGuidCName
, TokenCName
))
2407 Value
= ToPcd
.DefaultValue
2408 if Value
in [None, '']:
2409 ToPcd
.MaxDatumSize
= '1'
2410 elif Value
[0] == 'L':
2411 ToPcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2412 elif Value
[0] == '{':
2413 ToPcd
.MaxDatumSize
= str(len(Value
.split(',')))
2415 ToPcd
.MaxDatumSize
= str(len(Value
) - 1)
2417 # apply default SKU for dynamic PCDS if specified one is not available
2418 if (ToPcd
.Type
in PCD_DYNAMIC_TYPE_LIST
or ToPcd
.Type
in PCD_DYNAMIC_EX_TYPE_LIST
) \
2419 and ToPcd
.SkuInfoList
in [None, {}, '']:
2420 if self
.Platform
.SkuName
in self
.Platform
.SkuIds
:
2421 SkuName
= self
.Platform
.SkuName
2424 ToPcd
.SkuInfoList
= {
2425 SkuName
: SkuInfoClass(SkuName
, self
.Platform
.SkuIds
[SkuName
][0], '', '', '', '', '', ToPcd
.DefaultValue
)
2428 ## Apply PCD setting defined platform to a module
2430 # @param Module The module from which the PCD setting will be overrided
2432 # @retval PCD_list The list PCDs with settings from platform
2434 def ApplyPcdSetting(self
, Module
, Pcds
):
2435 # for each PCD in module
2436 for Name
, Guid
in Pcds
:
2437 PcdInModule
= Pcds
[Name
, Guid
]
2438 # find out the PCD setting in platform
2439 if (Name
, Guid
) in self
.Platform
.Pcds
:
2440 PcdInPlatform
= self
.Platform
.Pcds
[Name
, Guid
]
2442 PcdInPlatform
= None
2443 # then override the settings if any
2444 self
._OverridePcd
(PcdInModule
, PcdInPlatform
, Module
)
2445 # resolve the VariableGuid value
2446 for SkuId
in PcdInModule
.SkuInfoList
:
2447 Sku
= PcdInModule
.SkuInfoList
[SkuId
]
2448 if Sku
.VariableGuid
== '': continue
2449 Sku
.VariableGuidValue
= GuidValue(Sku
.VariableGuid
, self
.PackageList
, self
.MetaFile
.Path
)
2450 if Sku
.VariableGuidValue
== None:
2451 PackageList
= "\n\t".join([str(P
) for P
in self
.PackageList
])
2454 RESOURCE_NOT_AVAILABLE
,
2455 "Value of GUID [%s] is not found in" % Sku
.VariableGuid
,
2456 ExtraData
=PackageList
+ "\n\t(used with %s.%s from module %s)" \
2457 % (Guid
, Name
, str(Module
)),
2461 # override PCD settings with module specific setting
2462 if Module
in self
.Platform
.Modules
:
2463 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2464 for Key
in PlatformModule
.Pcds
:
2469 elif Key
in GlobalData
.MixedPcd
:
2470 for PcdItem
in GlobalData
.MixedPcd
[Key
]:
2472 ToPcd
= Pcds
[PcdItem
]
2476 self
._OverridePcd
(ToPcd
, PlatformModule
.Pcds
[Key
], Module
)
2477 # use PCD value to calculate the MaxDatumSize when it is not specified
2478 for Name
, Guid
in Pcds
:
2479 Pcd
= Pcds
[Name
, Guid
]
2480 if Pcd
.DatumType
== "VOID*" and Pcd
.MaxDatumSize
in ['', None]:
2481 Value
= Pcd
.DefaultValue
2482 if Value
in [None, '']:
2483 Pcd
.MaxDatumSize
= '1'
2484 elif Value
[0] == 'L':
2485 Pcd
.MaxDatumSize
= str((len(Value
) - 2) * 2)
2486 elif Value
[0] == '{':
2487 Pcd
.MaxDatumSize
= str(len(Value
.split(',')))
2489 Pcd
.MaxDatumSize
= str(len(Value
) - 1)
2490 return Pcds
.values()
2492 ## Resolve library names to library modules
2494 # (for Edk.x modules)
2496 # @param Module The module from which the library names will be resolved
2498 # @retval library_list The list of library modules
2500 def ResolveLibraryReference(self
, Module
):
2501 EdkLogger
.verbose("")
2502 EdkLogger
.verbose("Library instances of module [%s] [%s]:" % (str(Module
), self
.Arch
))
2503 LibraryConsumerList
= [Module
]
2505 # "CompilerStub" is a must for Edk modules
2506 if Module
.Libraries
:
2507 Module
.Libraries
.append("CompilerStub")
2509 while len(LibraryConsumerList
) > 0:
2510 M
= LibraryConsumerList
.pop()
2511 for LibraryName
in M
.Libraries
:
2512 Library
= self
.Platform
.LibraryClasses
[LibraryName
, ':dummy:']
2514 for Key
in self
.Platform
.LibraryClasses
.data
.keys():
2515 if LibraryName
.upper() == Key
.upper():
2516 Library
= self
.Platform
.LibraryClasses
[Key
, ':dummy:']
2519 EdkLogger
.warn("build", "Library [%s] is not found" % LibraryName
, File
=str(M
),
2520 ExtraData
="\t%s [%s]" % (str(Module
), self
.Arch
))
2523 if Library
not in LibraryList
:
2524 LibraryList
.append(Library
)
2525 LibraryConsumerList
.append(Library
)
2526 EdkLogger
.verbose("\t" + LibraryName
+ " : " + str(Library
) + ' ' + str(type(Library
)))
2529 ## Calculate the priority value of the build option
2531 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2533 # @retval Value Priority value based on the priority list.
2535 def CalculatePriorityValue(self
, Key
):
2536 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
.split('_')
2537 PriorityValue
= 0x11111
2539 PriorityValue
&= 0x01111
2540 if ToolChain
== "*":
2541 PriorityValue
&= 0x10111
2543 PriorityValue
&= 0x11011
2544 if CommandType
== "*":
2545 PriorityValue
&= 0x11101
2547 PriorityValue
&= 0x11110
2549 return self
.PrioList
["0x%0.5x" % PriorityValue
]
2552 ## Expand * in build option key
2554 # @param Options Options to be expanded
2556 # @retval options Options expanded
2558 def _ExpandBuildOption(self
, Options
, ModuleStyle
=None):
2565 # Construct a list contain the build options which need override.
2569 # Key[0] -- tool family
2570 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE
2572 if (Key
[0] == self
.BuildRuleFamily
and
2573 (ModuleStyle
== None or len(Key
) < 3 or (len(Key
) > 2 and Key
[2] == ModuleStyle
))):
2574 Target
, ToolChain
, Arch
, CommandType
, Attr
= Key
[1].split('_')
2575 if Target
== self
.BuildTarget
or Target
== "*":
2576 if ToolChain
== self
.ToolChain
or ToolChain
== "*":
2577 if Arch
== self
.Arch
or Arch
== "*":
2578 if Options
[Key
].startswith("="):
2579 if OverrideList
.get(Key
[1]) != None:
2580 OverrideList
.pop(Key
[1])
2581 OverrideList
[Key
[1]] = Options
[Key
]
2584 # Use the highest priority value.
2586 if (len(OverrideList
) >= 2):
2587 KeyList
= OverrideList
.keys()
2588 for Index
in range(len(KeyList
)):
2589 NowKey
= KeyList
[Index
]
2590 Target1
, ToolChain1
, Arch1
, CommandType1
, Attr1
= NowKey
.split("_")
2591 for Index1
in range(len(KeyList
) - Index
- 1):
2592 NextKey
= KeyList
[Index1
+ Index
+ 1]
2594 # Compare two Key, if one is included by another, choose the higher priority one
2596 Target2
, ToolChain2
, Arch2
, CommandType2
, Attr2
= NextKey
.split("_")
2597 if Target1
== Target2
or Target1
== "*" or Target2
== "*":
2598 if ToolChain1
== ToolChain2
or ToolChain1
== "*" or ToolChain2
== "*":
2599 if Arch1
== Arch2
or Arch1
== "*" or Arch2
== "*":
2600 if CommandType1
== CommandType2
or CommandType1
== "*" or CommandType2
== "*":
2601 if Attr1
== Attr2
or Attr1
== "*" or Attr2
== "*":
2602 if self
.CalculatePriorityValue(NowKey
) > self
.CalculatePriorityValue(NextKey
):
2603 if Options
.get((self
.BuildRuleFamily
, NextKey
)) != None:
2604 Options
.pop((self
.BuildRuleFamily
, NextKey
))
2606 if Options
.get((self
.BuildRuleFamily
, NowKey
)) != None:
2607 Options
.pop((self
.BuildRuleFamily
, NowKey
))
2610 if ModuleStyle
!= None and len (Key
) > 2:
2611 # Check Module style is EDK or EDKII.
2612 # Only append build option for the matched style module.
2613 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2615 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2618 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2619 # if tool chain family doesn't match, skip it
2620 if Tool
in self
.ToolDefinition
and Family
!= "":
2621 FamilyIsNull
= False
2622 if self
.ToolDefinition
[Tool
].get(TAB_TOD_DEFINES_BUILDRULEFAMILY
, "") != "":
2623 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_BUILDRULEFAMILY
]:
2625 elif Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2628 # expand any wildcard
2629 if Target
== "*" or Target
== self
.BuildTarget
:
2630 if Tag
== "*" or Tag
== self
.ToolChain
:
2631 if Arch
== "*" or Arch
== self
.Arch
:
2632 if Tool
not in BuildOptions
:
2633 BuildOptions
[Tool
] = {}
2634 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2635 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2637 # append options for the same tool except PATH
2639 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2641 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2642 # Build Option Family has been checked, which need't to be checked again for family.
2643 if FamilyMatch
or FamilyIsNull
:
2647 if ModuleStyle
!= None and len (Key
) > 2:
2648 # Check Module style is EDK or EDKII.
2649 # Only append build option for the matched style module.
2650 if ModuleStyle
== EDK_NAME
and Key
[2] != EDK_NAME
:
2652 elif ModuleStyle
== EDKII_NAME
and Key
[2] != EDKII_NAME
:
2655 Target
, Tag
, Arch
, Tool
, Attr
= Key
[1].split("_")
2656 # if tool chain family doesn't match, skip it
2657 if Tool
not in self
.ToolDefinition
or Family
== "":
2659 # option has been added before
2660 if Family
!= self
.ToolDefinition
[Tool
][TAB_TOD_DEFINES_FAMILY
]:
2663 # expand any wildcard
2664 if Target
== "*" or Target
== self
.BuildTarget
:
2665 if Tag
== "*" or Tag
== self
.ToolChain
:
2666 if Arch
== "*" or Arch
== self
.Arch
:
2667 if Tool
not in BuildOptions
:
2668 BuildOptions
[Tool
] = {}
2669 if Attr
!= "FLAGS" or Attr
not in BuildOptions
[Tool
] or Options
[Key
].startswith('='):
2670 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2672 # append options for the same tool except PATH
2674 BuildOptions
[Tool
][Attr
] += " " + Options
[Key
]
2676 BuildOptions
[Tool
][Attr
] = Options
[Key
]
2679 ## Append build options in platform to a module
2681 # @param Module The module to which the build options will be appened
2683 # @retval options The options appended with build options in platform
2685 def ApplyBuildOption(self
, Module
):
2686 # Get the different options for the different style module
2687 if Module
.AutoGenVersion
< 0x00010005:
2688 PlatformOptions
= self
.EdkBuildOption
2689 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDK_NAME
, Module
.ModuleType
)
2691 PlatformOptions
= self
.EdkIIBuildOption
2692 ModuleTypeOptions
= self
.Platform
.GetBuildOptionsByModuleType(EDKII_NAME
, Module
.ModuleType
)
2693 ModuleTypeOptions
= self
._ExpandBuildOption
(ModuleTypeOptions
)
2694 ModuleOptions
= self
._ExpandBuildOption
(Module
.BuildOptions
)
2695 if Module
in self
.Platform
.Modules
:
2696 PlatformModule
= self
.Platform
.Modules
[str(Module
)]
2697 PlatformModuleOptions
= self
._ExpandBuildOption
(PlatformModule
.BuildOptions
)
2699 PlatformModuleOptions
= {}
2701 BuildRuleOrder
= None
2702 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2703 for Tool
in Options
:
2704 for Attr
in Options
[Tool
]:
2705 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2706 BuildRuleOrder
= Options
[Tool
][Attr
]
2708 AllTools
= set(ModuleOptions
.keys() + PlatformOptions
.keys() +
2709 PlatformModuleOptions
.keys() + ModuleTypeOptions
.keys() +
2710 self
.ToolDefinition
.keys())
2712 for Tool
in AllTools
:
2713 if Tool
not in BuildOptions
:
2714 BuildOptions
[Tool
] = {}
2716 for Options
in [self
.ToolDefinition
, ModuleOptions
, PlatformOptions
, ModuleTypeOptions
, PlatformModuleOptions
]:
2717 if Tool
not in Options
:
2719 for Attr
in Options
[Tool
]:
2720 Value
= Options
[Tool
][Attr
]
2722 # Do not generate it in Makefile
2724 if Attr
== TAB_TOD_DEFINES_BUILDRULEORDER
:
2726 if Attr
not in BuildOptions
[Tool
]:
2727 BuildOptions
[Tool
][Attr
] = ""
2728 # check if override is indicated
2729 if Value
.startswith('='):
2730 ToolPath
= Value
[1:]
2731 ToolPath
= mws
.handleWsMacro(ToolPath
)
2732 BuildOptions
[Tool
][Attr
] = ToolPath
2734 Value
= mws
.handleWsMacro(Value
)
2736 BuildOptions
[Tool
][Attr
] += " " + Value
2738 BuildOptions
[Tool
][Attr
] = Value
2739 if Module
.AutoGenVersion
< 0x00010005 and self
.Workspace
.UniFlag
!= None:
2741 # Override UNI flag only for EDK module.
2743 if 'BUILD' not in BuildOptions
:
2744 BuildOptions
['BUILD'] = {}
2745 BuildOptions
['BUILD']['FLAGS'] = self
.Workspace
.UniFlag
2746 return BuildOptions
, BuildRuleOrder
2748 Platform
= property(_GetPlatform
)
2749 Name
= property(_GetName
)
2750 Guid
= property(_GetGuid
)
2751 Version
= property(_GetVersion
)
2753 OutputDir
= property(_GetOutputDir
)
2754 BuildDir
= property(_GetBuildDir
)
2755 MakeFileDir
= property(_GetMakeFileDir
)
2756 FdfFile
= property(_GetFdfFile
)
2758 PcdTokenNumber
= property(_GetPcdTokenNumbers
) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber
2759 DynamicPcdList
= property(_GetDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2760 NonDynamicPcdList
= property(_GetNonDynamicPcdList
) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]
2761 NonDynamicPcdDict
= property(_GetNonDynamicPcdDict
)
2762 PackageList
= property(_GetPackageList
)
2764 ToolDefinition
= property(_GetToolDefinition
) # toolcode : tool path
2765 ToolDefinitionFile
= property(_GetToolDefFile
) # toolcode : lib path
2766 ToolChainFamily
= property(_GetToolChainFamily
)
2767 BuildRuleFamily
= property(_GetBuildRuleFamily
)
2768 BuildOption
= property(_GetBuildOptions
) # toolcode : option
2769 EdkBuildOption
= property(_GetEdkBuildOptions
) # edktoolcode : option
2770 EdkIIBuildOption
= property(_GetEdkIIBuildOptions
) # edkiitoolcode : option
2772 BuildCommand
= property(_GetBuildCommand
)
2773 BuildRule
= property(_GetBuildRule
)
2774 ModuleAutoGenList
= property(_GetModuleAutoGenList
)
2775 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
2776 GenFdsCommand
= property(_GenFdsCommand
)
2778 ## ModuleAutoGen class
2780 # This class encapsules the AutoGen behaviors for the build tools. In addition to
2781 # the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according
2782 # to the [depex] section in module's inf file.
2784 class ModuleAutoGen(AutoGen
):
2785 # call super().__init__ then call the worker function with different parameter count
2786 def __init__(self
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2790 super(ModuleAutoGen
, self
).__init
__(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2791 self
._InitWorker
(Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
)
2794 ## Cache the timestamps of metafiles of every module in a class variable
2798 def __new__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
):
2799 obj
= super(ModuleAutoGen
, cls
).__new
__(cls
, Workspace
, MetaFile
, Target
, Toolchain
, Arch
, *args
, **kwargs
)
2800 # check if this module is employed by active platform
2801 if not PlatformAutoGen(Workspace
, args
[0], Target
, Toolchain
, Arch
).ValidModule(MetaFile
):
2802 EdkLogger
.verbose("Module [%s] for [%s] is not employed by active platform\n" \
2807 ## Initialize ModuleAutoGen
2809 # @param Workspace EdkIIWorkspaceBuild object
2810 # @param ModuleFile The path of module file
2811 # @param Target Build target (DEBUG, RELEASE)
2812 # @param Toolchain Name of tool chain
2813 # @param Arch The arch the module supports
2814 # @param PlatformFile Platform meta-file
2816 def _InitWorker(self
, Workspace
, ModuleFile
, Target
, Toolchain
, Arch
, PlatformFile
):
2817 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "AutoGen module [%s] [%s]" % (ModuleFile
, Arch
))
2818 GlobalData
.gProcessingFile
= "%s [%s, %s, %s]" % (ModuleFile
, Arch
, Toolchain
, Target
)
2820 self
.Workspace
= Workspace
2821 self
.WorkspaceDir
= Workspace
.WorkspaceDir
2823 self
.MetaFile
= ModuleFile
2824 self
.PlatformInfo
= PlatformAutoGen(Workspace
, PlatformFile
, Target
, Toolchain
, Arch
)
2826 self
.SourceDir
= self
.MetaFile
.SubDir
2827 self
.SourceDir
= mws
.relpath(self
.SourceDir
, self
.WorkspaceDir
)
2829 self
.SourceOverrideDir
= None
2830 # use overrided path defined in DSC file
2831 if self
.MetaFile
.Key
in GlobalData
.gOverrideDir
:
2832 self
.SourceOverrideDir
= GlobalData
.gOverrideDir
[self
.MetaFile
.Key
]
2834 self
.ToolChain
= Toolchain
2835 self
.BuildTarget
= Target
2837 self
.ToolChainFamily
= self
.PlatformInfo
.ToolChainFamily
2838 self
.BuildRuleFamily
= self
.PlatformInfo
.BuildRuleFamily
2840 self
.IsMakeFileCreated
= False
2841 self
.IsCodeFileCreated
= False
2842 self
.IsAsBuiltInfCreated
= False
2843 self
.DepexGenerated
= False
2845 self
.BuildDatabase
= self
.Workspace
.BuildDatabase
2846 self
.BuildRuleOrder
= None
2852 self
._Version
= None
2853 self
._ModuleType
= None
2854 self
._ComponentType
= None
2855 self
._PcdIsDriver
= None
2856 self
._AutoGenVersion
= None
2857 self
._LibraryFlag
= None
2858 self
._CustomMakefile
= None
2861 self
._BuildDir
= None
2862 self
._OutputDir
= None
2863 self
._FfsOutputDir
= None
2864 self
._DebugDir
= None
2865 self
._MakeFileDir
= None
2867 self
._IncludePathList
= None
2868 self
._IncludePathLength
= 0
2869 self
._AutoGenFileList
= None
2870 self
._UnicodeFileList
= None
2871 self
._VfrFileList
= None
2872 self
._IdfFileList
= None
2873 self
._SourceFileList
= None
2874 self
._ObjectFileList
= None
2875 self
._BinaryFileList
= None
2877 self
._DependentPackageList
= None
2878 self
._DependentLibraryList
= None
2879 self
._LibraryAutoGenList
= None
2880 self
._DerivedPackageList
= None
2881 self
._ModulePcdList
= None
2882 self
._LibraryPcdList
= None
2883 self
._PcdComments
= sdict()
2884 self
._GuidList
= None
2885 self
._GuidsUsedByPcd
= None
2886 self
._GuidComments
= sdict()
2887 self
._ProtocolList
= None
2888 self
._ProtocolComments
= sdict()
2889 self
._PpiList
= None
2890 self
._PpiComments
= sdict()
2891 self
._DepexList
= None
2892 self
._DepexExpressionList
= None
2893 self
._BuildOption
= None
2894 self
._BuildOptionIncPathList
= None
2895 self
._BuildTargets
= None
2896 self
._IntroBuildTargetList
= None
2897 self
._FinalBuildTargetList
= None
2898 self
._FileTypes
= None
2899 self
._BuildRules
= None
2901 self
._TimeStampPath
= None
2903 self
.AutoGenDepSet
= set()
2906 ## The Modules referenced to this Library
2907 # Only Library has this attribute
2908 self
._ReferenceModules
= []
2910 ## Store the FixedAtBuild Pcds
2912 self
._FixedAtBuildPcds
= []
2917 return "%s [%s]" % (self
.MetaFile
, self
.Arch
)
2919 # Get FixedAtBuild Pcds of this Module
2920 def _GetFixedAtBuildPcds(self
):
2921 if self
._FixedAtBuildPcds
:
2922 return self
._FixedAtBuildPcds
2923 for Pcd
in self
.ModulePcdList
:
2924 if Pcd
.Type
!= "FixedAtBuild":
2926 if Pcd
not in self
._FixedAtBuildPcds
:
2927 self
._FixedAtBuildPcds
.append(Pcd
)
2929 return self
._FixedAtBuildPcds
2931 def _GetUniqueBaseName(self
):
2932 BaseName
= self
.Name
2933 for Module
in self
.PlatformInfo
.ModuleAutoGenList
:
2934 if Module
.MetaFile
== self
.MetaFile
:
2936 if Module
.Name
== self
.Name
:
2937 if uuid
.UUID(Module
.Guid
) == uuid
.UUID(self
.Guid
):
2938 EdkLogger
.error("build", FILE_DUPLICATED
, 'Modules have same BaseName and FILE_GUID:\n'
2939 ' %s\n %s' % (Module
.MetaFile
, self
.MetaFile
))
2940 BaseName
= '%s_%s' % (self
.Name
, self
.Guid
)
2943 # Macros could be used in build_rule.txt (also Makefile)
2944 def _GetMacros(self
):
2945 if self
._Macro
== None:
2946 self
._Macro
= sdict()
2947 self
._Macro
["WORKSPACE" ] = self
.WorkspaceDir
2948 self
._Macro
["MODULE_NAME" ] = self
.Name
2949 self
._Macro
["MODULE_NAME_GUID" ] = self
._GetUniqueBaseName
()
2950 self
._Macro
["MODULE_GUID" ] = self
.Guid
2951 self
._Macro
["MODULE_VERSION" ] = self
.Version
2952 self
._Macro
["MODULE_TYPE" ] = self
.ModuleType
2953 self
._Macro
["MODULE_FILE" ] = str(self
.MetaFile
)
2954 self
._Macro
["MODULE_FILE_BASE_NAME" ] = self
.MetaFile
.BaseName
2955 self
._Macro
["MODULE_RELATIVE_DIR" ] = self
.SourceDir
2956 self
._Macro
["MODULE_DIR" ] = self
.SourceDir
2958 self
._Macro
["BASE_NAME" ] = self
.Name
2960 self
._Macro
["ARCH" ] = self
.Arch
2961 self
._Macro
["TOOLCHAIN" ] = self
.ToolChain
2962 self
._Macro
["TOOLCHAIN_TAG" ] = self
.ToolChain
2963 self
._Macro
["TOOL_CHAIN_TAG" ] = self
.ToolChain
2964 self
._Macro
["TARGET" ] = self
.BuildTarget
2966 self
._Macro
["BUILD_DIR" ] = self
.PlatformInfo
.BuildDir
2967 self
._Macro
["BIN_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2968 self
._Macro
["LIB_DIR" ] = os
.path
.join(self
.PlatformInfo
.BuildDir
, self
.Arch
)
2969 self
._Macro
["MODULE_BUILD_DIR" ] = self
.BuildDir
2970 self
._Macro
["OUTPUT_DIR" ] = self
.OutputDir
2971 self
._Macro
["DEBUG_DIR" ] = self
.DebugDir
2972 self
._Macro
["DEST_DIR_OUTPUT" ] = self
.OutputDir
2973 self
._Macro
["DEST_DIR_DEBUG" ] = self
.DebugDir
2974 self
._Macro
["PLATFORM_NAME" ] = self
.PlatformInfo
.Name
2975 self
._Macro
["PLATFORM_GUID" ] = self
.PlatformInfo
.Guid
2976 self
._Macro
["PLATFORM_VERSION" ] = self
.PlatformInfo
.Version
2977 self
._Macro
["PLATFORM_RELATIVE_DIR" ] = self
.PlatformInfo
.SourceDir
2978 self
._Macro
["PLATFORM_DIR" ] = mws
.join(self
.WorkspaceDir
, self
.PlatformInfo
.SourceDir
)
2979 self
._Macro
["PLATFORM_OUTPUT_DIR" ] = self
.PlatformInfo
.OutputDir
2980 self
._Macro
["FFS_OUTPUT_DIR" ] = self
.FfsOutputDir
2983 ## Return the module build data object
2984 def _GetModule(self
):
2985 if self
._Module
== None:
2986 self
._Module
= self
.Workspace
.BuildDatabase
[self
.MetaFile
, self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
2989 ## Return the module name
2990 def _GetBaseName(self
):
2991 return self
.Module
.BaseName
2993 ## Return the module DxsFile if exist
2994 def _GetDxsFile(self
):
2995 return self
.Module
.DxsFile
2997 ## Return the module SourceOverridePath
2998 def _GetSourceOverridePath(self
):
2999 return self
.Module
.SourceOverridePath
3001 ## Return the module meta-file GUID
3004 # To build same module more than once, the module path with FILE_GUID overridden has
3005 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path
3006 # in DSC. The overridden GUID can be retrieved from file name
3008 if os
.path
.basename(self
.MetaFile
.File
) != os
.path
.basename(self
.MetaFile
.Path
):
3010 # Length of GUID is 36
3012 return os
.path
.basename(self
.MetaFile
.Path
)[:36]
3013 return self
.Module
.Guid
3015 ## Return the module version
3016 def _GetVersion(self
):
3017 return self
.Module
.Version
3019 ## Return the module type
3020 def _GetModuleType(self
):
3021 return self
.Module
.ModuleType
3023 ## Return the component type (for Edk.x style of module)
3024 def _GetComponentType(self
):
3025 return self
.Module
.ComponentType
3027 ## Return the build type
3028 def _GetBuildType(self
):
3029 return self
.Module
.BuildType
3031 ## Return the PCD_IS_DRIVER setting
3032 def _GetPcdIsDriver(self
):
3033 return self
.Module
.PcdIsDriver
3035 ## Return the autogen version, i.e. module meta-file version
3036 def _GetAutoGenVersion(self
):
3037 return self
.Module
.AutoGenVersion
3039 ## Check if the module is library or not
3040 def _IsLibrary(self
):
3041 if self
._LibraryFlag
== None:
3042 if self
.Module
.LibraryClass
!= None and self
.Module
.LibraryClass
!= []:
3043 self
._LibraryFlag
= True
3045 self
._LibraryFlag
= False
3046 return self
._LibraryFlag
3048 ## Check if the module is binary module or not
3049 def _IsBinaryModule(self
):
3050 return self
.Module
.IsBinaryModule
3052 ## Return the directory to store intermediate files of the module
3053 def _GetBuildDir(self
):
3054 if self
._BuildDir
== None:
3055 self
._BuildDir
= path
.join(
3056 self
.PlatformInfo
.BuildDir
,
3059 self
.MetaFile
.BaseName
3061 CreateDirectory(self
._BuildDir
)
3062 return self
._BuildDir
3064 ## Return the directory to store the intermediate object files of the mdoule
3065 def _GetOutputDir(self
):
3066 if self
._OutputDir
== None:
3067 self
._OutputDir
= path
.join(self
.BuildDir
, "OUTPUT")
3068 CreateDirectory(self
._OutputDir
)
3069 return self
._OutputDir
3071 ## Return the directory to store ffs file
3072 def _GetFfsOutputDir(self
):
3073 if self
._FfsOutputDir
== None:
3074 if GlobalData
.gFdfParser
!= None:
3075 self
._FfsOutputDir
= path
.join(self
.PlatformInfo
.BuildDir
, "FV", "Ffs", self
.Guid
+ self
.Name
)
3077 self
._FfsOutputDir
= ''
3078 return self
._FfsOutputDir
3080 ## Return the directory to store auto-gened source files of the mdoule
3081 def _GetDebugDir(self
):
3082 if self
._DebugDir
== None:
3083 self
._DebugDir
= path
.join(self
.BuildDir
, "DEBUG")
3084 CreateDirectory(self
._DebugDir
)
3085 return self
._DebugDir
3087 ## Return the path of custom file
3088 def _GetCustomMakefile(self
):
3089 if self
._CustomMakefile
== None:
3090 self
._CustomMakefile
= {}
3091 for Type
in self
.Module
.CustomMakefile
:
3092 if Type
in gMakeTypeMap
:
3093 MakeType
= gMakeTypeMap
[Type
]
3096 if self
.SourceOverrideDir
!= None:
3097 File
= os
.path
.join(self
.SourceOverrideDir
, self
.Module
.CustomMakefile
[Type
])
3098 if not os
.path
.exists(File
):
3099 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3101 File
= os
.path
.join(self
.SourceDir
, self
.Module
.CustomMakefile
[Type
])
3102 self
._CustomMakefile
[MakeType
] = File
3103 return self
._CustomMakefile
3105 ## Return the directory of the makefile
3107 # @retval string The directory string of module's makefile
3109 def _GetMakeFileDir(self
):
3110 return self
.BuildDir
3112 ## Return build command string
3114 # @retval string Build command string
3116 def _GetBuildCommand(self
):
3117 return self
.PlatformInfo
.BuildCommand
3119 ## Get object list of all packages the module and its dependent libraries belong to
3121 # @retval list The list of package object
3123 def _GetDerivedPackageList(self
):
3125 for M
in [self
.Module
] + self
.DependentLibraryList
:
3126 for Package
in M
.Packages
:
3127 if Package
in PackageList
:
3129 PackageList
.append(Package
)
3132 ## Get the depex string
3134 # @return : a string contain all depex expresion.
3135 def _GetDepexExpresionString(self
):
3138 ## DPX_SOURCE IN Define section.
3139 if self
.Module
.DxsFile
:
3141 for M
in [self
.Module
] + self
.DependentLibraryList
:
3142 Filename
= M
.MetaFile
.Path
3143 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3144 DepexExpresionList
= InfObj
.GetDepexExpresionList()
3145 for DepexExpresion
in DepexExpresionList
:
3146 for key
in DepexExpresion
.keys():
3147 Arch
, ModuleType
= key
3148 DepexExpr
= [x
for x
in DepexExpresion
[key
] if not str(x
).startswith('#')]
3149 # the type of build module is USER_DEFINED.
3150 # All different DEPEX section tags would be copied into the As Built INF file
3151 # and there would be separate DEPEX section tags
3152 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3153 if (Arch
.upper() == self
.Arch
.upper()) and (ModuleType
.upper() != TAB_ARCH_COMMON
):
3154 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3156 if Arch
.upper() == TAB_ARCH_COMMON
or \
3157 (Arch
.upper() == self
.Arch
.upper() and \
3158 ModuleType
.upper() in [TAB_ARCH_COMMON
, self
.ModuleType
.upper()]):
3159 DepexList
.append({(Arch
, ModuleType
): DepexExpr
})
3161 #the type of build module is USER_DEFINED.
3162 if self
.ModuleType
.upper() == SUP_MODULE_USER_DEFINED
:
3163 for Depex
in DepexList
:
3164 for key
in Depex
.keys():
3165 DepexStr
+= '[Depex.%s.%s]\n' % key
3166 DepexStr
+= '\n'.join(['# '+ val
for val
in Depex
[key
]])
3169 return '[Depex.%s]\n' % self
.Arch
3172 #the type of build module not is USER_DEFINED.
3174 for Depex
in DepexList
:
3179 for D
in Depex
.values():
3180 DepexStr
+= ' '.join([val
for val
in D
])
3181 Index
= DepexStr
.find('END')
3182 if Index
> -1 and Index
== len(DepexStr
) - 3:
3183 DepexStr
= DepexStr
[:-3]
3184 DepexStr
= DepexStr
.strip()
3187 DepexStr
= DepexStr
.lstrip('(').rstrip(')').strip()
3189 return '[Depex.%s]\n' % self
.Arch
3190 return '[Depex.%s]\n# ' % self
.Arch
+ DepexStr
3192 ## Merge dependency expression
3194 # @retval list The token list of the dependency expression after parsed
3196 def _GetDepexTokenList(self
):
3197 if self
._DepexList
== None:
3198 self
._DepexList
= {}
3199 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3200 return self
._DepexList
3202 self
._DepexList
[self
.ModuleType
] = []
3204 for ModuleType
in self
._DepexList
:
3205 DepexList
= self
._DepexList
[ModuleType
]
3207 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3209 for M
in [self
.Module
] + self
.DependentLibraryList
:
3211 for D
in M
.Depex
[self
.Arch
, ModuleType
]:
3213 DepexList
.append('AND')
3214 DepexList
.append('(')
3216 if DepexList
[-1] == 'END': # no need of a END at this time
3218 DepexList
.append(')')
3221 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexList
))
3222 if 'BEFORE' in DepexList
or 'AFTER' in DepexList
:
3224 if len(DepexList
) > 0:
3225 EdkLogger
.verbose('')
3226 return self
._DepexList
3228 ## Merge dependency expression
3230 # @retval list The token list of the dependency expression after parsed
3232 def _GetDepexExpressionTokenList(self
):
3233 if self
._DepexExpressionList
== None:
3234 self
._DepexExpressionList
= {}
3235 if self
.DxsFile
or self
.IsLibrary
or TAB_DEPENDENCY_EXPRESSION_FILE
in self
.FileTypes
:
3236 return self
._DepexExpressionList
3238 self
._DepexExpressionList
[self
.ModuleType
] = ''
3240 for ModuleType
in self
._DepexExpressionList
:
3241 DepexExpressionList
= self
._DepexExpressionList
[ModuleType
]
3243 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion
3245 for M
in [self
.Module
] + self
.DependentLibraryList
:
3247 for D
in M
.DepexExpression
[self
.Arch
, ModuleType
]:
3248 if DepexExpressionList
!= '':
3249 DepexExpressionList
+= ' AND '
3250 DepexExpressionList
+= '('
3251 DepexExpressionList
+= D
3252 DepexExpressionList
= DepexExpressionList
.rstrip('END').strip()
3253 DepexExpressionList
+= ')'
3256 EdkLogger
.verbose("DEPEX[%s] (+%s) = %s" % (self
.Name
, M
.BaseName
, DepexExpressionList
))
3257 if 'BEFORE' in DepexExpressionList
or 'AFTER' in DepexExpressionList
:
3259 if len(DepexExpressionList
) > 0:
3260 EdkLogger
.verbose('')
3261 self
._DepexExpressionList
[ModuleType
] = DepexExpressionList
3262 return self
._DepexExpressionList
3264 # Get the tiano core user extension, it is contain dependent library.
3265 # @retval: a list contain tiano core userextension.
3267 def _GetTianoCoreUserExtensionList(self
):
3268 TianoCoreUserExtentionList
= []
3269 for M
in [self
.Module
] + self
.DependentLibraryList
:
3270 Filename
= M
.MetaFile
.Path
3271 InfObj
= InfSectionParser
.InfSectionParser(Filename
)
3272 TianoCoreUserExtenList
= InfObj
.GetUserExtensionTianoCore()
3273 for TianoCoreUserExtent
in TianoCoreUserExtenList
:
3274 for Section
in TianoCoreUserExtent
.keys():
3275 ItemList
= Section
.split(TAB_SPLIT
)
3277 if len(ItemList
) == 4:
3279 if Arch
.upper() == TAB_ARCH_COMMON
or Arch
.upper() == self
.Arch
.upper():
3281 TianoCoreList
.extend([TAB_SECTION_START
+ Section
+ TAB_SECTION_END
])
3282 TianoCoreList
.extend(TianoCoreUserExtent
[Section
][:])
3283 TianoCoreList
.append('\n')
3284 TianoCoreUserExtentionList
.append(TianoCoreList
)
3286 return TianoCoreUserExtentionList
3288 ## Return the list of specification version required for the module
3290 # @retval list The list of specification defined in module file
3292 def _GetSpecification(self
):
3293 return self
.Module
.Specification
3295 ## Tool option for the module build
3297 # @param PlatformInfo The object of PlatformBuildInfo
3298 # @retval dict The dict containing valid options
3300 def _GetModuleBuildOption(self
):
3301 if self
._BuildOption
== None:
3302 self
._BuildOption
, self
.BuildRuleOrder
= self
.PlatformInfo
.ApplyBuildOption(self
.Module
)
3303 if self
.BuildRuleOrder
:
3304 self
.BuildRuleOrder
= ['.%s' % Ext
for Ext
in self
.BuildRuleOrder
.split()]
3305 return self
._BuildOption
3307 ## Get include path list from tool option for the module build
3309 # @retval list The include path list
3311 def _GetBuildOptionIncPathList(self
):
3312 if self
._BuildOptionIncPathList
== None:
3314 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT
3315 # is the former use /I , the Latter used -I to specify include directories
3317 if self
.PlatformInfo
.ToolChainFamily
in ('MSFT'):
3318 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)/I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3319 elif self
.PlatformInfo
.ToolChainFamily
in ('INTEL', 'GCC', 'RVCT'):
3320 gBuildOptIncludePattern
= re
.compile(r
"(?:.*?)-I[ \t]*([^ ]*)", re
.MULTILINE | re
.DOTALL
)
3323 # New ToolChainFamily, don't known whether there is option to specify include directories
3325 self
._BuildOptionIncPathList
= []
3326 return self
._BuildOptionIncPathList
3328 BuildOptionIncPathList
= []
3329 for Tool
in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):
3332 FlagOption
= self
.BuildOption
[Tool
][Attr
]
3336 if self
.PlatformInfo
.ToolChainFamily
!= 'RVCT':
3337 IncPathList
= [NormPath(Path
, self
.Macros
) for Path
in gBuildOptIncludePattern
.findall(FlagOption
)]
3340 # RVCT may specify a list of directory seperated by commas
3343 for Path
in gBuildOptIncludePattern
.findall(FlagOption
):
3344 PathList
= GetSplitList(Path
, TAB_COMMA_SPLIT
)
3345 IncPathList
+= [NormPath(PathEntry
, self
.Macros
) for PathEntry
in PathList
]
3348 # EDK II modules must not reference header files outside of the packages they depend on or
3349 # within the module's directory tree. Report error if violation.
3351 if self
.AutoGenVersion
>= 0x00010005 and len(IncPathList
) > 0:
3352 for Path
in IncPathList
:
3353 if (Path
not in self
.IncludePathList
) and (CommonPath([Path
, self
.MetaFile
.Dir
]) != self
.MetaFile
.Dir
):
3354 ErrMsg
= "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path
, Tool
, FlagOption
)
3355 EdkLogger
.error("build",
3358 File
=str(self
.MetaFile
))
3361 BuildOptionIncPathList
+= IncPathList
3363 self
._BuildOptionIncPathList
= BuildOptionIncPathList
3365 return self
._BuildOptionIncPathList
3367 ## Return a list of files which can be built from source
3369 # What kind of files can be built is determined by build rules in
3370 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.
3372 def _GetSourceFileList(self
):
3373 if self
._SourceFileList
== None:
3374 self
._SourceFileList
= []
3375 for F
in self
.Module
.Sources
:
3377 if F
.TagName
not in ("", "*", self
.ToolChain
):
3378 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "The toolchain [%s] for processing file [%s] is found, "
3379 "but [%s] is needed" % (F
.TagName
, str(F
), self
.ToolChain
))
3381 # match tool chain family or build rule family
3382 if F
.ToolChainFamily
not in ("", "*", self
.ToolChainFamily
, self
.BuildRuleFamily
):
3385 "The file [%s] must be built by tools of [%s], " \
3386 "but current toolchain family is [%s], buildrule family is [%s]" \
3387 % (str(F
), F
.ToolChainFamily
, self
.ToolChainFamily
, self
.BuildRuleFamily
))
3390 # add the file path into search path list for file including
3391 if F
.Dir
not in self
.IncludePathList
and self
.AutoGenVersion
>= 0x00010005:
3392 self
.IncludePathList
.insert(0, F
.Dir
)
3393 self
._SourceFileList
.append(F
)
3395 self
._MatchBuildRuleOrder
(self
._SourceFileList
)
3397 for F
in self
._SourceFileList
:
3398 self
._ApplyBuildRule
(F
, TAB_UNKNOWN_FILE
)
3399 return self
._SourceFileList
3401 def _MatchBuildRuleOrder(self
, FileList
):
3403 self
._GetModuleBuildOption
()
3404 for SingleFile
in FileList
:
3405 if self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRuleOrder
and SingleFile
.Ext
in self
.BuildRules
:
3406 key
= SingleFile
.Path
.split(SingleFile
.Ext
)[0]
3407 if key
in Order_Dict
:
3408 Order_Dict
[key
].append(SingleFile
.Ext
)
3410 Order_Dict
[key
] = [SingleFile
.Ext
]
3413 for F
in Order_Dict
:
3414 if len(Order_Dict
[F
]) > 1:
3415 Order_Dict
[F
].sort(key
=lambda i
: self
.BuildRuleOrder
.index(i
))
3416 for Ext
in Order_Dict
[F
][1:]:
3417 RemoveList
.append(F
+ Ext
)
3419 for item
in RemoveList
:
3420 FileList
.remove(item
)
3424 ## Return the list of unicode files
3425 def _GetUnicodeFileList(self
):
3426 if self
._UnicodeFileList
== None:
3427 if TAB_UNICODE_FILE
in self
.FileTypes
:
3428 self
._UnicodeFileList
= self
.FileTypes
[TAB_UNICODE_FILE
]
3430 self
._UnicodeFileList
= []
3431 return self
._UnicodeFileList
3433 ## Return the list of vfr files
3434 def _GetVfrFileList(self
):
3435 if self
._VfrFileList
== None:
3436 if TAB_VFR_FILE
in self
.FileTypes
:
3437 self
._VfrFileList
= self
.FileTypes
[TAB_VFR_FILE
]
3439 self
._VfrFileList
= []
3440 return self
._VfrFileList
3442 ## Return the list of Image Definition files
3443 def _GetIdfFileList(self
):
3444 if self
._IdfFileList
== None:
3445 if TAB_IMAGE_FILE
in self
.FileTypes
:
3446 self
._IdfFileList
= self
.FileTypes
[TAB_IMAGE_FILE
]
3448 self
._IdfFileList
= []
3449 return self
._IdfFileList
3451 ## Return a list of files which can be built from binary
3453 # "Build" binary files are just to copy them to build directory.
3455 # @retval list The list of files which can be built later
3457 def _GetBinaryFiles(self
):
3458 if self
._BinaryFileList
== None:
3459 self
._BinaryFileList
= []
3460 for F
in self
.Module
.Binaries
:
3461 if F
.Target
not in ['COMMON', '*'] and F
.Target
!= self
.BuildTarget
:
3463 self
._BinaryFileList
.append(F
)
3464 self
._ApplyBuildRule
(F
, F
.Type
)
3465 return self
._BinaryFileList
3467 def _GetBuildRules(self
):
3468 if self
._BuildRules
== None:
3470 BuildRuleDatabase
= self
.PlatformInfo
.BuildRule
3471 for Type
in BuildRuleDatabase
.FileTypeList
:
3472 #first try getting build rule by BuildRuleFamily
3473 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.BuildRuleFamily
]
3475 # build type is always module type, but ...
3476 if self
.ModuleType
!= self
.BuildType
:
3477 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.BuildRuleFamily
]
3478 #second try getting build rule by ToolChainFamily
3480 RuleObject
= BuildRuleDatabase
[Type
, self
.BuildType
, self
.Arch
, self
.ToolChainFamily
]
3482 # build type is always module type, but ...
3483 if self
.ModuleType
!= self
.BuildType
:
3484 RuleObject
= BuildRuleDatabase
[Type
, self
.ModuleType
, self
.Arch
, self
.ToolChainFamily
]
3487 RuleObject
= RuleObject
.Instantiate(self
.Macros
)
3488 BuildRules
[Type
] = RuleObject
3489 for Ext
in RuleObject
.SourceFileExtList
:
3490 BuildRules
[Ext
] = RuleObject
3491 self
._BuildRules
= BuildRules
3492 return self
._BuildRules
3494 def _ApplyBuildRule(self
, File
, FileType
):
3495 if self
._BuildTargets
== None:
3496 self
._IntroBuildTargetList
= set()
3497 self
._FinalBuildTargetList
= set()
3498 self
._BuildTargets
= {}
3499 self
._FileTypes
= {}
3501 SubDirectory
= os
.path
.join(self
.OutputDir
, File
.SubDir
)
3502 if not os
.path
.exists(SubDirectory
):
3503 CreateDirectory(SubDirectory
)
3509 # Make sure to get build rule order value
3511 self
._GetModuleBuildOption
()
3513 while Index
< len(SourceList
):
3514 Source
= SourceList
[Index
]
3518 CreateDirectory(Source
.Dir
)
3520 if File
.IsBinary
and File
== Source
and self
._BinaryFileList
!= None and File
in self
._BinaryFileList
:
3521 # Skip all files that are not binary libraries
3522 if not self
.IsLibrary
:
3524 RuleObject
= self
.BuildRules
[TAB_DEFAULT_BINARY_FILE
]
3525 elif FileType
in self
.BuildRules
:
3526 RuleObject
= self
.BuildRules
[FileType
]
3527 elif Source
.Ext
in self
.BuildRules
:
3528 RuleObject
= self
.BuildRules
[Source
.Ext
]
3530 # stop at no more rules
3532 self
._FinalBuildTargetList
.add(LastTarget
)
3535 FileType
= RuleObject
.SourceFileType
3536 if FileType
not in self
._FileTypes
:
3537 self
._FileTypes
[FileType
] = set()
3538 self
._FileTypes
[FileType
].add(Source
)
3540 # stop at STATIC_LIBRARY for library
3541 if self
.IsLibrary
and FileType
== TAB_STATIC_LIBRARY
:
3543 self
._FinalBuildTargetList
.add(LastTarget
)
3546 Target
= RuleObject
.Apply(Source
, self
.BuildRuleOrder
)
3549 self
._FinalBuildTargetList
.add(LastTarget
)
3551 elif not Target
.Outputs
:
3552 # Only do build for target with outputs
3553 self
._FinalBuildTargetList
.add(Target
)
3555 if FileType
not in self
._BuildTargets
:
3556 self
._BuildTargets
[FileType
] = set()
3557 self
._BuildTargets
[FileType
].add(Target
)
3559 if not Source
.IsBinary
and Source
== File
:
3560 self
._IntroBuildTargetList
.add(Target
)
3562 # to avoid cyclic rule
3563 if FileType
in RuleChain
:
3566 RuleChain
.append(FileType
)
3567 SourceList
.extend(Target
.Outputs
)
3569 FileType
= TAB_UNKNOWN_FILE
3571 def _GetTargets(self
):
3572 if self
._BuildTargets
== None:
3573 self
._IntroBuildTargetList
= set()
3574 self
._FinalBuildTargetList
= set()
3575 self
._BuildTargets
= {}
3576 self
._FileTypes
= {}
3578 #TRICK: call _GetSourceFileList to apply build rule for source files
3579 if self
.SourceFileList
:
3582 #TRICK: call _GetBinaryFileList to apply build rule for binary files
3583 if self
.BinaryFileList
:
3586 return self
._BuildTargets
3588 def _GetIntroTargetList(self
):
3590 return self
._IntroBuildTargetList
3592 def _GetFinalTargetList(self
):
3594 return self
._FinalBuildTargetList
3596 def _GetFileTypes(self
):
3598 return self
._FileTypes
3600 ## Get the list of package object the module depends on
3602 # @retval list The package object list
3604 def _GetDependentPackageList(self
):
3605 return self
.Module
.Packages
3607 ## Return the list of auto-generated code file
3609 # @retval list The list of auto-generated file
3611 def _GetAutoGenFileList(self
):
3612 UniStringAutoGenC
= True
3613 IdfStringAutoGenC
= True
3614 UniStringBinBuffer
= StringIO()
3615 IdfGenBinBuffer
= StringIO()
3616 if self
.BuildType
== 'UEFI_HII':
3617 UniStringAutoGenC
= False
3618 IdfStringAutoGenC
= False
3619 if self
._AutoGenFileList
== None:
3620 self
._AutoGenFileList
= {}
3621 AutoGenC
= TemplateString()
3622 AutoGenH
= TemplateString()
3623 StringH
= TemplateString()
3624 StringIdf
= TemplateString()
3625 GenC
.CreateCode(self
, AutoGenC
, AutoGenH
, StringH
, UniStringAutoGenC
, UniStringBinBuffer
, StringIdf
, IdfStringAutoGenC
, IdfGenBinBuffer
)
3627 # AutoGen.c is generated if there are library classes in inf, or there are object files
3629 if str(AutoGenC
) != "" and (len(self
.Module
.LibraryClasses
) > 0
3630 or TAB_OBJECT_FILE
in self
.FileTypes
):
3631 AutoFile
= PathClass(gAutoGenCodeFileName
, self
.DebugDir
)
3632 self
._AutoGenFileList
[AutoFile
] = str(AutoGenC
)
3633 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3634 if str(AutoGenH
) != "":
3635 AutoFile
= PathClass(gAutoGenHeaderFileName
, self
.DebugDir
)
3636 self
._AutoGenFileList
[AutoFile
] = str(AutoGenH
)
3637 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3638 if str(StringH
) != "":
3639 AutoFile
= PathClass(gAutoGenStringFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3640 self
._AutoGenFileList
[AutoFile
] = str(StringH
)
3641 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3642 if UniStringBinBuffer
!= None and UniStringBinBuffer
.getvalue() != "":
3643 AutoFile
= PathClass(gAutoGenStringFormFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3644 self
._AutoGenFileList
[AutoFile
] = UniStringBinBuffer
.getvalue()
3645 AutoFile
.IsBinary
= True
3646 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3647 if UniStringBinBuffer
!= None:
3648 UniStringBinBuffer
.close()
3649 if str(StringIdf
) != "":
3650 AutoFile
= PathClass(gAutoGenImageDefFileName
% {"module_name":self
.Name
}, self
.DebugDir
)
3651 self
._AutoGenFileList
[AutoFile
] = str(StringIdf
)
3652 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3653 if IdfGenBinBuffer
!= None and IdfGenBinBuffer
.getvalue() != "":
3654 AutoFile
= PathClass(gAutoGenIdfFileName
% {"module_name":self
.Name
}, self
.OutputDir
)
3655 self
._AutoGenFileList
[AutoFile
] = IdfGenBinBuffer
.getvalue()
3656 AutoFile
.IsBinary
= True
3657 self
._ApplyBuildRule
(AutoFile
, TAB_UNKNOWN_FILE
)
3658 if IdfGenBinBuffer
!= None:
3659 IdfGenBinBuffer
.close()
3660 return self
._AutoGenFileList
3662 ## Return the list of library modules explicitly or implicityly used by this module
3663 def _GetLibraryList(self
):
3664 if self
._DependentLibraryList
== None:
3665 # only merge library classes and PCD for non-library module
3667 self
._DependentLibraryList
= []
3669 if self
.AutoGenVersion
< 0x00010005:
3670 self
._DependentLibraryList
= self
.PlatformInfo
.ResolveLibraryReference(self
.Module
)
3672 self
._DependentLibraryList
= self
.PlatformInfo
.ApplyLibraryInstance(self
.Module
)
3673 return self
._DependentLibraryList
3676 def UpdateComments(Recver
, Src
):
3678 if Key
not in Recver
:
3680 Recver
[Key
].extend(Src
[Key
])
3681 ## Get the list of PCDs from current module
3683 # @retval list The list of PCD
3685 def _GetModulePcdList(self
):
3686 if self
._ModulePcdList
== None:
3687 # apply PCD settings from platform
3688 self
._ModulePcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, self
.Module
.Pcds
)
3689 self
.UpdateComments(self
._PcdComments
, self
.Module
.PcdComments
)
3690 return self
._ModulePcdList
3692 ## Get the list of PCDs from dependent libraries
3694 # @retval list The list of PCD
3696 def _GetLibraryPcdList(self
):
3697 if self
._LibraryPcdList
== None:
3699 if not self
.IsLibrary
:
3700 # get PCDs from dependent libraries
3701 for Library
in self
.DependentLibraryList
:
3702 self
.UpdateComments(self
._PcdComments
, Library
.PcdComments
)
3703 for Key
in Library
.Pcds
:
3704 # skip duplicated PCDs
3705 if Key
in self
.Module
.Pcds
or Key
in Pcds
:
3707 Pcds
[Key
] = copy
.copy(Library
.Pcds
[Key
])
3708 # apply PCD settings from platform
3709 self
._LibraryPcdList
= self
.PlatformInfo
.ApplyPcdSetting(self
.Module
, Pcds
)
3711 self
._LibraryPcdList
= []
3712 return self
._LibraryPcdList
3714 ## Get the GUID value mapping
3716 # @retval dict The mapping between GUID cname and its value
3718 def _GetGuidList(self
):
3719 if self
._GuidList
== None:
3720 self
._GuidList
= sdict()
3721 self
._GuidList
.update(self
.Module
.Guids
)
3722 for Library
in self
.DependentLibraryList
:
3723 self
._GuidList
.update(Library
.Guids
)
3724 self
.UpdateComments(self
._GuidComments
, Library
.GuidComments
)
3725 self
.UpdateComments(self
._GuidComments
, self
.Module
.GuidComments
)
3726 return self
._GuidList
3728 def GetGuidsUsedByPcd(self
):
3729 if self
._GuidsUsedByPcd
== None:
3730 self
._GuidsUsedByPcd
= sdict()
3731 self
._GuidsUsedByPcd
.update(self
.Module
.GetGuidsUsedByPcd())
3732 for Library
in self
.DependentLibraryList
:
3733 self
._GuidsUsedByPcd
.update(Library
.GetGuidsUsedByPcd())
3734 return self
._GuidsUsedByPcd
3735 ## Get the protocol value mapping
3737 # @retval dict The mapping between protocol cname and its value
3739 def _GetProtocolList(self
):
3740 if self
._ProtocolList
== None:
3741 self
._ProtocolList
= sdict()
3742 self
._ProtocolList
.update(self
.Module
.Protocols
)
3743 for Library
in self
.DependentLibraryList
:
3744 self
._ProtocolList
.update(Library
.Protocols
)
3745 self
.UpdateComments(self
._ProtocolComments
, Library
.ProtocolComments
)
3746 self
.UpdateComments(self
._ProtocolComments
, self
.Module
.ProtocolComments
)
3747 return self
._ProtocolList
3749 ## Get the PPI value mapping
3751 # @retval dict The mapping between PPI cname and its value
3753 def _GetPpiList(self
):
3754 if self
._PpiList
== None:
3755 self
._PpiList
= sdict()
3756 self
._PpiList
.update(self
.Module
.Ppis
)
3757 for Library
in self
.DependentLibraryList
:
3758 self
._PpiList
.update(Library
.Ppis
)
3759 self
.UpdateComments(self
._PpiComments
, Library
.PpiComments
)
3760 self
.UpdateComments(self
._PpiComments
, self
.Module
.PpiComments
)
3761 return self
._PpiList
3763 ## Get the list of include search path
3765 # @retval list The list path
3767 def _GetIncludePathList(self
):
3768 if self
._IncludePathList
== None:
3769 self
._IncludePathList
= []
3770 if self
.AutoGenVersion
< 0x00010005:
3771 for Inc
in self
.Module
.Includes
:
3772 if Inc
not in self
._IncludePathList
:
3773 self
._IncludePathList
.append(Inc
)
3775 Inc
= path
.join(Inc
, self
.Arch
.capitalize())
3776 if os
.path
.exists(Inc
) and Inc
not in self
._IncludePathList
:
3777 self
._IncludePathList
.append(Inc
)
3778 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time
3779 self
._IncludePathList
.append(self
.DebugDir
)
3781 self
._IncludePathList
.append(self
.MetaFile
.Dir
)
3782 self
._IncludePathList
.append(self
.DebugDir
)
3784 for Package
in self
.Module
.Packages
:
3785 PackageDir
= mws
.join(self
.WorkspaceDir
, Package
.MetaFile
.Dir
)
3786 if PackageDir
not in self
._IncludePathList
:
3787 self
._IncludePathList
.append(PackageDir
)
3788 IncludesList
= Package
.Includes
3789 if Package
._PrivateIncludes
:
3790 if not self
.MetaFile
.Path
.startswith(PackageDir
):
3791 IncludesList
= list(set(Package
.Includes
).difference(set(Package
._PrivateIncludes
)))
3792 for Inc
in IncludesList
:
3793 if Inc
not in self
._IncludePathList
:
3794 self
._IncludePathList
.append(str(Inc
))
3795 return self
._IncludePathList
3797 def _GetIncludePathLength(self
):
3798 self
._IncludePathLength
= 0
3799 if self
._IncludePathList
:
3800 for inc
in self
._IncludePathList
:
3801 self
._IncludePathLength
+= len(' ' + inc
)
3802 return self
._IncludePathLength
3804 ## Get HII EX PCDs which maybe used by VFR
3806 # efivarstore used by VFR may relate with HII EX PCDs
3807 # Get the variable name and GUID from efivarstore and HII EX PCD
3808 # List the HII EX PCDs in As Built INF if both name and GUID match.
3810 # @retval list HII EX PCDs
3812 def _GetPcdsMaybeUsedByVfr(self
):
3813 if not self
.SourceFileList
:
3817 for SrcFile
in self
.SourceFileList
:
3818 if SrcFile
.Ext
.lower() != '.vfr':
3820 Vfri
= os
.path
.join(self
.OutputDir
, SrcFile
.BaseName
+ '.i')
3821 if not os
.path
.exists(Vfri
):
3823 VfriFile
= open(Vfri
, 'r')
3824 Content
= VfriFile
.read()
3826 Pos
= Content
.find('efivarstore')
3829 # Make sure 'efivarstore' is the start of efivarstore statement
3830 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'
3833 while Index
>= 0 and Content
[Index
] in ' \t\r\n':
3835 if Index
>= 0 and Content
[Index
] != ';':
3836 Pos
= Content
.find('efivarstore', Pos
+ len('efivarstore'))
3839 # 'efivarstore' must be followed by name and guid
3841 Name
= gEfiVarStoreNamePattern
.search(Content
, Pos
)
3844 Guid
= gEfiVarStoreGuidPattern
.search(Content
, Pos
)
3847 NameArray
= ConvertStringToByteArray('L"' + Name
.group(1) + '"')
3848 NameGuids
.append((NameArray
, GuidStructureStringToGuidString(Guid
.group(1))))
3849 Pos
= Content
.find('efivarstore', Name
.end())
3853 for Pcd
in self
.PlatformInfo
.Platform
.Pcds
.values():
3854 if Pcd
.Type
!= TAB_PCDS_DYNAMIC_EX_HII
:
3856 for SkuName
in Pcd
.SkuInfoList
:
3857 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
3858 Name
= ConvertStringToByteArray(SkuInfo
.VariableName
)
3859 Value
= GuidValue(SkuInfo
.VariableGuid
, self
.PlatformInfo
.PackageList
, self
.MetaFile
.Path
)
3862 Guid
= GuidStructureStringToGuidString(Value
)
3863 if (Name
, Guid
) in NameGuids
and Pcd
not in HiiExPcds
:
3864 HiiExPcds
.append(Pcd
)
3869 def _GenOffsetBin(self
):
3871 for SourceFile
in self
.Module
.Sources
:
3872 if SourceFile
.Type
.upper() == ".VFR" :
3874 # search the .map file to find the offset of vfr binary in the PE32+/TE file.
3876 VfrUniBaseName
[SourceFile
.BaseName
] = (SourceFile
.BaseName
+ "Bin")
3877 if SourceFile
.Type
.upper() == ".UNI" :
3879 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.
3881 VfrUniBaseName
["UniOffsetName"] = (self
.Name
+ "Strings")
3883 if len(VfrUniBaseName
) == 0:
3885 MapFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".map")
3886 EfiFileName
= os
.path
.join(self
.OutputDir
, self
.Name
+ ".efi")
3887 VfrUniOffsetList
= GetVariableOffset(MapFileName
, EfiFileName
, VfrUniBaseName
.values())
3888 if not VfrUniOffsetList
:
3891 OutputName
= '%sOffset.bin' % self
.Name
3892 UniVfrOffsetFileName
= os
.path
.join( self
.OutputDir
, OutputName
)
3895 fInputfile
= open(UniVfrOffsetFileName
, "wb+", 0)
3897 EdkLogger
.error("build", FILE_OPEN_FAILURE
, "File open failed for %s" % UniVfrOffsetFileName
,None)
3899 # Use a instance of StringIO to cache data
3900 fStringIO
= StringIO('')
3902 for Item
in VfrUniOffsetList
:
3903 if (Item
[0].find("Strings") != -1):
3905 # UNI offset in image.
3907 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
3909 UniGuid
= [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]
3910 UniGuid
= [chr(ItemGuid
) for ItemGuid
in UniGuid
]
3911 fStringIO
.write(''.join(UniGuid
))
3912 UniValue
= pack ('Q', int (Item
[1], 16))
3913 fStringIO
.write (UniValue
)
3916 # VFR binary offset in image.
3918 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
3920 VfrGuid
= [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]
3921 VfrGuid
= [chr(ItemGuid
) for ItemGuid
in VfrGuid
]
3922 fStringIO
.write(''.join(VfrGuid
))
3924 VfrValue
= pack ('Q', int (Item
[1], 16))
3925 fStringIO
.write (VfrValue
)
3927 # write data into file.
3930 fInputfile
.write (fStringIO
.getvalue())
3932 EdkLogger
.error("build", FILE_WRITE_FAILURE
, "Write data to file %s failed, please check whether the "
3933 "file been locked or using by other applications." %UniVfrOffsetFileName
,None)
3939 ## Create AsBuilt INF file the module
3941 def CreateAsBuiltInf(self
, IsOnlyCopy
= False):
3942 self
.OutputFile
= []
3944 if GlobalData
.gBinCacheDest
:
3945 self
.CopyModuleToCache()
3948 if self
.IsAsBuiltInfCreated
:
3951 # Skip the following code for EDK I inf
3952 if self
.AutoGenVersion
< 0x00010005:
3955 # Skip the following code for libraries
3959 # Skip the following code for modules with no source files
3960 if self
.SourceFileList
== None or self
.SourceFileList
== []:
3963 # Skip the following code for modules without any binary files
3964 if self
.BinaryFileList
<> None and self
.BinaryFileList
<> []:
3967 ### TODO: How to handles mixed source and binary modules
3969 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries
3970 # Also find all packages that the DynamicEx PCDs depend on
3975 PcdTokenSpaceList
= []
3976 for Pcd
in self
.ModulePcdList
+ self
.LibraryPcdList
:
3977 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
3978 PatchablePcds
+= [Pcd
]
3979 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'PatchableInModule'))
3980 elif Pcd
.Type
in GenC
.gDynamicExPcd
:
3983 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'DynamicEx'))
3984 PcdCheckList
.append((Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
, 'Dynamic'))
3985 PcdTokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
3987 GuidList
.update(self
.GuidList
)
3988 for TokenSpace
in self
.GetGuidsUsedByPcd():
3989 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list
3990 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs
3991 if TokenSpace
not in PcdTokenSpaceList
and TokenSpace
in GuidList
:
3992 GuidList
.pop(TokenSpace
)
3993 CheckList
= (GuidList
, self
.PpiList
, self
.ProtocolList
, PcdCheckList
)
3994 for Package
in self
.DerivedPackageList
:
3995 if Package
in Packages
:
3997 BeChecked
= (Package
.Guids
, Package
.Ppis
, Package
.Protocols
, Package
.Pcds
)
3999 for Index
in range(len(BeChecked
)):
4000 for Item
in CheckList
[Index
]:
4001 if Item
in BeChecked
[Index
]:
4002 Packages
+= [Package
]
4007 VfrPcds
= self
._GetPcdsMaybeUsedByVfr
()
4008 for Pkg
in self
.PlatformInfo
.PackageList
:
4011 for VfrPcd
in VfrPcds
:
4012 if ((VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'DynamicEx') in Pkg
.Pcds
or
4013 (VfrPcd
.TokenCName
, VfrPcd
.TokenSpaceGuidCName
, 'Dynamic') in Pkg
.Pcds
):
4017 ModuleType
= self
.ModuleType
4018 if ModuleType
== 'UEFI_DRIVER' and self
.DepexGenerated
:
4019 ModuleType
= 'DXE_DRIVER'
4022 if self
.PcdIsDriver
!= '':
4023 DriverType
= self
.PcdIsDriver
4026 MDefs
= self
.Module
.Defines
4029 'module_name' : self
.Name
,
4030 'module_guid' : Guid
,
4031 'module_module_type' : ModuleType
,
4032 'module_version_string' : [MDefs
['VERSION_STRING']] if 'VERSION_STRING' in MDefs
else [],
4033 'pcd_is_driver_string' : [],
4034 'module_uefi_specification_version' : [],
4035 'module_pi_specification_version' : [],
4036 'module_entry_point' : self
.Module
.ModuleEntryPointList
,
4037 'module_unload_image' : self
.Module
.ModuleUnloadImageList
,
4038 'module_constructor' : self
.Module
.ConstructorList
,
4039 'module_destructor' : self
.Module
.DestructorList
,
4040 'module_shadow' : [MDefs
['SHADOW']] if 'SHADOW' in MDefs
else [],
4041 'module_pci_vendor_id' : [MDefs
['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs
else [],
4042 'module_pci_device_id' : [MDefs
['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs
else [],
4043 'module_pci_class_code' : [MDefs
['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs
else [],
4044 'module_pci_revision' : [MDefs
['PCI_REVISION']] if 'PCI_REVISION' in MDefs
else [],
4045 'module_build_number' : [MDefs
['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs
else [],
4046 'module_spec' : [MDefs
['SPEC']] if 'SPEC' in MDefs
else [],
4047 'module_uefi_hii_resource_section' : [MDefs
['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs
else [],
4048 'module_uni_file' : [MDefs
['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs
else [],
4049 'module_arch' : self
.Arch
,
4050 'package_item' : ['%s' % (Package
.MetaFile
.File
.replace('\\', '/')) for Package
in Packages
],
4052 'patchablepcd_item' : [],
4054 'protocol_item' : [],
4058 'libraryclasses_item' : []
4061 if 'MODULE_UNI_FILE' in MDefs
:
4062 UNIFile
= os
.path
.join(self
.MetaFile
.Dir
, MDefs
['MODULE_UNI_FILE'])
4063 if os
.path
.isfile(UNIFile
):
4064 shutil
.copy2(UNIFile
, self
.OutputDir
)
4066 if self
.AutoGenVersion
> int(gInfSpecVersion
, 0):
4067 AsBuiltInfDict
['module_inf_version'] = '0x%08x' % self
.AutoGenVersion
4069 AsBuiltInfDict
['module_inf_version'] = gInfSpecVersion
4072 AsBuiltInfDict
['pcd_is_driver_string'] += [DriverType
]
4074 if 'UEFI_SPECIFICATION_VERSION' in self
.Specification
:
4075 AsBuiltInfDict
['module_uefi_specification_version'] += [self
.Specification
['UEFI_SPECIFICATION_VERSION']]
4076 if 'PI_SPECIFICATION_VERSION' in self
.Specification
:
4077 AsBuiltInfDict
['module_pi_specification_version'] += [self
.Specification
['PI_SPECIFICATION_VERSION']]
4079 OutputDir
= self
.OutputDir
.replace('\\', '/').strip('/')
4080 DebugDir
= self
.DebugDir
.replace('\\', '/').strip('/')
4081 for Item
in self
.CodaTargetList
:
4082 File
= Item
.Target
.Path
.replace('\\', '/').strip('/').replace(DebugDir
, '').replace(OutputDir
, '').strip('/')
4083 if File
not in self
.OutputFile
:
4084 self
.OutputFile
.append(File
)
4085 if os
.path
.isabs(File
):
4086 File
= File
.replace('\\', '/').strip('/').replace(OutputDir
, '').strip('/')
4087 if Item
.Target
.Ext
.lower() == '.aml':
4088 AsBuiltInfDict
['binary_item'] += ['ASL|' + File
]
4089 elif Item
.Target
.Ext
.lower() == '.acpi':
4090 AsBuiltInfDict
['binary_item'] += ['ACPI|' + File
]
4091 elif Item
.Target
.Ext
.lower() == '.efi':
4092 AsBuiltInfDict
['binary_item'] += ['PE32|' + self
.Name
+ '.efi']
4094 AsBuiltInfDict
['binary_item'] += ['BIN|' + File
]
4095 if self
.DepexGenerated
:
4096 if self
.Name
+ '.depex' not in self
.OutputFile
:
4097 self
.OutputFile
.append(self
.Name
+ '.depex')
4098 if self
.ModuleType
in ['PEIM']:
4099 AsBuiltInfDict
['binary_item'] += ['PEI_DEPEX|' + self
.Name
+ '.depex']
4100 if self
.ModuleType
in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:
4101 AsBuiltInfDict
['binary_item'] += ['DXE_DEPEX|' + self
.Name
+ '.depex']
4102 if self
.ModuleType
in ['DXE_SMM_DRIVER']:
4103 AsBuiltInfDict
['binary_item'] += ['SMM_DEPEX|' + self
.Name
+ '.depex']
4105 Bin
= self
._GenOffsetBin
()
4107 AsBuiltInfDict
['binary_item'] += ['BIN|%s' % Bin
]
4108 if Bin
not in self
.OutputFile
:
4109 self
.OutputFile
.append(Bin
)
4111 for Root
, Dirs
, Files
in os
.walk(OutputDir
):
4113 if File
.lower().endswith('.pdb'):
4114 AsBuiltInfDict
['binary_item'] += ['DISPOSABLE|' + File
]
4115 if File
not in self
.OutputFile
:
4116 self
.OutputFile
.append(File
)
4117 HeaderComments
= self
.Module
.HeaderComments
4119 for Index
in range(len(HeaderComments
)):
4120 if HeaderComments
[Index
].find('@BinaryHeader') != -1:
4121 HeaderComments
[Index
] = HeaderComments
[Index
].replace('@BinaryHeader', '@file')
4124 AsBuiltInfDict
['header_comments'] = '\n'.join(HeaderComments
[StartPos
:]).replace(':#', '://')
4125 AsBuiltInfDict
['tail_comments'] = '\n'.join(self
.Module
.TailComments
)
4128 (self
.ProtocolList
, self
._ProtocolComments
, 'protocol_item'),
4129 (self
.PpiList
, self
._PpiComments
, 'ppi_item'),
4130 (GuidList
, self
._GuidComments
, 'guid_item')
4132 for Item
in GenList
:
4133 for CName
in Item
[0]:
4135 if CName
in Item
[1]:
4136 Comments
= '\n '.join(Item
[1][CName
])
4139 Entry
= Comments
+ '\n ' + CName
4140 AsBuiltInfDict
[Item
[2]].append(Entry
)
4141 PatchList
= parsePcdInfoFromMapFile(
4142 os
.path
.join(self
.OutputDir
, self
.Name
+ '.map'),
4143 os
.path
.join(self
.OutputDir
, self
.Name
+ '.efi')
4146 for Pcd
in PatchablePcds
:
4147 TokenCName
= Pcd
.TokenCName
4148 for PcdItem
in GlobalData
.MixedPcd
:
4149 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4150 TokenCName
= PcdItem
[0]
4152 for PatchPcd
in PatchList
:
4153 if TokenCName
== PatchPcd
[0]:
4158 if Pcd
.DatumType
== 'BOOLEAN':
4159 BoolValue
= Pcd
.DefaultValue
.upper()
4160 if BoolValue
== 'TRUE':
4161 Pcd
.DefaultValue
= '1'
4162 elif BoolValue
== 'FALSE':
4163 Pcd
.DefaultValue
= '0'
4165 if Pcd
.DatumType
in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:
4166 HexFormat
= '0x%02x'
4167 if Pcd
.DatumType
== 'UINT16':
4168 HexFormat
= '0x%04x'
4169 elif Pcd
.DatumType
== 'UINT32':
4170 HexFormat
= '0x%08x'
4171 elif Pcd
.DatumType
== 'UINT64':
4172 HexFormat
= '0x%016x'
4173 PcdValue
= HexFormat
% int(Pcd
.DefaultValue
, 0)
4175 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
4176 EdkLogger
.error("build", AUTOGEN_ERROR
,
4177 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4179 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
4180 PcdValue
= Pcd
.DefaultValue
4181 if PcdValue
[0] != '{':
4183 if PcdValue
[0] == 'L':
4185 PcdValue
= PcdValue
.lstrip('L')
4186 PcdValue
= eval(PcdValue
)
4188 for Index
in range(0, len(PcdValue
)):
4190 CharVal
= ord(PcdValue
[Index
])
4191 NewValue
= NewValue
+ '0x%02x' % (CharVal
& 0x00FF) + ', ' \
4192 + '0x%02x' % (CharVal
>> 8) + ', '
4194 NewValue
= NewValue
+ '0x%02x' % (ord(PcdValue
[Index
]) % 0x100) + ', '
4197 Padding
= Padding
* 2
4198 ArraySize
= ArraySize
/ 2
4199 if ArraySize
< (len(PcdValue
) + 1):
4200 EdkLogger
.error("build", AUTOGEN_ERROR
,
4201 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4203 if ArraySize
> len(PcdValue
) + 1:
4204 NewValue
= NewValue
+ Padding
* (ArraySize
- len(PcdValue
) - 1)
4205 PcdValue
= NewValue
+ Padding
.strip().rstrip(',') + '}'
4206 elif len(PcdValue
.split(',')) <= ArraySize
:
4207 PcdValue
= PcdValue
.rstrip('}') + ', 0x00' * (ArraySize
- len(PcdValue
.split(',')))
4210 EdkLogger
.error("build", AUTOGEN_ERROR
,
4211 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
)
4213 PcdItem
= '%s.%s|%s|0x%X' % \
4214 (Pcd
.TokenSpaceGuidCName
, TokenCName
, PcdValue
, PatchPcd
[1])
4216 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4217 PcdComments
= '\n '.join(self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
])
4219 PcdItem
= PcdComments
+ '\n ' + PcdItem
4220 AsBuiltInfDict
['patchablepcd_item'].append(PcdItem
)
4223 for Pcd
in Pcds
+ VfrPcds
:
4228 TokenCName
= Pcd
.TokenCName
4229 for PcdItem
in GlobalData
.MixedPcd
:
4230 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
4231 TokenCName
= PcdItem
[0]
4233 if Pcd
.Type
== TAB_PCDS_DYNAMIC_EX_HII
:
4234 for SkuName
in Pcd
.SkuInfoList
:
4235 SkuInfo
= Pcd
.SkuInfoList
[SkuName
]
4236 SkuId
= SkuInfo
.SkuId
4237 HiiInfo
= '## %s|%s|%s' % (SkuInfo
.VariableName
, SkuInfo
.VariableGuid
, SkuInfo
.VariableOffset
)
4241 # Don't generate duplicated HII PCD
4243 if (SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in HiiPcds
:
4246 HiiPcds
.append((SkuId
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
4247 if (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
) in self
._PcdComments
:
4248 PcdCommentList
= self
._PcdComments
[Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
][:]
4252 for Index
, Comment
in enumerate(PcdCommentList
):
4253 for Usage
in UsageList
:
4254 if Comment
.find(Usage
) != -1:
4258 if UsageIndex
!= -1:
4259 PcdCommentList
[UsageIndex
] = '## %s %s %s' % (UsageStr
, HiiInfo
, PcdCommentList
[UsageIndex
].replace(UsageStr
, ''))
4261 PcdCommentList
.append('## UNDEFINED ' + HiiInfo
)
4262 PcdComments
= '\n '.join(PcdCommentList
)
4263 PcdEntry
= Pcd
.TokenSpaceGuidCName
+ '.' + TokenCName
4265 PcdEntry
= PcdComments
+ '\n ' + PcdEntry
4266 AsBuiltInfDict
['pcd_item'] += [PcdEntry
]
4267 for Item
in self
.BuildOption
:
4268 if 'FLAGS' in self
.BuildOption
[Item
]:
4269 AsBuiltInfDict
['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self
.ToolChainFamily
, self
.BuildTarget
, self
.ToolChain
, self
.Arch
, Item
, self
.BuildOption
[Item
]['FLAGS'].strip())]
4271 # Generated LibraryClasses section in comments.
4272 for Library
in self
.LibraryAutoGenList
:
4273 AsBuiltInfDict
['libraryclasses_item'] += [Library
.MetaFile
.File
.replace('\\', '/')]
4275 # Generated UserExtensions TianoCore section.
4276 # All tianocore user extensions are copied.
4278 for TianoCore
in self
._GetTianoCoreUserExtensionList
():
4279 UserExtStr
+= '\n'.join(TianoCore
)
4280 ExtensionFile
= os
.path
.join(self
.MetaFile
.Dir
, TianoCore
[1])
4281 if os
.path
.isfile(ExtensionFile
):
4282 shutil
.copy2(ExtensionFile
, self
.OutputDir
)
4283 AsBuiltInfDict
['userextension_tianocore_item'] = UserExtStr
4285 # Generated depex expression section in comments.
4286 AsBuiltInfDict
['depexsection_item'] = ''
4287 DepexExpresion
= self
._GetDepexExpresionString
()
4289 AsBuiltInfDict
['depexsection_item'] = DepexExpresion
4291 AsBuiltInf
= TemplateString()
4292 AsBuiltInf
.Append(gAsBuiltInfHeaderString
.Replace(AsBuiltInfDict
))
4294 SaveFileOnChange(os
.path
.join(self
.OutputDir
, self
.Name
+ '.inf'), str(AsBuiltInf
), False)
4296 self
.IsAsBuiltInfCreated
= True
4297 if GlobalData
.gBinCacheDest
:
4298 self
.CopyModuleToCache()
4300 def CopyModuleToCache(self
):
4301 FileDir
= path
.join(GlobalData
.gBinCacheDest
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4302 CreateDirectory (FileDir
)
4303 HashFile
= path
.join(self
.BuildDir
, self
.Name
+ '.hash')
4304 ModuleFile
= path
.join(self
.OutputDir
, self
.Name
+ '.inf')
4305 if os
.path
.exists(HashFile
):
4306 shutil
.copy2(HashFile
, FileDir
)
4307 if os
.path
.exists(ModuleFile
):
4308 shutil
.copy2(ModuleFile
, FileDir
)
4309 if not self
.OutputFile
:
4310 Ma
= self
.Workspace
.BuildDatabase
[PathClass(ModuleFile
), self
.Arch
, self
.BuildTarget
, self
.ToolChain
]
4311 self
.OutputFile
= Ma
.Binaries
4313 for File
in self
.OutputFile
:
4315 if not os
.path
.isabs(File
):
4316 File
= os
.path
.join(self
.OutputDir
, File
)
4317 if os
.path
.exists(File
):
4318 shutil
.copy2(File
, FileDir
)
4320 def AttemptModuleCacheCopy(self
):
4321 if self
.IsBinaryModule
:
4323 FileDir
= path
.join(GlobalData
.gBinCacheSource
, self
.Arch
, self
.SourceDir
, self
.MetaFile
.BaseName
)
4324 HashFile
= path
.join(FileDir
, self
.Name
+ '.hash')
4325 if os
.path
.exists(HashFile
):
4326 f
= open(HashFile
, 'r')
4327 CacheHash
= f
.read()
4329 if GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4330 if CacheHash
== GlobalData
.gModuleHash
[self
.Arch
][self
.Name
]:
4331 for root
, dir, files
in os
.walk(FileDir
):
4333 if self
.Name
+ '.hash' in f
:
4334 shutil
.copy2(HashFile
, self
.BuildDir
)
4336 File
= path
.join(root
, f
)
4337 shutil
.copy2(File
, self
.OutputDir
)
4338 if self
.Name
== "PcdPeim" or self
.Name
== "PcdDxe":
4339 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4343 ## Create makefile for the module and its dependent libraries
4345 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of
4346 # dependent libraries will be created
4348 def CreateMakeFile(self
, CreateLibraryMakeFile
=True, GenFfsList
= []):
4349 # Ignore generating makefile when it is a binary module
4350 if self
.IsBinaryModule
:
4353 if self
.IsMakeFileCreated
:
4355 self
.GenFfsList
= GenFfsList
4356 if not self
.IsLibrary
and CreateLibraryMakeFile
:
4357 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4358 LibraryAutoGen
.CreateMakeFile()
4363 if len(self
.CustomMakefile
) == 0:
4364 Makefile
= GenMake
.ModuleMakefile(self
)
4366 Makefile
= GenMake
.CustomMakefile(self
)
4367 if Makefile
.Generate():
4368 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated makefile for module %s [%s]" %
4369 (self
.Name
, self
.Arch
))
4371 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of makefile for module %s [%s]" %
4372 (self
.Name
, self
.Arch
))
4374 self
.CreateTimeStamp(Makefile
)
4375 self
.IsMakeFileCreated
= True
4377 def CopyBinaryFiles(self
):
4378 for File
in self
.Module
.Binaries
:
4380 DstPath
= os
.path
.join(self
.OutputDir
, os
.path
.basename(SrcPath
))
4381 CopyLongFilePath(SrcPath
, DstPath
)
4382 ## Create autogen code for the module and its dependent libraries
4384 # @param CreateLibraryCodeFile Flag indicating if or not the code of
4385 # dependent libraries will be created
4387 def CreateCodeFile(self
, CreateLibraryCodeFile
=True):
4388 if self
.IsCodeFileCreated
:
4391 # Need to generate PcdDatabase even PcdDriver is binarymodule
4392 if self
.IsBinaryModule
and self
.PcdIsDriver
!= '':
4393 CreatePcdDatabaseCode(self
, TemplateString(), TemplateString())
4395 if self
.IsBinaryModule
:
4397 self
.CopyBinaryFiles()
4400 if not self
.IsLibrary
and CreateLibraryCodeFile
:
4401 for LibraryAutoGen
in self
.LibraryAutoGenList
:
4402 LibraryAutoGen
.CreateCodeFile()
4408 IgoredAutoGenList
= []
4410 for File
in self
.AutoGenFileList
:
4411 if GenC
.Generate(File
.Path
, self
.AutoGenFileList
[File
], File
.IsBinary
):
4412 #Ignore Edk AutoGen.c
4413 if self
.AutoGenVersion
< 0x00010005 and File
.Name
== 'AutoGen.c':
4416 AutoGenList
.append(str(File
))
4418 IgoredAutoGenList
.append(str(File
))
4420 # Skip the following code for EDK I inf
4421 if self
.AutoGenVersion
< 0x00010005:
4424 for ModuleType
in self
.DepexList
:
4425 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module
4426 if len(self
.DepexList
[ModuleType
]) == 0 or ModuleType
== "USER_DEFINED":
4429 Dpx
= GenDepex
.DependencyExpression(self
.DepexList
[ModuleType
], ModuleType
, True)
4430 DpxFile
= gAutoGenDepexFileName
% {"module_name" : self
.Name
}
4432 if len(Dpx
.PostfixNotation
) <> 0:
4433 self
.DepexGenerated
= True
4435 if Dpx
.Generate(path
.join(self
.OutputDir
, DpxFile
)):
4436 AutoGenList
.append(str(DpxFile
))
4438 IgoredAutoGenList
.append(str(DpxFile
))
4440 if IgoredAutoGenList
== []:
4441 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] files for module %s [%s]" %
4442 (" ".join(AutoGenList
), self
.Name
, self
.Arch
))
4443 elif AutoGenList
== []:
4444 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Skipped the generation of [%s] files for module %s [%s]" %
4445 (" ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4447 EdkLogger
.debug(EdkLogger
.DEBUG_9
, "Generated [%s] (skipped %s) files for module %s [%s]" %
4448 (" ".join(AutoGenList
), " ".join(IgoredAutoGenList
), self
.Name
, self
.Arch
))
4450 self
.IsCodeFileCreated
= True
4453 ## Summarize the ModuleAutoGen objects of all libraries used by this module
4454 def _GetLibraryAutoGenList(self
):
4455 if self
._LibraryAutoGenList
== None:
4456 self
._LibraryAutoGenList
= []
4457 for Library
in self
.DependentLibraryList
:
4464 self
.PlatformInfo
.MetaFile
4466 if La
not in self
._LibraryAutoGenList
:
4467 self
._LibraryAutoGenList
.append(La
)
4468 for Lib
in La
.CodaTargetList
:
4469 self
._ApplyBuildRule
(Lib
.Target
, TAB_UNKNOWN_FILE
)
4470 return self
._LibraryAutoGenList
4472 def GenModuleHash(self
):
4473 if self
.Arch
not in GlobalData
.gModuleHash
:
4474 GlobalData
.gModuleHash
[self
.Arch
] = {}
4476 # Add Platform level hash
4477 m
.update(GlobalData
.gPlatformHash
)
4478 # Add Package level hash
4479 if self
.DependentPackageList
:
4480 for Pkg
in self
.DependentPackageList
:
4481 if Pkg
.PackageName
in GlobalData
.gPackageHash
[self
.Arch
]:
4482 m
.update(GlobalData
.gPackageHash
[self
.Arch
][Pkg
.PackageName
])
4485 if self
.LibraryAutoGenList
:
4486 for Lib
in self
.LibraryAutoGenList
:
4487 if Lib
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4489 m
.update(GlobalData
.gModuleHash
[self
.Arch
][Lib
.Name
])
4492 f
= open(str(self
.MetaFile
), 'r')
4496 # Add Module's source files
4497 if self
.SourceFileList
:
4498 for File
in self
.SourceFileList
:
4499 f
= open(str(File
), 'r')
4504 ModuleHashFile
= path
.join(self
.BuildDir
, self
.Name
+ ".hash")
4505 if self
.Name
not in GlobalData
.gModuleHash
[self
.Arch
]:
4506 GlobalData
.gModuleHash
[self
.Arch
][self
.Name
] = m
.hexdigest()
4507 if GlobalData
.gBinCacheSource
:
4508 CacheValid
= self
.AttemptModuleCacheCopy()
4511 return SaveFileOnChange(ModuleHashFile
, m
.hexdigest(), True)
4513 ## Decide whether we can skip the ModuleAutoGen process
4514 def CanSkipbyHash(self
):
4515 if GlobalData
.gUseHashCache
:
4516 return not self
.GenModuleHash()
4518 ## Decide whether we can skip the ModuleAutoGen process
4519 # If any source file is newer than the module than we cannot skip
4522 if not os
.path
.exists(self
.GetTimeStampPath()):
4524 #last creation time of the module
4525 DstTimeStamp
= os
.stat(self
.GetTimeStampPath())[8]
4527 SrcTimeStamp
= self
.Workspace
._SrcTimeStamp
4528 if SrcTimeStamp
> DstTimeStamp
:
4531 with
open(self
.GetTimeStampPath(),'r') as f
:
4533 source
= source
.rstrip('\n')
4534 if not os
.path
.exists(source
):
4536 if source
not in ModuleAutoGen
.TimeDict
:
4537 ModuleAutoGen
.TimeDict
[source
] = os
.stat(source
)[8]
4538 if ModuleAutoGen
.TimeDict
[source
] > DstTimeStamp
:
4542 def GetTimeStampPath(self
):
4543 if self
._TimeStampPath
== None:
4544 self
._TimeStampPath
= os
.path
.join(self
.MakeFileDir
, 'AutoGenTimeStamp')
4545 return self
._TimeStampPath
4546 def CreateTimeStamp(self
, Makefile
):
4550 FileSet
.add (self
.MetaFile
.Path
)
4552 for SourceFile
in self
.Module
.Sources
:
4553 FileSet
.add (SourceFile
.Path
)
4555 for Lib
in self
.DependentLibraryList
:
4556 FileSet
.add (Lib
.MetaFile
.Path
)
4558 for f
in self
.AutoGenDepSet
:
4559 FileSet
.add (f
.Path
)
4561 if os
.path
.exists (self
.GetTimeStampPath()):
4562 os
.remove (self
.GetTimeStampPath())
4563 with
open(self
.GetTimeStampPath(), 'w+') as file:
4567 Module
= property(_GetModule
)
4568 Name
= property(_GetBaseName
)
4569 Guid
= property(_GetGuid
)
4570 Version
= property(_GetVersion
)
4571 ModuleType
= property(_GetModuleType
)
4572 ComponentType
= property(_GetComponentType
)
4573 BuildType
= property(_GetBuildType
)
4574 PcdIsDriver
= property(_GetPcdIsDriver
)
4575 AutoGenVersion
= property(_GetAutoGenVersion
)
4576 Macros
= property(_GetMacros
)
4577 Specification
= property(_GetSpecification
)
4579 IsLibrary
= property(_IsLibrary
)
4580 IsBinaryModule
= property(_IsBinaryModule
)
4581 BuildDir
= property(_GetBuildDir
)
4582 OutputDir
= property(_GetOutputDir
)
4583 FfsOutputDir
= property(_GetFfsOutputDir
)
4584 DebugDir
= property(_GetDebugDir
)
4585 MakeFileDir
= property(_GetMakeFileDir
)
4586 CustomMakefile
= property(_GetCustomMakefile
)
4588 IncludePathList
= property(_GetIncludePathList
)
4589 IncludePathLength
= property(_GetIncludePathLength
)
4590 AutoGenFileList
= property(_GetAutoGenFileList
)
4591 UnicodeFileList
= property(_GetUnicodeFileList
)
4592 VfrFileList
= property(_GetVfrFileList
)
4593 SourceFileList
= property(_GetSourceFileList
)
4594 BinaryFileList
= property(_GetBinaryFiles
) # FileType : [File List]
4595 Targets
= property(_GetTargets
)
4596 IntroTargetList
= property(_GetIntroTargetList
)
4597 CodaTargetList
= property(_GetFinalTargetList
)
4598 FileTypes
= property(_GetFileTypes
)
4599 BuildRules
= property(_GetBuildRules
)
4600 IdfFileList
= property(_GetIdfFileList
)
4602 DependentPackageList
= property(_GetDependentPackageList
)
4603 DependentLibraryList
= property(_GetLibraryList
)
4604 LibraryAutoGenList
= property(_GetLibraryAutoGenList
)
4605 DerivedPackageList
= property(_GetDerivedPackageList
)
4607 ModulePcdList
= property(_GetModulePcdList
)
4608 LibraryPcdList
= property(_GetLibraryPcdList
)
4609 GuidList
= property(_GetGuidList
)
4610 ProtocolList
= property(_GetProtocolList
)
4611 PpiList
= property(_GetPpiList
)
4612 DepexList
= property(_GetDepexTokenList
)
4613 DxsFile
= property(_GetDxsFile
)
4614 DepexExpressionList
= property(_GetDepexExpressionTokenList
)
4615 BuildOption
= property(_GetModuleBuildOption
)
4616 BuildOptionIncPathList
= property(_GetBuildOptionIncPathList
)
4617 BuildCommand
= property(_GetBuildCommand
)
4619 FixedAtBuildPcds
= property(_GetFixedAtBuildPcds
)
4621 # This acts like the main() function for the script, unless it is 'import'ed into another script.
4622 if __name__
== '__main__':