]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTool: Filter out unused structure pcds
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
CommitLineData
52302d4d
LG
1## @file\r
2# Generate AutoGen.h, AutoGen.c and *.depex files\r
3#\r
e74cea4c 4# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
3f34e36d
LD
5# Copyright (c) 2018, Hewlett Packard Enterprise Development, L.P.<BR>\r
6#\r
40d841f6 7# This program and the accompanying materials\r
52302d4d
LG
8# are licensed and made available under the terms and conditions of the BSD License\r
9# which accompanies this distribution. The full text of the license may be found at\r
10# http://opensource.org/licenses/bsd-license.php\r
11#\r
12# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14#\r
15\r
16## Import Modules\r
17#\r
1ccc4d89
LG
18from __future__ import print_function\r
19from __future__ import absolute_import\r
1be2ed90 20import Common.LongFilePathOs as os\r
52302d4d
LG
21import re\r
22import os.path as path\r
23import copy\r
867d1cd4 24import uuid\r
52302d4d 25\r
0ff3b52e
GL
26from . import GenC\r
27from . import GenMake\r
28from . import GenDepex\r
86379ac4 29from io import BytesIO\r
52302d4d 30\r
0ff3b52e
GL
31from .StrGather import *\r
32from .BuildEngine import BuildRule\r
52302d4d 33\r
1be2ed90 34from Common.LongFilePathSupport import CopyLongFilePath\r
52302d4d
LG
35from Common.BuildToolError import *\r
36from Common.DataType import *\r
37from Common.Misc import *\r
5a57246e 38from Common.StringUtils import *\r
52302d4d
LG
39import Common.GlobalData as GlobalData\r
40from GenFds.FdfParser import *\r
41from CommonDataClass.CommonClass import SkuInfoClass\r
e8a47801 42from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile\r
e56468c0 43import Common.VpdInfoFile as VpdInfoFile\r
0ff3b52e 44from .GenPcdDb import CreatePcdDatabaseCode\r
e8a47801 45from Workspace.MetaFileCommentParser import UsageList\r
c14b5861 46from Workspace.WorkspaceCommon import GetModuleLibInstances\r
05cc51ad 47from Common.MultipleWorkspace import MultipleWorkspace as mws\r
0ff3b52e 48from . import InfSectionParser\r
c17956e0 49import datetime\r
36d083ef 50import hashlib\r
0ff3b52e 51from .GenVar import VariableMgr, var_info\r
9006a2c6 52from collections import OrderedDict\r
a993dc03 53from collections import defaultdict\r
caf74495 54from Workspace.WorkspaceCommon import OrderedListDict\r
97fa0ee9 55\r
830bf22f 56from Common.caching import cached_property, cached_class_function\r
b23414f6 57\r
e8a47801 58## Regular expression for splitting Dependency Expression string into tokens\r
52302d4d
LG
59gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")\r
60\r
c8802c3d
CJ
61## Regular expression for match: PCD(xxxx.yyy)\r
62gPCDAsGuidPattern = re.compile(r"^PCD\(.+\..+\)$")\r
63\r
64#\r
65# Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
66# is the former use /I , the Latter used -I to specify include directories\r
67#\r
68gBuildOptIncludePatternMsft = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
69gBuildOptIncludePatternOther = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
70\r
97fa0ee9
YL
71#\r
72# Match name = variable\r
73#\r
74gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")\r
75#\r
76# The format of guid in efivarstore statement likes following and must be correct:\r
77# guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}\r
78#\r
79gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")\r
80\r
52302d4d 81## Mapping Makefile type\r
94c04559 82gMakeTypeMap = {TAB_COMPILER_MSFT:"nmake", "GCC":"gmake"}\r
52302d4d
LG
83\r
84\r
85## Build rule configuration file\r
51de5c30 86gDefaultBuildRuleFile = 'build_rule.txt'\r
52302d4d 87\r
86601b78 88## Tools definition configuration file\r
51de5c30 89gDefaultToolsDefFile = 'tools_def.txt'\r
86601b78 90\r
64b2609f
LG
91## Build rule default version\r
92AutoGenReqBuildRuleVerNum = "0.1"\r
93\r
52302d4d
LG
94## default file name for AutoGen\r
95gAutoGenCodeFileName = "AutoGen.c"\r
96gAutoGenHeaderFileName = "AutoGen.h"\r
97gAutoGenStringFileName = "%(module_name)sStrDefs.h"\r
98gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"\r
99gAutoGenDepexFileName = "%(module_name)s.depex"\r
333ba578
YZ
100gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"\r
101gAutoGenIdfFileName = "%(module_name)sIdf.hpk"\r
97fa0ee9
YL
102gInfSpecVersion = "0x00010017"\r
103\r
da92f276
LG
104#\r
105# Template string to generic AsBuilt INF\r
106#\r
e8a47801 107gAsBuiltInfHeaderString = TemplateString("""${header_comments}\r
da92f276 108\r
97fa0ee9
YL
109# DO NOT EDIT\r
110# FILE auto-generated\r
111\r
da92f276 112[Defines]\r
97fa0ee9 113 INF_VERSION = ${module_inf_version}\r
da92f276
LG
114 BASE_NAME = ${module_name}\r
115 FILE_GUID = ${module_guid}\r
97fa0ee9
YL
116 MODULE_TYPE = ${module_module_type}${BEGIN}\r
117 VERSION_STRING = ${module_version_string}${END}${BEGIN}\r
e8a47801 118 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}\r
da92f276 119 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}\r
97fa0ee9
YL
120 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}\r
121 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}\r
122 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}\r
123 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}\r
124 DESTRUCTOR = ${module_destructor}${END}${BEGIN}\r
125 SHADOW = ${module_shadow}${END}${BEGIN}\r
126 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}\r
127 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}\r
128 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}\r
129 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}\r
130 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}\r
131 SPEC = ${module_spec}${END}${BEGIN}\r
132 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}\r
133 MODULE_UNI_FILE = ${module_uni_file}${END}\r
134\r
135[Packages.${module_arch}]${BEGIN}\r
da92f276
LG
136 ${package_item}${END}\r
137\r
138[Binaries.${module_arch}]${BEGIN}\r
139 ${binary_item}${END}\r
140\r
e8a47801
LG
141[PatchPcd.${module_arch}]${BEGIN}\r
142 ${patchablepcd_item}\r
143${END}\r
97fa0ee9 144\r
e8a47801
LG
145[Protocols.${module_arch}]${BEGIN}\r
146 ${protocol_item}\r
147${END}\r
97fa0ee9 148\r
e8a47801
LG
149[Ppis.${module_arch}]${BEGIN}\r
150 ${ppi_item}\r
151${END}\r
97fa0ee9 152\r
e8a47801
LG
153[Guids.${module_arch}]${BEGIN}\r
154 ${guid_item}\r
155${END}\r
97fa0ee9 156\r
e8a47801
LG
157[PcdEx.${module_arch}]${BEGIN}\r
158 ${pcd_item}\r
159${END}\r
da92f276 160\r
97fa0ee9
YL
161[LibraryClasses.${module_arch}]\r
162## @LIB_INSTANCES${BEGIN}\r
163# ${libraryclasses_item}${END}\r
164\r
165${depexsection_item}\r
166\r
dfa41b4a
YZ
167${userextension_tianocore_item}\r
168\r
97fa0ee9
YL
169${tail_comments}\r
170\r
171[BuildOptions.${module_arch}]\r
da92f276
LG
172## @AsBuilt${BEGIN}\r
173## ${flags_item}${END}\r
174""")\r
175\r
52302d4d
LG
176## Base class for AutoGen\r
177#\r
178# This class just implements the cache mechanism of AutoGen objects.\r
179#\r
180class AutoGen(object):\r
b24e99f7
CJ
181 # database to maintain the objects in each child class\r
182 __ObjectCache = {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object\r
52302d4d
LG
183\r
184 ## Factory method\r
185 #\r
186 # @param Class class object of real AutoGen class\r
187 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)\r
188 # @param Workspace Workspace directory or WorkspaceAutoGen object\r
189 # @param MetaFile The path of meta file\r
190 # @param Target Build target\r
191 # @param Toolchain Tool chain name\r
192 # @param Arch Target arch\r
193 # @param *args The specific class related parameters\r
194 # @param **kwargs The specific class related dict parameters\r
195 #\r
b24e99f7 196 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
52302d4d 197 # check if the object has been created\r
b24e99f7 198 Key = (Target, Toolchain, Arch, MetaFile)\r
b23414f6 199 if Key in cls.__ObjectCache:\r
b24e99f7
CJ
200 # if it exists, just return it directly\r
201 return cls.__ObjectCache[Key]\r
b24e99f7 202 # it didnt exist. create it, cache it, then return it\r
1ccc4d89 203 RetVal = cls.__ObjectCache[Key] = super(AutoGen, cls).__new__(cls)\r
b23414f6 204 return RetVal\r
b24e99f7
CJ
205\r
206 def __init__ (self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
1ccc4d89 207 super(AutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
52302d4d
LG
208\r
209 ## hash() operator\r
210 #\r
211 # The file path of platform file will be used to represent hash value of this object\r
212 #\r
213 # @retval int Hash value of the file path of platform file\r
214 #\r
215 def __hash__(self):\r
216 return hash(self.MetaFile)\r
217\r
218 ## str() operator\r
219 #\r
220 # The file path of platform file will be used to represent this object\r
221 #\r
222 # @retval string String of platform file path\r
223 #\r
224 def __str__(self):\r
225 return str(self.MetaFile)\r
226\r
227 ## "==" operator\r
228 def __eq__(self, Other):\r
229 return Other and self.MetaFile == Other\r
230\r
231## Workspace AutoGen class\r
232#\r
233# This class is used mainly to control the whole platform build for different\r
234# architecture. This class will generate top level makefile.\r
235#\r
236class WorkspaceAutoGen(AutoGen):\r
b24e99f7
CJ
237 # call super().__init__ then call the worker function with different parameter count\r
238 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b23414f6 239 if not hasattr(self, "_Init"):\r
1ccc4d89 240 super(WorkspaceAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
b24e99f7
CJ
241 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
242 self._Init = True\r
f7496d71 243\r
b24e99f7 244 ## Initialize WorkspaceAutoGen\r
52302d4d
LG
245 #\r
246 # @param WorkspaceDir Root directory of workspace\r
247 # @param ActivePlatform Meta-file of active platform\r
248 # @param Target Build target\r
249 # @param Toolchain Tool chain name\r
250 # @param ArchList List of architecture of current build\r
251 # @param MetaFileDb Database containing meta-files\r
252 # @param BuildConfig Configuration of build\r
253 # @param ToolDefinition Tool chain definitions\r
254 # @param FlashDefinitionFile File of flash definition\r
255 # @param Fds FD list to be generated\r
256 # @param Fvs FV list to be generated\r
4234283c 257 # @param Caps Capsule list to be generated\r
52302d4d
LG
258 # @param SkuId SKU id from command line\r
259 #\r
b24e99f7 260 def _InitWorker(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,\r
47fea6af 261 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,\r
9508d0fa 262 Progress=None, BuildModule=None):\r
0d2711a6
LG
263 self.BuildDatabase = MetaFileDb\r
264 self.MetaFile = ActivePlatform\r
52302d4d 265 self.WorkspaceDir = WorkspaceDir\r
6b1f2cf4 266 self.Platform = self.BuildDatabase[self.MetaFile, TAB_ARCH_COMMON, Target, Toolchain]\r
d0acc87a 267 GlobalData.gActivePlatform = self.Platform\r
52302d4d
LG
268 self.BuildTarget = Target\r
269 self.ToolChain = Toolchain\r
270 self.ArchList = ArchList\r
271 self.SkuId = SkuId\r
f3decdc3 272 self.UniFlag = UniFlag\r
52302d4d 273\r
52302d4d
LG
274 self.TargetTxt = BuildConfig\r
275 self.ToolDef = ToolDefinition\r
276 self.FdfFile = FlashDefinitionFile\r
066c7154
CJ
277 self.FdTargetList = Fds if Fds else []\r
278 self.FvTargetList = Fvs if Fvs else []\r
279 self.CapTargetList = Caps if Caps else []\r
52302d4d 280 self.AutoGenObjectList = []\r
726c501c 281 self._GuidDict = {}\r
52302d4d
LG
282\r
283 # there's many relative directory operations, so ...\r
284 os.chdir(self.WorkspaceDir)\r
285\r
0d2711a6
LG
286 #\r
287 # Merge Arch\r
288 #\r
289 if not self.ArchList:\r
290 ArchList = set(self.Platform.SupArchList)\r
291 else:\r
292 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)\r
293 if not ArchList:\r
294 EdkLogger.error("build", PARAMETER_INVALID,\r
295 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))\r
296 elif self.ArchList and len(ArchList) != len(self.ArchList):\r
297 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))\r
298 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"\r
299 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))\r
1ccc4d89 300 self.ArchList = tuple(ArchList)\r
0d2711a6
LG
301\r
302 # Validate build target\r
303 if self.BuildTarget not in self.Platform.BuildTargets:\r
47fea6af 304 EdkLogger.error("build", PARAMETER_INVALID,\r
0d2711a6
LG
305 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"\r
306 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))\r
307\r
f7496d71 308\r
52302d4d 309 # parse FDF file to get PCDs in it, if any\r
0d2711a6
LG
310 if not self.FdfFile:\r
311 self.FdfFile = self.Platform.FlashDefinition\r
47fea6af 312\r
9508d0fa
LG
313 EdkLogger.info("")\r
314 if self.ArchList:\r
315 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))\r
316 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))\r
47fea6af
YZ
317 EdkLogger.info('%-16s = %s' % ("Toolchain", self.ToolChain))\r
318\r
9508d0fa
LG
319 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))\r
320 if BuildModule:\r
321 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))\r
47fea6af 322\r
9508d0fa
LG
323 if self.FdfFile:\r
324 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))\r
0d2711a6 325\r
9508d0fa 326 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)\r
47fea6af 327\r
e74cea4c
YZ
328 if Progress:\r
329 Progress.Start("\nProcessing meta-data")\r
47fea6af 330\r
0d2711a6 331 if self.FdfFile:\r
df692f02
LG
332 #\r
333 # Mark now build in AutoGen Phase\r
334 #\r
47fea6af 335 GlobalData.gAutoGenPhase = True\r
52302d4d
LG
336 Fdf = FdfParser(self.FdfFile.Path)\r
337 Fdf.ParseFile()\r
a0a2cd1e 338 GlobalData.gFdfParser = Fdf\r
0d2711a6 339 GlobalData.gAutoGenPhase = False\r
52302d4d 340 PcdSet = Fdf.Profile.PcdDict\r
cb04330e
YZ
341 if Fdf.CurrentFdName and Fdf.CurrentFdName in Fdf.Profile.FdDict:\r
342 FdDict = Fdf.Profile.FdDict[Fdf.CurrentFdName]\r
343 for FdRegion in FdDict.RegionList:\r
344 if str(FdRegion.RegionType) is 'FILE' and self.Platform.VpdToolGuid in str(FdRegion.RegionDataList):\r
345 if int(FdRegion.Offset) % 8 != 0:\r
346 EdkLogger.error("build", FORMAT_INVALID, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion.Offset))\r
52302d4d
LG
347 ModuleList = Fdf.Profile.InfList\r
348 self.FdfProfile = Fdf.Profile\r
0d2711a6
LG
349 for fvname in self.FvTargetList:\r
350 if fvname.upper() not in self.FdfProfile.FvDict:\r
351 EdkLogger.error("build", OPTION_VALUE_INVALID,\r
352 "No such an FV in FDF file: %s" % fvname)\r
2502b735 353\r
622b1758
YZ
354 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,\r
355 # but the path (self.MetaFile.Path) is the real path\r
2502b735
YZ
356 for key in self.FdfProfile.InfDict:\r
357 if key == 'ArchTBD':\r
992fbe35 358 MetaFile_cache = defaultdict(set)\r
2502b735 359 for Arch in self.ArchList:\r
1530ceda 360 Current_Platform_cache = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
1530ceda
CJ
361 for Pkey in Current_Platform_cache.Modules:\r
362 MetaFile_cache[Arch].add(Current_Platform_cache.Modules[Pkey].MetaFile)\r
2502b735
YZ
363 for Inf in self.FdfProfile.InfDict[key]:\r
364 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
365 for Arch in self.ArchList:\r
622b1758 366 if ModuleFile in MetaFile_cache[Arch]:\r
2502b735
YZ
367 break\r
368 else:\r
369 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
370 if not ModuleData.IsBinaryModule:\r
371 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
372\r
373 else:\r
374 for Arch in self.ArchList:\r
375 if Arch == key:\r
376 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
b74b419a
CJ
377 MetaFileList = set()\r
378 for Pkey in Platform.Modules:\r
379 MetaFileList.add(Platform.Modules[Pkey].MetaFile)\r
2502b735
YZ
380 for Inf in self.FdfProfile.InfDict[key]:\r
381 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
622b1758 382 if ModuleFile in MetaFileList:\r
2502b735
YZ
383 continue\r
384 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
385 if not ModuleData.IsBinaryModule:\r
386 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
387\r
52302d4d
LG
388 else:\r
389 PcdSet = {}\r
390 ModuleList = []\r
391 self.FdfProfile = None\r
0d2711a6
LG
392 if self.FdTargetList:\r
393 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))\r
394 self.FdTargetList = []\r
395 if self.FvTargetList:\r
396 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))\r
397 self.FvTargetList = []\r
398 if self.CapTargetList:\r
399 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))\r
400 self.CapTargetList = []\r
47fea6af 401\r
52302d4d
LG
402 # apply SKU and inject PCDs from Flash Definition file\r
403 for Arch in self.ArchList:\r
0d2711a6 404 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
f9fa014e
YZ
405 PlatformPcds = Platform.Pcds\r
406 self._GuidDict = Platform._GuidDict\r
6b1f2cf4
CJ
407 SourcePcdDict = {TAB_PCDS_DYNAMIC_EX:set(), TAB_PCDS_PATCHABLE_IN_MODULE:set(),TAB_PCDS_DYNAMIC:set(),TAB_PCDS_FIXED_AT_BUILD:set()}\r
408 BinaryPcdDict = {TAB_PCDS_DYNAMIC_EX:set(), TAB_PCDS_PATCHABLE_IN_MODULE:set()}\r
2a29017e
YZ
409 SourcePcdDict_Keys = SourcePcdDict.keys()\r
410 BinaryPcdDict_Keys = BinaryPcdDict.keys()\r
411\r
412 # generate the SourcePcdDict and BinaryPcdDict\r
6f49996c 413 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
2a29017e
YZ
414 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
415 if BuildData.Arch != Arch:\r
416 continue\r
417 if BuildData.MetaFile.Ext == '.inf':\r
418 for key in BuildData.Pcds:\r
419 if BuildData.Pcds[key].Pending:\r
420 if key in Platform.Pcds:\r
421 PcdInPlatform = Platform.Pcds[key]\r
c93356ad 422 if PcdInPlatform.Type:\r
2a29017e 423 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
74f59e92 424 BuildData.Pcds[key].Pending = False\r
2a29017e
YZ
425\r
426 if BuildData.MetaFile in Platform.Modules:\r
427 PlatformModule = Platform.Modules[str(BuildData.MetaFile)]\r
428 if key in PlatformModule.Pcds:\r
429 PcdInPlatform = PlatformModule.Pcds[key]\r
c93356ad 430 if PcdInPlatform.Type:\r
2a29017e 431 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
74f59e92 432 BuildData.Pcds[key].Pending = False\r
5a444dfd
YF
433 else:\r
434 #Pcd used in Library, Pcd Type from reference module if Pcd Type is Pending\r
435 if BuildData.Pcds[key].Pending:\r
436 MGen = ModuleAutoGen(self, BuildData.MetaFile, Target, Toolchain, Arch, self.MetaFile)\r
437 if MGen and MGen.IsLibrary:\r
438 if MGen in PGen.LibraryAutoGenList:\r
b23414f6 439 ReferenceModules = MGen.ReferenceModules\r
5a444dfd
YF
440 for ReferenceModule in ReferenceModules:\r
441 if ReferenceModule.MetaFile in Platform.Modules:\r
442 RefPlatformModule = Platform.Modules[str(ReferenceModule.MetaFile)]\r
443 if key in RefPlatformModule.Pcds:\r
444 PcdInReferenceModule = RefPlatformModule.Pcds[key]\r
445 if PcdInReferenceModule.Type:\r
446 BuildData.Pcds[key].Type = PcdInReferenceModule.Type\r
447 BuildData.Pcds[key].Pending = False\r
448 break\r
2a29017e 449\r
6b1f2cf4 450 if TAB_PCDS_DYNAMIC_EX in BuildData.Pcds[key].Type:\r
2a29017e 451 if BuildData.IsBinaryModule:\r
6b1f2cf4 452 BinaryPcdDict[TAB_PCDS_DYNAMIC_EX].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 453 else:\r
6b1f2cf4 454 SourcePcdDict[TAB_PCDS_DYNAMIC_EX].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 455\r
6b1f2cf4 456 elif TAB_PCDS_PATCHABLE_IN_MODULE in BuildData.Pcds[key].Type:\r
2a29017e
YZ
457 if BuildData.MetaFile.Ext == '.inf':\r
458 if BuildData.IsBinaryModule:\r
6b1f2cf4 459 BinaryPcdDict[TAB_PCDS_PATCHABLE_IN_MODULE].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 460 else:\r
6b1f2cf4 461 SourcePcdDict[TAB_PCDS_PATCHABLE_IN_MODULE].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 462\r
6b1f2cf4
CJ
463 elif TAB_PCDS_DYNAMIC in BuildData.Pcds[key].Type:\r
464 SourcePcdDict[TAB_PCDS_DYNAMIC].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
465 elif TAB_PCDS_FIXED_AT_BUILD in BuildData.Pcds[key].Type:\r
466 SourcePcdDict[TAB_PCDS_FIXED_AT_BUILD].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e
YZ
467 else:\r
468 pass\r
97cdb33b
YZ
469 #\r
470 # A PCD can only use one type for all source modules\r
471 #\r
472 for i in SourcePcdDict_Keys:\r
473 for j in SourcePcdDict_Keys:\r
474 if i != j:\r
ff5635e9
CJ
475 Intersections = SourcePcdDict[i].intersection(SourcePcdDict[j])\r
476 if len(Intersections) > 0:\r
97cdb33b
YZ
477 EdkLogger.error(\r
478 'build',\r
479 FORMAT_INVALID,\r
480 "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),\r
caf74495 481 ExtraData='\n\t'.join(str(P[1]+'.'+P[0]) for P in Intersections)\r
97cdb33b 482 )\r
2a29017e
YZ
483\r
484 #\r
485 # intersection the BinaryPCD for Mixed PCD\r
486 #\r
487 for i in BinaryPcdDict_Keys:\r
488 for j in BinaryPcdDict_Keys:\r
489 if i != j:\r
ff5635e9
CJ
490 Intersections = BinaryPcdDict[i].intersection(BinaryPcdDict[j])\r
491 for item in Intersections:\r
2a29017e
YZ
492 NewPcd1 = (item[0] + '_' + i, item[1])\r
493 NewPcd2 = (item[0] + '_' + j, item[1])\r
494 if item not in GlobalData.MixedPcd:\r
495 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
496 else:\r
497 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
498 GlobalData.MixedPcd[item].append(NewPcd1)\r
499 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
500 GlobalData.MixedPcd[item].append(NewPcd2)\r
2a29017e
YZ
501\r
502 #\r
503 # intersection the SourcePCD and BinaryPCD for Mixed PCD\r
504 #\r
505 for i in SourcePcdDict_Keys:\r
506 for j in BinaryPcdDict_Keys:\r
507 if i != j:\r
ff5635e9
CJ
508 Intersections = SourcePcdDict[i].intersection(BinaryPcdDict[j])\r
509 for item in Intersections:\r
2a29017e
YZ
510 NewPcd1 = (item[0] + '_' + i, item[1])\r
511 NewPcd2 = (item[0] + '_' + j, item[1])\r
512 if item not in GlobalData.MixedPcd:\r
513 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
514 else:\r
515 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
516 GlobalData.MixedPcd[item].append(NewPcd1)\r
517 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
518 GlobalData.MixedPcd[item].append(NewPcd2)\r
2a29017e
YZ
519\r
520 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
521 if BuildData.Arch != Arch:\r
522 continue\r
1ccc4d89 523 for key in BuildData.Pcds:\r
2a29017e
YZ
524 for SinglePcd in GlobalData.MixedPcd:\r
525 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
526 for item in GlobalData.MixedPcd[SinglePcd]:\r
527 Pcd_Type = item[0].split('_')[-1]\r
eece4292
CJ
528 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in PCD_DYNAMIC_EX_TYPE_SET) or \\r
529 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in PCD_DYNAMIC_TYPE_SET):\r
2a29017e
YZ
530 Value = BuildData.Pcds[key]\r
531 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type\r
532 if len(key) == 2:\r
533 newkey = (Value.TokenCName, key[1])\r
534 elif len(key) == 3:\r
535 newkey = (Value.TokenCName, key[1], key[2])\r
536 del BuildData.Pcds[key]\r
537 BuildData.Pcds[newkey] = Value\r
538 break\r
2a29017e 539 break\r
2a29017e
YZ
540\r
541 # handle the mixed pcd in FDF file\r
542 for key in PcdSet:\r
543 if key in GlobalData.MixedPcd:\r
544 Value = PcdSet[key]\r
545 del PcdSet[key]\r
546 for item in GlobalData.MixedPcd[key]:\r
547 PcdSet[item] = Value\r
548\r
97fa0ee9 549 #Collect package set information from INF of FDF\r
a0a2cd1e
FB
550 PkgSet = set()\r
551 for Inf in ModuleList:\r
552 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
553 if ModuleFile in Platform.Modules:\r
554 continue\r
555 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
556 PkgSet.update(ModuleData.Packages)\r
557 Pkgs = list(PkgSet) + list(PGen.PackageList)\r
6b26dd71 558 DecPcds = set()\r
6f49996c 559 DecPcdsKey = set()\r
64b2609f 560 for Pkg in Pkgs:\r
25918452 561 for Pcd in Pkg.Pcds:\r
6b26dd71 562 DecPcds.add((Pcd[0], Pcd[1]))\r
4afd3d04 563 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))\r
64b2609f 564\r
52302d4d 565 Platform.SkuName = self.SkuId\r
543f5ac3 566 for Name, Guid,Fileds in PcdSet:\r
64b2609f
LG
567 if (Name, Guid) not in DecPcds:\r
568 EdkLogger.error(\r
569 'build',\r
570 PARSER_ERROR,\r
571 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),\r
eb99b52f
YZ
572 File = self.FdfProfile.PcdFileLineDict[Name, Guid, Fileds][0],\r
573 Line = self.FdfProfile.PcdFileLineDict[Name, Guid, Fileds][1]\r
64b2609f 574 )\r
4afd3d04
LG
575 else:\r
576 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.\r
577 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \\r
578 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \\r
579 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:\r
4afd3d04
LG
580 continue\r
581 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:\r
582 EdkLogger.error(\r
583 'build',\r
584 PARSER_ERROR,\r
585 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),\r
eb99b52f
YZ
586 File = self.FdfProfile.PcdFileLineDict[Name, Guid, Fileds][0],\r
587 Line = self.FdfProfile.PcdFileLineDict[Name, Guid, Fileds][1]\r
4afd3d04 588 )\r
52302d4d
LG
589\r
590 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
591 #\r
592 # Explicitly collect platform's dynamic PCDs\r
593 #\r
594 Pa.CollectPlatformDynamicPcds()\r
2bc3256c 595 Pa.CollectFixedAtBuildPcds()\r
52302d4d 596 self.AutoGenObjectList.append(Pa)\r
47fea6af 597\r
36d083ef
YZ
598 #\r
599 # Generate Package level hash value\r
600 #\r
601 GlobalData.gPackageHash[Arch] = {}\r
602 if GlobalData.gUseHashCache:\r
603 for Pkg in Pkgs:\r
604 self._GenPkgLevelHash(Pkg)\r
605\r
6780eef1
LG
606 #\r
607 # Check PCDs token value conflict in each DEC file.\r
608 #\r
609 self._CheckAllPcdsTokenValueConflict()\r
47fea6af 610\r
4234283c
LG
611 #\r
612 # Check PCD type and definition between DSC and DEC\r
613 #\r
614 self._CheckPcdDefineAndType()\r
97fa0ee9 615\r
c17956e0 616 #\r
2d499388 617 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.\r
c17956e0
DL
618 #\r
619 content = 'gCommandLineDefines: '\r
620 content += str(GlobalData.gCommandLineDefines)\r
1ccc4d89 621 content += os.linesep\r
c17956e0
DL
622 content += 'BuildOptionPcd: '\r
623 content += str(GlobalData.BuildOptionPcd)\r
1ccc4d89 624 content += os.linesep\r
2d499388
YZ
625 content += 'Active Platform: '\r
626 content += str(self.Platform)\r
1ccc4d89 627 content += os.linesep\r
2d499388
YZ
628 if self.FdfFile:\r
629 content += 'Flash Image Definition: '\r
630 content += str(self.FdfFile)\r
1ccc4d89 631 content += os.linesep\r
c17956e0
DL
632 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)\r
633\r
99adfe9f
YZ
634 #\r
635 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.\r
636 #\r
637 PcdTokenNumber = 'PcdTokenNumber: '\r
638 if Pa.PcdTokenNumber:\r
639 if Pa.DynamicPcdList:\r
640 for Pcd in Pa.DynamicPcdList:\r
1ccc4d89 641 PcdTokenNumber += os.linesep\r
99adfe9f
YZ
642 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))\r
643 PcdTokenNumber += ' : '\r
644 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])\r
645 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)\r
646\r
c17956e0
DL
647 #\r
648 # Get set of workspace metafiles\r
649 #\r
650 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)\r
651\r
652 #\r
653 # Retrieve latest modified time of all metafiles\r
654 #\r
655 SrcTimeStamp = 0\r
656 for f in AllWorkSpaceMetaFiles:\r
657 if os.stat(f)[8] > SrcTimeStamp:\r
658 SrcTimeStamp = os.stat(f)[8]\r
659 self._SrcTimeStamp = SrcTimeStamp\r
660\r
36d083ef
YZ
661 if GlobalData.gUseHashCache:\r
662 m = hashlib.md5()\r
663 for files in AllWorkSpaceMetaFiles:\r
664 if files.endswith('.dec'):\r
665 continue\r
1ccc4d89 666 f = open(files, 'r')\r
36d083ef
YZ
667 Content = f.read()\r
668 f.close()\r
669 m.update(Content)\r
670 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)\r
671 GlobalData.gPlatformHash = m.hexdigest()\r
672\r
c17956e0
DL
673 #\r
674 # Write metafile list to build directory\r
675 #\r
676 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')\r
677 if os.path.exists (AutoGenFilePath):\r
678 os.remove(AutoGenFilePath)\r
679 if not os.path.exists(self.BuildDir):\r
680 os.makedirs(self.BuildDir)\r
681 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:\r
1ccc4d89 682 for f in AllWorkSpaceMetaFiles:\r
72443dd2 683 print(f, file=file)\r
52302d4d
LG
684 return True\r
685\r
36d083ef 686 def _GenPkgLevelHash(self, Pkg):\r
3f34e36d
LD
687 if Pkg.PackageName in GlobalData.gPackageHash[Pkg.Arch]:\r
688 return\r
689\r
36d083ef
YZ
690 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)\r
691 CreateDirectory(PkgDir)\r
692 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')\r
693 m = hashlib.md5()\r
694 # Get .dec file's hash value\r
1ccc4d89 695 f = open(Pkg.MetaFile.Path, 'r')\r
36d083ef
YZ
696 Content = f.read()\r
697 f.close()\r
698 m.update(Content)\r
699 # Get include files hash value\r
700 if Pkg.Includes:\r
3f34e36d 701 for inc in sorted(Pkg.Includes, key=lambda x: str(x)):\r
36d083ef 702 for Root, Dirs, Files in os.walk(str(inc)):\r
3f34e36d 703 for File in sorted(Files):\r
36d083ef 704 File_Path = os.path.join(Root, File)\r
1ccc4d89 705 f = open(File_Path, 'r')\r
36d083ef
YZ
706 Content = f.read()\r
707 f.close()\r
708 m.update(Content)\r
709 SaveFileOnChange(HashFile, m.hexdigest(), True)\r
3f34e36d 710 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()\r
763e8edf 711\r
c17956e0
DL
712 def _GetMetaFiles(self, Target, Toolchain, Arch):\r
713 AllWorkSpaceMetaFiles = set()\r
714 #\r
715 # add fdf\r
716 #\r
717 if self.FdfFile:\r
718 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)\r
caf74495
JC
719 for f in GlobalData.gFdfParser.GetAllIncludedFile():\r
720 AllWorkSpaceMetaFiles.add (f.FileName)\r
c17956e0
DL
721 #\r
722 # add dsc\r
723 #\r
724 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)\r
725\r
726 #\r
86601b78
DL
727 # add build_rule.txt & tools_def.txt\r
728 #\r
51de5c30
YZ
729 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))\r
730 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))\r
86601b78 731\r
c17956e0
DL
732 # add BuildOption metafile\r
733 #\r
734 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))\r
735\r
99adfe9f
YZ
736 # add PcdToken Number file for Dynamic/DynamicEx Pcd\r
737 #\r
738 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))\r
739\r
c17956e0 740 for Arch in self.ArchList:\r
c17956e0
DL
741 #\r
742 # add dec\r
743 #\r
caf74495 744 for Package in PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch).PackageList:\r
c17956e0
DL
745 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)\r
746\r
747 #\r
748 # add included dsc\r
749 #\r
caf74495 750 for filePath in self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]._RawData.IncludedFiles:\r
c17956e0
DL
751 AllWorkSpaceMetaFiles.add(filePath.Path)\r
752\r
753 return AllWorkSpaceMetaFiles\r
754\r
4234283c 755 def _CheckPcdDefineAndType(self):\r
caf74495
JC
756 PcdTypeSet = {TAB_PCDS_FIXED_AT_BUILD,\r
757 TAB_PCDS_PATCHABLE_IN_MODULE,\r
758 TAB_PCDS_FEATURE_FLAG,\r
759 TAB_PCDS_DYNAMIC,\r
760 TAB_PCDS_DYNAMIC_EX}\r
4234283c
LG
761\r
762 # This dict store PCDs which are not used by any modules with specified arches\r
9006a2c6 763 UnusedPcd = OrderedDict()\r
4234283c
LG
764 for Pa in self.AutoGenObjectList:\r
765 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid\r
766 for Pcd in Pa.Platform.Pcds:\r
767 PcdType = Pa.Platform.Pcds[Pcd].Type\r
47fea6af 768\r
f7496d71 769 # If no PCD type, this PCD comes from FDF\r
4234283c
LG
770 if not PcdType:\r
771 continue\r
47fea6af 772\r
4234283c 773 # Try to remove Hii and Vpd suffix\r
6b1f2cf4
CJ
774 if PcdType.startswith(TAB_PCDS_DYNAMIC_EX):\r
775 PcdType = TAB_PCDS_DYNAMIC_EX\r
776 elif PcdType.startswith(TAB_PCDS_DYNAMIC):\r
777 PcdType = TAB_PCDS_DYNAMIC\r
47fea6af 778\r
4234283c
LG
779 for Package in Pa.PackageList:\r
780 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType\r
781 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:\r
782 break\r
caf74495 783 for Type in PcdTypeSet:\r
4234283c
LG
784 if (Pcd[0], Pcd[1], Type) in Package.Pcds:\r
785 EdkLogger.error(\r
786 'build',\r
787 FORMAT_INVALID,\r
788 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \\r
789 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),\r
790 ExtraData=None\r
791 )\r
792 return\r
793 else:\r
794 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)\r
795\r
796 for Pcd in UnusedPcd:\r
797 EdkLogger.warn(\r
798 'build',\r
799 "The PCD was not specified by any INF module in the platform for the given architecture.\n"\r
800 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"\r
801 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),\r
802 ExtraData=None\r
803 )\r
804\r
52302d4d
LG
805 def __repr__(self):\r
806 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))\r
807\r
808 ## Return the directory to store FV files\r
e6c62ab7
CJ
809 @cached_property\r
810 def FvDir(self):\r
811 return path.join(self.BuildDir, TAB_FV_DIRECTORY)\r
52302d4d
LG
812\r
813 ## Return the directory to store all intermediate and final files built\r
e6c62ab7
CJ
814 @cached_property\r
815 def BuildDir(self):\r
816 return self.AutoGenObjectList[0].BuildDir\r
52302d4d
LG
817\r
818 ## Return the build output directory platform specifies\r
e6c62ab7
CJ
819 @cached_property\r
820 def OutputDir(self):\r
52302d4d
LG
821 return self.Platform.OutputDirectory\r
822\r
823 ## Return platform name\r
e6c62ab7
CJ
824 @cached_property\r
825 def Name(self):\r
52302d4d
LG
826 return self.Platform.PlatformName\r
827\r
828 ## Return meta-file GUID\r
e6c62ab7
CJ
829 @cached_property\r
830 def Guid(self):\r
52302d4d
LG
831 return self.Platform.Guid\r
832\r
833 ## Return platform version\r
e6c62ab7
CJ
834 @cached_property\r
835 def Version(self):\r
52302d4d
LG
836 return self.Platform.Version\r
837\r
838 ## Return paths of tools\r
e6c62ab7
CJ
839 @cached_property\r
840 def ToolDefinition(self):\r
52302d4d
LG
841 return self.AutoGenObjectList[0].ToolDefinition\r
842\r
843 ## Return directory of platform makefile\r
844 #\r
845 # @retval string Makefile directory\r
846 #\r
e6c62ab7
CJ
847 @cached_property\r
848 def MakeFileDir(self):\r
849 return self.BuildDir\r
52302d4d
LG
850\r
851 ## Return build command string\r
852 #\r
853 # @retval string Build command string\r
854 #\r
e6c62ab7
CJ
855 @cached_property\r
856 def BuildCommand(self):\r
857 # BuildCommand should be all the same. So just get one from platform AutoGen\r
858 return self.AutoGenObjectList[0].BuildCommand\r
47fea6af 859\r
6780eef1
LG
860 ## Check the PCDs token value conflict in each DEC file.\r
861 #\r
862 # Will cause build break and raise error message while two PCDs conflict.\r
f7496d71 863 #\r
6780eef1
LG
864 # @return None\r
865 #\r
866 def _CheckAllPcdsTokenValueConflict(self):\r
b36d134f
LG
867 for Pa in self.AutoGenObjectList:\r
868 for Package in Pa.PackageList:\r
1ccc4d89 869 PcdList = Package.Pcds.values()\r
87010d3d 870 PcdList.sort(key=lambda x: int(x.TokenValue, 0))\r
6780eef1
LG
871 Count = 0\r
872 while (Count < len(PcdList) - 1) :\r
873 Item = PcdList[Count]\r
874 ItemNext = PcdList[Count + 1]\r
875 #\r
876 # Make sure in the same token space the TokenValue should be unique\r
877 #\r
f827cd07 878 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
879 SameTokenValuePcdList = []\r
880 SameTokenValuePcdList.append(Item)\r
881 SameTokenValuePcdList.append(ItemNext)\r
882 RemainPcdListLength = len(PcdList) - Count - 2\r
883 for ValueSameCount in range(RemainPcdListLength):\r
f827cd07 884 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):\r
6780eef1
LG
885 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])\r
886 else:\r
887 break;\r
888 #\r
889 # Sort same token value PCD list with TokenGuid and TokenCName\r
890 #\r
87010d3d 891 SameTokenValuePcdList.sort(key=lambda x: "%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName))\r
47fea6af 892 SameTokenValuePcdListCount = 0\r
6780eef1 893 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):\r
2a29017e 894 Flag = False\r
47fea6af
YZ
895 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]\r
896 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]\r
897\r
6780eef1 898 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):\r
2a29017e
YZ
899 for PcdItem in GlobalData.MixedPcd:\r
900 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \\r
901 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
902 Flag = True\r
903 if not Flag:\r
904 EdkLogger.error(\r
905 'build',\r
906 FORMAT_INVALID,\r
907 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\\r
908 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),\r
909 ExtraData=None\r
910 )\r
6780eef1
LG
911 SameTokenValuePcdListCount += 1\r
912 Count += SameTokenValuePcdListCount\r
913 Count += 1\r
47fea6af 914\r
1ccc4d89 915 PcdList = Package.Pcds.values()\r
87010d3d 916 PcdList.sort(key=lambda x: "%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName))\r
6780eef1
LG
917 Count = 0\r
918 while (Count < len(PcdList) - 1) :\r
919 Item = PcdList[Count]\r
47fea6af 920 ItemNext = PcdList[Count + 1]\r
6780eef1
LG
921 #\r
922 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.\r
923 #\r
f827cd07 924 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
925 EdkLogger.error(\r
926 'build',\r
927 FORMAT_INVALID,\r
928 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\\r
929 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),\r
930 ExtraData=None\r
931 )\r
932 Count += 1\r
97fa0ee9 933 ## Generate fds command\r
e6c62ab7
CJ
934 @property\r
935 def GenFdsCommand(self):\r
03af2753 936 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()\r
52302d4d 937\r
e56468c0 938 ## Create makefile for the platform and modules in it\r
52302d4d
LG
939 #\r
940 # @param CreateDepsMakeFile Flag indicating if the makefile for\r
941 # modules will be created as well\r
942 #\r
943 def CreateMakeFile(self, CreateDepsMakeFile=False):\r
caf74495
JC
944 if not CreateDepsMakeFile:\r
945 return\r
946 for Pa in self.AutoGenObjectList:\r
947 Pa.CreateMakeFile(True)\r
52302d4d
LG
948\r
949 ## Create autogen code for platform and modules\r
950 #\r
951 # Since there's no autogen code for platform, this method will do nothing\r
952 # if CreateModuleCodeFile is set to False.\r
953 #\r
954 # @param CreateDepsCodeFile Flag indicating if creating module's\r
955 # autogen code file or not\r
956 #\r
957 def CreateCodeFile(self, CreateDepsCodeFile=False):\r
958 if not CreateDepsCodeFile:\r
959 return\r
960 for Pa in self.AutoGenObjectList:\r
caf74495 961 Pa.CreateCodeFile(True)\r
52302d4d 962\r
7c1fd323
LG
963 ## Create AsBuilt INF file the platform\r
964 #\r
965 def CreateAsBuiltInf(self):\r
966 return\r
967\r
52302d4d
LG
968\r
969## AutoGen class for platform\r
970#\r
971# PlatformAutoGen class will process the original information in platform\r
972# file in order to generate makefile for platform.\r
973#\r
974class PlatformAutoGen(AutoGen):\r
b24e99f7
CJ
975 # call super().__init__ then call the worker function with different parameter count\r
976 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b23414f6 977 if not hasattr(self, "_Init"):\r
1ccc4d89 978 super(PlatformAutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
b24e99f7
CJ
979 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch)\r
980 self._Init = True\r
52302d4d 981 #\r
f7496d71 982 # Used to store all PCDs for both PEI and DXE phase, in order to generate\r
52302d4d 983 # correct PCD database\r
f7496d71 984 #\r
52302d4d
LG
985 _DynaPcdList_ = []\r
986 _NonDynaPcdList_ = []\r
61ee1dff 987 _PlatformPcds = {}\r
f7496d71 988\r
6780eef1 989 #\r
f7496d71 990 # The priority list while override build option\r
6780eef1
LG
991 #\r
992 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)\r
993 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
994 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
f7496d71 995 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
6780eef1
LG
996 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
997 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
998 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE\r
999 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE\r
1000 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1001 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1002 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE\r
1003 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE\r
1004 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE\r
1005 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE\r
1006 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE\r
1007 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)\r
47fea6af 1008\r
b24e99f7 1009 ## Initialize PlatformAutoGen\r
52302d4d 1010 #\r
52302d4d
LG
1011 #\r
1012 # @param Workspace WorkspaceAutoGen object\r
1013 # @param PlatformFile Platform file (DSC file)\r
1014 # @param Target Build target (DEBUG, RELEASE)\r
1015 # @param Toolchain Name of tool chain\r
1016 # @param Arch arch of the platform supports\r
1017 #\r
b24e99f7 1018 def _InitWorker(self, Workspace, PlatformFile, Target, Toolchain, Arch):\r
52302d4d
LG
1019 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))\r
1020 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)\r
1021\r
1022 self.MetaFile = PlatformFile\r
1023 self.Workspace = Workspace\r
1024 self.WorkspaceDir = Workspace.WorkspaceDir\r
1025 self.ToolChain = Toolchain\r
1026 self.BuildTarget = Target\r
1027 self.Arch = Arch\r
1028 self.SourceDir = PlatformFile.SubDir\r
1029 self.SourceOverrideDir = None\r
1030 self.FdTargetList = self.Workspace.FdTargetList\r
1031 self.FvTargetList = self.Workspace.FvTargetList\r
1032 self.AllPcdList = []\r
a0a2cd1e
FB
1033 # get the original module/package/platform objects\r
1034 self.BuildDatabase = Workspace.BuildDatabase\r
8518bf0b 1035 self.DscBuildDataObj = Workspace.Platform\r
52302d4d
LG
1036\r
1037 # flag indicating if the makefile/C-code file has been created or not\r
1038 self.IsMakeFileCreated = False\r
e6eae3b4 1039\r
52302d4d
LG
1040 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
1041 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
e6eae3b4 1042\r
a0a2cd1e
FB
1043 self._AsBuildInfList = []\r
1044 self._AsBuildModuleList = []\r
47854fd5
LG
1045\r
1046 self.VariableInfo = None\r
1047\r
4231a819 1048 if GlobalData.gFdfParser is not None:\r
a0a2cd1e
FB
1049 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList\r
1050 for Inf in self._AsBuildInfList:\r
1051 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)\r
1052 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
f5f4667d 1053 if not M.IsBinaryModule:\r
a0a2cd1e
FB
1054 continue\r
1055 self._AsBuildModuleList.append(InfClass)\r
03af2753
HC
1056 # get library/modules for build\r
1057 self.LibraryBuildDirectoryList = []\r
1058 self.ModuleBuildDirectoryList = []\r
47854fd5 1059\r
52302d4d
LG
1060 return True\r
1061\r
e6eae3b4 1062 @cached_class_function\r
52302d4d
LG
1063 def __repr__(self):\r
1064 return "%s [%s]" % (self.MetaFile, self.Arch)\r
1065\r
1066 ## Create autogen code for platform and modules\r
1067 #\r
1068 # Since there's no autogen code for platform, this method will do nothing\r
1069 # if CreateModuleCodeFile is set to False.\r
1070 #\r
1071 # @param CreateModuleCodeFile Flag indicating if creating module's\r
1072 # autogen code file or not\r
1073 #\r
e6eae3b4 1074 @cached_class_function\r
52302d4d
LG
1075 def CreateCodeFile(self, CreateModuleCodeFile=False):\r
1076 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False\r
e6eae3b4 1077 if not CreateModuleCodeFile:\r
52302d4d
LG
1078 return\r
1079\r
1080 for Ma in self.ModuleAutoGenList:\r
1081 Ma.CreateCodeFile(True)\r
1082\r
03af2753 1083 ## Generate Fds Command\r
e6eae3b4
CJ
1084 @cached_property\r
1085 def GenFdsCommand(self):\r
03af2753 1086 return self.Workspace.GenFdsCommand\r
481252bb 1087\r
4def57d9 1088 ## Create makefile for the platform and modules in it\r
52302d4d
LG
1089 #\r
1090 # @param CreateModuleMakeFile Flag indicating if the makefile for\r
1091 # modules will be created as well\r
1092 #\r
37de70b7 1093 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):\r
52302d4d 1094 if CreateModuleMakeFile:\r
4def57d9
CJ
1095 for Ma in self._MaList:\r
1096 key = (Ma.MetaFile.File, self.Arch)\r
1097 if key in FfsCommand:\r
1098 Ma.CreateMakeFile(True, FfsCommand[key])\r
37de70b7
YZ
1099 else:\r
1100 Ma.CreateMakeFile(True)\r
52302d4d
LG
1101\r
1102 # no need to create makefile for the platform more than once\r
1103 if self.IsMakeFileCreated:\r
1104 return\r
1105\r
03af2753 1106 # create library/module build dirs for platform\r
52302d4d 1107 Makefile = GenMake.PlatformMakefile(self)\r
03af2753
HC
1108 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()\r
1109 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()\r
1110\r
52302d4d
LG
1111 self.IsMakeFileCreated = True\r
1112\r
2bc3256c
LG
1113 ## Deal with Shared FixedAtBuild Pcds\r
1114 #\r
1115 def CollectFixedAtBuildPcds(self):\r
1116 for LibAuto in self.LibraryAutoGenList:\r
f7496d71
LG
1117 FixedAtBuildPcds = {}\r
1118 ShareFixedAtBuildPcdsSameValue = {}\r
b23414f6 1119 for Module in LibAuto.ReferenceModules:\r
d900d7c9 1120 for Pcd in set(Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds):\r
9edba51f
YZ
1121 DefaultValue = Pcd.DefaultValue\r
1122 # Cover the case: DSC component override the Pcd value and the Pcd only used in one Lib\r
1123 if Pcd in Module.LibraryPcdList:\r
1124 Index = Module.LibraryPcdList.index(Pcd)\r
1125 DefaultValue = Module.LibraryPcdList[Index].DefaultValue\r
ccaa7754 1126 key = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
2bc3256c
LG
1127 if key not in FixedAtBuildPcds:\r
1128 ShareFixedAtBuildPcdsSameValue[key] = True\r
9edba51f 1129 FixedAtBuildPcds[key] = DefaultValue\r
2bc3256c 1130 else:\r
9edba51f 1131 if FixedAtBuildPcds[key] != DefaultValue:\r
f7496d71 1132 ShareFixedAtBuildPcdsSameValue[key] = False\r
2bc3256c 1133 for Pcd in LibAuto.FixedAtBuildPcds:\r
ccaa7754
GL
1134 key = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1135 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:\r
2bc3256c
LG
1136 continue\r
1137 else:\r
ccaa7754 1138 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)]\r
6b1f2cf4 1139 if DscPcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
2bc3256c 1140 continue\r
f7496d71 1141 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:\r
eca980c0 1142 LibAuto.ConstPcd[key] = FixedAtBuildPcds[key]\r
2bc3256c 1143\r
34952f49 1144 def CollectVariables(self, DynamicPcdSet):\r
47854fd5
LG
1145 VpdRegionSize = 0\r
1146 VpdRegionBase = 0\r
1147 if self.Workspace.FdfFile:\r
1148 FdDict = self.Workspace.FdfProfile.FdDict[GlobalData.gFdfParser.CurrentFdName]\r
1149 for FdRegion in FdDict.RegionList:\r
1150 for item in FdRegion.RegionDataList:\r
1151 if self.Platform.VpdToolGuid.strip() and self.Platform.VpdToolGuid in item:\r
1152 VpdRegionSize = FdRegion.Size\r
1153 VpdRegionBase = FdRegion.Offset\r
1154 break\r
1155\r
f27e800a 1156 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(), self.DscBuildDataObj.SkuIds)\r
47854fd5
LG
1157 VariableInfo.SetVpdRegionMaxSize(VpdRegionSize)\r
1158 VariableInfo.SetVpdRegionOffset(VpdRegionBase)\r
34952f49
LG
1159 Index = 0\r
1160 for Pcd in DynamicPcdSet:\r
ccaa7754 1161 pcdname = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
8518bf0b
LG
1162 for SkuName in Pcd.SkuInfoList:\r
1163 Sku = Pcd.SkuInfoList[SkuName]\r
1164 SkuId = Sku.SkuId\r
4231a819 1165 if SkuId is None or SkuId == '':\r
8518bf0b
LG
1166 continue\r
1167 if len(Sku.VariableName) > 0:\r
5af5153a
FB
1168 if Sku.VariableAttribute and 'NV' not in Sku.VariableAttribute:\r
1169 continue\r
8518bf0b
LG
1170 VariableGuidStructure = Sku.VariableGuidValue\r
1171 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)\r
a3623244 1172 for StorageName in Sku.DefaultStoreDict:\r
da2d4f76 1173 VariableInfo.append_variable(var_info(Index, pcdname, StorageName, SkuName, StringToArray(Sku.VariableName), VariableGuid, Sku.VariableOffset, Sku.VariableAttribute, Sku.HiiDefaultValue, Sku.DefaultStoreDict[StorageName] if Pcd.DatumType in TAB_PCD_NUMERIC_TYPES else StringToArray(Sku.DefaultStoreDict[StorageName]), Pcd.DatumType, Pcd.CustomAttribute['DscPosition'], Pcd.CustomAttribute.get('IsStru',False)))\r
34952f49
LG
1174 Index += 1\r
1175 return VariableInfo\r
47854fd5 1176\r
ccaa7754 1177 def UpdateNVStoreMaxSize(self, OrgVpdFile):\r
0b6c5954 1178 if self.VariableInfo:\r
91fa33ee 1179 VpdMapFilePath = os.path.join(self.BuildDir, TAB_FV_DIRECTORY, "%s.map" % self.Platform.VpdToolGuid)\r
0b6c5954
LG
1180 PcdNvStoreDfBuffer = [item for item in self._DynamicPcdList if item.TokenCName == "PcdNvStoreDefaultValueBuffer" and item.TokenSpaceGuidCName == "gEfiMdeModulePkgTokenSpaceGuid"]\r
1181\r
1182 if PcdNvStoreDfBuffer:\r
1183 if os.path.exists(VpdMapFilePath):\r
1184 OrgVpdFile.Read(VpdMapFilePath)\r
1185 PcdItems = OrgVpdFile.GetOffset(PcdNvStoreDfBuffer[0])\r
1ccc4d89 1186 NvStoreOffset = PcdItems.values()[0].strip() if PcdItems else '0'\r
0b6c5954
LG
1187 else:\r
1188 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
1189\r
ccaa7754 1190 NvStoreOffset = int(NvStoreOffset, 16) if NvStoreOffset.upper().startswith("0X") else int(NvStoreOffset)\r
55c84777 1191 default_skuobj = PcdNvStoreDfBuffer[0].SkuInfoList.get(TAB_DEFAULT)\r
0b6c5954
LG
1192 maxsize = self.VariableInfo.VpdRegionSize - NvStoreOffset if self.VariableInfo.VpdRegionSize else len(default_skuobj.DefaultValue.split(","))\r
1193 var_data = self.VariableInfo.PatchNVStoreDefaultMaxSize(maxsize)\r
1194\r
1195 if var_data and default_skuobj:\r
1196 default_skuobj.DefaultValue = var_data\r
1197 PcdNvStoreDfBuffer[0].DefaultValue = var_data\r
1198 PcdNvStoreDfBuffer[0].SkuInfoList.clear()\r
55c84777 1199 PcdNvStoreDfBuffer[0].SkuInfoList[TAB_DEFAULT] = default_skuobj\r
0b6c5954 1200 PcdNvStoreDfBuffer[0].MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))\r
47854fd5
LG
1201\r
1202 return OrgVpdFile\r
1203\r
52302d4d
LG
1204 ## Collect dynamic PCDs\r
1205 #\r
1206 # Gather dynamic PCDs list from each module and their settings from platform\r
1207 # This interface should be invoked explicitly when platform action is created.\r
1208 #\r
1209 def CollectPlatformDynamicPcds(self):\r
2a29017e
YZ
1210 for key in self.Platform.Pcds:\r
1211 for SinglePcd in GlobalData.MixedPcd:\r
1212 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
1213 for item in GlobalData.MixedPcd[SinglePcd]:\r
1214 Pcd_Type = item[0].split('_')[-1]\r
eece4292
CJ
1215 if (Pcd_Type == self.Platform.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and self.Platform.Pcds[key].Type in PCD_DYNAMIC_EX_TYPE_SET) or \\r
1216 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in PCD_DYNAMIC_TYPE_SET):\r
2a29017e
YZ
1217 Value = self.Platform.Pcds[key]\r
1218 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type\r
1219 if len(key) == 2:\r
1220 newkey = (Value.TokenCName, key[1])\r
1221 elif len(key) == 3:\r
1222 newkey = (Value.TokenCName, key[1], key[2])\r
1223 del self.Platform.Pcds[key]\r
1224 self.Platform.Pcds[newkey] = Value\r
1225 break\r
2a29017e 1226 break\r
2a29017e 1227\r
52302d4d
LG
1228 # for gathering error information\r
1229 NoDatumTypePcdList = set()\r
a0a2cd1e
FB
1230 FdfModuleList = []\r
1231 for InfName in self._AsBuildInfList:\r
05cc51ad 1232 InfName = mws.join(self.WorkspaceDir, InfName)\r
a0a2cd1e 1233 FdfModuleList.append(os.path.normpath(InfName))\r
4def57d9
CJ
1234 for M in self._MaList:\r
1235# F is the Module for which M is the module autogen\r
1ccc4d89 1236 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:\r
52302d4d 1237 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
c93356ad 1238 if PcdFromModule.DatumType == TAB_VOID and not PcdFromModule.MaxDatumSize:\r
4def57d9 1239 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, M.MetaFile))\r
52302d4d 1240\r
97fa0ee9 1241 # Check the PCD from Binary INF or Source INF\r
a0a2cd1e
FB
1242 if M.IsBinaryModule == True:\r
1243 PcdFromModule.IsFromBinaryInf = True\r
97fa0ee9 1244\r
f7496d71 1245 # Check the PCD from DSC or not\r
9eb87141
CJ
1246 PcdFromModule.IsFromDsc = (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds\r
1247\r
eece4292 1248 if PcdFromModule.Type in PCD_DYNAMIC_TYPE_SET or PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
4def57d9 1249 if M.MetaFile.Path not in FdfModuleList:\r
f7496d71
LG
1250 # If one of the Source built modules listed in the DSC is not listed\r
1251 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic\r
1252 # access method (it is only listed in the DEC file that declares the\r
a0a2cd1e 1253 # PCD as PcdsDynamic), then build tool will report warning message\r
f7496d71
LG
1254 # notify the PI that they are attempting to build a module that must\r
1255 # be included in a flash image in order to be functional. These Dynamic\r
1256 # PCD will not be added into the Database unless it is used by other\r
a0a2cd1e 1257 # modules that are included in the FDF file.\r
eece4292 1258 if PcdFromModule.Type in PCD_DYNAMIC_TYPE_SET and \\r
a0a2cd1e
FB
1259 PcdFromModule.IsFromBinaryInf == False:\r
1260 # Print warning message to let the developer make a determine.\r
a0a2cd1e 1261 continue\r
f7496d71
LG
1262 # If one of the Source built modules listed in the DSC is not listed in\r
1263 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx\r
1264 # access method (it is only listed in the DEC file that declares the\r
1265 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the\r
a0a2cd1e 1266 # PCD to the Platform's PCD Database.\r
eece4292 1267 if PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
a0a2cd1e 1268 continue\r
52302d4d
LG
1269 #\r
1270 # If a dynamic PCD used by a PEM module/PEI module & DXE module,\r
1271 # it should be stored in Pcd PEI database, If a dynamic only\r
1272 # used by DXE module, it should be stored in DXE PCD database.\r
1273 # The default Phase is DXE\r
1274 #\r
88c6c1b6 1275 if M.ModuleType in SUP_MODULE_SET_PEI:\r
52302d4d
LG
1276 PcdFromModule.Phase = "PEI"\r
1277 if PcdFromModule not in self._DynaPcdList_:\r
1278 self._DynaPcdList_.append(PcdFromModule)\r
1279 elif PcdFromModule.Phase == 'PEI':\r
1280 # overwrite any the same PCD existing, if Phase is PEI\r
1281 Index = self._DynaPcdList_.index(PcdFromModule)\r
1282 self._DynaPcdList_[Index] = PcdFromModule\r
1283 elif PcdFromModule not in self._NonDynaPcdList_:\r
1284 self._NonDynaPcdList_.append(PcdFromModule)\r
a0a2cd1e
FB
1285 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:\r
1286 Index = self._NonDynaPcdList_.index(PcdFromModule)\r
1287 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:\r
1288 #The PCD from Binary INF will override the same one from source INF\r
1289 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])\r
1290 PcdFromModule.Pending = False\r
1291 self._NonDynaPcdList_.append (PcdFromModule)\r
1563349a 1292 DscModuleSet = {os.path.normpath(ModuleInf.Path) for ModuleInf in self.Platform.Modules}\r
f7496d71 1293 # add the PCD from modules that listed in FDF but not in DSC to Database\r
a0a2cd1e 1294 for InfName in FdfModuleList:\r
1563349a 1295 if InfName not in DscModuleSet:\r
a0a2cd1e
FB
1296 InfClass = PathClass(InfName)\r
1297 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
f7496d71
LG
1298 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)\r
1299 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.\r
1300 # For binary module, if in current arch, we need to list the PCDs into database.\r
f5f4667d 1301 if not M.IsBinaryModule:\r
a0a2cd1e
FB
1302 continue\r
1303 # Override the module PCD setting by platform setting\r
1304 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)\r
1305 for PcdFromModule in ModulePcdList:\r
1306 PcdFromModule.IsFromBinaryInf = True\r
1307 PcdFromModule.IsFromDsc = False\r
1308 # Only allow the DynamicEx and Patchable PCD in AsBuild INF\r
eece4292 1309 if PcdFromModule.Type not in PCD_DYNAMIC_EX_TYPE_SET and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:\r
a0a2cd1e
FB
1310 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1311 File=self.MetaFile,\r
1312 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"\r
1313 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))\r
1314 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
c93356ad 1315 if PcdFromModule.DatumType == TAB_VOID and not PcdFromModule.MaxDatumSize:\r
a0a2cd1e 1316 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))\r
88c6c1b6 1317 if M.ModuleType in SUP_MODULE_SET_PEI:\r
a0a2cd1e 1318 PcdFromModule.Phase = "PEI"\r
eece4292 1319 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
a0a2cd1e
FB
1320 self._DynaPcdList_.append(PcdFromModule)\r
1321 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1322 self._NonDynaPcdList_.append(PcdFromModule)\r
eece4292 1323 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
97fa0ee9 1324 # Overwrite the phase of any the same PCD existing, if Phase is PEI.\r
f7496d71 1325 # It is to solve the case that a dynamic PCD used by a PEM module/PEI\r
97fa0ee9
YL
1326 # module & DXE module at a same time.\r
1327 # Overwrite the type of the PCDs in source INF by the type of AsBuild\r
f7496d71 1328 # INF file as DynamicEx.\r
a0a2cd1e
FB
1329 Index = self._DynaPcdList_.index(PcdFromModule)\r
1330 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase\r
1331 self._DynaPcdList_[Index].Type = PcdFromModule.Type\r
1332 for PcdFromModule in self._NonDynaPcdList_:\r
f7496d71
LG
1333 # If a PCD is not listed in the DSC file, but binary INF files used by\r
1334 # this platform all (that use this PCD) list the PCD in a [PatchPcds]\r
1335 # section, AND all source INF files used by this platform the build\r
1336 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]\r
a0a2cd1e 1337 # section, then the tools must NOT add the PCD to the Platform's PCD\r
f7496d71 1338 # Database; the build must assign the access method for this PCD as\r
a0a2cd1e
FB
1339 # PcdsPatchableInModule.\r
1340 if PcdFromModule not in self._DynaPcdList_:\r
1341 continue\r
1342 Index = self._DynaPcdList_.index(PcdFromModule)\r
1343 if PcdFromModule.IsFromDsc == False and \\r
1344 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \\r
1345 PcdFromModule.IsFromBinaryInf == True and \\r
1346 self._DynaPcdList_[Index].IsFromBinaryInf == False:\r
1347 Index = self._DynaPcdList_.index(PcdFromModule)\r
1348 self._DynaPcdList_.remove (self._DynaPcdList_[Index])\r
52302d4d
LG
1349\r
1350 # print out error information and break the build, if error found\r
1351 if len(NoDatumTypePcdList) > 0:\r
1352 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)\r
1353 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1354 File=self.MetaFile,\r
1355 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"\r
1356 % NoDatumTypePcdListString)\r
1357 self._NonDynamicPcdList = self._NonDynaPcdList_\r
1358 self._DynamicPcdList = self._DynaPcdList_\r
52302d4d
LG
1359 #\r
1360 # Sort dynamic PCD list to:\r
f7496d71 1361 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should\r
52302d4d
LG
1362 # try to be put header of dynamicd List\r
1363 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD\r
1364 #\r
1365 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.\r
1366 #\r
0b6c5954
LG
1367 UnicodePcdArray = set()\r
1368 HiiPcdArray = set()\r
1369 OtherPcdArray = set()\r
6780eef1 1370 VpdPcdDict = {}\r
e56468c0 1371 VpdFile = VpdInfoFile.VpdInfoFile()\r
61ee1dff
YZ
1372 NeedProcessVpdMapFile = False\r
1373\r
9eb87141
CJ
1374 for pcd in self.Platform.Pcds:\r
1375 if pcd not in self._PlatformPcds:\r
61ee1dff
YZ
1376 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]\r
1377\r
ae7b6df8
LG
1378 for item in self._PlatformPcds:\r
1379 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
656d2539 1380 self._PlatformPcds[item].DatumType = TAB_VOID\r
ae7b6df8 1381\r
f7496d71 1382 if (self.Workspace.ArchList[-1] == self.Arch):\r
e56468c0 1383 for Pcd in self._DynamicPcdList:\r
e56468c0 1384 # just pick the a value to determine whether is unicode string type\r
1ccc4d89 1385 Sku = Pcd.SkuInfoList.values()[0]\r
e56468c0 1386 Sku.VpdOffset = Sku.VpdOffset.strip()\r
47fea6af 1387\r
ae7b6df8 1388 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
656d2539 1389 Pcd.DatumType = TAB_VOID\r
ae7b6df8 1390\r
e56468c0 1391 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
e56468c0 1392 # if found HII type PCD then insert to right of UnicodeIndex\r
e56468c0 1393 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
47fea6af
YZ
1394 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd\r
1395\r
34952f49 1396 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer\r
ccaa7754 1397 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer", "gEfiMdeModulePkgTokenSpaceGuid"))\r
34952f49 1398 if PcdNvStoreDfBuffer:\r
47854fd5 1399 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)\r
47854fd5 1400 vardump = self.VariableInfo.dump()\r
626bece4 1401 if vardump:\r
93f98985
ZZ
1402 #\r
1403 #According to PCD_DATABASE_INIT in edk2\MdeModulePkg\Include\Guid\PcdDataBaseSignatureGuid.h,\r
1404 #the max size for string PCD should not exceed USHRT_MAX 65535(0xffff).\r
1405 #typedef UINT16 SIZE_INFO;\r
1406 #//SIZE_INFO SizeTable[];\r
1407 if len(vardump.split(",")) > 0xffff:\r
1408 EdkLogger.error("build", RESOURCE_OVERFLOW, 'The current length of PCD %s value is %d, it exceeds to the max size of String PCD.' %(".".join([PcdNvStoreDfBuffer.TokenSpaceGuidCName,PcdNvStoreDfBuffer.TokenCName]) ,len(vardump.split(","))))\r
2b8a6c44 1409 PcdNvStoreDfBuffer.DefaultValue = vardump\r
626bece4
LG
1410 for skuname in PcdNvStoreDfBuffer.SkuInfoList:\r
1411 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump\r
1412 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))\r
ced86858
ZZ
1413 else:\r
1414 #If the end user define [DefaultStores] and [XXX.Menufacturing] in DSC, but forget to configure PcdNvStoreDefaultValueBuffer to PcdsDynamicVpd\r
1415 if [Pcd for Pcd in self._DynamicPcdList if Pcd.UserDefinedDefaultStoresFlag]:\r
1416 EdkLogger.warn("build", "PcdNvStoreDefaultValueBuffer should be defined as PcdsDynamicExVpd in dsc file since the DefaultStores is enabled for this platform.\n%s" %self.Platform.MetaFile.Path)\r
caf74495 1417 PlatformPcds = sorted(self._PlatformPcds.keys())\r
6780eef1
LG
1418 #\r
1419 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
1420 #\r
626bece4 1421 VpdSkuMap = {}\r
6780eef1 1422 for PcdKey in PlatformPcds:\r
61ee1dff 1423 Pcd = self._PlatformPcds[PcdKey]\r
e8a47801
LG
1424 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \\r
1425 PcdKey in VpdPcdDict:\r
1426 Pcd = VpdPcdDict[PcdKey]\r
626bece4 1427 SkuValueMap = {}\r
55c84777 1428 DefaultSku = Pcd.SkuInfoList.get(TAB_DEFAULT)\r
8ac16789
LG
1429 if DefaultSku:\r
1430 PcdValue = DefaultSku.DefaultValue\r
1431 if PcdValue not in SkuValueMap:\r
1432 SkuValueMap[PcdValue] = []\r
ccaa7754 1433 VpdFile.Add(Pcd, TAB_DEFAULT, DefaultSku.VpdOffset)\r
8ac16789
LG
1434 SkuValueMap[PcdValue].append(DefaultSku)\r
1435\r
ccaa7754 1436 for (SkuName, Sku) in Pcd.SkuInfoList.items():\r
e8a47801 1437 Sku.VpdOffset = Sku.VpdOffset.strip()\r
5a13737a
YZ
1438 PcdValue = Sku.DefaultValue\r
1439 if PcdValue == "":\r
1440 PcdValue = Pcd.DefaultValue\r
bc39c5cb 1441 if Sku.VpdOffset != TAB_STAR:\r
5a13737a
YZ
1442 if PcdValue.startswith("{"):\r
1443 Alignment = 8\r
1444 elif PcdValue.startswith("L"):\r
1445 Alignment = 2\r
1446 else:\r
1447 Alignment = 1\r
ca85291f
YZ
1448 try:\r
1449 VpdOffset = int(Sku.VpdOffset)\r
1450 except:\r
1451 try:\r
1452 VpdOffset = int(Sku.VpdOffset, 16)\r
1453 except:\r
1454 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1455 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1456 if PcdValue.startswith("{"):\r
1457 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)\r
1458 else:\r
1459 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))\r
626bece4
LG
1460 if PcdValue not in SkuValueMap:\r
1461 SkuValueMap[PcdValue] = []\r
ccaa7754 1462 VpdFile.Add(Pcd, SkuName, Sku.VpdOffset)\r
626bece4 1463 SkuValueMap[PcdValue].append(Sku)\r
e8a47801 1464 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
bc39c5cb 1465 if not NeedProcessVpdMapFile and Sku.VpdOffset == TAB_STAR:\r
e8a47801 1466 NeedProcessVpdMapFile = True\r
4231a819 1467 if self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == '':\r
e8a47801
LG
1468 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
1469 "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.")\r
47fea6af 1470\r
626bece4 1471 VpdSkuMap[PcdKey] = SkuValueMap\r
e56468c0 1472 #\r
1473 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
1474 # An example is PCD for signature usage.\r
f7496d71 1475 #\r
6780eef1 1476 for DscPcd in PlatformPcds:\r
61ee1dff 1477 DscPcdEntry = self._PlatformPcds[DscPcd]\r
e56468c0 1478 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
4231a819 1479 if not (self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == ''):\r
e56468c0 1480 FoundFlag = False\r
9eb87141 1481 for VpdPcd in VpdFile._VpdArray:\r
e56468c0 1482 # This PCD has been referenced by module\r
1483 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1484 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
1485 FoundFlag = True\r
47fea6af 1486\r
e56468c0 1487 # Not found, it should be signature\r
1488 if not FoundFlag :\r
1489 # just pick the a value to determine whether is unicode string type\r
626bece4 1490 SkuValueMap = {}\r
1ccc4d89 1491 SkuObjList = DscPcdEntry.SkuInfoList.items()\r
55c84777 1492 DefaultSku = DscPcdEntry.SkuInfoList.get(TAB_DEFAULT)\r
8ac16789 1493 if DefaultSku:\r
ccaa7754
GL
1494 defaultindex = SkuObjList.index((TAB_DEFAULT, DefaultSku))\r
1495 SkuObjList[0], SkuObjList[defaultindex] = SkuObjList[defaultindex], SkuObjList[0]\r
1496 for (SkuName, Sku) in SkuObjList:\r
f7496d71
LG
1497 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1498\r
e8a47801
LG
1499 # Need to iterate DEC pcd information to get the value & datumtype\r
1500 for eachDec in self.PackageList:\r
1501 for DecPcd in eachDec.Pcds:\r
1502 DecPcdEntry = eachDec.Pcds[DecPcd]\r
1503 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1504 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
1505 # Print warning message to let the developer make a determine.\r
1506 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
1507 File=self.MetaFile, \\r
1508 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
f7496d71
LG
1509 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))\r
1510\r
e8a47801
LG
1511 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1512 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
1513 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue\r
1514 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]\r
1515 # Only fix the value while no value provided in DSC file.\r
128d435f 1516 if not Sku.DefaultValue:\r
1ccc4d89 1517 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
f7496d71 1518\r
e8a47801
LG
1519 if DscPcdEntry not in self._DynamicPcdList:\r
1520 self._DynamicPcdList.append(DscPcdEntry)\r
e8a47801
LG
1521 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1522 PcdValue = Sku.DefaultValue\r
5a13737a
YZ
1523 if PcdValue == "":\r
1524 PcdValue = DscPcdEntry.DefaultValue\r
bc39c5cb 1525 if Sku.VpdOffset != TAB_STAR:\r
5a13737a
YZ
1526 if PcdValue.startswith("{"):\r
1527 Alignment = 8\r
1528 elif PcdValue.startswith("L"):\r
1529 Alignment = 2\r
1530 else:\r
1531 Alignment = 1\r
ca85291f
YZ
1532 try:\r
1533 VpdOffset = int(Sku.VpdOffset)\r
1534 except:\r
1535 try:\r
1536 VpdOffset = int(Sku.VpdOffset, 16)\r
1537 except:\r
1538 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))\r
1539 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1540 if PcdValue.startswith("{"):\r
1541 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)\r
1542 else:\r
1543 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))\r
626bece4
LG
1544 if PcdValue not in SkuValueMap:\r
1545 SkuValueMap[PcdValue] = []\r
ccaa7754 1546 VpdFile.Add(DscPcdEntry, SkuName, Sku.VpdOffset)\r
626bece4 1547 SkuValueMap[PcdValue].append(Sku)\r
bc39c5cb 1548 if not NeedProcessVpdMapFile and Sku.VpdOffset == TAB_STAR:\r
f7496d71 1549 NeedProcessVpdMapFile = True\r
656d2539 1550 if DscPcdEntry.DatumType == TAB_VOID and PcdValue.startswith("L"):\r
0b6c5954 1551 UnicodePcdArray.add(DscPcdEntry)\r
e8a47801 1552 elif len(Sku.VariableName) > 0:\r
0b6c5954 1553 HiiPcdArray.add(DscPcdEntry)\r
e8a47801 1554 else:\r
0b6c5954
LG
1555 OtherPcdArray.add(DscPcdEntry)\r
1556\r
e8a47801 1557 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
626bece4 1558 VpdSkuMap[DscPcd] = SkuValueMap\r
4231a819 1559 if (self.Platform.FlashDefinition is None or self.Platform.FlashDefinition == '') and \\r
e56468c0 1560 VpdFile.GetCount() != 0:\r
f7496d71 1561 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
e56468c0 1562 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
47fea6af 1563\r
e56468c0 1564 if VpdFile.GetCount() != 0:\r
47854fd5
LG
1565\r
1566 self.FixVpdOffset(VpdFile)\r
1567\r
1568 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))\r
47fea6af 1569\r
e56468c0 1570 # Process VPD map file generated by third party BPDG tool\r
1571 if NeedProcessVpdMapFile:\r
91fa33ee 1572 VpdMapFilePath = os.path.join(self.BuildDir, TAB_FV_DIRECTORY, "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1573 if os.path.exists(VpdMapFilePath):\r
1574 VpdFile.Read(VpdMapFilePath)\r
47fea6af 1575\r
bc39c5cb 1576 # Fixup TAB_STAR offset\r
626bece4
LG
1577 for pcd in VpdSkuMap:\r
1578 vpdinfo = VpdFile.GetVpdInfo(pcd)\r
1579 if vpdinfo is None:\r
e56468c0 1580 # just pick the a value to determine whether is unicode string type\r
626bece4
LG
1581 continue\r
1582 for pcdvalue in VpdSkuMap[pcd]:\r
1583 for sku in VpdSkuMap[pcd][pcdvalue]:\r
1584 for item in vpdinfo:\r
1585 if item[2] == pcdvalue:\r
1586 sku.VpdOffset = item[1]\r
e56468c0 1587 else:\r
1588 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
47fea6af 1589\r
626bece4
LG
1590 # Delete the DynamicPcdList At the last time enter into this function\r
1591 for Pcd in self._DynamicPcdList:\r
1592 # just pick the a value to determine whether is unicode string type\r
1ccc4d89 1593 Sku = Pcd.SkuInfoList.values()[0]\r
626bece4
LG
1594 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1595\r
1596 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
656d2539 1597 Pcd.DatumType = TAB_VOID\r
626bece4
LG
1598\r
1599 PcdValue = Sku.DefaultValue\r
656d2539 1600 if Pcd.DatumType == TAB_VOID and PcdValue.startswith("L"):\r
626bece4 1601 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
0b6c5954 1602 UnicodePcdArray.add(Pcd)\r
626bece4
LG
1603 elif len(Sku.VariableName) > 0:\r
1604 # if found HII type PCD then insert to right of UnicodeIndex\r
0b6c5954 1605 HiiPcdArray.add(Pcd)\r
626bece4 1606 else:\r
0b6c5954 1607 OtherPcdArray.add(Pcd)\r
47fea6af 1608 del self._DynamicPcdList[:]\r
0b6c5954
LG
1609 self._DynamicPcdList.extend(list(UnicodePcdArray))\r
1610 self._DynamicPcdList.extend(list(HiiPcdArray))\r
1611 self._DynamicPcdList.extend(list(OtherPcdArray))\r
ccaa7754 1612 allskuset = [(SkuName, Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName, Sku) in pcd.SkuInfoList.items()]\r
2b8a6c44
LG
1613 for pcd in self._DynamicPcdList:\r
1614 if len(pcd.SkuInfoList) == 1:\r
ccaa7754 1615 for (SkuName, SkuId) in allskuset:\r
1ccc4d89 1616 if type(SkuId) in (str, unicode) and eval(SkuId) == 0 or SkuId == 0:\r
2b8a6c44 1617 continue\r
55c84777 1618 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList[TAB_DEFAULT])\r
65eff519 1619 pcd.SkuInfoList[SkuName].SkuId = SkuId\r
71127ce8 1620 pcd.SkuInfoList[SkuName].SkuIdName = SkuName\r
a0a2cd1e 1621 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
47854fd5 1622\r
ccaa7754 1623 def FixVpdOffset(self, VpdFile ):\r
91fa33ee 1624 FvPath = os.path.join(self.BuildDir, TAB_FV_DIRECTORY)\r
47854fd5
LG
1625 if not os.path.exists(FvPath):\r
1626 try:\r
1627 os.makedirs(FvPath)\r
1628 except:\r
1629 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
1630\r
1631 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1632\r
1633 if VpdFile.Write(VpdFilePath):\r
1634 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1635 BPDGToolName = None\r
1636 for ToolDef in self.ToolDefinition.values():\r
27c4ceb4
GL
1637 if TAB_GUID in ToolDef and ToolDef[TAB_GUID] == self.Platform.VpdToolGuid:\r
1638 if "PATH" not in ToolDef:\r
47854fd5
LG
1639 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1640 BPDGToolName = ToolDef["PATH"]\r
1641 break\r
1642 # Call third party GUID BPDG tool.\r
4231a819 1643 if BPDGToolName is not None:\r
47854fd5
LG
1644 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
1645 else:\r
1646 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.")\r
1647\r
52302d4d 1648 ## Return the platform build data object\r
e6eae3b4
CJ
1649 @cached_property\r
1650 def Platform(self):\r
1651 return self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1652\r
1653 ## Return platform name\r
e6eae3b4
CJ
1654 @cached_property\r
1655 def Name(self):\r
52302d4d
LG
1656 return self.Platform.PlatformName\r
1657\r
1658 ## Return the meta file GUID\r
e6eae3b4
CJ
1659 @cached_property\r
1660 def Guid(self):\r
52302d4d
LG
1661 return self.Platform.Guid\r
1662\r
1663 ## Return the platform version\r
e6eae3b4
CJ
1664 @cached_property\r
1665 def Version(self):\r
52302d4d
LG
1666 return self.Platform.Version\r
1667\r
1668 ## Return the FDF file name\r
e6eae3b4
CJ
1669 @cached_property\r
1670 def FdfFile(self):\r
1671 if self.Workspace.FdfFile:\r
1672 RetVal= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
1673 else:\r
1674 RetVal = ''\r
1675 return RetVal\r
52302d4d
LG
1676\r
1677 ## Return the build output directory platform specifies\r
e6eae3b4
CJ
1678 @cached_property\r
1679 def OutputDir(self):\r
52302d4d
LG
1680 return self.Platform.OutputDirectory\r
1681\r
1682 ## Return the directory to store all intermediate and final files built\r
e6eae3b4
CJ
1683 @cached_property\r
1684 def BuildDir(self):\r
1685 if os.path.isabs(self.OutputDir):\r
1686 GlobalData.gBuildDirectory = RetVal = path.join(\r
1687 path.abspath(self.OutputDir),\r
1688 self.BuildTarget + "_" + self.ToolChain,\r
1689 )\r
1690 else:\r
1691 GlobalData.gBuildDirectory = RetVal = path.join(\r
1692 self.WorkspaceDir,\r
1693 self.OutputDir,\r
1694 self.BuildTarget + "_" + self.ToolChain,\r
1695 )\r
1696 return RetVal\r
52302d4d
LG
1697\r
1698 ## Return directory of platform makefile\r
1699 #\r
1700 # @retval string Makefile directory\r
1701 #\r
e6eae3b4
CJ
1702 @cached_property\r
1703 def MakeFileDir(self):\r
1704 return path.join(self.BuildDir, self.Arch)\r
52302d4d
LG
1705\r
1706 ## Return build command string\r
1707 #\r
1708 # @retval string Build command string\r
1709 #\r
e6eae3b4
CJ
1710 @cached_property\r
1711 def BuildCommand(self):\r
1712 RetVal = []\r
1713 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1714 RetVal += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1715 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1716 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1717 if NewOption != '':\r
1718 RetVal += SplitOption(NewOption)\r
1719 if "MAKE" in self.EdkIIBuildOption:\r
1720 if "FLAGS" in self.EdkIIBuildOption["MAKE"]:\r
1721 Flags = self.EdkIIBuildOption["MAKE"]["FLAGS"]\r
1722 if Flags.startswith('='):\r
1723 RetVal = [RetVal[0]] + [Flags[1:]]\r
1724 else:\r
1725 RetVal.append(Flags)\r
1726 return RetVal\r
52302d4d
LG
1727\r
1728 ## Get tool chain definition\r
1729 #\r
1730 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1731 #\r
e6eae3b4
CJ
1732 @cached_property\r
1733 def ToolDefinition(self):\r
1734 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1735 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1736 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1737 ExtraData="[%s]" % self.MetaFile)\r
1738 RetVal = {}\r
1739 DllPathList = set()\r
1740 for Def in ToolDefinition:\r
1741 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1742 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1743 continue\r
52302d4d 1744\r
e6eae3b4
CJ
1745 Value = ToolDefinition[Def]\r
1746 # don't record the DLL\r
1747 if Attr == "DLL":\r
1748 DllPathList.add(Value)\r
1749 continue\r
52302d4d 1750\r
e6eae3b4
CJ
1751 if Tool not in RetVal:\r
1752 RetVal[Tool] = {}\r
1753 RetVal[Tool][Attr] = Value\r
1754\r
1755 ToolsDef = ''\r
1756 if GlobalData.gOptions.SilentMode and "MAKE" in RetVal:\r
1757 if "FLAGS" not in RetVal["MAKE"]:\r
1758 RetVal["MAKE"]["FLAGS"] = ""\r
1759 RetVal["MAKE"]["FLAGS"] += " -s"\r
1760 MakeFlags = ''\r
1761 for Tool in RetVal:\r
1762 for Attr in RetVal[Tool]:\r
1763 Value = RetVal[Tool][Attr]\r
1764 if Tool in self._BuildOptionWithToolDef(RetVal) and Attr in self._BuildOptionWithToolDef(RetVal)[Tool]:\r
1765 # check if override is indicated\r
1766 if self._BuildOptionWithToolDef(RetVal)[Tool][Attr].startswith('='):\r
1767 Value = self._BuildOptionWithToolDef(RetVal)[Tool][Attr][1:]\r
1768 else:\r
1769 if Attr != 'PATH':\r
1770 Value += " " + self._BuildOptionWithToolDef(RetVal)[Tool][Attr]\r
52302d4d 1771 else:\r
e6eae3b4
CJ
1772 Value = self._BuildOptionWithToolDef(RetVal)[Tool][Attr]\r
1773\r
1774 if Attr == "PATH":\r
1775 # Don't put MAKE definition in the file\r
1776 if Tool != "MAKE":\r
1777 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1778 elif Attr != "DLL":\r
1779 # Don't put MAKE definition in the file\r
1780 if Tool == "MAKE":\r
1781 if Attr == "FLAGS":\r
1782 MakeFlags = Value\r
1783 else:\r
1784 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1785 ToolsDef += "\n"\r
52302d4d 1786\r
e6eae3b4
CJ
1787 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1788 for DllPath in DllPathList:\r
1789 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1790 os.environ["MAKE_FLAGS"] = MakeFlags\r
52302d4d 1791\r
e6eae3b4 1792 return RetVal\r
52302d4d
LG
1793\r
1794 ## Return the paths of tools\r
e6eae3b4
CJ
1795 @cached_property\r
1796 def ToolDefinitionFile(self):\r
1797 return os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
52302d4d
LG
1798\r
1799 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
e6eae3b4
CJ
1800 @cached_property\r
1801 def ToolChainFamily(self):\r
1802 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1803 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
1804 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
1805 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
1806 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1807 % self.ToolChain)\r
1808 RetVal = TAB_COMPILER_MSFT\r
1809 else:\r
1810 RetVal = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
1811 return RetVal\r
1812\r
1813 @cached_property\r
1814 def BuildRuleFamily(self):\r
1815 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1816 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
1817 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
1818 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
1819 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1820 % self.ToolChain)\r
1821 return TAB_COMPILER_MSFT\r
1822\r
1823 return ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
52302d4d
LG
1824\r
1825 ## Return the build options specific for all modules in this platform\r
e6eae3b4
CJ
1826 @cached_property\r
1827 def BuildOption(self):\r
1828 return self._ExpandBuildOption(self.Platform.BuildOptions)\r
1829\r
1830 def _BuildOptionWithToolDef(self, ToolDef):\r
1831 return self._ExpandBuildOption(self.Platform.BuildOptions, ToolDef=ToolDef)\r
52302d4d
LG
1832\r
1833 ## Return the build options specific for EDK modules in this platform\r
e6eae3b4
CJ
1834 @cached_property\r
1835 def EdkBuildOption(self):\r
1836 return self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
52302d4d
LG
1837\r
1838 ## Return the build options specific for EDKII modules in this platform\r
e6eae3b4
CJ
1839 @cached_property\r
1840 def EdkIIBuildOption(self):\r
1841 return self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
52302d4d 1842\r
97fa0ee9 1843 ## Parse build_rule.txt in Conf Directory.\r
52302d4d
LG
1844 #\r
1845 # @retval BuildRule object\r
1846 #\r
e6eae3b4
CJ
1847 @cached_property\r
1848 def BuildRule(self):\r
1849 BuildRuleFile = None\r
1850 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
1851 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
1852 if not BuildRuleFile:\r
1853 BuildRuleFile = gDefaultBuildRuleFile\r
1854 RetVal = BuildRule(BuildRuleFile)\r
1855 if RetVal._FileVersion == "":\r
1856 RetVal._FileVersion = AutoGenReqBuildRuleVerNum\r
1857 else:\r
1858 if RetVal._FileVersion < AutoGenReqBuildRuleVerNum :\r
1859 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
1860 EdkLogger.error("build", AUTOGEN_ERROR,\r
1861 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])"\\r
1862 % (RetVal._FileVersion, AutoGenReqBuildRuleVerNum))\r
1863 return RetVal\r
52302d4d
LG
1864\r
1865 ## Summarize the packages used by modules in this platform\r
e6eae3b4
CJ
1866 @cached_property\r
1867 def PackageList(self):\r
1868 RetVal = set()\r
1869 for La in self.LibraryAutoGenList:\r
1870 RetVal.update(La.DependentPackageList)\r
1871 for Ma in self.ModuleAutoGenList:\r
1872 RetVal.update(Ma.DependentPackageList)\r
1873 #Collect package set information from INF of FDF\r
1874 for ModuleFile in self._AsBuildModuleList:\r
1875 if ModuleFile in self.Platform.Modules:\r
1876 continue\r
1877 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]\r
1878 RetVal.update(ModuleData.Packages)\r
1879 return list(RetVal)\r
52302d4d 1880\r
e6eae3b4
CJ
1881 @cached_property\r
1882 def NonDynamicPcdDict(self):\r
1883 return {(Pcd.TokenCName, Pcd.TokenSpaceGuidCName):Pcd for Pcd in self.NonDynamicPcdList}\r
2bc3256c 1884\r
52302d4d 1885 ## Get list of non-dynamic PCDs\r
e6eae3b4
CJ
1886 @cached_property\r
1887 def NonDynamicPcdList(self):\r
1888 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1889 return self._NonDynamicPcdList\r
1890\r
1891 ## Get list of dynamic PCDs\r
e6eae3b4
CJ
1892 @cached_property\r
1893 def DynamicPcdList(self):\r
1894 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1895 return self._DynamicPcdList\r
1896\r
1897 ## Generate Token Number for all PCD\r
e6eae3b4
CJ
1898 @cached_property\r
1899 def PcdTokenNumber(self):\r
1900 RetVal = OrderedDict()\r
1901 TokenNumber = 1\r
1902 #\r
1903 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.\r
1904 # Such as:\r
1905 #\r
1906 # Dynamic PCD:\r
1907 # TokenNumber 0 ~ 10\r
1908 # DynamicEx PCD:\r
1909 # TokeNumber 11 ~ 20\r
1910 #\r
1911 for Pcd in self.DynamicPcdList:\r
1912 if Pcd.Phase == "PEI" and Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
1913 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1914 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1915 TokenNumber += 1\r
1916\r
1917 for Pcd in self.DynamicPcdList:\r
1918 if Pcd.Phase == "PEI" and Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
1919 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1920 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1921 TokenNumber += 1\r
1922\r
1923 for Pcd in self.DynamicPcdList:\r
1924 if Pcd.Phase == "DXE" and Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
1925 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1926 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1927 TokenNumber += 1\r
1928\r
1929 for Pcd in self.DynamicPcdList:\r
1930 if Pcd.Phase == "DXE" and Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
1931 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1932 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
52302d4d 1933 TokenNumber += 1\r
52302d4d 1934\r
e6eae3b4
CJ
1935 for Pcd in self.NonDynamicPcdList:\r
1936 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1937 TokenNumber += 1\r
1938 return RetVal\r
1939\r
4def57d9
CJ
1940 @cached_property\r
1941 def _MaList(self):\r
1942 for ModuleFile in self.Platform.Modules:\r
1943 Ma = ModuleAutoGen(\r
1944 self.Workspace,\r
1945 ModuleFile,\r
1946 self.BuildTarget,\r
1947 self.ToolChain,\r
1948 self.Arch,\r
1949 self.MetaFile\r
1950 )\r
1951 self.Platform.Modules[ModuleFile].M = Ma\r
1952 return [x.M for x in self.Platform.Modules.values()]\r
1953\r
e6eae3b4
CJ
1954 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
1955 @cached_property\r
1956 def ModuleAutoGenList(self):\r
1957 RetVal = []\r
4def57d9 1958 for Ma in self._MaList:\r
e6eae3b4
CJ
1959 if Ma not in RetVal:\r
1960 RetVal.append(Ma)\r
1961 return RetVal\r
1962\r
1963 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
1964 @cached_property\r
1965 def LibraryAutoGenList(self):\r
1966 RetVal = []\r
4def57d9 1967 for Ma in self._MaList:\r
52302d4d 1968 for La in Ma.LibraryAutoGenList:\r
e6eae3b4
CJ
1969 if La not in RetVal:\r
1970 RetVal.append(La)\r
b23414f6
JC
1971 if Ma not in La.ReferenceModules:\r
1972 La.ReferenceModules.append(Ma)\r
e6eae3b4 1973 return RetVal\r
52302d4d
LG
1974\r
1975 ## Test if a module is supported by the platform\r
1976 #\r
1977 # An error will be raised directly if the module or its arch is not supported\r
1978 # by the platform or current configuration\r
1979 #\r
1980 def ValidModule(self, Module):\r
a0a2cd1e
FB
1981 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \\r
1982 or Module in self._AsBuildModuleList\r
52302d4d
LG
1983\r
1984 ## Resolve the library classes in a module to library instances\r
1985 #\r
1986 # This method will not only resolve library classes but also sort the library\r
1987 # instances according to the dependency-ship.\r
1988 #\r
1989 # @param Module The module from which the library classes will be resolved\r
1990 #\r
1991 # @retval library_list List of library instances sorted\r
1992 #\r
1993 def ApplyLibraryInstance(self, Module):\r
25193a33
YZ
1994 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly\r
1995 if str(Module) not in self.Platform.Modules:\r
1996 return []\r
1997\r
c14b5861
JC
1998 return GetModuleLibInstances(Module,\r
1999 self.Platform,\r
2000 self.BuildDatabase,\r
2001 self.Arch,\r
2002 self.BuildTarget,\r
2003 self.ToolChain,\r
2004 self.MetaFile,\r
2005 EdkLogger)\r
52302d4d
LG
2006\r
2007 ## Override PCD setting (type, value, ...)\r
2008 #\r
2009 # @param ToPcd The PCD to be overrided\r
2010 # @param FromPcd The PCD overrideing from\r
2011 #\r
a253d217 2012 def _OverridePcd(self, ToPcd, FromPcd, Module="", Msg="", Library=""):\r
52302d4d
LG
2013 #\r
2014 # in case there's PCDs coming from FDF file, which have no type given.\r
2015 # at this point, ToPcd.Type has the type found from dependent\r
2016 # package\r
2017 #\r
2a29017e
YZ
2018 TokenCName = ToPcd.TokenCName\r
2019 for PcdItem in GlobalData.MixedPcd:\r
2020 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
2021 TokenCName = PcdItem[0]\r
2022 break\r
4231a819 2023 if FromPcd is not None:\r
c93356ad 2024 if ToPcd.Pending and FromPcd.Type:\r
52302d4d 2025 ToPcd.Type = FromPcd.Type\r
caf74495
JC
2026 elif ToPcd.Type and FromPcd.Type\\r
2027 and ToPcd.Type != FromPcd.Type and ToPcd.Type in FromPcd.Type:\r
6b1f2cf4 2028 if ToPcd.Type.strip() == TAB_PCDS_DYNAMIC_EX:\r
47fea6af 2029 ToPcd.Type = FromPcd.Type\r
c93356ad 2030 elif ToPcd.Type and FromPcd.Type \\r
52302d4d 2031 and ToPcd.Type != FromPcd.Type:\r
a253d217
YF
2032 if Library:\r
2033 Module = str(Module) + " 's library file (" + str(Library) + ")"\r
52302d4d 2034 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
a253d217 2035 ExtraData="%s.%s is used as [%s] in module %s, but as [%s] in %s."\\r
2a29017e 2036 % (ToPcd.TokenSpaceGuidCName, TokenCName,\r
a253d217 2037 ToPcd.Type, Module, FromPcd.Type, Msg),\r
52302d4d
LG
2038 File=self.MetaFile)\r
2039\r
6be94743 2040 if FromPcd.MaxDatumSize:\r
52302d4d 2041 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
c33081c9 2042 ToPcd.MaxSizeUserSet = FromPcd.MaxDatumSize\r
6be94743 2043 if FromPcd.DefaultValue:\r
52302d4d 2044 ToPcd.DefaultValue = FromPcd.DefaultValue\r
6be94743 2045 if FromPcd.TokenValue:\r
52302d4d 2046 ToPcd.TokenValue = FromPcd.TokenValue\r
6be94743 2047 if FromPcd.DatumType:\r
52302d4d 2048 ToPcd.DatumType = FromPcd.DatumType\r
6be94743 2049 if FromPcd.SkuInfoList:\r
52302d4d 2050 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
ced86858
ZZ
2051 if FromPcd.UserDefinedDefaultStoresFlag:\r
2052 ToPcd.UserDefinedDefaultStoresFlag = FromPcd.UserDefinedDefaultStoresFlag\r
726c501c 2053 # Add Flexible PCD format parse\r
726c501c 2054 if ToPcd.DefaultValue:\r
726c501c 2055 try:\r
e6eae3b4 2056 ToPcd.DefaultValue = ValueExpressionEx(ToPcd.DefaultValue, ToPcd.DatumType, self.Workspace._GuidDict)(True)\r
5b0671c1 2057 except BadExpression as Value:\r
726c501c
YZ
2058 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),\r
2059 File=self.MetaFile)\r
52302d4d
LG
2060\r
2061 # check the validation of datum\r
2062 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
2063 if not IsValid:\r
2064 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
2a29017e 2065 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
82a6a960
BF
2066 ToPcd.validateranges = FromPcd.validateranges\r
2067 ToPcd.validlists = FromPcd.validlists\r
2068 ToPcd.expressions = FromPcd.expressions\r
6a147d6d 2069 ToPcd.CustomAttribute = FromPcd.CustomAttribute\r
52302d4d 2070\r
c93356ad 2071 if FromPcd is not None and ToPcd.DatumType == TAB_VOID and not ToPcd.MaxDatumSize:\r
52302d4d 2072 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
2a29017e 2073 % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
52302d4d 2074 Value = ToPcd.DefaultValue\r
c93356ad 2075 if not Value:\r
e8a47801 2076 ToPcd.MaxDatumSize = '1'\r
52302d4d 2077 elif Value[0] == 'L':\r
e8a47801 2078 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
52302d4d
LG
2079 elif Value[0] == '{':\r
2080 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
2081 else:\r
e8a47801 2082 ToPcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2083\r
2084 # apply default SKU for dynamic PCDS if specified one is not available\r
eece4292 2085 if (ToPcd.Type in PCD_DYNAMIC_TYPE_SET or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_SET) \\r
c93356ad 2086 and not ToPcd.SkuInfoList:\r
52302d4d
LG
2087 if self.Platform.SkuName in self.Platform.SkuIds:\r
2088 SkuName = self.Platform.SkuName\r
2089 else:\r
55c84777 2090 SkuName = TAB_DEFAULT\r
52302d4d 2091 ToPcd.SkuInfoList = {\r
8518bf0b 2092 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)\r
52302d4d
LG
2093 }\r
2094\r
2095 ## Apply PCD setting defined platform to a module\r
2096 #\r
2097 # @param Module The module from which the PCD setting will be overrided\r
2098 #\r
2099 # @retval PCD_list The list PCDs with settings from platform\r
2100 #\r
a253d217 2101 def ApplyPcdSetting(self, Module, Pcds, Library=""):\r
52302d4d 2102 # for each PCD in module\r
47fea6af
YZ
2103 for Name, Guid in Pcds:\r
2104 PcdInModule = Pcds[Name, Guid]\r
52302d4d 2105 # find out the PCD setting in platform\r
47fea6af
YZ
2106 if (Name, Guid) in self.Platform.Pcds:\r
2107 PcdInPlatform = self.Platform.Pcds[Name, Guid]\r
52302d4d
LG
2108 else:\r
2109 PcdInPlatform = None\r
2110 # then override the settings if any\r
a253d217 2111 self._OverridePcd(PcdInModule, PcdInPlatform, Module, Msg="DSC PCD sections", Library=Library)\r
52302d4d
LG
2112 # resolve the VariableGuid value\r
2113 for SkuId in PcdInModule.SkuInfoList:\r
2114 Sku = PcdInModule.SkuInfoList[SkuId]\r
2115 if Sku.VariableGuid == '': continue\r
c28d2e10 2116 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)\r
4231a819 2117 if Sku.VariableGuidValue is None:\r
8252e6bf 2118 PackageList = "\n\t".join(str(P) for P in self.PackageList)\r
52302d4d
LG
2119 EdkLogger.error(\r
2120 'build',\r
2121 RESOURCE_NOT_AVAILABLE,\r
2122 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
2123 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
2124 % (Guid, Name, str(Module)),\r
2125 File=self.MetaFile\r
2126 )\r
2127\r
2128 # override PCD settings with module specific setting\r
2129 if Module in self.Platform.Modules:\r
2130 PlatformModule = self.Platform.Modules[str(Module)]\r
2131 for Key in PlatformModule.Pcds:\r
5d54ab94
YZ
2132 if GlobalData.BuildOptionPcd:\r
2133 for pcd in GlobalData.BuildOptionPcd:\r
2134 (TokenSpaceGuidCName, TokenCName, FieldName, pcdvalue, _) = pcd\r
2135 if (TokenCName, TokenSpaceGuidCName) == Key and FieldName =="":\r
2136 PlatformModule.Pcds[Key].DefaultValue = pcdvalue\r
2137 PlatformModule.Pcds[Key].PcdValueFromComm = pcdvalue\r
2138 break\r
aa9aa47e 2139 Flag = False\r
52302d4d 2140 if Key in Pcds:\r
aa9aa47e
YZ
2141 ToPcd = Pcds[Key]\r
2142 Flag = True\r
2143 elif Key in GlobalData.MixedPcd:\r
2144 for PcdItem in GlobalData.MixedPcd[Key]:\r
2145 if PcdItem in Pcds:\r
2146 ToPcd = Pcds[PcdItem]\r
2147 Flag = True\r
2148 break\r
2149 if Flag:\r
a253d217 2150 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module, Msg="DSC Components Module scoped PCD section", Library=Library)\r
cdbf45ad
YZ
2151 # use PCD value to calculate the MaxDatumSize when it is not specified\r
2152 for Name, Guid in Pcds:\r
2153 Pcd = Pcds[Name, Guid]\r
c93356ad 2154 if Pcd.DatumType == TAB_VOID and not Pcd.MaxDatumSize:\r
c33081c9 2155 Pcd.MaxSizeUserSet = None\r
cdbf45ad 2156 Value = Pcd.DefaultValue\r
c93356ad 2157 if not Value:\r
cdbf45ad
YZ
2158 Pcd.MaxDatumSize = '1'\r
2159 elif Value[0] == 'L':\r
2160 Pcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
2161 elif Value[0] == '{':\r
2162 Pcd.MaxDatumSize = str(len(Value.split(',')))\r
2163 else:\r
2164 Pcd.MaxDatumSize = str(len(Value) - 1)\r
1ccc4d89 2165 return Pcds.values()\r
52302d4d
LG
2166\r
2167 ## Resolve library names to library modules\r
2168 #\r
b36d134f 2169 # (for Edk.x modules)\r
52302d4d
LG
2170 #\r
2171 # @param Module The module from which the library names will be resolved\r
2172 #\r
2173 # @retval library_list The list of library modules\r
2174 #\r
2175 def ResolveLibraryReference(self, Module):\r
2176 EdkLogger.verbose("")\r
2177 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2178 LibraryConsumerList = [Module]\r
2179\r
b36d134f 2180 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
2181 if Module.Libraries:\r
2182 Module.Libraries.append("CompilerStub")\r
2183 LibraryList = []\r
2184 while len(LibraryConsumerList) > 0:\r
2185 M = LibraryConsumerList.pop()\r
2186 for LibraryName in M.Libraries:\r
2187 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
4231a819 2188 if Library is None:\r
9eb87141 2189 for Key in self.Platform.LibraryClasses.data:\r
52302d4d
LG
2190 if LibraryName.upper() == Key.upper():\r
2191 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
2192 break\r
4231a819 2193 if Library is None:\r
52302d4d
LG
2194 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
2195 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
2196 continue\r
2197\r
2198 if Library not in LibraryList:\r
2199 LibraryList.append(Library)\r
2200 LibraryConsumerList.append(Library)\r
2201 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
2202 return LibraryList\r
2203\r
6780eef1
LG
2204 ## Calculate the priority value of the build option\r
2205 #\r
2206 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2207 #\r
2208 # @retval Value Priority value based on the priority list.\r
2209 #\r
2210 def CalculatePriorityValue(self, Key):\r
47fea6af
YZ
2211 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
2212 PriorityValue = 0x11111\r
bc39c5cb 2213 if Target == TAB_STAR:\r
6780eef1 2214 PriorityValue &= 0x01111\r
bc39c5cb 2215 if ToolChain == TAB_STAR:\r
6780eef1 2216 PriorityValue &= 0x10111\r
bc39c5cb 2217 if Arch == TAB_STAR:\r
6780eef1 2218 PriorityValue &= 0x11011\r
bc39c5cb 2219 if CommandType == TAB_STAR:\r
6780eef1 2220 PriorityValue &= 0x11101\r
bc39c5cb 2221 if Attr == TAB_STAR:\r
6780eef1 2222 PriorityValue &= 0x11110\r
47fea6af
YZ
2223\r
2224 return self.PrioList["0x%0.5x" % PriorityValue]\r
2225\r
6780eef1 2226\r
52302d4d
LG
2227 ## Expand * in build option key\r
2228 #\r
2229 # @param Options Options to be expanded\r
e6eae3b4
CJ
2230 # @param ToolDef Use specified ToolDef instead of full version.\r
2231 # This is needed during initialization to prevent\r
2232 # infinite recursion betweeh BuildOptions,\r
2233 # ToolDefinition, and this function.\r
52302d4d
LG
2234 #\r
2235 # @retval options Options expanded\r
f7496d71 2236 #\r
e6eae3b4
CJ
2237 def _ExpandBuildOption(self, Options, ModuleStyle=None, ToolDef=None):\r
2238 if not ToolDef:\r
2239 ToolDef = self.ToolDefinition\r
52302d4d
LG
2240 BuildOptions = {}\r
2241 FamilyMatch = False\r
2242 FamilyIsNull = True\r
47fea6af 2243\r
6780eef1
LG
2244 OverrideList = {}\r
2245 #\r
2246 # Construct a list contain the build options which need override.\r
2247 #\r
2248 for Key in Options:\r
2249 #\r
2250 # Key[0] -- tool family\r
2251 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2252 #\r
1ba5124e 2253 if (Key[0] == self.BuildRuleFamily and\r
4231a819 2254 (ModuleStyle is None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):\r
6780eef1 2255 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
bc39c5cb
JC
2256 if (Target == self.BuildTarget or Target == TAB_STAR) and\\r
2257 (ToolChain == self.ToolChain or ToolChain == TAB_STAR) and\\r
2258 (Arch == self.Arch or Arch == TAB_STAR) and\\r
caf74495
JC
2259 Options[Key].startswith("="):\r
2260\r
2261 if OverrideList.get(Key[1]) is not None:\r
2262 OverrideList.pop(Key[1])\r
2263 OverrideList[Key[1]] = Options[Key]\r
f7496d71 2264\r
6780eef1 2265 #\r
f7496d71 2266 # Use the highest priority value.\r
6780eef1
LG
2267 #\r
2268 if (len(OverrideList) >= 2):\r
1ccc4d89 2269 KeyList = OverrideList.keys()\r
6780eef1 2270 for Index in range(len(KeyList)):\r
47fea6af 2271 NowKey = KeyList[Index]\r
6780eef1
LG
2272 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
2273 for Index1 in range(len(KeyList) - Index - 1):\r
2274 NextKey = KeyList[Index1 + Index + 1]\r
2275 #\r
2276 # Compare two Key, if one is included by another, choose the higher priority one\r
f7496d71 2277 #\r
6780eef1 2278 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
bc39c5cb
JC
2279 if (Target1 == Target2 or Target1 == TAB_STAR or Target2 == TAB_STAR) and\\r
2280 (ToolChain1 == ToolChain2 or ToolChain1 == TAB_STAR or ToolChain2 == TAB_STAR) and\\r
2281 (Arch1 == Arch2 or Arch1 == TAB_STAR or Arch2 == TAB_STAR) and\\r
2282 (CommandType1 == CommandType2 or CommandType1 == TAB_STAR or CommandType2 == TAB_STAR) and\\r
2283 (Attr1 == Attr2 or Attr1 == TAB_STAR or Attr2 == TAB_STAR):\r
caf74495
JC
2284\r
2285 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
2286 if Options.get((self.BuildRuleFamily, NextKey)) is not None:\r
2287 Options.pop((self.BuildRuleFamily, NextKey))\r
2288 else:\r
2289 if Options.get((self.BuildRuleFamily, NowKey)) is not None:\r
2290 Options.pop((self.BuildRuleFamily, NowKey))\r
f7496d71 2291\r
52302d4d 2292 for Key in Options:\r
4231a819 2293 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2294 # Check Module style is EDK or EDKII.\r
2295 # Only append build option for the matched style module.\r
2296 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2297 continue\r
2298 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2299 continue\r
2300 Family = Key[0]\r
2301 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2302 # if tool chain family doesn't match, skip it\r
e6eae3b4 2303 if Tool in ToolDef and Family != "":\r
52302d4d 2304 FamilyIsNull = False\r
e6eae3b4
CJ
2305 if ToolDef[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
2306 if Family != ToolDef[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
52302d4d 2307 continue\r
e6eae3b4 2308 elif Family != ToolDef[Tool][TAB_TOD_DEFINES_FAMILY]:\r
52302d4d
LG
2309 continue\r
2310 FamilyMatch = True\r
2311 # expand any wildcard\r
bc39c5cb
JC
2312 if Target == TAB_STAR or Target == self.BuildTarget:\r
2313 if Tag == TAB_STAR or Tag == self.ToolChain:\r
2314 if Arch == TAB_STAR or Arch == self.Arch:\r
52302d4d
LG
2315 if Tool not in BuildOptions:\r
2316 BuildOptions[Tool] = {}\r
5015bee2 2317 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2318 BuildOptions[Tool][Attr] = Options[Key]\r
2319 else:\r
95816356
YZ
2320 # append options for the same tool except PATH\r
2321 if Attr != 'PATH':\r
2322 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2323 else:\r
2324 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2325 # Build Option Family has been checked, which need't to be checked again for family.\r
2326 if FamilyMatch or FamilyIsNull:\r
2327 return BuildOptions\r
1ba5124e 2328\r
52302d4d 2329 for Key in Options:\r
4231a819 2330 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2331 # Check Module style is EDK or EDKII.\r
2332 # Only append build option for the matched style module.\r
2333 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2334 continue\r
2335 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2336 continue\r
2337 Family = Key[0]\r
2338 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2339 # if tool chain family doesn't match, skip it\r
e6eae3b4 2340 if Tool not in ToolDef or Family == "":\r
52302d4d
LG
2341 continue\r
2342 # option has been added before\r
e6eae3b4 2343 if Family != ToolDef[Tool][TAB_TOD_DEFINES_FAMILY]:\r
52302d4d
LG
2344 continue\r
2345\r
2346 # expand any wildcard\r
bc39c5cb
JC
2347 if Target == TAB_STAR or Target == self.BuildTarget:\r
2348 if Tag == TAB_STAR or Tag == self.ToolChain:\r
2349 if Arch == TAB_STAR or Arch == self.Arch:\r
52302d4d
LG
2350 if Tool not in BuildOptions:\r
2351 BuildOptions[Tool] = {}\r
5015bee2 2352 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2353 BuildOptions[Tool][Attr] = Options[Key]\r
2354 else:\r
95816356
YZ
2355 # append options for the same tool except PATH\r
2356 if Attr != 'PATH':\r
2357 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2358 else:\r
2359 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2360 return BuildOptions\r
2361\r
2362 ## Append build options in platform to a module\r
2363 #\r
2364 # @param Module The module to which the build options will be appened\r
2365 #\r
2366 # @retval options The options appended with build options in platform\r
2367 #\r
2368 def ApplyBuildOption(self, Module):\r
2369 # Get the different options for the different style module\r
2370 if Module.AutoGenVersion < 0x00010005:\r
2371 PlatformOptions = self.EdkBuildOption\r
35f69db9 2372 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)\r
52302d4d
LG
2373 else:\r
2374 PlatformOptions = self.EdkIIBuildOption\r
35f69db9
YL
2375 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)\r
2376 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)\r
52302d4d
LG
2377 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
2378 if Module in self.Platform.Modules:\r
2379 PlatformModule = self.Platform.Modules[str(Module)]\r
2380 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
2381 else:\r
2382 PlatformModuleOptions = {}\r
2383\r
fe4bf2f9 2384 BuildRuleOrder = None\r
35f69db9 2385 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
fe4bf2f9
YL
2386 for Tool in Options:\r
2387 for Attr in Options[Tool]:\r
2388 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2389 BuildRuleOrder = Options[Tool][Attr]\r
2390\r
1ccc4d89
LG
2391 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +\r
2392 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +\r
2393 self.ToolDefinition.keys())\r
339fe8dd 2394 BuildOptions = defaultdict(lambda: defaultdict(str))\r
1ccc4d89 2395 for Tool in AllTools:\r
35f69db9 2396 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
52302d4d
LG
2397 if Tool not in Options:\r
2398 continue\r
2399 for Attr in Options[Tool]:\r
fe4bf2f9
YL
2400 #\r
2401 # Do not generate it in Makefile\r
2402 #\r
2403 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2404 continue\r
339fe8dd 2405 Value = Options[Tool][Attr]\r
52302d4d
LG
2406 # check if override is indicated\r
2407 if Value.startswith('='):\r
339fe8dd 2408 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value[1:])\r
5015bee2 2409 else:\r
95816356 2410 if Attr != 'PATH':\r
339fe8dd 2411 BuildOptions[Tool][Attr] += " " + mws.handleWsMacro(Value)\r
95816356 2412 else:\r
339fe8dd
CJ
2413 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value)\r
2414\r
4231a819 2415 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag is not None:\r
f3decdc3
LG
2416 #\r
2417 # Override UNI flag only for EDK module.\r
2418 #\r
f3decdc3 2419 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
fe4bf2f9 2420 return BuildOptions, BuildRuleOrder\r
52302d4d 2421\r
caf74495
JC
2422#\r
2423# extend lists contained in a dictionary with lists stored in another dictionary\r
2424# if CopyToDict is not derived from DefaultDict(list) then this may raise exception\r
2425#\r
2426def ExtendCopyDictionaryLists(CopyToDict, CopyFromDict):\r
2427 for Key in CopyFromDict:\r
2428 CopyToDict[Key].extend(CopyFromDict[Key])\r
2429\r
b23414f6
JC
2430# Create a directory specified by a set of path elements and return the full path\r
2431def _MakeDir(PathList):\r
2432 RetVal = path.join(*PathList)\r
2433 CreateDirectory(RetVal)\r
2434 return RetVal\r
caf74495 2435\r
52302d4d
LG
2436## ModuleAutoGen class\r
2437#\r
2438# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
2439# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
2440# to the [depex] section in module's inf file.\r
2441#\r
2442class ModuleAutoGen(AutoGen):\r
b24e99f7
CJ
2443 # call super().__init__ then call the worker function with different parameter count\r
2444 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b23414f6 2445 if not hasattr(self, "_Init"):\r
1ccc4d89 2446 super(ModuleAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
b24e99f7
CJ
2447 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args)\r
2448 self._Init = True\r
2449\r
b23414f6 2450 ## Cache the timestamps of metafiles of every module in a class attribute\r
c17956e0
DL
2451 #\r
2452 TimeDict = {}\r
2453\r
b24e99f7 2454 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b24e99f7
CJ
2455 # check if this module is employed by active platform\r
2456 if not PlatformAutoGen(Workspace, args[0], Target, Toolchain, Arch).ValidModule(MetaFile):\r
2457 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
2458 % (MetaFile, Arch))\r
2459 return None\r
1ccc4d89 2460 return super(ModuleAutoGen, cls).__new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
f7496d71 2461\r
b24e99f7 2462 ## Initialize ModuleAutoGen\r
52302d4d
LG
2463 #\r
2464 # @param Workspace EdkIIWorkspaceBuild object\r
2465 # @param ModuleFile The path of module file\r
2466 # @param Target Build target (DEBUG, RELEASE)\r
2467 # @param Toolchain Name of tool chain\r
2468 # @param Arch The arch the module supports\r
2469 # @param PlatformFile Platform meta-file\r
2470 #\r
b24e99f7 2471 def _InitWorker(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
52302d4d
LG
2472 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
2473 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
2474\r
2475 self.Workspace = Workspace\r
2476 self.WorkspaceDir = Workspace.WorkspaceDir\r
52302d4d
LG
2477 self.MetaFile = ModuleFile\r
2478 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
52302d4d
LG
2479\r
2480 self.SourceDir = self.MetaFile.SubDir\r
05cc51ad 2481 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)\r
97fa0ee9 2482\r
52302d4d
LG
2483 self.SourceOverrideDir = None\r
2484 # use overrided path defined in DSC file\r
2485 if self.MetaFile.Key in GlobalData.gOverrideDir:\r
2486 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]\r
2487\r
2488 self.ToolChain = Toolchain\r
2489 self.BuildTarget = Target\r
2490 self.Arch = Arch\r
2491 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily\r
2492 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily\r
2493\r
52302d4d 2494 self.IsCodeFileCreated = False\r
da92f276
LG
2495 self.IsAsBuiltInfCreated = False\r
2496 self.DepexGenerated = False\r
52302d4d
LG
2497\r
2498 self.BuildDatabase = self.Workspace.BuildDatabase\r
fe4bf2f9 2499 self.BuildRuleOrder = None\r
1b8eca8b 2500 self.BuildTime = 0\r
52302d4d 2501\r
caf74495 2502 self._PcdComments = OrderedListDict()\r
caf74495 2503 self._GuidComments = OrderedListDict()\r
caf74495 2504 self._ProtocolComments = OrderedListDict()\r
caf74495 2505 self._PpiComments = OrderedListDict()\r
52302d4d
LG
2506 self._BuildTargets = None\r
2507 self._IntroBuildTargetList = None\r
2508 self._FinalBuildTargetList = None\r
2509 self._FileTypes = None\r
c17956e0
DL
2510\r
2511 self.AutoGenDepSet = set()\r
b23414f6 2512 self.ReferenceModules = []\r
2bc3256c 2513 self.ConstPcd = {}\r
52302d4d 2514\r
a10def91 2515\r
52302d4d
LG
2516 def __repr__(self):\r
2517 return "%s [%s]" % (self.MetaFile, self.Arch)\r
2518\r
2bc3256c 2519 # Get FixedAtBuild Pcds of this Module\r
b23414f6
JC
2520 @cached_property\r
2521 def FixedAtBuildPcds(self):\r
2522 RetVal = []\r
2bc3256c 2523 for Pcd in self.ModulePcdList:\r
6b1f2cf4 2524 if Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
2bc3256c 2525 continue\r
b23414f6
JC
2526 if Pcd not in RetVal:\r
2527 RetVal.append(Pcd)\r
2528 return RetVal\r
2529\r
2530 @cached_property\r
2531 def FixedVoidTypePcds(self):\r
2532 RetVal = {}\r
2533 for Pcd in self.FixedAtBuildPcds:\r
2534 if Pcd.DatumType == TAB_VOID:\r
2535 if '{}.{}'.format(Pcd.TokenSpaceGuidCName, Pcd.TokenCName) not in RetVal:\r
2536 RetVal['{}.{}'.format(Pcd.TokenSpaceGuidCName, Pcd.TokenCName)] = Pcd.DefaultValue\r
2537 return RetVal\r
2538\r
2539 @property\r
2540 def UniqueBaseName(self):\r
867d1cd4
YL
2541 BaseName = self.Name\r
2542 for Module in self.PlatformInfo.ModuleAutoGenList:\r
2543 if Module.MetaFile == self.MetaFile:\r
2544 continue\r
2545 if Module.Name == self.Name:\r
867d1cd4
YL
2546 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):\r
2547 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'\r
2548 ' %s\n %s' % (Module.MetaFile, self.MetaFile))\r
2549 BaseName = '%s_%s' % (self.Name, self.Guid)\r
2550 return BaseName\r
2551\r
52302d4d 2552 # Macros could be used in build_rule.txt (also Makefile)\r
b23414f6
JC
2553 @cached_property\r
2554 def Macros(self):\r
2555 return OrderedDict((\r
2556 ("WORKSPACE" ,self.WorkspaceDir),\r
2557 ("MODULE_NAME" ,self.Name),\r
2558 ("MODULE_NAME_GUID" ,self.UniqueBaseName),\r
2559 ("MODULE_GUID" ,self.Guid),\r
2560 ("MODULE_VERSION" ,self.Version),\r
2561 ("MODULE_TYPE" ,self.ModuleType),\r
2562 ("MODULE_FILE" ,str(self.MetaFile)),\r
2563 ("MODULE_FILE_BASE_NAME" ,self.MetaFile.BaseName),\r
2564 ("MODULE_RELATIVE_DIR" ,self.SourceDir),\r
2565 ("MODULE_DIR" ,self.SourceDir),\r
2566 ("BASE_NAME" ,self.Name),\r
2567 ("ARCH" ,self.Arch),\r
2568 ("TOOLCHAIN" ,self.ToolChain),\r
2569 ("TOOLCHAIN_TAG" ,self.ToolChain),\r
2570 ("TOOL_CHAIN_TAG" ,self.ToolChain),\r
2571 ("TARGET" ,self.BuildTarget),\r
2572 ("BUILD_DIR" ,self.PlatformInfo.BuildDir),\r
2573 ("BIN_DIR" ,os.path.join(self.PlatformInfo.BuildDir, self.Arch)),\r
2574 ("LIB_DIR" ,os.path.join(self.PlatformInfo.BuildDir, self.Arch)),\r
2575 ("MODULE_BUILD_DIR" ,self.BuildDir),\r
2576 ("OUTPUT_DIR" ,self.OutputDir),\r
2577 ("DEBUG_DIR" ,self.DebugDir),\r
2578 ("DEST_DIR_OUTPUT" ,self.OutputDir),\r
2579 ("DEST_DIR_DEBUG" ,self.DebugDir),\r
2580 ("PLATFORM_NAME" ,self.PlatformInfo.Name),\r
2581 ("PLATFORM_GUID" ,self.PlatformInfo.Guid),\r
2582 ("PLATFORM_VERSION" ,self.PlatformInfo.Version),\r
2583 ("PLATFORM_RELATIVE_DIR" ,self.PlatformInfo.SourceDir),\r
2584 ("PLATFORM_DIR" ,mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)),\r
2585 ("PLATFORM_OUTPUT_DIR" ,self.PlatformInfo.OutputDir),\r
2586 ("FFS_OUTPUT_DIR" ,self.FfsOutputDir)\r
2587 ))\r
52302d4d
LG
2588\r
2589 ## Return the module build data object\r
b23414f6
JC
2590 @cached_property\r
2591 def Module(self):\r
e6c62ab7 2592 return self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2593\r
2594 ## Return the module name\r
b23414f6
JC
2595 @cached_property\r
2596 def Name(self):\r
52302d4d
LG
2597 return self.Module.BaseName\r
2598\r
b36d134f 2599 ## Return the module DxsFile if exist\r
b23414f6
JC
2600 @cached_property\r
2601 def DxsFile(self):\r
b36d134f
LG
2602 return self.Module.DxsFile\r
2603\r
52302d4d 2604 ## Return the module meta-file GUID\r
b23414f6
JC
2605 @cached_property\r
2606 def Guid(self):\r
97fa0ee9
YL
2607 #\r
2608 # To build same module more than once, the module path with FILE_GUID overridden has\r
2609 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path\r
2610 # in DSC. The overridden GUID can be retrieved from file name\r
2611 #\r
2612 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):\r
2613 #\r
2614 # Length of GUID is 36\r
2615 #\r
2616 return os.path.basename(self.MetaFile.Path)[:36]\r
52302d4d
LG
2617 return self.Module.Guid\r
2618\r
2619 ## Return the module version\r
b23414f6
JC
2620 @cached_property\r
2621 def Version(self):\r
52302d4d
LG
2622 return self.Module.Version\r
2623\r
2624 ## Return the module type\r
b23414f6
JC
2625 @cached_property\r
2626 def ModuleType(self):\r
52302d4d
LG
2627 return self.Module.ModuleType\r
2628\r
b36d134f 2629 ## Return the component type (for Edk.x style of module)\r
b23414f6
JC
2630 @cached_property\r
2631 def ComponentType(self):\r
52302d4d
LG
2632 return self.Module.ComponentType\r
2633\r
2634 ## Return the build type\r
b23414f6
JC
2635 @cached_property\r
2636 def BuildType(self):\r
52302d4d
LG
2637 return self.Module.BuildType\r
2638\r
2639 ## Return the PCD_IS_DRIVER setting\r
b23414f6
JC
2640 @cached_property\r
2641 def PcdIsDriver(self):\r
52302d4d
LG
2642 return self.Module.PcdIsDriver\r
2643\r
2644 ## Return the autogen version, i.e. module meta-file version\r
b23414f6
JC
2645 @cached_property\r
2646 def AutoGenVersion(self):\r
52302d4d
LG
2647 return self.Module.AutoGenVersion\r
2648\r
2649 ## Check if the module is library or not\r
b23414f6
JC
2650 @cached_property\r
2651 def IsLibrary(self):\r
2652 return bool(self.Module.LibraryClass)\r
52302d4d 2653\r
e8a47801 2654 ## Check if the module is binary module or not\r
b23414f6
JC
2655 @cached_property\r
2656 def IsBinaryModule(self):\r
e8a47801
LG
2657 return self.Module.IsBinaryModule\r
2658\r
52302d4d 2659 ## Return the directory to store intermediate files of the module\r
b23414f6
JC
2660 @cached_property\r
2661 def BuildDir(self):\r
2662 return _MakeDir((\r
52302d4d
LG
2663 self.PlatformInfo.BuildDir,\r
2664 self.Arch,\r
2665 self.SourceDir,\r
2666 self.MetaFile.BaseName\r
b23414f6 2667 ))\r
52302d4d
LG
2668\r
2669 ## Return the directory to store the intermediate object files of the mdoule\r
b23414f6
JC
2670 @cached_property\r
2671 def OutputDir(self):\r
2672 return _MakeDir((self.BuildDir, "OUTPUT"))\r
2673\r
2674 ## Return the directory path to store ffs file\r
2675 @cached_property\r
2676 def FfsOutputDir(self):\r
2677 if GlobalData.gFdfParser:\r
2678 return path.join(self.PlatformInfo.BuildDir, TAB_FV_DIRECTORY, "Ffs", self.Guid + self.Name)\r
2679 return ''\r
37de70b7 2680\r
52302d4d 2681 ## Return the directory to store auto-gened source files of the mdoule\r
b23414f6
JC
2682 @cached_property\r
2683 def DebugDir(self):\r
2684 return _MakeDir((self.BuildDir, "DEBUG"))\r
52302d4d
LG
2685\r
2686 ## Return the path of custom file\r
b23414f6
JC
2687 @cached_property\r
2688 def CustomMakefile(self):\r
2689 RetVal = {}\r
2690 for Type in self.Module.CustomMakefile:\r
2691 MakeType = gMakeTypeMap[Type] if Type in gMakeTypeMap else 'nmake'\r
2692 if self.SourceOverrideDir is not None:\r
2693 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])\r
2694 if not os.path.exists(File):\r
52302d4d 2695 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
b23414f6
JC
2696 else:\r
2697 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
2698 RetVal[MakeType] = File\r
2699 return RetVal\r
52302d4d
LG
2700\r
2701 ## Return the directory of the makefile\r
2702 #\r
2703 # @retval string The directory string of module's makefile\r
2704 #\r
b23414f6
JC
2705 @cached_property\r
2706 def MakeFileDir(self):\r
52302d4d
LG
2707 return self.BuildDir\r
2708\r
2709 ## Return build command string\r
2710 #\r
2711 # @retval string Build command string\r
2712 #\r
b23414f6
JC
2713 @cached_property\r
2714 def BuildCommand(self):\r
52302d4d
LG
2715 return self.PlatformInfo.BuildCommand\r
2716\r
2717 ## Get object list of all packages the module and its dependent libraries belong to\r
2718 #\r
2719 # @retval list The list of package object\r
2720 #\r
b23414f6
JC
2721 @cached_property\r
2722 def DerivedPackageList(self):\r
52302d4d
LG
2723 PackageList = []\r
2724 for M in [self.Module] + self.DependentLibraryList:\r
2725 for Package in M.Packages:\r
2726 if Package in PackageList:\r
2727 continue\r
2728 PackageList.append(Package)\r
2729 return PackageList\r
f7496d71 2730\r
97fa0ee9
YL
2731 ## Get the depex string\r
2732 #\r
2733 # @return : a string contain all depex expresion.\r
2734 def _GetDepexExpresionString(self):\r
2735 DepexStr = ''\r
2736 DepexList = []\r
2737 ## DPX_SOURCE IN Define section.\r
2738 if self.Module.DxsFile:\r
2739 return DepexStr\r
2740 for M in [self.Module] + self.DependentLibraryList:\r
2741 Filename = M.MetaFile.Path\r
2742 InfObj = InfSectionParser.InfSectionParser(Filename)\r
2743 DepexExpresionList = InfObj.GetDepexExpresionList()\r
2744 for DepexExpresion in DepexExpresionList:\r
9eb87141 2745 for key in DepexExpresion:\r
97fa0ee9 2746 Arch, ModuleType = key\r
518aebe2 2747 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]\r
97fa0ee9
YL
2748 # the type of build module is USER_DEFINED.\r
2749 # All different DEPEX section tags would be copied into the As Built INF file\r
2750 # and there would be separate DEPEX section tags\r
2751 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
2752 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):\r
518aebe2 2753 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
2754 else:\r
2755 if Arch.upper() == TAB_ARCH_COMMON or \\r
2756 (Arch.upper() == self.Arch.upper() and \\r
2757 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):\r
518aebe2 2758 DepexList.append({(Arch, ModuleType): DepexExpr})\r
f7496d71 2759\r
97fa0ee9
YL
2760 #the type of build module is USER_DEFINED.\r
2761 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
2762 for Depex in DepexList:\r
9eb87141 2763 for key in Depex:\r
97fa0ee9 2764 DepexStr += '[Depex.%s.%s]\n' % key\r
8252e6bf 2765 DepexStr += '\n'.join('# '+ val for val in Depex[key])\r
97fa0ee9
YL
2766 DepexStr += '\n\n'\r
2767 if not DepexStr:\r
2768 return '[Depex.%s]\n' % self.Arch\r
2769 return DepexStr\r
f7496d71 2770\r
97fa0ee9
YL
2771 #the type of build module not is USER_DEFINED.\r
2772 Count = 0\r
2773 for Depex in DepexList:\r
2774 Count += 1\r
2775 if DepexStr != '':\r
2776 DepexStr += ' AND '\r
2777 DepexStr += '('\r
2778 for D in Depex.values():\r
8252e6bf 2779 DepexStr += ' '.join(val for val in D)\r
97fa0ee9
YL
2780 Index = DepexStr.find('END')\r
2781 if Index > -1 and Index == len(DepexStr) - 3:\r
2782 DepexStr = DepexStr[:-3]\r
2783 DepexStr = DepexStr.strip()\r
2784 DepexStr += ')'\r
2785 if Count == 1:\r
2786 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()\r
2787 if not DepexStr:\r
2788 return '[Depex.%s]\n' % self.Arch\r
2789 return '[Depex.%s]\n# ' % self.Arch + DepexStr\r
f7496d71 2790\r
52302d4d
LG
2791 ## Merge dependency expression\r
2792 #\r
2793 # @retval list The token list of the dependency expression after parsed\r
2794 #\r
b23414f6
JC
2795 @cached_property\r
2796 def DepexList(self):\r
2797 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
2798 return {}\r
2799\r
0258ba62
JC
2800 DepexList = []\r
2801 #\r
2802 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2803 #\r
2804 for M in [self.Module] + self.DependentLibraryList:\r
2805 Inherited = False\r
2806 for D in M.Depex[self.Arch, self.ModuleType]:\r
2807 if DepexList != []:\r
2808 DepexList.append('AND')\r
2809 DepexList.append('(')\r
2810 #replace D with value if D is FixedAtBuild PCD\r
2811 NewList = []\r
2812 for item in D:\r
2813 if '.' not in item:\r
2814 NewList.append(item)\r
2815 else:\r
2816 if item not in self._FixedPcdVoidTypeDict:\r
2817 EdkLogger.error("build", FORMAT_INVALID, "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type in the module.".format(item))\r
b23414f6 2818 else:\r
0258ba62
JC
2819 Value = self._FixedPcdVoidTypeDict[item]\r
2820 if len(Value.split(',')) != 16:\r
2821 EdkLogger.error("build", FORMAT_INVALID,\r
2822 "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type and 16 bytes in the module.".format(item))\r
2823 NewList.append(Value)\r
2824 DepexList.extend(NewList)\r
2825 if DepexList[-1] == 'END': # no need of a END at this time\r
2826 DepexList.pop()\r
2827 DepexList.append(')')\r
2828 Inherited = True\r
2829 if Inherited:\r
2830 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))\r
2831 if 'BEFORE' in DepexList or 'AFTER' in DepexList:\r
2832 break\r
2833 if len(DepexList) > 0:\r
2834 EdkLogger.verbose('')\r
2835 return {self.ModuleType:DepexList}\r
52302d4d
LG
2836\r
2837 ## Merge dependency expression\r
2838 #\r
2839 # @retval list The token list of the dependency expression after parsed\r
2840 #\r
b23414f6 2841 @cached_property\r
6cf6fed0 2842 def DepexExpressionDict(self):\r
b23414f6
JC
2843 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
2844 return {}\r
52302d4d 2845\r
0258ba62
JC
2846 DepexExpressionString = ''\r
2847 #\r
2848 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2849 #\r
2850 for M in [self.Module] + self.DependentLibraryList:\r
2851 Inherited = False\r
2852 for D in M.DepexExpression[self.Arch, self.ModuleType]:\r
2853 if DepexExpressionString != '':\r
2854 DepexExpressionString += ' AND '\r
2855 DepexExpressionString += '('\r
2856 DepexExpressionString += D\r
2857 DepexExpressionString = DepexExpressionString.rstrip('END').strip()\r
2858 DepexExpressionString += ')'\r
2859 Inherited = True\r
2860 if Inherited:\r
2861 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionString))\r
2862 if 'BEFORE' in DepexExpressionString or 'AFTER' in DepexExpressionString:\r
2863 break\r
2864 if len(DepexExpressionString) > 0:\r
2865 EdkLogger.verbose('')\r
52302d4d 2866\r
0258ba62 2867 return {self.ModuleType:DepexExpressionString}\r
52302d4d 2868\r
dfa41b4a
YZ
2869 # Get the tiano core user extension, it is contain dependent library.\r
2870 # @retval: a list contain tiano core userextension.\r
2871 #\r
2872 def _GetTianoCoreUserExtensionList(self):\r
2873 TianoCoreUserExtentionList = []\r
2874 for M in [self.Module] + self.DependentLibraryList:\r
2875 Filename = M.MetaFile.Path\r
2876 InfObj = InfSectionParser.InfSectionParser(Filename)\r
2877 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()\r
2878 for TianoCoreUserExtent in TianoCoreUserExtenList:\r
9eb87141 2879 for Section in TianoCoreUserExtent:\r
dfa41b4a
YZ
2880 ItemList = Section.split(TAB_SPLIT)\r
2881 Arch = self.Arch\r
2882 if len(ItemList) == 4:\r
2883 Arch = ItemList[3]\r
2884 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():\r
2885 TianoCoreList = []\r
2886 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])\r
2887 TianoCoreList.extend(TianoCoreUserExtent[Section][:])\r
2888 TianoCoreList.append('\n')\r
2889 TianoCoreUserExtentionList.append(TianoCoreList)\r
2890\r
2891 return TianoCoreUserExtentionList\r
2892\r
52302d4d
LG
2893 ## Return the list of specification version required for the module\r
2894 #\r
2895 # @retval list The list of specification defined in module file\r
2896 #\r
b23414f6
JC
2897 @cached_property\r
2898 def Specification(self):\r
52302d4d
LG
2899 return self.Module.Specification\r
2900\r
2901 ## Tool option for the module build\r
2902 #\r
2903 # @param PlatformInfo The object of PlatformBuildInfo\r
2904 # @retval dict The dict containing valid options\r
2905 #\r
b23414f6
JC
2906 @cached_property\r
2907 def BuildOption(self):\r
2908 RetVal, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)\r
2909 if self.BuildRuleOrder:\r
2910 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]\r
2911 return RetVal\r
52302d4d 2912\r
79b74a03
LG
2913 ## Get include path list from tool option for the module build\r
2914 #\r
2915 # @retval list The include path list\r
2916 #\r
b23414f6
JC
2917 @cached_property\r
2918 def BuildOptionIncPathList(self):\r
2919 #\r
2920 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
2921 # is the former use /I , the Latter used -I to specify include directories\r
2922 #\r
94c04559 2923 if self.PlatformInfo.ToolChainFamily in (TAB_COMPILER_MSFT):\r
b23414f6
JC
2924 BuildOptIncludeRegEx = gBuildOptIncludePatternMsft\r
2925 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):\r
2926 BuildOptIncludeRegEx = gBuildOptIncludePatternOther\r
2927 else:\r
79b74a03 2928 #\r
b23414f6 2929 # New ToolChainFamily, don't known whether there is option to specify include directories\r
79b74a03 2930 #\r
b23414f6 2931 return []\r
f7496d71 2932\r
b23414f6
JC
2933 RetVal = []\r
2934 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):\r
2935 try:\r
2936 FlagOption = self.BuildOption[Tool]['FLAGS']\r
2937 except KeyError:\r
2938 FlagOption = ''\r
d40b2ee6 2939\r
e6c62ab7 2940 if self.ToolChainFamily != 'RVCT':\r
b23414f6
JC
2941 IncPathList = [NormPath(Path, self.Macros) for Path in BuildOptIncludeRegEx.findall(FlagOption)]\r
2942 else:\r
79b74a03 2943 #\r
b23414f6 2944 # RVCT may specify a list of directory seperated by commas\r
79b74a03 2945 #\r
b23414f6
JC
2946 IncPathList = []\r
2947 for Path in BuildOptIncludeRegEx.findall(FlagOption):\r
2948 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)\r
2949 IncPathList.extend(NormPath(PathEntry, self.Macros) for PathEntry in PathList)\r
f7496d71 2950\r
b23414f6
JC
2951 #\r
2952 # EDK II modules must not reference header files outside of the packages they depend on or\r
2953 # within the module's directory tree. Report error if violation.\r
2954 #\r
2955 if self.AutoGenVersion >= 0x00010005:\r
2956 for Path in IncPathList:\r
2957 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):\r
2958 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)\r
2959 EdkLogger.error("build",\r
2960 PARAMETER_INVALID,\r
2961 ExtraData=ErrMsg,\r
2962 File=str(self.MetaFile))\r
2963 RetVal += IncPathList\r
2964 return RetVal\r
f7496d71 2965\r
52302d4d
LG
2966 ## Return a list of files which can be built from source\r
2967 #\r
2968 # What kind of files can be built is determined by build rules in\r
97fa0ee9 2969 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.\r
52302d4d 2970 #\r
b23414f6
JC
2971 @cached_property\r
2972 def SourceFileList(self):\r
2973 RetVal = []\r
bc39c5cb
JC
2974 ToolChainTagSet = {"", TAB_STAR, self.ToolChain}\r
2975 ToolChainFamilySet = {"", TAB_STAR, self.ToolChainFamily, self.BuildRuleFamily}\r
b23414f6
JC
2976 for F in self.Module.Sources:\r
2977 # match tool chain\r
2978 if F.TagName not in ToolChainTagSet:\r
2979 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "\r
2980 "but [%s] is currently used" % (F.TagName, str(F), self.ToolChain))\r
2981 continue\r
2982 # match tool chain family or build rule family\r
2983 if F.ToolChainFamily not in ToolChainFamilySet:\r
2984 EdkLogger.debug(\r
2985 EdkLogger.DEBUG_0,\r
2986 "The file [%s] must be built by tools of [%s], " \\r
2987 "but current toolchain family is [%s], buildrule family is [%s]" \\r
2988 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))\r
2989 continue\r
52302d4d 2990\r
b23414f6
JC
2991 # add the file path into search path list for file including\r
2992 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:\r
2993 self.IncludePathList.insert(0, F.Dir)\r
2994 RetVal.append(F)\r
4cb7bade 2995\r
b23414f6 2996 self._MatchBuildRuleOrder(RetVal)\r
4cb7bade 2997\r
b23414f6
JC
2998 for F in RetVal:\r
2999 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)\r
3000 return RetVal\r
52302d4d 3001\r
4cb7bade
YZ
3002 def _MatchBuildRuleOrder(self, FileList):\r
3003 Order_Dict = {}\r
b23414f6 3004 self.BuildOption\r
4cb7bade
YZ
3005 for SingleFile in FileList:\r
3006 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:\r
3007 key = SingleFile.Path.split(SingleFile.Ext)[0]\r
3008 if key in Order_Dict:\r
3009 Order_Dict[key].append(SingleFile.Ext)\r
3010 else:\r
3011 Order_Dict[key] = [SingleFile.Ext]\r
3012\r
3013 RemoveList = []\r
3014 for F in Order_Dict:\r
3015 if len(Order_Dict[F]) > 1:\r
3016 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))\r
3017 for Ext in Order_Dict[F][1:]:\r
3018 RemoveList.append(F + Ext)\r
f7496d71 3019\r
4cb7bade
YZ
3020 for item in RemoveList:\r
3021 FileList.remove(item)\r
3022\r
3023 return FileList\r
3024\r
52302d4d 3025 ## Return the list of unicode files\r
b23414f6
JC
3026 @cached_property\r
3027 def UnicodeFileList(self):\r
3028 return self.FileTypes.get(TAB_UNICODE_FILE,[])\r
52302d4d 3029\r
5b97eb4c 3030 ## Return the list of vfr files\r
b23414f6
JC
3031 @cached_property\r
3032 def VfrFileList(self):\r
3033 return self.FileTypes.get(TAB_VFR_FILE, [])\r
5b97eb4c 3034\r
333ba578 3035 ## Return the list of Image Definition files\r
b23414f6
JC
3036 @cached_property\r
3037 def IdfFileList(self):\r
3038 return self.FileTypes.get(TAB_IMAGE_FILE,[])\r
333ba578 3039\r
52302d4d
LG
3040 ## Return a list of files which can be built from binary\r
3041 #\r
3042 # "Build" binary files are just to copy them to build directory.\r
3043 #\r
3044 # @retval list The list of files which can be built later\r
3045 #\r
b23414f6
JC
3046 @cached_property\r
3047 def BinaryFileList(self):\r
3048 RetVal = []\r
3049 for F in self.Module.Binaries:\r
bc39c5cb 3050 if F.Target not in [TAB_ARCH_COMMON, TAB_STAR] and F.Target != self.BuildTarget:\r
b23414f6
JC
3051 continue\r
3052 RetVal.append(F)\r
3053 self._ApplyBuildRule(F, F.Type, BinaryFileList=RetVal)\r
3054 return RetVal\r
3055\r
3056 @cached_property\r
3057 def BuildRules(self):\r
3058 RetVal = {}\r
3059 BuildRuleDatabase = self.PlatformInfo.BuildRule\r
3060 for Type in BuildRuleDatabase.FileTypeList:\r
3061 #first try getting build rule by BuildRuleFamily\r
3062 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]\r
3063 if not RuleObject:\r
3064 # build type is always module type, but ...\r
3065 if self.ModuleType != self.BuildType:\r
3066 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]\r
3067 #second try getting build rule by ToolChainFamily\r
3068 if not RuleObject:\r
3069 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]\r
52302d4d
LG
3070 if not RuleObject:\r
3071 # build type is always module type, but ...\r
3072 if self.ModuleType != self.BuildType:\r
b23414f6
JC
3073 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]\r
3074 if not RuleObject:\r
3075 continue\r
3076 RuleObject = RuleObject.Instantiate(self.Macros)\r
3077 RetVal[Type] = RuleObject\r
3078 for Ext in RuleObject.SourceFileExtList:\r
3079 RetVal[Ext] = RuleObject\r
3080 return RetVal\r
3081\r
3082 def _ApplyBuildRule(self, File, FileType, BinaryFileList=None):\r
4231a819 3083 if self._BuildTargets is None:\r
52302d4d
LG
3084 self._IntroBuildTargetList = set()\r
3085 self._FinalBuildTargetList = set()\r
a993dc03
CJ
3086 self._BuildTargets = defaultdict(set)\r
3087 self._FileTypes = defaultdict(set)\r
52302d4d 3088\r
b23414f6
JC
3089 if not BinaryFileList:\r
3090 BinaryFileList = self.BinaryFileList\r
3091\r
fcd4fbf3
YL
3092 SubDirectory = os.path.join(self.OutputDir, File.SubDir)\r
3093 if not os.path.exists(SubDirectory):\r
3094 CreateDirectory(SubDirectory)\r
52302d4d 3095 LastTarget = None\r
caf74495 3096 RuleChain = set()\r
52302d4d
LG
3097 SourceList = [File]\r
3098 Index = 0\r
fe4bf2f9
YL
3099 #\r
3100 # Make sure to get build rule order value\r
3101 #\r
b23414f6 3102 self.BuildOption\r
fe4bf2f9 3103\r
52302d4d
LG
3104 while Index < len(SourceList):\r
3105 Source = SourceList[Index]\r
3106 Index = Index + 1\r
3107\r
3108 if Source != File:\r
3109 CreateDirectory(Source.Dir)\r
3110\r
b23414f6 3111 if File.IsBinary and File == Source and File in BinaryFileList:\r
da92f276
LG
3112 # Skip all files that are not binary libraries\r
3113 if not self.IsLibrary:\r
47fea6af 3114 continue\r
52302d4d
LG
3115 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]\r
3116 elif FileType in self.BuildRules:\r
3117 RuleObject = self.BuildRules[FileType]\r
3118 elif Source.Ext in self.BuildRules:\r
3119 RuleObject = self.BuildRules[Source.Ext]\r
3120 else:\r
3121 # stop at no more rules\r
3122 if LastTarget:\r
3123 self._FinalBuildTargetList.add(LastTarget)\r
3124 break\r
3125\r
3126 FileType = RuleObject.SourceFileType\r
52302d4d
LG
3127 self._FileTypes[FileType].add(Source)\r
3128\r
3129 # stop at STATIC_LIBRARY for library\r
3130 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:\r
3131 if LastTarget:\r
3132 self._FinalBuildTargetList.add(LastTarget)\r
3133 break\r
3134\r
fe4bf2f9 3135 Target = RuleObject.Apply(Source, self.BuildRuleOrder)\r
52302d4d
LG
3136 if not Target:\r
3137 if LastTarget:\r
3138 self._FinalBuildTargetList.add(LastTarget)\r
3139 break\r
3140 elif not Target.Outputs:\r
3141 # Only do build for target with outputs\r
3142 self._FinalBuildTargetList.add(Target)\r
3143\r
52302d4d
LG
3144 self._BuildTargets[FileType].add(Target)\r
3145\r
3146 if not Source.IsBinary and Source == File:\r
3147 self._IntroBuildTargetList.add(Target)\r
3148\r
3149 # to avoid cyclic rule\r
3150 if FileType in RuleChain:\r
3151 break\r
3152\r
caf74495 3153 RuleChain.add(FileType)\r
52302d4d
LG
3154 SourceList.extend(Target.Outputs)\r
3155 LastTarget = Target\r
3156 FileType = TAB_UNKNOWN_FILE\r
3157\r
b23414f6
JC
3158 @cached_property\r
3159 def Targets(self):\r
4231a819 3160 if self._BuildTargets is None:\r
52302d4d
LG
3161 self._IntroBuildTargetList = set()\r
3162 self._FinalBuildTargetList = set()\r
a993dc03
CJ
3163 self._BuildTargets = defaultdict(set)\r
3164 self._FileTypes = defaultdict(set)\r
52302d4d 3165\r
b23414f6
JC
3166 #TRICK: call SourceFileList property to apply build rule for source files\r
3167 self.SourceFileList\r
52302d4d
LG
3168\r
3169 #TRICK: call _GetBinaryFileList to apply build rule for binary files\r
b23414f6 3170 self.BinaryFileList\r
52302d4d
LG
3171\r
3172 return self._BuildTargets\r
3173\r
b23414f6
JC
3174 @cached_property\r
3175 def IntroTargetList(self):\r
3176 self.Targets\r
1ccc4d89 3177 return self._IntroBuildTargetList\r
52302d4d 3178\r
b23414f6
JC
3179 @cached_property\r
3180 def CodaTargetList(self):\r
3181 self.Targets\r
1ccc4d89 3182 return self._FinalBuildTargetList\r
52302d4d 3183\r
b23414f6
JC
3184 @cached_property\r
3185 def FileTypes(self):\r
3186 self.Targets\r
52302d4d
LG
3187 return self._FileTypes\r
3188\r
3189 ## Get the list of package object the module depends on\r
3190 #\r
3191 # @retval list The package object list\r
3192 #\r
b23414f6
JC
3193 @cached_property\r
3194 def DependentPackageList(self):\r
52302d4d
LG
3195 return self.Module.Packages\r
3196\r
3197 ## Return the list of auto-generated code file\r
3198 #\r
3199 # @retval list The list of auto-generated file\r
3200 #\r
b23414f6
JC
3201 @cached_property\r
3202 def AutoGenFileList(self):\r
3203 AutoGenUniIdf = self.BuildType != 'UEFI_HII'\r
86379ac4
GL
3204 UniStringBinBuffer = BytesIO()\r
3205 IdfGenBinBuffer = BytesIO()\r
b23414f6
JC
3206 RetVal = {}\r
3207 AutoGenC = TemplateString()\r
3208 AutoGenH = TemplateString()\r
3209 StringH = TemplateString()\r
3210 StringIdf = TemplateString()\r
3211 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, AutoGenUniIdf, UniStringBinBuffer, StringIdf, AutoGenUniIdf, IdfGenBinBuffer)\r
3212 #\r
3213 # AutoGen.c is generated if there are library classes in inf, or there are object files\r
3214 #\r
3215 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0\r
3216 or TAB_OBJECT_FILE in self.FileTypes):\r
3217 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)\r
3218 RetVal[AutoFile] = str(AutoGenC)\r
3219 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3220 if str(AutoGenH) != "":\r
3221 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)\r
3222 RetVal[AutoFile] = str(AutoGenH)\r
3223 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3224 if str(StringH) != "":\r
3225 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)\r
3226 RetVal[AutoFile] = str(StringH)\r
3227 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
1ccc4d89 3228 if UniStringBinBuffer is not None and UniStringBinBuffer.getvalue() != "":\r
b23414f6
JC
3229 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)\r
3230 RetVal[AutoFile] = UniStringBinBuffer.getvalue()\r
3231 AutoFile.IsBinary = True\r
3232 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3233 if UniStringBinBuffer is not None:\r
3234 UniStringBinBuffer.close()\r
3235 if str(StringIdf) != "":\r
3236 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)\r
3237 RetVal[AutoFile] = str(StringIdf)\r
3238 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
1ccc4d89 3239 if IdfGenBinBuffer is not None and IdfGenBinBuffer.getvalue() != "":\r
b23414f6
JC
3240 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)\r
3241 RetVal[AutoFile] = IdfGenBinBuffer.getvalue()\r
3242 AutoFile.IsBinary = True\r
3243 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3244 if IdfGenBinBuffer is not None:\r
3245 IdfGenBinBuffer.close()\r
3246 return RetVal\r
52302d4d
LG
3247\r
3248 ## Return the list of library modules explicitly or implicityly used by this module\r
b23414f6
JC
3249 @cached_property\r
3250 def DependentLibraryList(self):\r
3251 # only merge library classes and PCD for non-library module\r
3252 if self.IsLibrary:\r
3253 return []\r
3254 if self.AutoGenVersion < 0x00010005:\r
3255 return self.PlatformInfo.ResolveLibraryReference(self.Module)\r
3256 return self.PlatformInfo.ApplyLibraryInstance(self.Module)\r
52302d4d
LG
3257\r
3258 ## Get the list of PCDs from current module\r
3259 #\r
3260 # @retval list The list of PCD\r
3261 #\r
b23414f6
JC
3262 @cached_property\r
3263 def ModulePcdList(self):\r
3264 # apply PCD settings from platform\r
3265 RetVal = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)\r
3266 ExtendCopyDictionaryLists(self._PcdComments, self.Module.PcdComments)\r
3267 return RetVal\r
52302d4d
LG
3268\r
3269 ## Get the list of PCDs from dependent libraries\r
3270 #\r
3271 # @retval list The list of PCD\r
3272 #\r
b23414f6
JC
3273 @cached_property\r
3274 def LibraryPcdList(self):\r
3275 if self.IsLibrary:\r
3276 return []\r
3277 RetVal = []\r
3278 Pcds = set()\r
3279 # get PCDs from dependent libraries\r
3280 for Library in self.DependentLibraryList:\r
3281 PcdsInLibrary = OrderedDict()\r
3282 ExtendCopyDictionaryLists(self._PcdComments, Library.PcdComments)\r
3283 for Key in Library.Pcds:\r
3284 # skip duplicated PCDs\r
3285 if Key in self.Module.Pcds or Key in Pcds:\r
3286 continue\r
3287 Pcds.add(Key)\r
3288 PcdsInLibrary[Key] = copy.copy(Library.Pcds[Key])\r
3289 RetVal.extend(self.PlatformInfo.ApplyPcdSetting(self.Module, PcdsInLibrary, Library=Library))\r
3290 return RetVal\r
52302d4d
LG
3291\r
3292 ## Get the GUID value mapping\r
3293 #\r
3294 # @retval dict The mapping between GUID cname and its value\r
3295 #\r
b23414f6
JC
3296 @cached_property\r
3297 def GuidList(self):\r
3298 RetVal = OrderedDict(self.Module.Guids)\r
3299 for Library in self.DependentLibraryList:\r
3300 RetVal.update(Library.Guids)\r
3301 ExtendCopyDictionaryLists(self._GuidComments, Library.GuidComments)\r
3302 ExtendCopyDictionaryLists(self._GuidComments, self.Module.GuidComments)\r
3303 return RetVal\r
3304\r
3305 @cached_property\r
e8a47801 3306 def GetGuidsUsedByPcd(self):\r
b23414f6
JC
3307 RetVal = OrderedDict(self.Module.GetGuidsUsedByPcd())\r
3308 for Library in self.DependentLibraryList:\r
3309 RetVal.update(Library.GetGuidsUsedByPcd())\r
3310 return RetVal\r
52302d4d
LG
3311 ## Get the protocol value mapping\r
3312 #\r
3313 # @retval dict The mapping between protocol cname and its value\r
3314 #\r
b23414f6
JC
3315 @cached_property\r
3316 def ProtocolList(self):\r
3317 RetVal = OrderedDict(self.Module.Protocols)\r
3318 for Library in self.DependentLibraryList:\r
3319 RetVal.update(Library.Protocols)\r
3320 ExtendCopyDictionaryLists(self._ProtocolComments, Library.ProtocolComments)\r
3321 ExtendCopyDictionaryLists(self._ProtocolComments, self.Module.ProtocolComments)\r
3322 return RetVal\r
52302d4d
LG
3323\r
3324 ## Get the PPI value mapping\r
3325 #\r
3326 # @retval dict The mapping between PPI cname and its value\r
3327 #\r
b23414f6
JC
3328 @cached_property\r
3329 def PpiList(self):\r
3330 RetVal = OrderedDict(self.Module.Ppis)\r
3331 for Library in self.DependentLibraryList:\r
3332 RetVal.update(Library.Ppis)\r
3333 ExtendCopyDictionaryLists(self._PpiComments, Library.PpiComments)\r
3334 ExtendCopyDictionaryLists(self._PpiComments, self.Module.PpiComments)\r
3335 return RetVal\r
52302d4d
LG
3336\r
3337 ## Get the list of include search path\r
3338 #\r
3339 # @retval list The list path\r
3340 #\r
b23414f6
JC
3341 @cached_property\r
3342 def IncludePathList(self):\r
3343 RetVal = []\r
3344 if self.AutoGenVersion < 0x00010005:\r
3345 for Inc in self.Module.Includes:\r
3346 if Inc not in RetVal:\r
3347 RetVal.append(Inc)\r
3348 # for Edk modules\r
3349 Inc = path.join(Inc, self.Arch.capitalize())\r
3350 if os.path.exists(Inc) and Inc not in RetVal:\r
3351 RetVal.append(Inc)\r
3352 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time\r
3353 RetVal.append(self.DebugDir)\r
3354 else:\r
3355 RetVal.append(self.MetaFile.Dir)\r
3356 RetVal.append(self.DebugDir)\r
3357\r
3358 for Package in self.Module.Packages:\r
3359 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)\r
3360 if PackageDir not in RetVal:\r
3361 RetVal.append(PackageDir)\r
3362 IncludesList = Package.Includes\r
3363 if Package._PrivateIncludes:\r
3364 if not self.MetaFile.Path.startswith(PackageDir):\r
3365 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))\r
3366 for Inc in IncludesList:\r
3367 if Inc not in RetVal:\r
3368 RetVal.append(str(Inc))\r
3369 return RetVal\r
3370\r
3371 @cached_property\r
3372 def IncludePathLength(self):\r
3373 return sum(len(inc)+1 for inc in self.IncludePathList)\r
725cdb8f 3374\r
97fa0ee9
YL
3375 ## Get HII EX PCDs which maybe used by VFR\r
3376 #\r
3377 # efivarstore used by VFR may relate with HII EX PCDs\r
3378 # Get the variable name and GUID from efivarstore and HII EX PCD\r
3379 # List the HII EX PCDs in As Built INF if both name and GUID match.\r
3380 #\r
3381 # @retval list HII EX PCDs\r
3382 #\r
3383 def _GetPcdsMaybeUsedByVfr(self):\r
3384 if not self.SourceFileList:\r
3385 return []\r
3386\r
29189291 3387 NameGuids = set()\r
97fa0ee9
YL
3388 for SrcFile in self.SourceFileList:\r
3389 if SrcFile.Ext.lower() != '.vfr':\r
3390 continue\r
3391 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')\r
3392 if not os.path.exists(Vfri):\r
3393 continue\r
3394 VfriFile = open(Vfri, 'r')\r
3395 Content = VfriFile.read()\r
3396 VfriFile.close()\r
3397 Pos = Content.find('efivarstore')\r
3398 while Pos != -1:\r
3399 #\r
3400 # Make sure 'efivarstore' is the start of efivarstore statement\r
3401 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'\r
3402 #\r
3403 Index = Pos - 1\r
3404 while Index >= 0 and Content[Index] in ' \t\r\n':\r
3405 Index -= 1\r
3406 if Index >= 0 and Content[Index] != ';':\r
3407 Pos = Content.find('efivarstore', Pos + len('efivarstore'))\r
3408 continue\r
3409 #\r
3410 # 'efivarstore' must be followed by name and guid\r
3411 #\r
3412 Name = gEfiVarStoreNamePattern.search(Content, Pos)\r
3413 if not Name:\r
3414 break\r
3415 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)\r
3416 if not Guid:\r
3417 break\r
3418 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')\r
29189291 3419 NameGuids.add((NameArray, GuidStructureStringToGuidString(Guid.group(1))))\r
97fa0ee9
YL
3420 Pos = Content.find('efivarstore', Name.end())\r
3421 if not NameGuids:\r
3422 return []\r
3423 HiiExPcds = []\r
3424 for Pcd in self.PlatformInfo.Platform.Pcds.values():\r
3425 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:\r
3426 continue\r
caf74495 3427 for SkuInfo in Pcd.SkuInfoList.values():\r
c28d2e10 3428 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)\r
97fa0ee9
YL
3429 if not Value:\r
3430 continue\r
caf74495 3431 Name = ConvertStringToByteArray(SkuInfo.VariableName)\r
97fa0ee9
YL
3432 Guid = GuidStructureStringToGuidString(Value)\r
3433 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:\r
3434 HiiExPcds.append(Pcd)\r
3435 break\r
3436\r
3437 return HiiExPcds\r
3438\r
aeaaf754
YL
3439 def _GenOffsetBin(self):\r
3440 VfrUniBaseName = {}\r
3441 for SourceFile in self.Module.Sources:\r
3442 if SourceFile.Type.upper() == ".VFR" :\r
3443 #\r
f7496d71 3444 # search the .map file to find the offset of vfr binary in the PE32+/TE file.\r
aeaaf754
YL
3445 #\r
3446 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")\r
caf74495 3447 elif SourceFile.Type.upper() == ".UNI" :\r
aeaaf754 3448 #\r
f7496d71 3449 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.\r
aeaaf754
YL
3450 #\r
3451 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")\r
3452\r
caf74495 3453 if not VfrUniBaseName:\r
aeaaf754
YL
3454 return None\r
3455 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")\r
3456 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")\r
1ccc4d89 3457 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())\r
aeaaf754
YL
3458 if not VfrUniOffsetList:\r
3459 return None\r
3460\r
3461 OutputName = '%sOffset.bin' % self.Name\r
3462 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)\r
3463\r
3464 try:\r
3465 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)\r
3466 except:\r
ccaa7754 3467 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName, None)\r
aeaaf754 3468\r
86379ac4 3469 # Use a instance of BytesIO to cache data\r
1ccc4d89 3470 fStringIO = BytesIO('')\r
aeaaf754
YL
3471\r
3472 for Item in VfrUniOffsetList:\r
3473 if (Item[0].find("Strings") != -1):\r
3474 #\r
3475 # UNI offset in image.\r
3476 # GUID + Offset\r
3477 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
3478 #\r
3479 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]\r
1ccc4d89
LG
3480 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]\r
3481 fStringIO.write(''.join(UniGuid))\r
aeaaf754
YL
3482 UniValue = pack ('Q', int (Item[1], 16))\r
3483 fStringIO.write (UniValue)\r
3484 else:\r
3485 #\r
3486 # VFR binary offset in image.\r
3487 # GUID + Offset\r
3488 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };\r
3489 #\r
3490 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]\r
1ccc4d89
LG
3491 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]\r
3492 fStringIO.write(''.join(VfrGuid))\r
aeaaf754
YL
3493 VfrValue = pack ('Q', int (Item[1], 16))\r
3494 fStringIO.write (VfrValue)\r
3495 #\r
3496 # write data into file.\r
3497 #\r
f7496d71 3498 try :\r
aeaaf754
YL
3499 fInputfile.write (fStringIO.getvalue())\r
3500 except:\r
3501 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "\r
ccaa7754 3502 "file been locked or using by other applications." %UniVfrOffsetFileName, None)\r
aeaaf754
YL
3503\r
3504 fStringIO.close ()\r
3505 fInputfile.close ()\r
3506 return OutputName\r
3507\r
da92f276
LG
3508 ## Create AsBuilt INF file the module\r
3509 #\r
83397f95 3510 def CreateAsBuiltInf(self, IsOnlyCopy = False):\r
ac55e478 3511 self.OutputFile = set()\r
caf74495
JC
3512 if IsOnlyCopy and GlobalData.gBinCacheDest:\r
3513 self.CopyModuleToCache()\r
3514 return\r
83397f95 3515\r
da92f276
LG
3516 if self.IsAsBuiltInfCreated:\r
3517 return\r
f7496d71 3518\r
da92f276
LG
3519 # Skip the following code for EDK I inf\r
3520 if self.AutoGenVersion < 0x00010005:\r
3521 return\r
f7496d71 3522\r
da92f276
LG
3523 # Skip the following code for libraries\r
3524 if self.IsLibrary:\r
3525 return\r
f7496d71 3526\r
da92f276 3527 # Skip the following code for modules with no source files\r
6be94743 3528 if not self.SourceFileList:\r
da92f276
LG
3529 return\r
3530\r
3531 # Skip the following code for modules without any binary files\r
40857777 3532 if self.BinaryFileList:\r
da92f276 3533 return\r
f7496d71 3534\r
da92f276
LG
3535 ### TODO: How to handles mixed source and binary modules\r
3536\r
e8a47801 3537 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries\r
da92f276
LG
3538 # Also find all packages that the DynamicEx PCDs depend on\r
3539 Pcds = []\r
e5cf9198 3540 PatchablePcds = []\r
47fea6af 3541 Packages = []\r
e8a47801
LG
3542 PcdCheckList = []\r
3543 PcdTokenSpaceList = []\r
1ccc4d89 3544 for Pcd in self.ModulePcdList + self.LibraryPcdList:\r
e8a47801 3545 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
caf74495 3546 PatchablePcds.append(Pcd)\r
6b1f2cf4 3547 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_PATCHABLE_IN_MODULE))\r
eece4292 3548 elif Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
e8a47801 3549 if Pcd not in Pcds:\r
caf74495 3550 Pcds.append(Pcd)\r
6b1f2cf4
CJ
3551 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC_EX))\r
3552 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC))\r
e8a47801 3553 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)\r
b23414f6
JC
3554 GuidList = OrderedDict(self.GuidList)\r
3555 for TokenSpace in self.GetGuidsUsedByPcd:\r
e8a47801
LG
3556 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list\r
3557 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs\r
3558 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:\r
3559 GuidList.pop(TokenSpace)\r
3560 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)\r
3561 for Package in self.DerivedPackageList:\r
3562 if Package in Packages:\r
3563 continue\r
3564 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)\r
3565 Found = False\r
3566 for Index in range(len(BeChecked)):\r
3567 for Item in CheckList[Index]:\r
3568 if Item in BeChecked[Index]:\r
caf74495 3569 Packages.append(Package)\r
e8a47801
LG
3570 Found = True\r
3571 break\r
caf74495
JC
3572 if Found:\r
3573 break\r
da92f276 3574\r
97fa0ee9
YL
3575 VfrPcds = self._GetPcdsMaybeUsedByVfr()\r
3576 for Pkg in self.PlatformInfo.PackageList:\r
3577 if Pkg in Packages:\r
3578 continue\r
3579 for VfrPcd in VfrPcds:\r
6b1f2cf4
CJ
3580 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC_EX) in Pkg.Pcds or\r
3581 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC) in Pkg.Pcds):\r
caf74495 3582 Packages.append(Pkg)\r
97fa0ee9
YL
3583 break\r
3584\r
caf74495
JC
3585 ModuleType = SUP_MODULE_DXE_DRIVER if self.ModuleType == SUP_MODULE_UEFI_DRIVER and self.DepexGenerated else self.ModuleType\r
3586 DriverType = self.PcdIsDriver if self.PcdIsDriver else ''\r
97fa0ee9
YL
3587 Guid = self.Guid\r
3588 MDefs = self.Module.Defines\r
3589\r
da92f276
LG
3590 AsBuiltInfDict = {\r
3591 'module_name' : self.Name,\r
97fa0ee9 3592 'module_guid' : Guid,\r
da92f276 3593 'module_module_type' : ModuleType,\r
97fa0ee9 3594 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],\r
e8a47801 3595 'pcd_is_driver_string' : [],\r
da92f276
LG
3596 'module_uefi_specification_version' : [],\r
3597 'module_pi_specification_version' : [],\r
97fa0ee9
YL
3598 'module_entry_point' : self.Module.ModuleEntryPointList,\r
3599 'module_unload_image' : self.Module.ModuleUnloadImageList,\r
3600 'module_constructor' : self.Module.ConstructorList,\r
3601 'module_destructor' : self.Module.DestructorList,\r
3602 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],\r
3603 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],\r
3604 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],\r
3605 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],\r
3606 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],\r
3607 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],\r
3608 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],\r
3609 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],\r
3610 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],\r
da92f276 3611 'module_arch' : self.Arch,\r
caf74495 3612 'package_item' : [Package.MetaFile.File.replace('\\', '/') for Package in Packages],\r
da92f276 3613 'binary_item' : [],\r
e8a47801 3614 'patchablepcd_item' : [],\r
da92f276 3615 'pcd_item' : [],\r
e8a47801
LG
3616 'protocol_item' : [],\r
3617 'ppi_item' : [],\r
3618 'guid_item' : [],\r
3619 'flags_item' : [],\r
3620 'libraryclasses_item' : []\r
da92f276 3621 }\r
97fa0ee9 3622\r
78bcd52a
YZ
3623 if 'MODULE_UNI_FILE' in MDefs:\r
3624 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])\r
3625 if os.path.isfile(UNIFile):\r
3626 shutil.copy2(UNIFile, self.OutputDir)\r
3627\r
97fa0ee9
YL
3628 if self.AutoGenVersion > int(gInfSpecVersion, 0):\r
3629 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion\r
3630 else:\r
3631 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion\r
3632\r
e8a47801 3633 if DriverType:\r
caf74495 3634 AsBuiltInfDict['pcd_is_driver_string'].append(DriverType)\r
da92f276
LG
3635\r
3636 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:\r
caf74495 3637 AsBuiltInfDict['module_uefi_specification_version'].append(self.Specification['UEFI_SPECIFICATION_VERSION'])\r
da92f276 3638 if 'PI_SPECIFICATION_VERSION' in self.Specification:\r
caf74495 3639 AsBuiltInfDict['module_pi_specification_version'].append(self.Specification['PI_SPECIFICATION_VERSION'])\r
da92f276 3640\r
47fea6af 3641 OutputDir = self.OutputDir.replace('\\', '/').strip('/')\r
c7c5a6c4 3642 DebugDir = self.DebugDir.replace('\\', '/').strip('/')\r
481252bb 3643 for Item in self.CodaTargetList:\r
90456c3c 3644 File = Item.Target.Path.replace('\\', '/').strip('/').replace(DebugDir, '').replace(OutputDir, '').strip('/')\r
ac55e478 3645 self.OutputFile.add(File)\r
5e2c0ecd
YZ
3646 if os.path.isabs(File):\r
3647 File = File.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')\r
47fea6af 3648 if Item.Target.Ext.lower() == '.aml':\r
caf74495 3649 AsBuiltInfDict['binary_item'].append('ASL|' + File)\r
47fea6af 3650 elif Item.Target.Ext.lower() == '.acpi':\r
caf74495 3651 AsBuiltInfDict['binary_item'].append('ACPI|' + File)\r
481252bb 3652 elif Item.Target.Ext.lower() == '.efi':\r
caf74495 3653 AsBuiltInfDict['binary_item'].append('PE32|' + self.Name + '.efi')\r
da92f276 3654 else:\r
caf74495 3655 AsBuiltInfDict['binary_item'].append('BIN|' + File)\r
04aa423c
YF
3656 if not self.DepexGenerated:\r
3657 DepexFile = os.path.join(self.OutputDir, self.Name + '.depex')\r
3658 if os.path.exists(DepexFile):\r
3659 self.DepexGenerated = True\r
481252bb 3660 if self.DepexGenerated:\r
ac55e478 3661 self.OutputFile.add(self.Name + '.depex')\r
8bb63e37 3662 if self.ModuleType in [SUP_MODULE_PEIM]:\r
caf74495
JC
3663 AsBuiltInfDict['binary_item'].append('PEI_DEPEX|' + self.Name + '.depex')\r
3664 elif self.ModuleType in [SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER]:\r
3665 AsBuiltInfDict['binary_item'].append('DXE_DEPEX|' + self.Name + '.depex')\r
3666 elif self.ModuleType in [SUP_MODULE_DXE_SMM_DRIVER]:\r
3667 AsBuiltInfDict['binary_item'].append('SMM_DEPEX|' + self.Name + '.depex')\r
da92f276 3668\r
aeaaf754
YL
3669 Bin = self._GenOffsetBin()\r
3670 if Bin:\r
caf74495 3671 AsBuiltInfDict['binary_item'].append('BIN|%s' % Bin)\r
ac55e478 3672 self.OutputFile.add(Bin)\r
aeaaf754 3673\r
e8a47801
LG
3674 for Root, Dirs, Files in os.walk(OutputDir):\r
3675 for File in Files:\r
3676 if File.lower().endswith('.pdb'):\r
caf74495 3677 AsBuiltInfDict['binary_item'].append('DISPOSABLE|' + File)\r
ac55e478 3678 self.OutputFile.add(File)\r
e8a47801
LG
3679 HeaderComments = self.Module.HeaderComments\r
3680 StartPos = 0\r
3681 for Index in range(len(HeaderComments)):\r
3682 if HeaderComments[Index].find('@BinaryHeader') != -1:\r
3683 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')\r
3684 StartPos = Index\r
3685 break\r
3686 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')\r
97fa0ee9
YL
3687 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)\r
3688\r
e8a47801
LG
3689 GenList = [\r
3690 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),\r
3691 (self.PpiList, self._PpiComments, 'ppi_item'),\r
3692 (GuidList, self._GuidComments, 'guid_item')\r
3693 ]\r
3694 for Item in GenList:\r
3695 for CName in Item[0]:\r
caf74495
JC
3696 Comments = '\n '.join(Item[1][CName]) if CName in Item[1] else ''\r
3697 Entry = Comments + '\n ' + CName if Comments else CName\r
e8a47801
LG
3698 AsBuiltInfDict[Item[2]].append(Entry)\r
3699 PatchList = parsePcdInfoFromMapFile(\r
3700 os.path.join(self.OutputDir, self.Name + '.map'),\r
3701 os.path.join(self.OutputDir, self.Name + '.efi')\r
3702 )\r
3703 if PatchList:\r
e5cf9198
YZ
3704 for Pcd in PatchablePcds:\r
3705 TokenCName = Pcd.TokenCName\r
3706 for PcdItem in GlobalData.MixedPcd:\r
3707 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
3708 TokenCName = PcdItem[0]\r
3709 break\r
3710 for PatchPcd in PatchList:\r
3711 if TokenCName == PatchPcd[0]:\r
3712 break\r
2a29017e 3713 else:\r
e8a47801 3714 continue\r
e8a47801 3715 PcdValue = ''\r
7ced8bb4
YZ
3716 if Pcd.DatumType == 'BOOLEAN':\r
3717 BoolValue = Pcd.DefaultValue.upper()\r
3718 if BoolValue == 'TRUE':\r
3719 Pcd.DefaultValue = '1'\r
3720 elif BoolValue == 'FALSE':\r
3721 Pcd.DefaultValue = '0'\r
3722\r
656d2539 3723 if Pcd.DatumType in TAB_PCD_NUMERIC_TYPES:\r
e8a47801 3724 HexFormat = '0x%02x'\r
656d2539 3725 if Pcd.DatumType == TAB_UINT16:\r
e8a47801 3726 HexFormat = '0x%04x'\r
656d2539 3727 elif Pcd.DatumType == TAB_UINT32:\r
e8a47801 3728 HexFormat = '0x%08x'\r
656d2539 3729 elif Pcd.DatumType == TAB_UINT64:\r
e8a47801
LG
3730 HexFormat = '0x%016x'\r
3731 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)\r
3732 else:\r
4231a819 3733 if Pcd.MaxDatumSize is None or Pcd.MaxDatumSize == '':\r
e8a47801 3734 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 3735 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
3736 )\r
3737 ArraySize = int(Pcd.MaxDatumSize, 0)\r
3738 PcdValue = Pcd.DefaultValue\r
3739 if PcdValue[0] != '{':\r
3740 Unicode = False\r
3741 if PcdValue[0] == 'L':\r
3742 Unicode = True\r
3743 PcdValue = PcdValue.lstrip('L')\r
3744 PcdValue = eval(PcdValue)\r
3745 NewValue = '{'\r
3746 for Index in range(0, len(PcdValue)):\r
3747 if Unicode:\r
3748 CharVal = ord(PcdValue[Index])\r
3749 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \\r
3750 + '0x%02x' % (CharVal >> 8) + ', '\r
3751 else:\r
3752 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '\r
3753 Padding = '0x00, '\r
3754 if Unicode:\r
3755 Padding = Padding * 2\r
1ccc4d89 3756 ArraySize = ArraySize / 2\r
e8a47801 3757 if ArraySize < (len(PcdValue) + 1):\r
c33081c9
YZ
3758 if Pcd.MaxSizeUserSet:\r
3759 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 3760 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801 3761 )\r
c33081c9
YZ
3762 else:\r
3763 ArraySize = len(PcdValue) + 1\r
e8a47801
LG
3764 if ArraySize > len(PcdValue) + 1:\r
3765 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)\r
3766 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'\r
3767 elif len(PcdValue.split(',')) <= ArraySize:\r
3768 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))\r
3769 PcdValue += '}'\r
3770 else:\r
c33081c9
YZ
3771 if Pcd.MaxSizeUserSet:\r
3772 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 3773 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801 3774 )\r
c33081c9
YZ
3775 else:\r
3776 ArraySize = len(PcdValue) + 1\r
e8a47801 3777 PcdItem = '%s.%s|%s|0x%X' % \\r
2a29017e 3778 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])\r
e8a47801
LG
3779 PcdComments = ''\r
3780 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
3781 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])\r
3782 if PcdComments:\r
3783 PcdItem = PcdComments + '\n ' + PcdItem\r
3784 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)\r
97fa0ee9 3785\r
97fa0ee9 3786 for Pcd in Pcds + VfrPcds:\r
e8a47801
LG
3787 PcdCommentList = []\r
3788 HiiInfo = ''\r
2a29017e
YZ
3789 TokenCName = Pcd.TokenCName\r
3790 for PcdItem in GlobalData.MixedPcd:\r
3791 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
3792 TokenCName = PcdItem[0]\r
3793 break\r
e8a47801
LG
3794 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:\r
3795 for SkuName in Pcd.SkuInfoList:\r
3796 SkuInfo = Pcd.SkuInfoList[SkuName]\r
3797 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)\r
3798 break\r
3799 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
3800 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]\r
3801 if HiiInfo:\r
3802 UsageIndex = -1\r
97fa0ee9 3803 UsageStr = ''\r
e8a47801
LG
3804 for Index, Comment in enumerate(PcdCommentList):\r
3805 for Usage in UsageList:\r
3806 if Comment.find(Usage) != -1:\r
97fa0ee9 3807 UsageStr = Usage\r
e8a47801
LG
3808 UsageIndex = Index\r
3809 break\r
3810 if UsageIndex != -1:\r
f7496d71 3811 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))\r
e8a47801 3812 else:\r
97fa0ee9 3813 PcdCommentList.append('## UNDEFINED ' + HiiInfo)\r
e8a47801 3814 PcdComments = '\n '.join(PcdCommentList)\r
2a29017e 3815 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName\r
e8a47801
LG
3816 if PcdComments:\r
3817 PcdEntry = PcdComments + '\n ' + PcdEntry\r
caf74495 3818 AsBuiltInfDict['pcd_item'].append(PcdEntry)\r
da92f276 3819 for Item in self.BuildOption:\r
481252bb 3820 if 'FLAGS' in self.BuildOption[Item]:\r
caf74495 3821 AsBuiltInfDict['flags_item'].append('%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip()))\r
97fa0ee9
YL
3822\r
3823 # Generated LibraryClasses section in comments.\r
3824 for Library in self.LibraryAutoGenList:\r
caf74495 3825 AsBuiltInfDict['libraryclasses_item'].append(Library.MetaFile.File.replace('\\', '/'))\r
f7496d71 3826\r
dfa41b4a
YZ
3827 # Generated UserExtensions TianoCore section.\r
3828 # All tianocore user extensions are copied.\r
3829 UserExtStr = ''\r
3830 for TianoCore in self._GetTianoCoreUserExtensionList():\r
3831 UserExtStr += '\n'.join(TianoCore)\r
3832 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])\r
3833 if os.path.isfile(ExtensionFile):\r
3834 shutil.copy2(ExtensionFile, self.OutputDir)\r
3835 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr\r
3836\r
97fa0ee9 3837 # Generated depex expression section in comments.\r
97fa0ee9 3838 DepexExpresion = self._GetDepexExpresionString()\r
caf74495 3839 AsBuiltInfDict['depexsection_item'] = DepexExpresion if DepexExpresion else ''\r
f7496d71 3840\r
da92f276
LG
3841 AsBuiltInf = TemplateString()\r
3842 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))\r
f7496d71 3843\r
da92f276 3844 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)\r
f7496d71 3845\r
da92f276 3846 self.IsAsBuiltInfCreated = True\r
36d083ef
YZ
3847 if GlobalData.gBinCacheDest:\r
3848 self.CopyModuleToCache()\r
3849\r
3850 def CopyModuleToCache(self):\r
3851 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
3852 CreateDirectory (FileDir)\r
3853 HashFile = path.join(self.BuildDir, self.Name + '.hash')\r
3854 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')\r
3855 if os.path.exists(HashFile):\r
3856 shutil.copy2(HashFile, FileDir)\r
3857 if os.path.exists(ModuleFile):\r
3858 shutil.copy2(ModuleFile, FileDir)\r
83397f95 3859 if not self.OutputFile:\r
e6c62ab7 3860 Ma = self.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]\r
83397f95 3861 self.OutputFile = Ma.Binaries\r
36d083ef
YZ
3862 if self.OutputFile:\r
3863 for File in self.OutputFile:\r
83397f95 3864 File = str(File)\r
36d083ef
YZ
3865 if not os.path.isabs(File):\r
3866 File = os.path.join(self.OutputDir, File)\r
3867 if os.path.exists(File):\r
3868 shutil.copy2(File, FileDir)\r
3869\r
3870 def AttemptModuleCacheCopy(self):\r
3871 if self.IsBinaryModule:\r
3872 return False\r
3873 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
3874 HashFile = path.join(FileDir, self.Name + '.hash')\r
3875 if os.path.exists(HashFile):\r
3876 f = open(HashFile, 'r')\r
3877 CacheHash = f.read()\r
3878 f.close()\r
3879 if GlobalData.gModuleHash[self.Arch][self.Name]:\r
3880 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:\r
3881 for root, dir, files in os.walk(FileDir):\r
3882 for f in files:\r
3883 if self.Name + '.hash' in f:\r
3884 shutil.copy2(HashFile, self.BuildDir)\r
3885 else:\r
3886 File = path.join(root, f)\r
3887 shutil.copy2(File, self.OutputDir)\r
3888 if self.Name == "PcdPeim" or self.Name == "PcdDxe":\r
3889 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
3890 return True\r
3891 return False\r
3892\r
52302d4d
LG
3893 ## Create makefile for the module and its dependent libraries\r
3894 #\r
3895 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of\r
3896 # dependent libraries will be created\r
3897 #\r
830bf22f 3898 @cached_class_function\r
37de70b7 3899 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):\r
830bf22f
JC
3900 # nest this function inside it's only caller.\r
3901 def CreateTimeStamp():\r
3902 FileSet = {self.MetaFile.Path}\r
3903\r
3904 for SourceFile in self.Module.Sources:\r
3905 FileSet.add (SourceFile.Path)\r
3906\r
3907 for Lib in self.DependentLibraryList:\r
3908 FileSet.add (Lib.MetaFile.Path)\r
3909\r
3910 for f in self.AutoGenDepSet:\r
3911 FileSet.add (f.Path)\r
3912\r
3913 if os.path.exists (self.TimeStampPath):\r
3914 os.remove (self.TimeStampPath)\r
3915 with open(self.TimeStampPath, 'w+') as file:\r
1ccc4d89 3916 for f in FileSet:\r
830bf22f
JC
3917 print(f, file=file)\r
3918\r
fae62ff2 3919 # Ignore generating makefile when it is a binary module\r
a0a2cd1e
FB
3920 if self.IsBinaryModule:\r
3921 return\r
fae62ff2 3922\r
37de70b7 3923 self.GenFfsList = GenFfsList\r
52302d4d
LG
3924 if not self.IsLibrary and CreateLibraryMakeFile:\r
3925 for LibraryAutoGen in self.LibraryAutoGenList:\r
3926 LibraryAutoGen.CreateMakeFile()\r
3927\r
36513f3a
YZ
3928 if self.CanSkip():\r
3929 return\r
3930\r
52302d4d
LG
3931 if len(self.CustomMakefile) == 0:\r
3932 Makefile = GenMake.ModuleMakefile(self)\r
3933 else:\r
3934 Makefile = GenMake.CustomMakefile(self)\r
3935 if Makefile.Generate():\r
3936 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %\r
3937 (self.Name, self.Arch))\r
3938 else:\r
3939 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %\r
3940 (self.Name, self.Arch))\r
3941\r
830bf22f 3942 CreateTimeStamp()\r
52302d4d 3943\r
a0a2cd1e
FB
3944 def CopyBinaryFiles(self):\r
3945 for File in self.Module.Binaries:\r
3946 SrcPath = File.Path\r
ccaa7754 3947 DstPath = os.path.join(self.OutputDir, os.path.basename(SrcPath))\r
a0a2cd1e 3948 CopyLongFilePath(SrcPath, DstPath)\r
52302d4d
LG
3949 ## Create autogen code for the module and its dependent libraries\r
3950 #\r
3951 # @param CreateLibraryCodeFile Flag indicating if or not the code of\r
3952 # dependent libraries will be created\r
3953 #\r
3954 def CreateCodeFile(self, CreateLibraryCodeFile=True):\r
3955 if self.IsCodeFileCreated:\r
3956 return\r
3957\r
e8a47801
LG
3958 # Need to generate PcdDatabase even PcdDriver is binarymodule\r
3959 if self.IsBinaryModule and self.PcdIsDriver != '':\r
3960 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
3961 return\r
a0a2cd1e 3962 if self.IsBinaryModule:\r
49d9b71d
HC
3963 if self.IsLibrary:\r
3964 self.CopyBinaryFiles()\r
a0a2cd1e 3965 return\r
e8a47801 3966\r
52302d4d
LG
3967 if not self.IsLibrary and CreateLibraryCodeFile:\r
3968 for LibraryAutoGen in self.LibraryAutoGenList:\r
3969 LibraryAutoGen.CreateCodeFile()\r
3970\r
36513f3a
YZ
3971 if self.CanSkip():\r
3972 return\r
3973\r
52302d4d
LG
3974 AutoGenList = []\r
3975 IgoredAutoGenList = []\r
3976\r
3977 for File in self.AutoGenFileList:\r
3978 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):\r
b36d134f 3979 #Ignore Edk AutoGen.c\r
52302d4d
LG
3980 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':\r
3981 continue\r
3982\r
3983 AutoGenList.append(str(File))\r
3984 else:\r
3985 IgoredAutoGenList.append(str(File))\r
3986\r
3987 # Skip the following code for EDK I inf\r
3988 if self.AutoGenVersion < 0x00010005:\r
3989 return\r
3990\r
3991 for ModuleType in self.DepexList:\r
8bb63e37
CJ
3992 # Ignore empty [depex] section or [depex] section for SUP_MODULE_USER_DEFINED module\r
3993 if len(self.DepexList[ModuleType]) == 0 or ModuleType == SUP_MODULE_USER_DEFINED:\r
52302d4d 3994 continue\r
40d841f6 3995\r
52302d4d
LG
3996 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)\r
3997 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}\r
3998\r
87d2afd0 3999 if len(Dpx.PostfixNotation) != 0:\r
0d2711a6 4000 self.DepexGenerated = True\r
da92f276 4001\r
52302d4d
LG
4002 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):\r
4003 AutoGenList.append(str(DpxFile))\r
4004 else:\r
4005 IgoredAutoGenList.append(str(DpxFile))\r
4006\r
4007 if IgoredAutoGenList == []:\r
4008 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %\r
4009 (" ".join(AutoGenList), self.Name, self.Arch))\r
4010 elif AutoGenList == []:\r
4011 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %\r
4012 (" ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4013 else:\r
4014 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %\r
4015 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4016\r
4017 self.IsCodeFileCreated = True\r
4018 return AutoGenList\r
4019\r
4020 ## Summarize the ModuleAutoGen objects of all libraries used by this module\r
b23414f6
JC
4021 @cached_property\r
4022 def LibraryAutoGenList(self):\r
4023 RetVal = []\r
4024 for Library in self.DependentLibraryList:\r
4025 La = ModuleAutoGen(\r
52302d4d
LG
4026 self.Workspace,\r
4027 Library.MetaFile,\r
4028 self.BuildTarget,\r
4029 self.ToolChain,\r
4030 self.Arch,\r
4031 self.PlatformInfo.MetaFile\r
4032 )\r
b23414f6
JC
4033 if La not in RetVal:\r
4034 RetVal.append(La)\r
4035 for Lib in La.CodaTargetList:\r
4036 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)\r
4037 return RetVal\r
52302d4d 4038\r
36d083ef
YZ
4039 def GenModuleHash(self):\r
4040 if self.Arch not in GlobalData.gModuleHash:\r
4041 GlobalData.gModuleHash[self.Arch] = {}\r
4042 m = hashlib.md5()\r
4043 # Add Platform level hash\r
1ccc4d89 4044 m.update(GlobalData.gPlatformHash)\r
36d083ef
YZ
4045 # Add Package level hash\r
4046 if self.DependentPackageList:\r
3f34e36d 4047 for Pkg in sorted(self.DependentPackageList, key=lambda x: x.PackageName):\r
36d083ef 4048 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:\r
1ccc4d89 4049 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])\r
36d083ef
YZ
4050\r
4051 # Add Library hash\r
4052 if self.LibraryAutoGenList:\r
3f34e36d 4053 for Lib in sorted(self.LibraryAutoGenList, key=lambda x: x.Name):\r
36d083ef
YZ
4054 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:\r
4055 Lib.GenModuleHash()\r
1ccc4d89 4056 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])\r
36d083ef
YZ
4057\r
4058 # Add Module self\r
1ccc4d89 4059 f = open(str(self.MetaFile), 'r')\r
36d083ef
YZ
4060 Content = f.read()\r
4061 f.close()\r
4062 m.update(Content)\r
4063 # Add Module's source files\r
4064 if self.SourceFileList:\r
3f34e36d 4065 for File in sorted(self.SourceFileList, key=lambda x: str(x)):\r
1ccc4d89 4066 f = open(str(File), 'r')\r
36d083ef
YZ
4067 Content = f.read()\r
4068 f.close()\r
4069 m.update(Content)\r
4070\r
4071 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")\r
4072 if self.Name not in GlobalData.gModuleHash[self.Arch]:\r
4073 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()\r
4074 if GlobalData.gBinCacheSource:\r
caf74495 4075 if self.AttemptModuleCacheCopy():\r
36d083ef
YZ
4076 return False\r
4077 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)\r
4078\r
4079 ## Decide whether we can skip the ModuleAutoGen process\r
4080 def CanSkipbyHash(self):\r
4081 if GlobalData.gUseHashCache:\r
4082 return not self.GenModuleHash()\r
18ef4e71 4083 return False\r
36d083ef 4084\r
c17956e0 4085 ## Decide whether we can skip the ModuleAutoGen process\r
36d083ef 4086 # If any source file is newer than the module than we cannot skip\r
c17956e0
DL
4087 #\r
4088 def CanSkip(self):\r
0a563f3f 4089 if self.MakeFileDir in GlobalData.gSikpAutoGenCache:\r
18ef4e71 4090 return True\r
b23414f6 4091 if not os.path.exists(self.TimeStampPath):\r
c17956e0
DL
4092 return False\r
4093 #last creation time of the module\r
b23414f6 4094 DstTimeStamp = os.stat(self.TimeStampPath)[8]\r
c17956e0
DL
4095\r
4096 SrcTimeStamp = self.Workspace._SrcTimeStamp\r
4097 if SrcTimeStamp > DstTimeStamp:\r
4098 return False\r
4099\r
b23414f6 4100 with open(self.TimeStampPath,'r') as f:\r
c17956e0
DL
4101 for source in f:\r
4102 source = source.rstrip('\n')\r
4a1167df
YZ
4103 if not os.path.exists(source):\r
4104 return False\r
c17956e0
DL
4105 if source not in ModuleAutoGen.TimeDict :\r
4106 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]\r
4107 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:\r
4108 return False\r
0a563f3f 4109 GlobalData.gSikpAutoGenCache.add(self.MakeFileDir)\r
c17956e0
DL
4110 return True\r
4111\r
b23414f6
JC
4112 @cached_property\r
4113 def TimeStampPath(self):\r
4114 return os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')\r