]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTools: AutoGen refactor WorkspaceAutoGen class
[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
72443dd2 18from __future__ import print_function\r
0ff3b52e 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
b23414f6
JC
203 RetVal = cls.__ObjectCache[Key] = super(AutoGen, cls).__new__(cls)\r
204 return RetVal\r
b24e99f7
CJ
205\r
206 def __init__ (self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
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
b24e99f7
CJ
240 super(WorkspaceAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
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
300 self.ArchList = tuple(ArchList)\r
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
523 for key in BuildData.Pcds:\r
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
572 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
573 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
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
586 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
587 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
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
621 content += os.linesep\r
622 content += 'BuildOptionPcd: '\r
623 content += str(GlobalData.BuildOptionPcd)\r
2d499388
YZ
624 content += os.linesep\r
625 content += 'Active Platform: '\r
626 content += str(self.Platform)\r
627 content += os.linesep\r
628 if self.FdfFile:\r
629 content += 'Flash Image Definition: '\r
630 content += str(self.FdfFile)\r
36d083ef 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
641 PcdTokenNumber += os.linesep\r
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
666 f = open(files, 'r')\r
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
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
695 f = open(Pkg.MetaFile.Path, 'r')\r
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
YZ
704 File_Path = os.path.join(Root, File)\r
705 f = open(File_Path, 'r')\r
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
6780eef1 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
6780eef1 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
b24e99f7
CJ
978 super(PlatformAutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
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
52302d4d
LG
1088 ## Create makefile for the platform and mdoules in it\r
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
LG
1094 if CreateModuleMakeFile:\r
1095 for ModuleFile in self.Platform.Modules:\r
1096 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,\r
1097 self.ToolChain, self.Arch, self.MetaFile)\r
37de70b7
YZ
1098 if (ModuleFile.File, self.Arch) in FfsCommand:\r
1099 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])\r
1100 else:\r
1101 Ma.CreateMakeFile(True)\r
97fa0ee9 1102 #Ma.CreateAsBuiltInf()\r
52302d4d
LG
1103\r
1104 # no need to create makefile for the platform more than once\r
1105 if self.IsMakeFileCreated:\r
1106 return\r
1107\r
03af2753 1108 # create library/module build dirs for platform\r
52302d4d 1109 Makefile = GenMake.PlatformMakefile(self)\r
03af2753
HC
1110 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()\r
1111 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()\r
1112\r
52302d4d
LG
1113 self.IsMakeFileCreated = True\r
1114\r
2bc3256c
LG
1115 ## Deal with Shared FixedAtBuild Pcds\r
1116 #\r
1117 def CollectFixedAtBuildPcds(self):\r
1118 for LibAuto in self.LibraryAutoGenList:\r
f7496d71
LG
1119 FixedAtBuildPcds = {}\r
1120 ShareFixedAtBuildPcdsSameValue = {}\r
b23414f6 1121 for Module in LibAuto.ReferenceModules:\r
d900d7c9 1122 for Pcd in set(Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds):\r
9edba51f
YZ
1123 DefaultValue = Pcd.DefaultValue\r
1124 # Cover the case: DSC component override the Pcd value and the Pcd only used in one Lib\r
1125 if Pcd in Module.LibraryPcdList:\r
1126 Index = Module.LibraryPcdList.index(Pcd)\r
1127 DefaultValue = Module.LibraryPcdList[Index].DefaultValue\r
ccaa7754 1128 key = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
2bc3256c
LG
1129 if key not in FixedAtBuildPcds:\r
1130 ShareFixedAtBuildPcdsSameValue[key] = True\r
9edba51f 1131 FixedAtBuildPcds[key] = DefaultValue\r
2bc3256c 1132 else:\r
9edba51f 1133 if FixedAtBuildPcds[key] != DefaultValue:\r
f7496d71 1134 ShareFixedAtBuildPcdsSameValue[key] = False\r
2bc3256c 1135 for Pcd in LibAuto.FixedAtBuildPcds:\r
ccaa7754
GL
1136 key = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1137 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:\r
2bc3256c
LG
1138 continue\r
1139 else:\r
ccaa7754 1140 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)]\r
6b1f2cf4 1141 if DscPcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
2bc3256c 1142 continue\r
f7496d71 1143 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]:\r
eca980c0 1144 LibAuto.ConstPcd[key] = FixedAtBuildPcds[key]\r
2bc3256c 1145\r
34952f49 1146 def CollectVariables(self, DynamicPcdSet):\r
47854fd5
LG
1147 VpdRegionSize = 0\r
1148 VpdRegionBase = 0\r
1149 if self.Workspace.FdfFile:\r
1150 FdDict = self.Workspace.FdfProfile.FdDict[GlobalData.gFdfParser.CurrentFdName]\r
1151 for FdRegion in FdDict.RegionList:\r
1152 for item in FdRegion.RegionDataList:\r
1153 if self.Platform.VpdToolGuid.strip() and self.Platform.VpdToolGuid in item:\r
1154 VpdRegionSize = FdRegion.Size\r
1155 VpdRegionBase = FdRegion.Offset\r
1156 break\r
1157\r
ccaa7754 1158 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(), self.DscBuildDataObj._GetSkuIds())\r
47854fd5
LG
1159 VariableInfo.SetVpdRegionMaxSize(VpdRegionSize)\r
1160 VariableInfo.SetVpdRegionOffset(VpdRegionBase)\r
34952f49
LG
1161 Index = 0\r
1162 for Pcd in DynamicPcdSet:\r
ccaa7754 1163 pcdname = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
8518bf0b
LG
1164 for SkuName in Pcd.SkuInfoList:\r
1165 Sku = Pcd.SkuInfoList[SkuName]\r
1166 SkuId = Sku.SkuId\r
4231a819 1167 if SkuId is None or SkuId == '':\r
8518bf0b
LG
1168 continue\r
1169 if len(Sku.VariableName) > 0:\r
1170 VariableGuidStructure = Sku.VariableGuidValue\r
1171 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)\r
a3623244 1172 for StorageName in Sku.DefaultStoreDict:\r
ccaa7754 1173 VariableInfo.append_variable(var_info(Index, pcdname, StorageName, SkuName, StringToArray(Sku.VariableName), VariableGuid, Sku.VariableOffset, Sku.VariableAttribute, Sku.HiiDefaultValue, Sku.DefaultStoreDict[StorageName], Pcd.DatumType))\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
8ac16789 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
52302d4d
LG
1234 for F in self.Platform.Modules.keys():\r
1235 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)\r
1236 #GuidValue.update(M.Guids)\r
f7496d71 1237\r
52302d4d 1238 self.Platform.Modules[F].M = M\r
47fea6af
YZ
1239\r
1240 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:\r
52302d4d 1241 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
c93356ad 1242 if PcdFromModule.DatumType == TAB_VOID and not PcdFromModule.MaxDatumSize:\r
52302d4d
LG
1243 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))\r
1244\r
97fa0ee9 1245 # Check the PCD from Binary INF or Source INF\r
a0a2cd1e
FB
1246 if M.IsBinaryModule == True:\r
1247 PcdFromModule.IsFromBinaryInf = True\r
97fa0ee9 1248\r
f7496d71 1249 # Check the PCD from DSC or not\r
9eb87141
CJ
1250 PcdFromModule.IsFromDsc = (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds\r
1251\r
eece4292 1252 if PcdFromModule.Type in PCD_DYNAMIC_TYPE_SET or PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
a0a2cd1e 1253 if F.Path not in FdfModuleList:\r
f7496d71
LG
1254 # If one of the Source built modules listed in the DSC is not listed\r
1255 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic\r
1256 # access method (it is only listed in the DEC file that declares the\r
a0a2cd1e 1257 # PCD as PcdsDynamic), then build tool will report warning message\r
f7496d71
LG
1258 # notify the PI that they are attempting to build a module that must\r
1259 # be included in a flash image in order to be functional. These Dynamic\r
1260 # PCD will not be added into the Database unless it is used by other\r
a0a2cd1e 1261 # modules that are included in the FDF file.\r
eece4292 1262 if PcdFromModule.Type in PCD_DYNAMIC_TYPE_SET and \\r
a0a2cd1e
FB
1263 PcdFromModule.IsFromBinaryInf == False:\r
1264 # Print warning message to let the developer make a determine.\r
a0a2cd1e 1265 continue\r
f7496d71
LG
1266 # If one of the Source built modules listed in the DSC is not listed in\r
1267 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx\r
1268 # access method (it is only listed in the DEC file that declares the\r
1269 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the\r
a0a2cd1e 1270 # PCD to the Platform's PCD Database.\r
eece4292 1271 if PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
a0a2cd1e 1272 continue\r
52302d4d
LG
1273 #\r
1274 # If a dynamic PCD used by a PEM module/PEI module & DXE module,\r
1275 # it should be stored in Pcd PEI database, If a dynamic only\r
1276 # used by DXE module, it should be stored in DXE PCD database.\r
1277 # The default Phase is DXE\r
1278 #\r
88c6c1b6 1279 if M.ModuleType in SUP_MODULE_SET_PEI:\r
52302d4d
LG
1280 PcdFromModule.Phase = "PEI"\r
1281 if PcdFromModule not in self._DynaPcdList_:\r
1282 self._DynaPcdList_.append(PcdFromModule)\r
1283 elif PcdFromModule.Phase == 'PEI':\r
1284 # overwrite any the same PCD existing, if Phase is PEI\r
1285 Index = self._DynaPcdList_.index(PcdFromModule)\r
1286 self._DynaPcdList_[Index] = PcdFromModule\r
1287 elif PcdFromModule not in self._NonDynaPcdList_:\r
1288 self._NonDynaPcdList_.append(PcdFromModule)\r
a0a2cd1e
FB
1289 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:\r
1290 Index = self._NonDynaPcdList_.index(PcdFromModule)\r
1291 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:\r
1292 #The PCD from Binary INF will override the same one from source INF\r
1293 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])\r
1294 PcdFromModule.Pending = False\r
1295 self._NonDynaPcdList_.append (PcdFromModule)\r
1563349a 1296 DscModuleSet = {os.path.normpath(ModuleInf.Path) for ModuleInf in self.Platform.Modules}\r
f7496d71 1297 # add the PCD from modules that listed in FDF but not in DSC to Database\r
a0a2cd1e 1298 for InfName in FdfModuleList:\r
1563349a 1299 if InfName not in DscModuleSet:\r
a0a2cd1e
FB
1300 InfClass = PathClass(InfName)\r
1301 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
f7496d71
LG
1302 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source)\r
1303 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here.\r
1304 # For binary module, if in current arch, we need to list the PCDs into database.\r
f5f4667d 1305 if not M.IsBinaryModule:\r
a0a2cd1e
FB
1306 continue\r
1307 # Override the module PCD setting by platform setting\r
1308 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)\r
1309 for PcdFromModule in ModulePcdList:\r
1310 PcdFromModule.IsFromBinaryInf = True\r
1311 PcdFromModule.IsFromDsc = False\r
1312 # Only allow the DynamicEx and Patchable PCD in AsBuild INF\r
eece4292 1313 if PcdFromModule.Type not in PCD_DYNAMIC_EX_TYPE_SET and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:\r
a0a2cd1e
FB
1314 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1315 File=self.MetaFile,\r
1316 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"\r
1317 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))\r
1318 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
c93356ad 1319 if PcdFromModule.DatumType == TAB_VOID and not PcdFromModule.MaxDatumSize:\r
a0a2cd1e 1320 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))\r
88c6c1b6 1321 if M.ModuleType in SUP_MODULE_SET_PEI:\r
a0a2cd1e 1322 PcdFromModule.Phase = "PEI"\r
eece4292 1323 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
a0a2cd1e
FB
1324 self._DynaPcdList_.append(PcdFromModule)\r
1325 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1326 self._NonDynaPcdList_.append(PcdFromModule)\r
eece4292 1327 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
97fa0ee9 1328 # Overwrite the phase of any the same PCD existing, if Phase is PEI.\r
f7496d71 1329 # It is to solve the case that a dynamic PCD used by a PEM module/PEI\r
97fa0ee9
YL
1330 # module & DXE module at a same time.\r
1331 # Overwrite the type of the PCDs in source INF by the type of AsBuild\r
f7496d71 1332 # INF file as DynamicEx.\r
a0a2cd1e
FB
1333 Index = self._DynaPcdList_.index(PcdFromModule)\r
1334 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase\r
1335 self._DynaPcdList_[Index].Type = PcdFromModule.Type\r
1336 for PcdFromModule in self._NonDynaPcdList_:\r
f7496d71
LG
1337 # If a PCD is not listed in the DSC file, but binary INF files used by\r
1338 # this platform all (that use this PCD) list the PCD in a [PatchPcds]\r
1339 # section, AND all source INF files used by this platform the build\r
1340 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds]\r
a0a2cd1e 1341 # section, then the tools must NOT add the PCD to the Platform's PCD\r
f7496d71 1342 # Database; the build must assign the access method for this PCD as\r
a0a2cd1e
FB
1343 # PcdsPatchableInModule.\r
1344 if PcdFromModule not in self._DynaPcdList_:\r
1345 continue\r
1346 Index = self._DynaPcdList_.index(PcdFromModule)\r
1347 if PcdFromModule.IsFromDsc == False and \\r
1348 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \\r
1349 PcdFromModule.IsFromBinaryInf == True and \\r
1350 self._DynaPcdList_[Index].IsFromBinaryInf == False:\r
1351 Index = self._DynaPcdList_.index(PcdFromModule)\r
1352 self._DynaPcdList_.remove (self._DynaPcdList_[Index])\r
52302d4d
LG
1353\r
1354 # print out error information and break the build, if error found\r
1355 if len(NoDatumTypePcdList) > 0:\r
1356 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)\r
1357 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1358 File=self.MetaFile,\r
1359 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"\r
1360 % NoDatumTypePcdListString)\r
1361 self._NonDynamicPcdList = self._NonDynaPcdList_\r
1362 self._DynamicPcdList = self._DynaPcdList_\r
52302d4d
LG
1363 #\r
1364 # Sort dynamic PCD list to:\r
f7496d71 1365 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should\r
52302d4d
LG
1366 # try to be put header of dynamicd List\r
1367 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD\r
1368 #\r
1369 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.\r
1370 #\r
0b6c5954
LG
1371 UnicodePcdArray = set()\r
1372 HiiPcdArray = set()\r
1373 OtherPcdArray = set()\r
6780eef1 1374 VpdPcdDict = {}\r
e56468c0 1375 VpdFile = VpdInfoFile.VpdInfoFile()\r
61ee1dff
YZ
1376 NeedProcessVpdMapFile = False\r
1377\r
9eb87141
CJ
1378 for pcd in self.Platform.Pcds:\r
1379 if pcd not in self._PlatformPcds:\r
61ee1dff
YZ
1380 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]\r
1381\r
ae7b6df8
LG
1382 for item in self._PlatformPcds:\r
1383 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 1384 self._PlatformPcds[item].DatumType = TAB_VOID\r
ae7b6df8 1385\r
f7496d71 1386 if (self.Workspace.ArchList[-1] == self.Arch):\r
e56468c0 1387 for Pcd in self._DynamicPcdList:\r
e56468c0 1388 # just pick the a value to determine whether is unicode string type\r
9eb87141 1389 Sku = Pcd.SkuInfoList.values()[0]\r
e56468c0 1390 Sku.VpdOffset = Sku.VpdOffset.strip()\r
47fea6af 1391\r
ae7b6df8 1392 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
656d2539 1393 Pcd.DatumType = TAB_VOID\r
ae7b6df8 1394\r
e56468c0 1395 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
e56468c0 1396 # if found HII type PCD then insert to right of UnicodeIndex\r
e56468c0 1397 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
47fea6af
YZ
1398 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd\r
1399\r
34952f49 1400 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer\r
ccaa7754 1401 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer", "gEfiMdeModulePkgTokenSpaceGuid"))\r
34952f49 1402 if PcdNvStoreDfBuffer:\r
47854fd5 1403 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)\r
47854fd5 1404 vardump = self.VariableInfo.dump()\r
626bece4 1405 if vardump:\r
2b8a6c44 1406 PcdNvStoreDfBuffer.DefaultValue = vardump\r
626bece4
LG
1407 for skuname in PcdNvStoreDfBuffer.SkuInfoList:\r
1408 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump\r
1409 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))\r
ced86858
ZZ
1410 else:\r
1411 #If the end user define [DefaultStores] and [XXX.Menufacturing] in DSC, but forget to configure PcdNvStoreDefaultValueBuffer to PcdsDynamicVpd\r
1412 if [Pcd for Pcd in self._DynamicPcdList if Pcd.UserDefinedDefaultStoresFlag]:\r
1413 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 1414 PlatformPcds = sorted(self._PlatformPcds.keys())\r
6780eef1
LG
1415 #\r
1416 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
1417 #\r
626bece4 1418 VpdSkuMap = {}\r
6780eef1 1419 for PcdKey in PlatformPcds:\r
61ee1dff 1420 Pcd = self._PlatformPcds[PcdKey]\r
e8a47801
LG
1421 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \\r
1422 PcdKey in VpdPcdDict:\r
1423 Pcd = VpdPcdDict[PcdKey]\r
626bece4 1424 SkuValueMap = {}\r
55c84777 1425 DefaultSku = Pcd.SkuInfoList.get(TAB_DEFAULT)\r
8ac16789
LG
1426 if DefaultSku:\r
1427 PcdValue = DefaultSku.DefaultValue\r
1428 if PcdValue not in SkuValueMap:\r
1429 SkuValueMap[PcdValue] = []\r
ccaa7754 1430 VpdFile.Add(Pcd, TAB_DEFAULT, DefaultSku.VpdOffset)\r
8ac16789
LG
1431 SkuValueMap[PcdValue].append(DefaultSku)\r
1432\r
ccaa7754 1433 for (SkuName, Sku) in Pcd.SkuInfoList.items():\r
e8a47801 1434 Sku.VpdOffset = Sku.VpdOffset.strip()\r
5a13737a
YZ
1435 PcdValue = Sku.DefaultValue\r
1436 if PcdValue == "":\r
1437 PcdValue = Pcd.DefaultValue\r
1438 if Sku.VpdOffset != '*':\r
1439 if PcdValue.startswith("{"):\r
1440 Alignment = 8\r
1441 elif PcdValue.startswith("L"):\r
1442 Alignment = 2\r
1443 else:\r
1444 Alignment = 1\r
ca85291f
YZ
1445 try:\r
1446 VpdOffset = int(Sku.VpdOffset)\r
1447 except:\r
1448 try:\r
1449 VpdOffset = int(Sku.VpdOffset, 16)\r
1450 except:\r
1451 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1452 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1453 if PcdValue.startswith("{"):\r
1454 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)\r
1455 else:\r
1456 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
1457 if PcdValue not in SkuValueMap:\r
1458 SkuValueMap[PcdValue] = []\r
ccaa7754 1459 VpdFile.Add(Pcd, SkuName, Sku.VpdOffset)\r
626bece4 1460 SkuValueMap[PcdValue].append(Sku)\r
e8a47801
LG
1461 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
1462 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1463 NeedProcessVpdMapFile = True\r
4231a819 1464 if self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == '':\r
e8a47801
LG
1465 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
1466 "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 1467\r
626bece4 1468 VpdSkuMap[PcdKey] = SkuValueMap\r
e56468c0 1469 #\r
1470 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
1471 # An example is PCD for signature usage.\r
f7496d71 1472 #\r
6780eef1 1473 for DscPcd in PlatformPcds:\r
61ee1dff 1474 DscPcdEntry = self._PlatformPcds[DscPcd]\r
e56468c0 1475 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
4231a819 1476 if not (self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == ''):\r
e56468c0 1477 FoundFlag = False\r
9eb87141 1478 for VpdPcd in VpdFile._VpdArray:\r
e56468c0 1479 # This PCD has been referenced by module\r
1480 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1481 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
1482 FoundFlag = True\r
47fea6af 1483\r
e56468c0 1484 # Not found, it should be signature\r
1485 if not FoundFlag :\r
1486 # just pick the a value to determine whether is unicode string type\r
626bece4 1487 SkuValueMap = {}\r
e827d21d 1488 SkuObjList = DscPcdEntry.SkuInfoList.items()\r
55c84777 1489 DefaultSku = DscPcdEntry.SkuInfoList.get(TAB_DEFAULT)\r
8ac16789 1490 if DefaultSku:\r
ccaa7754
GL
1491 defaultindex = SkuObjList.index((TAB_DEFAULT, DefaultSku))\r
1492 SkuObjList[0], SkuObjList[defaultindex] = SkuObjList[defaultindex], SkuObjList[0]\r
1493 for (SkuName, Sku) in SkuObjList:\r
f7496d71
LG
1494 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1495\r
e8a47801
LG
1496 # Need to iterate DEC pcd information to get the value & datumtype\r
1497 for eachDec in self.PackageList:\r
1498 for DecPcd in eachDec.Pcds:\r
1499 DecPcdEntry = eachDec.Pcds[DecPcd]\r
1500 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1501 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
1502 # Print warning message to let the developer make a determine.\r
1503 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
1504 File=self.MetaFile, \\r
1505 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
f7496d71
LG
1506 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path))\r
1507\r
e8a47801
LG
1508 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1509 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
1510 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue\r
1511 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]\r
1512 # Only fix the value while no value provided in DSC file.\r
128d435f 1513 if not Sku.DefaultValue:\r
e8a47801 1514 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
f7496d71 1515\r
e8a47801
LG
1516 if DscPcdEntry not in self._DynamicPcdList:\r
1517 self._DynamicPcdList.append(DscPcdEntry)\r
e8a47801
LG
1518 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1519 PcdValue = Sku.DefaultValue\r
5a13737a
YZ
1520 if PcdValue == "":\r
1521 PcdValue = DscPcdEntry.DefaultValue\r
1522 if Sku.VpdOffset != '*':\r
1523 if PcdValue.startswith("{"):\r
1524 Alignment = 8\r
1525 elif PcdValue.startswith("L"):\r
1526 Alignment = 2\r
1527 else:\r
1528 Alignment = 1\r
ca85291f
YZ
1529 try:\r
1530 VpdOffset = int(Sku.VpdOffset)\r
1531 except:\r
1532 try:\r
1533 VpdOffset = int(Sku.VpdOffset, 16)\r
1534 except:\r
1535 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))\r
1536 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1537 if PcdValue.startswith("{"):\r
1538 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)\r
1539 else:\r
1540 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
1541 if PcdValue not in SkuValueMap:\r
1542 SkuValueMap[PcdValue] = []\r
ccaa7754 1543 VpdFile.Add(DscPcdEntry, SkuName, Sku.VpdOffset)\r
626bece4 1544 SkuValueMap[PcdValue].append(Sku)\r
e8a47801 1545 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
f7496d71 1546 NeedProcessVpdMapFile = True\r
656d2539 1547 if DscPcdEntry.DatumType == TAB_VOID and PcdValue.startswith("L"):\r
0b6c5954 1548 UnicodePcdArray.add(DscPcdEntry)\r
e8a47801 1549 elif len(Sku.VariableName) > 0:\r
0b6c5954 1550 HiiPcdArray.add(DscPcdEntry)\r
e8a47801 1551 else:\r
0b6c5954
LG
1552 OtherPcdArray.add(DscPcdEntry)\r
1553\r
e8a47801 1554 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
626bece4 1555 VpdSkuMap[DscPcd] = SkuValueMap\r
4231a819 1556 if (self.Platform.FlashDefinition is None or self.Platform.FlashDefinition == '') and \\r
e56468c0 1557 VpdFile.GetCount() != 0:\r
f7496d71 1558 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
e56468c0 1559 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
47fea6af 1560\r
e56468c0 1561 if VpdFile.GetCount() != 0:\r
47854fd5
LG
1562\r
1563 self.FixVpdOffset(VpdFile)\r
1564\r
1565 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))\r
47fea6af 1566\r
e56468c0 1567 # Process VPD map file generated by third party BPDG tool\r
1568 if NeedProcessVpdMapFile:\r
91fa33ee 1569 VpdMapFilePath = os.path.join(self.BuildDir, TAB_FV_DIRECTORY, "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1570 if os.path.exists(VpdMapFilePath):\r
1571 VpdFile.Read(VpdMapFilePath)\r
47fea6af 1572\r
e56468c0 1573 # Fixup "*" offset\r
626bece4
LG
1574 for pcd in VpdSkuMap:\r
1575 vpdinfo = VpdFile.GetVpdInfo(pcd)\r
1576 if vpdinfo is None:\r
e56468c0 1577 # just pick the a value to determine whether is unicode string type\r
626bece4
LG
1578 continue\r
1579 for pcdvalue in VpdSkuMap[pcd]:\r
1580 for sku in VpdSkuMap[pcd][pcdvalue]:\r
1581 for item in vpdinfo:\r
1582 if item[2] == pcdvalue:\r
1583 sku.VpdOffset = item[1]\r
e56468c0 1584 else:\r
1585 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
47fea6af 1586\r
626bece4
LG
1587 # Delete the DynamicPcdList At the last time enter into this function\r
1588 for Pcd in self._DynamicPcdList:\r
1589 # just pick the a value to determine whether is unicode string type\r
9eb87141 1590 Sku = Pcd.SkuInfoList.values()[0]\r
626bece4
LG
1591 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1592\r
1593 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
656d2539 1594 Pcd.DatumType = TAB_VOID\r
626bece4
LG
1595\r
1596 PcdValue = Sku.DefaultValue\r
656d2539 1597 if Pcd.DatumType == TAB_VOID and PcdValue.startswith("L"):\r
626bece4 1598 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
0b6c5954 1599 UnicodePcdArray.add(Pcd)\r
626bece4
LG
1600 elif len(Sku.VariableName) > 0:\r
1601 # if found HII type PCD then insert to right of UnicodeIndex\r
0b6c5954 1602 HiiPcdArray.add(Pcd)\r
626bece4 1603 else:\r
0b6c5954 1604 OtherPcdArray.add(Pcd)\r
47fea6af 1605 del self._DynamicPcdList[:]\r
0b6c5954
LG
1606 self._DynamicPcdList.extend(list(UnicodePcdArray))\r
1607 self._DynamicPcdList.extend(list(HiiPcdArray))\r
1608 self._DynamicPcdList.extend(list(OtherPcdArray))\r
ccaa7754 1609 allskuset = [(SkuName, Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName, Sku) in pcd.SkuInfoList.items()]\r
2b8a6c44
LG
1610 for pcd in self._DynamicPcdList:\r
1611 if len(pcd.SkuInfoList) == 1:\r
ccaa7754
GL
1612 for (SkuName, SkuId) in allskuset:\r
1613 if type(SkuId) in (str, unicode) and eval(SkuId) == 0 or SkuId == 0:\r
2b8a6c44 1614 continue\r
55c84777 1615 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList[TAB_DEFAULT])\r
65eff519 1616 pcd.SkuInfoList[SkuName].SkuId = SkuId\r
71127ce8 1617 pcd.SkuInfoList[SkuName].SkuIdName = SkuName\r
a0a2cd1e 1618 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
47854fd5 1619\r
ccaa7754 1620 def FixVpdOffset(self, VpdFile ):\r
91fa33ee 1621 FvPath = os.path.join(self.BuildDir, TAB_FV_DIRECTORY)\r
47854fd5
LG
1622 if not os.path.exists(FvPath):\r
1623 try:\r
1624 os.makedirs(FvPath)\r
1625 except:\r
1626 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
1627\r
1628 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1629\r
1630 if VpdFile.Write(VpdFilePath):\r
1631 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1632 BPDGToolName = None\r
1633 for ToolDef in self.ToolDefinition.values():\r
27c4ceb4
GL
1634 if TAB_GUID in ToolDef and ToolDef[TAB_GUID] == self.Platform.VpdToolGuid:\r
1635 if "PATH" not in ToolDef:\r
47854fd5
LG
1636 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1637 BPDGToolName = ToolDef["PATH"]\r
1638 break\r
1639 # Call third party GUID BPDG tool.\r
4231a819 1640 if BPDGToolName is not None:\r
47854fd5
LG
1641 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
1642 else:\r
1643 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
1644\r
52302d4d 1645 ## Return the platform build data object\r
e6eae3b4
CJ
1646 @cached_property\r
1647 def Platform(self):\r
1648 return self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1649\r
1650 ## Return platform name\r
e6eae3b4
CJ
1651 @cached_property\r
1652 def Name(self):\r
52302d4d
LG
1653 return self.Platform.PlatformName\r
1654\r
1655 ## Return the meta file GUID\r
e6eae3b4
CJ
1656 @cached_property\r
1657 def Guid(self):\r
52302d4d
LG
1658 return self.Platform.Guid\r
1659\r
1660 ## Return the platform version\r
e6eae3b4
CJ
1661 @cached_property\r
1662 def Version(self):\r
52302d4d
LG
1663 return self.Platform.Version\r
1664\r
1665 ## Return the FDF file name\r
e6eae3b4
CJ
1666 @cached_property\r
1667 def FdfFile(self):\r
1668 if self.Workspace.FdfFile:\r
1669 RetVal= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
1670 else:\r
1671 RetVal = ''\r
1672 return RetVal\r
52302d4d
LG
1673\r
1674 ## Return the build output directory platform specifies\r
e6eae3b4
CJ
1675 @cached_property\r
1676 def OutputDir(self):\r
52302d4d
LG
1677 return self.Platform.OutputDirectory\r
1678\r
1679 ## Return the directory to store all intermediate and final files built\r
e6eae3b4
CJ
1680 @cached_property\r
1681 def BuildDir(self):\r
1682 if os.path.isabs(self.OutputDir):\r
1683 GlobalData.gBuildDirectory = RetVal = path.join(\r
1684 path.abspath(self.OutputDir),\r
1685 self.BuildTarget + "_" + self.ToolChain,\r
1686 )\r
1687 else:\r
1688 GlobalData.gBuildDirectory = RetVal = path.join(\r
1689 self.WorkspaceDir,\r
1690 self.OutputDir,\r
1691 self.BuildTarget + "_" + self.ToolChain,\r
1692 )\r
1693 return RetVal\r
52302d4d
LG
1694\r
1695 ## Return directory of platform makefile\r
1696 #\r
1697 # @retval string Makefile directory\r
1698 #\r
e6eae3b4
CJ
1699 @cached_property\r
1700 def MakeFileDir(self):\r
1701 return path.join(self.BuildDir, self.Arch)\r
52302d4d
LG
1702\r
1703 ## Return build command string\r
1704 #\r
1705 # @retval string Build command string\r
1706 #\r
e6eae3b4
CJ
1707 @cached_property\r
1708 def BuildCommand(self):\r
1709 RetVal = []\r
1710 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1711 RetVal += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1712 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1713 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1714 if NewOption != '':\r
1715 RetVal += SplitOption(NewOption)\r
1716 if "MAKE" in self.EdkIIBuildOption:\r
1717 if "FLAGS" in self.EdkIIBuildOption["MAKE"]:\r
1718 Flags = self.EdkIIBuildOption["MAKE"]["FLAGS"]\r
1719 if Flags.startswith('='):\r
1720 RetVal = [RetVal[0]] + [Flags[1:]]\r
1721 else:\r
1722 RetVal.append(Flags)\r
1723 return RetVal\r
52302d4d
LG
1724\r
1725 ## Get tool chain definition\r
1726 #\r
1727 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1728 #\r
e6eae3b4
CJ
1729 @cached_property\r
1730 def ToolDefinition(self):\r
1731 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1732 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1733 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1734 ExtraData="[%s]" % self.MetaFile)\r
1735 RetVal = {}\r
1736 DllPathList = set()\r
1737 for Def in ToolDefinition:\r
1738 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1739 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1740 continue\r
52302d4d 1741\r
e6eae3b4
CJ
1742 Value = ToolDefinition[Def]\r
1743 # don't record the DLL\r
1744 if Attr == "DLL":\r
1745 DllPathList.add(Value)\r
1746 continue\r
52302d4d 1747\r
e6eae3b4
CJ
1748 if Tool not in RetVal:\r
1749 RetVal[Tool] = {}\r
1750 RetVal[Tool][Attr] = Value\r
1751\r
1752 ToolsDef = ''\r
1753 if GlobalData.gOptions.SilentMode and "MAKE" in RetVal:\r
1754 if "FLAGS" not in RetVal["MAKE"]:\r
1755 RetVal["MAKE"]["FLAGS"] = ""\r
1756 RetVal["MAKE"]["FLAGS"] += " -s"\r
1757 MakeFlags = ''\r
1758 for Tool in RetVal:\r
1759 for Attr in RetVal[Tool]:\r
1760 Value = RetVal[Tool][Attr]\r
1761 if Tool in self._BuildOptionWithToolDef(RetVal) and Attr in self._BuildOptionWithToolDef(RetVal)[Tool]:\r
1762 # check if override is indicated\r
1763 if self._BuildOptionWithToolDef(RetVal)[Tool][Attr].startswith('='):\r
1764 Value = self._BuildOptionWithToolDef(RetVal)[Tool][Attr][1:]\r
1765 else:\r
1766 if Attr != 'PATH':\r
1767 Value += " " + self._BuildOptionWithToolDef(RetVal)[Tool][Attr]\r
52302d4d 1768 else:\r
e6eae3b4
CJ
1769 Value = self._BuildOptionWithToolDef(RetVal)[Tool][Attr]\r
1770\r
1771 if Attr == "PATH":\r
1772 # Don't put MAKE definition in the file\r
1773 if Tool != "MAKE":\r
1774 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1775 elif Attr != "DLL":\r
1776 # Don't put MAKE definition in the file\r
1777 if Tool == "MAKE":\r
1778 if Attr == "FLAGS":\r
1779 MakeFlags = Value\r
1780 else:\r
1781 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1782 ToolsDef += "\n"\r
52302d4d 1783\r
e6eae3b4
CJ
1784 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1785 for DllPath in DllPathList:\r
1786 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1787 os.environ["MAKE_FLAGS"] = MakeFlags\r
52302d4d 1788\r
e6eae3b4 1789 return RetVal\r
52302d4d
LG
1790\r
1791 ## Return the paths of tools\r
e6eae3b4
CJ
1792 @cached_property\r
1793 def ToolDefinitionFile(self):\r
1794 return os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
52302d4d
LG
1795\r
1796 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
e6eae3b4
CJ
1797 @cached_property\r
1798 def ToolChainFamily(self):\r
1799 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1800 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
1801 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
1802 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
1803 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1804 % self.ToolChain)\r
1805 RetVal = TAB_COMPILER_MSFT\r
1806 else:\r
1807 RetVal = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
1808 return RetVal\r
1809\r
1810 @cached_property\r
1811 def BuildRuleFamily(self):\r
1812 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1813 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
1814 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
1815 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
1816 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1817 % self.ToolChain)\r
1818 return TAB_COMPILER_MSFT\r
1819\r
1820 return ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
52302d4d
LG
1821\r
1822 ## Return the build options specific for all modules in this platform\r
e6eae3b4
CJ
1823 @cached_property\r
1824 def BuildOption(self):\r
1825 return self._ExpandBuildOption(self.Platform.BuildOptions)\r
1826\r
1827 def _BuildOptionWithToolDef(self, ToolDef):\r
1828 return self._ExpandBuildOption(self.Platform.BuildOptions, ToolDef=ToolDef)\r
52302d4d
LG
1829\r
1830 ## Return the build options specific for EDK modules in this platform\r
e6eae3b4
CJ
1831 @cached_property\r
1832 def EdkBuildOption(self):\r
1833 return self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
52302d4d
LG
1834\r
1835 ## Return the build options specific for EDKII modules in this platform\r
e6eae3b4
CJ
1836 @cached_property\r
1837 def EdkIIBuildOption(self):\r
1838 return self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
52302d4d 1839\r
97fa0ee9 1840 ## Parse build_rule.txt in Conf Directory.\r
52302d4d
LG
1841 #\r
1842 # @retval BuildRule object\r
1843 #\r
e6eae3b4
CJ
1844 @cached_property\r
1845 def BuildRule(self):\r
1846 BuildRuleFile = None\r
1847 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
1848 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
1849 if not BuildRuleFile:\r
1850 BuildRuleFile = gDefaultBuildRuleFile\r
1851 RetVal = BuildRule(BuildRuleFile)\r
1852 if RetVal._FileVersion == "":\r
1853 RetVal._FileVersion = AutoGenReqBuildRuleVerNum\r
1854 else:\r
1855 if RetVal._FileVersion < AutoGenReqBuildRuleVerNum :\r
1856 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
1857 EdkLogger.error("build", AUTOGEN_ERROR,\r
1858 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
1859 % (RetVal._FileVersion, AutoGenReqBuildRuleVerNum))\r
1860 return RetVal\r
52302d4d
LG
1861\r
1862 ## Summarize the packages used by modules in this platform\r
e6eae3b4
CJ
1863 @cached_property\r
1864 def PackageList(self):\r
1865 RetVal = set()\r
1866 for La in self.LibraryAutoGenList:\r
1867 RetVal.update(La.DependentPackageList)\r
1868 for Ma in self.ModuleAutoGenList:\r
1869 RetVal.update(Ma.DependentPackageList)\r
1870 #Collect package set information from INF of FDF\r
1871 for ModuleFile in self._AsBuildModuleList:\r
1872 if ModuleFile in self.Platform.Modules:\r
1873 continue\r
1874 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]\r
1875 RetVal.update(ModuleData.Packages)\r
1876 return list(RetVal)\r
52302d4d 1877\r
e6eae3b4
CJ
1878 @cached_property\r
1879 def NonDynamicPcdDict(self):\r
1880 return {(Pcd.TokenCName, Pcd.TokenSpaceGuidCName):Pcd for Pcd in self.NonDynamicPcdList}\r
2bc3256c 1881\r
52302d4d 1882 ## Get list of non-dynamic PCDs\r
e6eae3b4
CJ
1883 @cached_property\r
1884 def NonDynamicPcdList(self):\r
1885 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1886 return self._NonDynamicPcdList\r
1887\r
1888 ## Get list of dynamic PCDs\r
e6eae3b4
CJ
1889 @cached_property\r
1890 def DynamicPcdList(self):\r
1891 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1892 return self._DynamicPcdList\r
1893\r
1894 ## Generate Token Number for all PCD\r
e6eae3b4
CJ
1895 @cached_property\r
1896 def PcdTokenNumber(self):\r
1897 RetVal = OrderedDict()\r
1898 TokenNumber = 1\r
1899 #\r
1900 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area.\r
1901 # Such as:\r
1902 #\r
1903 # Dynamic PCD:\r
1904 # TokenNumber 0 ~ 10\r
1905 # DynamicEx PCD:\r
1906 # TokeNumber 11 ~ 20\r
1907 #\r
1908 for Pcd in self.DynamicPcdList:\r
1909 if Pcd.Phase == "PEI" and Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
1910 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1911 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1912 TokenNumber += 1\r
1913\r
1914 for Pcd in self.DynamicPcdList:\r
1915 if Pcd.Phase == "PEI" and Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
1916 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1917 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1918 TokenNumber += 1\r
1919\r
1920 for Pcd in self.DynamicPcdList:\r
1921 if Pcd.Phase == "DXE" and Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
1922 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1923 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1924 TokenNumber += 1\r
1925\r
1926 for Pcd in self.DynamicPcdList:\r
1927 if Pcd.Phase == "DXE" and Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
1928 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1929 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
52302d4d 1930 TokenNumber += 1\r
52302d4d 1931\r
e6eae3b4
CJ
1932 for Pcd in self.NonDynamicPcdList:\r
1933 RetVal[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1934 TokenNumber += 1\r
1935 return RetVal\r
1936\r
1937 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
1938 @cached_property\r
1939 def ModuleAutoGenList(self):\r
1940 RetVal = []\r
1941 for ModuleFile in self.Platform.Modules:\r
1942 Ma = ModuleAutoGen(\r
1943 self.Workspace,\r
1944 ModuleFile,\r
1945 self.BuildTarget,\r
1946 self.ToolChain,\r
1947 self.Arch,\r
1948 self.MetaFile\r
1949 )\r
1950 if Ma not in RetVal:\r
1951 RetVal.append(Ma)\r
1952 return RetVal\r
1953\r
1954 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
1955 @cached_property\r
1956 def LibraryAutoGenList(self):\r
1957 RetVal = []\r
52302d4d
LG
1958 for ModuleFile in self.Platform.Modules:\r
1959 Ma = ModuleAutoGen(\r
1960 self.Workspace,\r
1961 ModuleFile,\r
1962 self.BuildTarget,\r
1963 self.ToolChain,\r
1964 self.Arch,\r
1965 self.MetaFile\r
1966 )\r
52302d4d 1967 for La in Ma.LibraryAutoGenList:\r
e6eae3b4
CJ
1968 if La not in RetVal:\r
1969 RetVal.append(La)\r
b23414f6
JC
1970 if Ma not in La.ReferenceModules:\r
1971 La.ReferenceModules.append(Ma)\r
e6eae3b4 1972 return RetVal\r
52302d4d
LG
1973\r
1974 ## Test if a module is supported by the platform\r
1975 #\r
1976 # An error will be raised directly if the module or its arch is not supported\r
1977 # by the platform or current configuration\r
1978 #\r
1979 def ValidModule(self, Module):\r
a0a2cd1e
FB
1980 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \\r
1981 or Module in self._AsBuildModuleList\r
52302d4d
LG
1982\r
1983 ## Resolve the library classes in a module to library instances\r
1984 #\r
1985 # This method will not only resolve library classes but also sort the library\r
1986 # instances according to the dependency-ship.\r
1987 #\r
1988 # @param Module The module from which the library classes will be resolved\r
1989 #\r
1990 # @retval library_list List of library instances sorted\r
1991 #\r
1992 def ApplyLibraryInstance(self, Module):\r
25193a33
YZ
1993 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly\r
1994 if str(Module) not in self.Platform.Modules:\r
1995 return []\r
1996\r
c14b5861
JC
1997 return GetModuleLibInstances(Module,\r
1998 self.Platform,\r
1999 self.BuildDatabase,\r
2000 self.Arch,\r
2001 self.BuildTarget,\r
2002 self.ToolChain,\r
2003 self.MetaFile,\r
2004 EdkLogger)\r
52302d4d
LG
2005\r
2006 ## Override PCD setting (type, value, ...)\r
2007 #\r
2008 # @param ToPcd The PCD to be overrided\r
2009 # @param FromPcd The PCD overrideing from\r
2010 #\r
a253d217 2011 def _OverridePcd(self, ToPcd, FromPcd, Module="", Msg="", Library=""):\r
52302d4d
LG
2012 #\r
2013 # in case there's PCDs coming from FDF file, which have no type given.\r
2014 # at this point, ToPcd.Type has the type found from dependent\r
2015 # package\r
2016 #\r
2a29017e
YZ
2017 TokenCName = ToPcd.TokenCName\r
2018 for PcdItem in GlobalData.MixedPcd:\r
2019 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
2020 TokenCName = PcdItem[0]\r
2021 break\r
4231a819 2022 if FromPcd is not None:\r
c93356ad 2023 if ToPcd.Pending and FromPcd.Type:\r
52302d4d 2024 ToPcd.Type = FromPcd.Type\r
caf74495
JC
2025 elif ToPcd.Type and FromPcd.Type\\r
2026 and ToPcd.Type != FromPcd.Type and ToPcd.Type in FromPcd.Type:\r
6b1f2cf4 2027 if ToPcd.Type.strip() == TAB_PCDS_DYNAMIC_EX:\r
47fea6af 2028 ToPcd.Type = FromPcd.Type\r
c93356ad 2029 elif ToPcd.Type and FromPcd.Type \\r
52302d4d 2030 and ToPcd.Type != FromPcd.Type:\r
a253d217
YF
2031 if Library:\r
2032 Module = str(Module) + " 's library file (" + str(Library) + ")"\r
52302d4d 2033 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
a253d217 2034 ExtraData="%s.%s is used as [%s] in module %s, but as [%s] in %s."\\r
2a29017e 2035 % (ToPcd.TokenSpaceGuidCName, TokenCName,\r
a253d217 2036 ToPcd.Type, Module, FromPcd.Type, Msg),\r
52302d4d
LG
2037 File=self.MetaFile)\r
2038\r
6be94743 2039 if FromPcd.MaxDatumSize:\r
52302d4d 2040 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
c33081c9 2041 ToPcd.MaxSizeUserSet = FromPcd.MaxDatumSize\r
6be94743 2042 if FromPcd.DefaultValue:\r
52302d4d 2043 ToPcd.DefaultValue = FromPcd.DefaultValue\r
6be94743 2044 if FromPcd.TokenValue:\r
52302d4d 2045 ToPcd.TokenValue = FromPcd.TokenValue\r
6be94743 2046 if FromPcd.DatumType:\r
52302d4d 2047 ToPcd.DatumType = FromPcd.DatumType\r
6be94743 2048 if FromPcd.SkuInfoList:\r
52302d4d 2049 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
ced86858
ZZ
2050 if FromPcd.UserDefinedDefaultStoresFlag:\r
2051 ToPcd.UserDefinedDefaultStoresFlag = FromPcd.UserDefinedDefaultStoresFlag\r
726c501c 2052 # Add Flexible PCD format parse\r
726c501c 2053 if ToPcd.DefaultValue:\r
726c501c 2054 try:\r
e6eae3b4 2055 ToPcd.DefaultValue = ValueExpressionEx(ToPcd.DefaultValue, ToPcd.DatumType, self.Workspace._GuidDict)(True)\r
5b0671c1 2056 except BadExpression as Value:\r
726c501c
YZ
2057 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),\r
2058 File=self.MetaFile)\r
52302d4d
LG
2059\r
2060 # check the validation of datum\r
2061 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
2062 if not IsValid:\r
2063 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
2a29017e 2064 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
82a6a960
BF
2065 ToPcd.validateranges = FromPcd.validateranges\r
2066 ToPcd.validlists = FromPcd.validlists\r
2067 ToPcd.expressions = FromPcd.expressions\r
52302d4d 2068\r
c93356ad 2069 if FromPcd is not None and ToPcd.DatumType == TAB_VOID and not ToPcd.MaxDatumSize:\r
52302d4d 2070 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
2a29017e 2071 % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
52302d4d 2072 Value = ToPcd.DefaultValue\r
c93356ad 2073 if not Value:\r
e8a47801 2074 ToPcd.MaxDatumSize = '1'\r
52302d4d 2075 elif Value[0] == 'L':\r
e8a47801 2076 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
52302d4d
LG
2077 elif Value[0] == '{':\r
2078 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
2079 else:\r
e8a47801 2080 ToPcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2081\r
2082 # apply default SKU for dynamic PCDS if specified one is not available\r
eece4292 2083 if (ToPcd.Type in PCD_DYNAMIC_TYPE_SET or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_SET) \\r
c93356ad 2084 and not ToPcd.SkuInfoList:\r
52302d4d
LG
2085 if self.Platform.SkuName in self.Platform.SkuIds:\r
2086 SkuName = self.Platform.SkuName\r
2087 else:\r
55c84777 2088 SkuName = TAB_DEFAULT\r
52302d4d 2089 ToPcd.SkuInfoList = {\r
8518bf0b 2090 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)\r
52302d4d
LG
2091 }\r
2092\r
2093 ## Apply PCD setting defined platform to a module\r
2094 #\r
2095 # @param Module The module from which the PCD setting will be overrided\r
2096 #\r
2097 # @retval PCD_list The list PCDs with settings from platform\r
2098 #\r
a253d217 2099 def ApplyPcdSetting(self, Module, Pcds, Library=""):\r
52302d4d 2100 # for each PCD in module\r
47fea6af
YZ
2101 for Name, Guid in Pcds:\r
2102 PcdInModule = Pcds[Name, Guid]\r
52302d4d 2103 # find out the PCD setting in platform\r
47fea6af
YZ
2104 if (Name, Guid) in self.Platform.Pcds:\r
2105 PcdInPlatform = self.Platform.Pcds[Name, Guid]\r
52302d4d
LG
2106 else:\r
2107 PcdInPlatform = None\r
2108 # then override the settings if any\r
a253d217 2109 self._OverridePcd(PcdInModule, PcdInPlatform, Module, Msg="DSC PCD sections", Library=Library)\r
52302d4d
LG
2110 # resolve the VariableGuid value\r
2111 for SkuId in PcdInModule.SkuInfoList:\r
2112 Sku = PcdInModule.SkuInfoList[SkuId]\r
2113 if Sku.VariableGuid == '': continue\r
c28d2e10 2114 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)\r
4231a819 2115 if Sku.VariableGuidValue is None:\r
8252e6bf 2116 PackageList = "\n\t".join(str(P) for P in self.PackageList)\r
52302d4d
LG
2117 EdkLogger.error(\r
2118 'build',\r
2119 RESOURCE_NOT_AVAILABLE,\r
2120 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
2121 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
2122 % (Guid, Name, str(Module)),\r
2123 File=self.MetaFile\r
2124 )\r
2125\r
2126 # override PCD settings with module specific setting\r
2127 if Module in self.Platform.Modules:\r
2128 PlatformModule = self.Platform.Modules[str(Module)]\r
2129 for Key in PlatformModule.Pcds:\r
aa9aa47e 2130 Flag = False\r
52302d4d 2131 if Key in Pcds:\r
aa9aa47e
YZ
2132 ToPcd = Pcds[Key]\r
2133 Flag = True\r
2134 elif Key in GlobalData.MixedPcd:\r
2135 for PcdItem in GlobalData.MixedPcd[Key]:\r
2136 if PcdItem in Pcds:\r
2137 ToPcd = Pcds[PcdItem]\r
2138 Flag = True\r
2139 break\r
2140 if Flag:\r
a253d217 2141 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module, Msg="DSC Components Module scoped PCD section", Library=Library)\r
cdbf45ad
YZ
2142 # use PCD value to calculate the MaxDatumSize when it is not specified\r
2143 for Name, Guid in Pcds:\r
2144 Pcd = Pcds[Name, Guid]\r
c93356ad 2145 if Pcd.DatumType == TAB_VOID and not Pcd.MaxDatumSize:\r
c33081c9 2146 Pcd.MaxSizeUserSet = None\r
cdbf45ad 2147 Value = Pcd.DefaultValue\r
c93356ad 2148 if not Value:\r
cdbf45ad
YZ
2149 Pcd.MaxDatumSize = '1'\r
2150 elif Value[0] == 'L':\r
2151 Pcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
2152 elif Value[0] == '{':\r
2153 Pcd.MaxDatumSize = str(len(Value.split(',')))\r
2154 else:\r
2155 Pcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2156 return Pcds.values()\r
2157\r
2158 ## Resolve library names to library modules\r
2159 #\r
b36d134f 2160 # (for Edk.x modules)\r
52302d4d
LG
2161 #\r
2162 # @param Module The module from which the library names will be resolved\r
2163 #\r
2164 # @retval library_list The list of library modules\r
2165 #\r
2166 def ResolveLibraryReference(self, Module):\r
2167 EdkLogger.verbose("")\r
2168 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2169 LibraryConsumerList = [Module]\r
2170\r
b36d134f 2171 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
2172 if Module.Libraries:\r
2173 Module.Libraries.append("CompilerStub")\r
2174 LibraryList = []\r
2175 while len(LibraryConsumerList) > 0:\r
2176 M = LibraryConsumerList.pop()\r
2177 for LibraryName in M.Libraries:\r
2178 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
4231a819 2179 if Library is None:\r
9eb87141 2180 for Key in self.Platform.LibraryClasses.data:\r
52302d4d
LG
2181 if LibraryName.upper() == Key.upper():\r
2182 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
2183 break\r
4231a819 2184 if Library is None:\r
52302d4d
LG
2185 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
2186 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
2187 continue\r
2188\r
2189 if Library not in LibraryList:\r
2190 LibraryList.append(Library)\r
2191 LibraryConsumerList.append(Library)\r
2192 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
2193 return LibraryList\r
2194\r
6780eef1
LG
2195 ## Calculate the priority value of the build option\r
2196 #\r
2197 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2198 #\r
2199 # @retval Value Priority value based on the priority list.\r
2200 #\r
2201 def CalculatePriorityValue(self, Key):\r
47fea6af
YZ
2202 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
2203 PriorityValue = 0x11111\r
6780eef1
LG
2204 if Target == "*":\r
2205 PriorityValue &= 0x01111\r
2206 if ToolChain == "*":\r
2207 PriorityValue &= 0x10111\r
2208 if Arch == "*":\r
2209 PriorityValue &= 0x11011\r
2210 if CommandType == "*":\r
2211 PriorityValue &= 0x11101\r
2212 if Attr == "*":\r
2213 PriorityValue &= 0x11110\r
47fea6af
YZ
2214\r
2215 return self.PrioList["0x%0.5x" % PriorityValue]\r
2216\r
6780eef1 2217\r
52302d4d
LG
2218 ## Expand * in build option key\r
2219 #\r
2220 # @param Options Options to be expanded\r
e6eae3b4
CJ
2221 # @param ToolDef Use specified ToolDef instead of full version.\r
2222 # This is needed during initialization to prevent\r
2223 # infinite recursion betweeh BuildOptions,\r
2224 # ToolDefinition, and this function.\r
52302d4d
LG
2225 #\r
2226 # @retval options Options expanded\r
f7496d71 2227 #\r
e6eae3b4
CJ
2228 def _ExpandBuildOption(self, Options, ModuleStyle=None, ToolDef=None):\r
2229 if not ToolDef:\r
2230 ToolDef = self.ToolDefinition\r
52302d4d
LG
2231 BuildOptions = {}\r
2232 FamilyMatch = False\r
2233 FamilyIsNull = True\r
47fea6af 2234\r
6780eef1
LG
2235 OverrideList = {}\r
2236 #\r
2237 # Construct a list contain the build options which need override.\r
2238 #\r
2239 for Key in Options:\r
2240 #\r
2241 # Key[0] -- tool family\r
2242 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2243 #\r
1ba5124e 2244 if (Key[0] == self.BuildRuleFamily and\r
4231a819 2245 (ModuleStyle is None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):\r
6780eef1 2246 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
caf74495
JC
2247 if (Target == self.BuildTarget or Target == "*") and\\r
2248 (ToolChain == self.ToolChain or ToolChain == "*") and\\r
2249 (Arch == self.Arch or Arch == "*") and\\r
2250 Options[Key].startswith("="):\r
2251\r
2252 if OverrideList.get(Key[1]) is not None:\r
2253 OverrideList.pop(Key[1])\r
2254 OverrideList[Key[1]] = Options[Key]\r
f7496d71 2255\r
6780eef1 2256 #\r
f7496d71 2257 # Use the highest priority value.\r
6780eef1
LG
2258 #\r
2259 if (len(OverrideList) >= 2):\r
47fea6af 2260 KeyList = OverrideList.keys()\r
6780eef1 2261 for Index in range(len(KeyList)):\r
47fea6af 2262 NowKey = KeyList[Index]\r
6780eef1
LG
2263 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
2264 for Index1 in range(len(KeyList) - Index - 1):\r
2265 NextKey = KeyList[Index1 + Index + 1]\r
2266 #\r
2267 # Compare two Key, if one is included by another, choose the higher priority one\r
f7496d71 2268 #\r
6780eef1 2269 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
caf74495
JC
2270 if (Target1 == Target2 or Target1 == "*" or Target2 == "*") and\\r
2271 (ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*") and\\r
2272 (Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*") and\\r
2273 (CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*") and\\r
2274 (Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*"):\r
2275\r
2276 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
2277 if Options.get((self.BuildRuleFamily, NextKey)) is not None:\r
2278 Options.pop((self.BuildRuleFamily, NextKey))\r
2279 else:\r
2280 if Options.get((self.BuildRuleFamily, NowKey)) is not None:\r
2281 Options.pop((self.BuildRuleFamily, NowKey))\r
f7496d71 2282\r
52302d4d 2283 for Key in Options:\r
4231a819 2284 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2285 # Check Module style is EDK or EDKII.\r
2286 # Only append build option for the matched style module.\r
2287 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2288 continue\r
2289 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2290 continue\r
2291 Family = Key[0]\r
2292 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2293 # if tool chain family doesn't match, skip it\r
e6eae3b4 2294 if Tool in ToolDef and Family != "":\r
52302d4d 2295 FamilyIsNull = False\r
e6eae3b4
CJ
2296 if ToolDef[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
2297 if Family != ToolDef[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
52302d4d 2298 continue\r
e6eae3b4 2299 elif Family != ToolDef[Tool][TAB_TOD_DEFINES_FAMILY]:\r
52302d4d
LG
2300 continue\r
2301 FamilyMatch = True\r
2302 # expand any wildcard\r
2303 if Target == "*" or Target == self.BuildTarget:\r
2304 if Tag == "*" or Tag == self.ToolChain:\r
2305 if Arch == "*" or Arch == self.Arch:\r
2306 if Tool not in BuildOptions:\r
2307 BuildOptions[Tool] = {}\r
5015bee2 2308 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2309 BuildOptions[Tool][Attr] = Options[Key]\r
2310 else:\r
95816356
YZ
2311 # append options for the same tool except PATH\r
2312 if Attr != 'PATH':\r
2313 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2314 else:\r
2315 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2316 # Build Option Family has been checked, which need't to be checked again for family.\r
2317 if FamilyMatch or FamilyIsNull:\r
2318 return BuildOptions\r
1ba5124e 2319\r
52302d4d 2320 for Key in Options:\r
4231a819 2321 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2322 # Check Module style is EDK or EDKII.\r
2323 # Only append build option for the matched style module.\r
2324 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2325 continue\r
2326 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2327 continue\r
2328 Family = Key[0]\r
2329 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2330 # if tool chain family doesn't match, skip it\r
e6eae3b4 2331 if Tool not in ToolDef or Family == "":\r
52302d4d
LG
2332 continue\r
2333 # option has been added before\r
e6eae3b4 2334 if Family != ToolDef[Tool][TAB_TOD_DEFINES_FAMILY]:\r
52302d4d
LG
2335 continue\r
2336\r
2337 # expand any wildcard\r
2338 if Target == "*" or Target == self.BuildTarget:\r
2339 if Tag == "*" or Tag == self.ToolChain:\r
2340 if Arch == "*" or Arch == self.Arch:\r
2341 if Tool not in BuildOptions:\r
2342 BuildOptions[Tool] = {}\r
5015bee2 2343 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2344 BuildOptions[Tool][Attr] = Options[Key]\r
2345 else:\r
95816356
YZ
2346 # append options for the same tool except PATH\r
2347 if Attr != 'PATH':\r
2348 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2349 else:\r
2350 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2351 return BuildOptions\r
2352\r
2353 ## Append build options in platform to a module\r
2354 #\r
2355 # @param Module The module to which the build options will be appened\r
2356 #\r
2357 # @retval options The options appended with build options in platform\r
2358 #\r
2359 def ApplyBuildOption(self, Module):\r
2360 # Get the different options for the different style module\r
2361 if Module.AutoGenVersion < 0x00010005:\r
2362 PlatformOptions = self.EdkBuildOption\r
35f69db9 2363 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)\r
52302d4d
LG
2364 else:\r
2365 PlatformOptions = self.EdkIIBuildOption\r
35f69db9
YL
2366 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)\r
2367 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)\r
52302d4d
LG
2368 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
2369 if Module in self.Platform.Modules:\r
2370 PlatformModule = self.Platform.Modules[str(Module)]\r
2371 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
2372 else:\r
2373 PlatformModuleOptions = {}\r
2374\r
fe4bf2f9 2375 BuildRuleOrder = None\r
35f69db9 2376 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
fe4bf2f9
YL
2377 for Tool in Options:\r
2378 for Attr in Options[Tool]:\r
2379 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2380 BuildRuleOrder = Options[Tool][Attr]\r
2381\r
35f69db9
YL
2382 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +\r
2383 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +\r
2384 self.ToolDefinition.keys())\r
339fe8dd 2385 BuildOptions = defaultdict(lambda: defaultdict(str))\r
52302d4d 2386 for Tool in AllTools:\r
35f69db9 2387 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
52302d4d
LG
2388 if Tool not in Options:\r
2389 continue\r
2390 for Attr in Options[Tool]:\r
fe4bf2f9
YL
2391 #\r
2392 # Do not generate it in Makefile\r
2393 #\r
2394 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2395 continue\r
339fe8dd 2396 Value = Options[Tool][Attr]\r
52302d4d
LG
2397 # check if override is indicated\r
2398 if Value.startswith('='):\r
339fe8dd 2399 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value[1:])\r
5015bee2 2400 else:\r
95816356 2401 if Attr != 'PATH':\r
339fe8dd 2402 BuildOptions[Tool][Attr] += " " + mws.handleWsMacro(Value)\r
95816356 2403 else:\r
339fe8dd
CJ
2404 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value)\r
2405\r
4231a819 2406 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag is not None:\r
f3decdc3
LG
2407 #\r
2408 # Override UNI flag only for EDK module.\r
2409 #\r
f3decdc3 2410 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
fe4bf2f9 2411 return BuildOptions, BuildRuleOrder\r
52302d4d 2412\r
caf74495
JC
2413#\r
2414# extend lists contained in a dictionary with lists stored in another dictionary\r
2415# if CopyToDict is not derived from DefaultDict(list) then this may raise exception\r
2416#\r
2417def ExtendCopyDictionaryLists(CopyToDict, CopyFromDict):\r
2418 for Key in CopyFromDict:\r
2419 CopyToDict[Key].extend(CopyFromDict[Key])\r
2420\r
b23414f6
JC
2421# Create a directory specified by a set of path elements and return the full path\r
2422def _MakeDir(PathList):\r
2423 RetVal = path.join(*PathList)\r
2424 CreateDirectory(RetVal)\r
2425 return RetVal\r
caf74495 2426\r
52302d4d
LG
2427## ModuleAutoGen class\r
2428#\r
2429# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
2430# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
2431# to the [depex] section in module's inf file.\r
2432#\r
2433class ModuleAutoGen(AutoGen):\r
b24e99f7
CJ
2434 # call super().__init__ then call the worker function with different parameter count\r
2435 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b23414f6 2436 if not hasattr(self, "_Init"):\r
b24e99f7
CJ
2437 super(ModuleAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
2438 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args)\r
2439 self._Init = True\r
2440\r
b23414f6 2441 ## Cache the timestamps of metafiles of every module in a class attribute\r
c17956e0
DL
2442 #\r
2443 TimeDict = {}\r
2444\r
b24e99f7 2445 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
b24e99f7
CJ
2446 # check if this module is employed by active platform\r
2447 if not PlatformAutoGen(Workspace, args[0], Target, Toolchain, Arch).ValidModule(MetaFile):\r
2448 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
2449 % (MetaFile, Arch))\r
2450 return None\r
b23414f6 2451 return super(ModuleAutoGen, cls).__new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
f7496d71 2452\r
b24e99f7 2453 ## Initialize ModuleAutoGen\r
52302d4d
LG
2454 #\r
2455 # @param Workspace EdkIIWorkspaceBuild object\r
2456 # @param ModuleFile The path of module file\r
2457 # @param Target Build target (DEBUG, RELEASE)\r
2458 # @param Toolchain Name of tool chain\r
2459 # @param Arch The arch the module supports\r
2460 # @param PlatformFile Platform meta-file\r
2461 #\r
b24e99f7 2462 def _InitWorker(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
52302d4d
LG
2463 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
2464 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
2465\r
2466 self.Workspace = Workspace\r
2467 self.WorkspaceDir = Workspace.WorkspaceDir\r
52302d4d
LG
2468 self.MetaFile = ModuleFile\r
2469 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
52302d4d
LG
2470\r
2471 self.SourceDir = self.MetaFile.SubDir\r
05cc51ad 2472 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)\r
97fa0ee9 2473\r
52302d4d
LG
2474 self.SourceOverrideDir = None\r
2475 # use overrided path defined in DSC file\r
2476 if self.MetaFile.Key in GlobalData.gOverrideDir:\r
2477 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]\r
2478\r
2479 self.ToolChain = Toolchain\r
2480 self.BuildTarget = Target\r
2481 self.Arch = Arch\r
2482 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily\r
2483 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily\r
2484\r
52302d4d 2485 self.IsCodeFileCreated = False\r
da92f276
LG
2486 self.IsAsBuiltInfCreated = False\r
2487 self.DepexGenerated = False\r
52302d4d
LG
2488\r
2489 self.BuildDatabase = self.Workspace.BuildDatabase\r
fe4bf2f9 2490 self.BuildRuleOrder = None\r
1b8eca8b 2491 self.BuildTime = 0\r
52302d4d 2492\r
caf74495 2493 self._PcdComments = OrderedListDict()\r
caf74495 2494 self._GuidComments = OrderedListDict()\r
caf74495 2495 self._ProtocolComments = OrderedListDict()\r
caf74495 2496 self._PpiComments = OrderedListDict()\r
52302d4d
LG
2497 self._BuildTargets = None\r
2498 self._IntroBuildTargetList = None\r
2499 self._FinalBuildTargetList = None\r
2500 self._FileTypes = None\r
c17956e0
DL
2501\r
2502 self.AutoGenDepSet = set()\r
b23414f6 2503 self.ReferenceModules = []\r
2bc3256c 2504 self.ConstPcd = {}\r
52302d4d 2505\r
a10def91 2506\r
52302d4d
LG
2507 def __repr__(self):\r
2508 return "%s [%s]" % (self.MetaFile, self.Arch)\r
2509\r
2bc3256c 2510 # Get FixedAtBuild Pcds of this Module\r
b23414f6
JC
2511 @cached_property\r
2512 def FixedAtBuildPcds(self):\r
2513 RetVal = []\r
2bc3256c 2514 for Pcd in self.ModulePcdList:\r
6b1f2cf4 2515 if Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
2bc3256c 2516 continue\r
b23414f6
JC
2517 if Pcd not in RetVal:\r
2518 RetVal.append(Pcd)\r
2519 return RetVal\r
2520\r
2521 @cached_property\r
2522 def FixedVoidTypePcds(self):\r
2523 RetVal = {}\r
2524 for Pcd in self.FixedAtBuildPcds:\r
2525 if Pcd.DatumType == TAB_VOID:\r
2526 if '{}.{}'.format(Pcd.TokenSpaceGuidCName, Pcd.TokenCName) not in RetVal:\r
2527 RetVal['{}.{}'.format(Pcd.TokenSpaceGuidCName, Pcd.TokenCName)] = Pcd.DefaultValue\r
2528 return RetVal\r
2529\r
2530 @property\r
2531 def UniqueBaseName(self):\r
867d1cd4
YL
2532 BaseName = self.Name\r
2533 for Module in self.PlatformInfo.ModuleAutoGenList:\r
2534 if Module.MetaFile == self.MetaFile:\r
2535 continue\r
2536 if Module.Name == self.Name:\r
867d1cd4
YL
2537 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):\r
2538 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'\r
2539 ' %s\n %s' % (Module.MetaFile, self.MetaFile))\r
2540 BaseName = '%s_%s' % (self.Name, self.Guid)\r
2541 return BaseName\r
2542\r
52302d4d 2543 # Macros could be used in build_rule.txt (also Makefile)\r
b23414f6
JC
2544 @cached_property\r
2545 def Macros(self):\r
2546 return OrderedDict((\r
2547 ("WORKSPACE" ,self.WorkspaceDir),\r
2548 ("MODULE_NAME" ,self.Name),\r
2549 ("MODULE_NAME_GUID" ,self.UniqueBaseName),\r
2550 ("MODULE_GUID" ,self.Guid),\r
2551 ("MODULE_VERSION" ,self.Version),\r
2552 ("MODULE_TYPE" ,self.ModuleType),\r
2553 ("MODULE_FILE" ,str(self.MetaFile)),\r
2554 ("MODULE_FILE_BASE_NAME" ,self.MetaFile.BaseName),\r
2555 ("MODULE_RELATIVE_DIR" ,self.SourceDir),\r
2556 ("MODULE_DIR" ,self.SourceDir),\r
2557 ("BASE_NAME" ,self.Name),\r
2558 ("ARCH" ,self.Arch),\r
2559 ("TOOLCHAIN" ,self.ToolChain),\r
2560 ("TOOLCHAIN_TAG" ,self.ToolChain),\r
2561 ("TOOL_CHAIN_TAG" ,self.ToolChain),\r
2562 ("TARGET" ,self.BuildTarget),\r
2563 ("BUILD_DIR" ,self.PlatformInfo.BuildDir),\r
2564 ("BIN_DIR" ,os.path.join(self.PlatformInfo.BuildDir, self.Arch)),\r
2565 ("LIB_DIR" ,os.path.join(self.PlatformInfo.BuildDir, self.Arch)),\r
2566 ("MODULE_BUILD_DIR" ,self.BuildDir),\r
2567 ("OUTPUT_DIR" ,self.OutputDir),\r
2568 ("DEBUG_DIR" ,self.DebugDir),\r
2569 ("DEST_DIR_OUTPUT" ,self.OutputDir),\r
2570 ("DEST_DIR_DEBUG" ,self.DebugDir),\r
2571 ("PLATFORM_NAME" ,self.PlatformInfo.Name),\r
2572 ("PLATFORM_GUID" ,self.PlatformInfo.Guid),\r
2573 ("PLATFORM_VERSION" ,self.PlatformInfo.Version),\r
2574 ("PLATFORM_RELATIVE_DIR" ,self.PlatformInfo.SourceDir),\r
2575 ("PLATFORM_DIR" ,mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)),\r
2576 ("PLATFORM_OUTPUT_DIR" ,self.PlatformInfo.OutputDir),\r
2577 ("FFS_OUTPUT_DIR" ,self.FfsOutputDir)\r
2578 ))\r
52302d4d
LG
2579\r
2580 ## Return the module build data object\r
b23414f6
JC
2581 @cached_property\r
2582 def Module(self):\r
e6c62ab7 2583 return self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2584\r
2585 ## Return the module name\r
b23414f6
JC
2586 @cached_property\r
2587 def Name(self):\r
52302d4d
LG
2588 return self.Module.BaseName\r
2589\r
b36d134f 2590 ## Return the module DxsFile if exist\r
b23414f6
JC
2591 @cached_property\r
2592 def DxsFile(self):\r
b36d134f
LG
2593 return self.Module.DxsFile\r
2594\r
52302d4d 2595 ## Return the module meta-file GUID\r
b23414f6
JC
2596 @cached_property\r
2597 def Guid(self):\r
97fa0ee9
YL
2598 #\r
2599 # To build same module more than once, the module path with FILE_GUID overridden has\r
2600 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path\r
2601 # in DSC. The overridden GUID can be retrieved from file name\r
2602 #\r
2603 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):\r
2604 #\r
2605 # Length of GUID is 36\r
2606 #\r
2607 return os.path.basename(self.MetaFile.Path)[:36]\r
52302d4d
LG
2608 return self.Module.Guid\r
2609\r
2610 ## Return the module version\r
b23414f6
JC
2611 @cached_property\r
2612 def Version(self):\r
52302d4d
LG
2613 return self.Module.Version\r
2614\r
2615 ## Return the module type\r
b23414f6
JC
2616 @cached_property\r
2617 def ModuleType(self):\r
52302d4d
LG
2618 return self.Module.ModuleType\r
2619\r
b36d134f 2620 ## Return the component type (for Edk.x style of module)\r
b23414f6
JC
2621 @cached_property\r
2622 def ComponentType(self):\r
52302d4d
LG
2623 return self.Module.ComponentType\r
2624\r
2625 ## Return the build type\r
b23414f6
JC
2626 @cached_property\r
2627 def BuildType(self):\r
52302d4d
LG
2628 return self.Module.BuildType\r
2629\r
2630 ## Return the PCD_IS_DRIVER setting\r
b23414f6
JC
2631 @cached_property\r
2632 def PcdIsDriver(self):\r
52302d4d
LG
2633 return self.Module.PcdIsDriver\r
2634\r
2635 ## Return the autogen version, i.e. module meta-file version\r
b23414f6
JC
2636 @cached_property\r
2637 def AutoGenVersion(self):\r
52302d4d
LG
2638 return self.Module.AutoGenVersion\r
2639\r
2640 ## Check if the module is library or not\r
b23414f6
JC
2641 @cached_property\r
2642 def IsLibrary(self):\r
2643 return bool(self.Module.LibraryClass)\r
52302d4d 2644\r
e8a47801 2645 ## Check if the module is binary module or not\r
b23414f6
JC
2646 @cached_property\r
2647 def IsBinaryModule(self):\r
e8a47801
LG
2648 return self.Module.IsBinaryModule\r
2649\r
52302d4d 2650 ## Return the directory to store intermediate files of the module\r
b23414f6
JC
2651 @cached_property\r
2652 def BuildDir(self):\r
2653 return _MakeDir((\r
52302d4d
LG
2654 self.PlatformInfo.BuildDir,\r
2655 self.Arch,\r
2656 self.SourceDir,\r
2657 self.MetaFile.BaseName\r
b23414f6 2658 ))\r
52302d4d
LG
2659\r
2660 ## Return the directory to store the intermediate object files of the mdoule\r
b23414f6
JC
2661 @cached_property\r
2662 def OutputDir(self):\r
2663 return _MakeDir((self.BuildDir, "OUTPUT"))\r
2664\r
2665 ## Return the directory path to store ffs file\r
2666 @cached_property\r
2667 def FfsOutputDir(self):\r
2668 if GlobalData.gFdfParser:\r
2669 return path.join(self.PlatformInfo.BuildDir, TAB_FV_DIRECTORY, "Ffs", self.Guid + self.Name)\r
2670 return ''\r
37de70b7 2671\r
52302d4d 2672 ## Return the directory to store auto-gened source files of the mdoule\r
b23414f6
JC
2673 @cached_property\r
2674 def DebugDir(self):\r
2675 return _MakeDir((self.BuildDir, "DEBUG"))\r
52302d4d
LG
2676\r
2677 ## Return the path of custom file\r
b23414f6
JC
2678 @cached_property\r
2679 def CustomMakefile(self):\r
2680 RetVal = {}\r
2681 for Type in self.Module.CustomMakefile:\r
2682 MakeType = gMakeTypeMap[Type] if Type in gMakeTypeMap else 'nmake'\r
2683 if self.SourceOverrideDir is not None:\r
2684 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])\r
2685 if not os.path.exists(File):\r
52302d4d 2686 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
b23414f6
JC
2687 else:\r
2688 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
2689 RetVal[MakeType] = File\r
2690 return RetVal\r
52302d4d
LG
2691\r
2692 ## Return the directory of the makefile\r
2693 #\r
2694 # @retval string The directory string of module's makefile\r
2695 #\r
b23414f6
JC
2696 @cached_property\r
2697 def MakeFileDir(self):\r
52302d4d
LG
2698 return self.BuildDir\r
2699\r
2700 ## Return build command string\r
2701 #\r
2702 # @retval string Build command string\r
2703 #\r
b23414f6
JC
2704 @cached_property\r
2705 def BuildCommand(self):\r
52302d4d
LG
2706 return self.PlatformInfo.BuildCommand\r
2707\r
2708 ## Get object list of all packages the module and its dependent libraries belong to\r
2709 #\r
2710 # @retval list The list of package object\r
2711 #\r
b23414f6
JC
2712 @cached_property\r
2713 def DerivedPackageList(self):\r
52302d4d
LG
2714 PackageList = []\r
2715 for M in [self.Module] + self.DependentLibraryList:\r
2716 for Package in M.Packages:\r
2717 if Package in PackageList:\r
2718 continue\r
2719 PackageList.append(Package)\r
2720 return PackageList\r
f7496d71 2721\r
97fa0ee9
YL
2722 ## Get the depex string\r
2723 #\r
2724 # @return : a string contain all depex expresion.\r
2725 def _GetDepexExpresionString(self):\r
2726 DepexStr = ''\r
2727 DepexList = []\r
2728 ## DPX_SOURCE IN Define section.\r
2729 if self.Module.DxsFile:\r
2730 return DepexStr\r
2731 for M in [self.Module] + self.DependentLibraryList:\r
2732 Filename = M.MetaFile.Path\r
2733 InfObj = InfSectionParser.InfSectionParser(Filename)\r
2734 DepexExpresionList = InfObj.GetDepexExpresionList()\r
2735 for DepexExpresion in DepexExpresionList:\r
9eb87141 2736 for key in DepexExpresion:\r
97fa0ee9 2737 Arch, ModuleType = key\r
518aebe2 2738 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]\r
97fa0ee9
YL
2739 # the type of build module is USER_DEFINED.\r
2740 # All different DEPEX section tags would be copied into the As Built INF file\r
2741 # and there would be separate DEPEX section tags\r
2742 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
2743 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):\r
518aebe2 2744 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
2745 else:\r
2746 if Arch.upper() == TAB_ARCH_COMMON or \\r
2747 (Arch.upper() == self.Arch.upper() and \\r
2748 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):\r
518aebe2 2749 DepexList.append({(Arch, ModuleType): DepexExpr})\r
f7496d71 2750\r
97fa0ee9
YL
2751 #the type of build module is USER_DEFINED.\r
2752 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
2753 for Depex in DepexList:\r
9eb87141 2754 for key in Depex:\r
97fa0ee9 2755 DepexStr += '[Depex.%s.%s]\n' % key\r
8252e6bf 2756 DepexStr += '\n'.join('# '+ val for val in Depex[key])\r
97fa0ee9
YL
2757 DepexStr += '\n\n'\r
2758 if not DepexStr:\r
2759 return '[Depex.%s]\n' % self.Arch\r
2760 return DepexStr\r
f7496d71 2761\r
97fa0ee9
YL
2762 #the type of build module not is USER_DEFINED.\r
2763 Count = 0\r
2764 for Depex in DepexList:\r
2765 Count += 1\r
2766 if DepexStr != '':\r
2767 DepexStr += ' AND '\r
2768 DepexStr += '('\r
2769 for D in Depex.values():\r
8252e6bf 2770 DepexStr += ' '.join(val for val in D)\r
97fa0ee9
YL
2771 Index = DepexStr.find('END')\r
2772 if Index > -1 and Index == len(DepexStr) - 3:\r
2773 DepexStr = DepexStr[:-3]\r
2774 DepexStr = DepexStr.strip()\r
2775 DepexStr += ')'\r
2776 if Count == 1:\r
2777 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()\r
2778 if not DepexStr:\r
2779 return '[Depex.%s]\n' % self.Arch\r
2780 return '[Depex.%s]\n# ' % self.Arch + DepexStr\r
f7496d71 2781\r
52302d4d
LG
2782 ## Merge dependency expression\r
2783 #\r
2784 # @retval list The token list of the dependency expression after parsed\r
2785 #\r
b23414f6
JC
2786 @cached_property\r
2787 def DepexList(self):\r
2788 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
2789 return {}\r
2790\r
0258ba62
JC
2791 DepexList = []\r
2792 #\r
2793 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2794 #\r
2795 for M in [self.Module] + self.DependentLibraryList:\r
2796 Inherited = False\r
2797 for D in M.Depex[self.Arch, self.ModuleType]:\r
2798 if DepexList != []:\r
2799 DepexList.append('AND')\r
2800 DepexList.append('(')\r
2801 #replace D with value if D is FixedAtBuild PCD\r
2802 NewList = []\r
2803 for item in D:\r
2804 if '.' not in item:\r
2805 NewList.append(item)\r
2806 else:\r
2807 if item not in self._FixedPcdVoidTypeDict:\r
2808 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 2809 else:\r
0258ba62
JC
2810 Value = self._FixedPcdVoidTypeDict[item]\r
2811 if len(Value.split(',')) != 16:\r
2812 EdkLogger.error("build", FORMAT_INVALID,\r
2813 "{} used in [Depex] section should be used as FixedAtBuild type and VOID* datum type and 16 bytes in the module.".format(item))\r
2814 NewList.append(Value)\r
2815 DepexList.extend(NewList)\r
2816 if DepexList[-1] == 'END': # no need of a END at this time\r
2817 DepexList.pop()\r
2818 DepexList.append(')')\r
2819 Inherited = True\r
2820 if Inherited:\r
2821 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))\r
2822 if 'BEFORE' in DepexList or 'AFTER' in DepexList:\r
2823 break\r
2824 if len(DepexList) > 0:\r
2825 EdkLogger.verbose('')\r
2826 return {self.ModuleType:DepexList}\r
52302d4d
LG
2827\r
2828 ## Merge dependency expression\r
2829 #\r
2830 # @retval list The token list of the dependency expression after parsed\r
2831 #\r
b23414f6 2832 @cached_property\r
6cf6fed0 2833 def DepexExpressionDict(self):\r
b23414f6
JC
2834 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
2835 return {}\r
52302d4d 2836\r
0258ba62
JC
2837 DepexExpressionString = ''\r
2838 #\r
2839 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2840 #\r
2841 for M in [self.Module] + self.DependentLibraryList:\r
2842 Inherited = False\r
2843 for D in M.DepexExpression[self.Arch, self.ModuleType]:\r
2844 if DepexExpressionString != '':\r
2845 DepexExpressionString += ' AND '\r
2846 DepexExpressionString += '('\r
2847 DepexExpressionString += D\r
2848 DepexExpressionString = DepexExpressionString.rstrip('END').strip()\r
2849 DepexExpressionString += ')'\r
2850 Inherited = True\r
2851 if Inherited:\r
2852 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionString))\r
2853 if 'BEFORE' in DepexExpressionString or 'AFTER' in DepexExpressionString:\r
2854 break\r
2855 if len(DepexExpressionString) > 0:\r
2856 EdkLogger.verbose('')\r
52302d4d 2857\r
0258ba62 2858 return {self.ModuleType:DepexExpressionString}\r
52302d4d 2859\r
dfa41b4a
YZ
2860 # Get the tiano core user extension, it is contain dependent library.\r
2861 # @retval: a list contain tiano core userextension.\r
2862 #\r
2863 def _GetTianoCoreUserExtensionList(self):\r
2864 TianoCoreUserExtentionList = []\r
2865 for M in [self.Module] + self.DependentLibraryList:\r
2866 Filename = M.MetaFile.Path\r
2867 InfObj = InfSectionParser.InfSectionParser(Filename)\r
2868 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()\r
2869 for TianoCoreUserExtent in TianoCoreUserExtenList:\r
9eb87141 2870 for Section in TianoCoreUserExtent:\r
dfa41b4a
YZ
2871 ItemList = Section.split(TAB_SPLIT)\r
2872 Arch = self.Arch\r
2873 if len(ItemList) == 4:\r
2874 Arch = ItemList[3]\r
2875 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():\r
2876 TianoCoreList = []\r
2877 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])\r
2878 TianoCoreList.extend(TianoCoreUserExtent[Section][:])\r
2879 TianoCoreList.append('\n')\r
2880 TianoCoreUserExtentionList.append(TianoCoreList)\r
2881\r
2882 return TianoCoreUserExtentionList\r
2883\r
52302d4d
LG
2884 ## Return the list of specification version required for the module\r
2885 #\r
2886 # @retval list The list of specification defined in module file\r
2887 #\r
b23414f6
JC
2888 @cached_property\r
2889 def Specification(self):\r
52302d4d
LG
2890 return self.Module.Specification\r
2891\r
2892 ## Tool option for the module build\r
2893 #\r
2894 # @param PlatformInfo The object of PlatformBuildInfo\r
2895 # @retval dict The dict containing valid options\r
2896 #\r
b23414f6
JC
2897 @cached_property\r
2898 def BuildOption(self):\r
2899 RetVal, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)\r
2900 if self.BuildRuleOrder:\r
2901 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]\r
2902 return RetVal\r
52302d4d 2903\r
79b74a03
LG
2904 ## Get include path list from tool option for the module build\r
2905 #\r
2906 # @retval list The include path list\r
2907 #\r
b23414f6
JC
2908 @cached_property\r
2909 def BuildOptionIncPathList(self):\r
2910 #\r
2911 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
2912 # is the former use /I , the Latter used -I to specify include directories\r
2913 #\r
94c04559 2914 if self.PlatformInfo.ToolChainFamily in (TAB_COMPILER_MSFT):\r
b23414f6
JC
2915 BuildOptIncludeRegEx = gBuildOptIncludePatternMsft\r
2916 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):\r
2917 BuildOptIncludeRegEx = gBuildOptIncludePatternOther\r
2918 else:\r
79b74a03 2919 #\r
b23414f6 2920 # New ToolChainFamily, don't known whether there is option to specify include directories\r
79b74a03 2921 #\r
b23414f6 2922 return []\r
f7496d71 2923\r
b23414f6
JC
2924 RetVal = []\r
2925 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):\r
2926 try:\r
2927 FlagOption = self.BuildOption[Tool]['FLAGS']\r
2928 except KeyError:\r
2929 FlagOption = ''\r
d40b2ee6 2930\r
e6c62ab7 2931 if self.ToolChainFamily != 'RVCT':\r
b23414f6
JC
2932 IncPathList = [NormPath(Path, self.Macros) for Path in BuildOptIncludeRegEx.findall(FlagOption)]\r
2933 else:\r
79b74a03 2934 #\r
b23414f6 2935 # RVCT may specify a list of directory seperated by commas\r
79b74a03 2936 #\r
b23414f6
JC
2937 IncPathList = []\r
2938 for Path in BuildOptIncludeRegEx.findall(FlagOption):\r
2939 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)\r
2940 IncPathList.extend(NormPath(PathEntry, self.Macros) for PathEntry in PathList)\r
f7496d71 2941\r
b23414f6
JC
2942 #\r
2943 # EDK II modules must not reference header files outside of the packages they depend on or\r
2944 # within the module's directory tree. Report error if violation.\r
2945 #\r
2946 if self.AutoGenVersion >= 0x00010005:\r
2947 for Path in IncPathList:\r
2948 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):\r
2949 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)\r
2950 EdkLogger.error("build",\r
2951 PARAMETER_INVALID,\r
2952 ExtraData=ErrMsg,\r
2953 File=str(self.MetaFile))\r
2954 RetVal += IncPathList\r
2955 return RetVal\r
f7496d71 2956\r
52302d4d
LG
2957 ## Return a list of files which can be built from source\r
2958 #\r
2959 # What kind of files can be built is determined by build rules in\r
97fa0ee9 2960 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.\r
52302d4d 2961 #\r
b23414f6
JC
2962 @cached_property\r
2963 def SourceFileList(self):\r
2964 RetVal = []\r
2965 ToolChainTagSet = {"", "*", self.ToolChain}\r
2966 ToolChainFamilySet = {"", "*", self.ToolChainFamily, self.BuildRuleFamily}\r
2967 for F in self.Module.Sources:\r
2968 # match tool chain\r
2969 if F.TagName not in ToolChainTagSet:\r
2970 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "\r
2971 "but [%s] is currently used" % (F.TagName, str(F), self.ToolChain))\r
2972 continue\r
2973 # match tool chain family or build rule family\r
2974 if F.ToolChainFamily not in ToolChainFamilySet:\r
2975 EdkLogger.debug(\r
2976 EdkLogger.DEBUG_0,\r
2977 "The file [%s] must be built by tools of [%s], " \\r
2978 "but current toolchain family is [%s], buildrule family is [%s]" \\r
2979 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))\r
2980 continue\r
52302d4d 2981\r
b23414f6
JC
2982 # add the file path into search path list for file including\r
2983 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:\r
2984 self.IncludePathList.insert(0, F.Dir)\r
2985 RetVal.append(F)\r
4cb7bade 2986\r
b23414f6 2987 self._MatchBuildRuleOrder(RetVal)\r
4cb7bade 2988\r
b23414f6
JC
2989 for F in RetVal:\r
2990 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)\r
2991 return RetVal\r
52302d4d 2992\r
4cb7bade
YZ
2993 def _MatchBuildRuleOrder(self, FileList):\r
2994 Order_Dict = {}\r
b23414f6 2995 self.BuildOption\r
4cb7bade
YZ
2996 for SingleFile in FileList:\r
2997 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:\r
2998 key = SingleFile.Path.split(SingleFile.Ext)[0]\r
2999 if key in Order_Dict:\r
3000 Order_Dict[key].append(SingleFile.Ext)\r
3001 else:\r
3002 Order_Dict[key] = [SingleFile.Ext]\r
3003\r
3004 RemoveList = []\r
3005 for F in Order_Dict:\r
3006 if len(Order_Dict[F]) > 1:\r
3007 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))\r
3008 for Ext in Order_Dict[F][1:]:\r
3009 RemoveList.append(F + Ext)\r
f7496d71 3010\r
4cb7bade
YZ
3011 for item in RemoveList:\r
3012 FileList.remove(item)\r
3013\r
3014 return FileList\r
3015\r
52302d4d 3016 ## Return the list of unicode files\r
b23414f6
JC
3017 @cached_property\r
3018 def UnicodeFileList(self):\r
3019 return self.FileTypes.get(TAB_UNICODE_FILE,[])\r
52302d4d 3020\r
5b97eb4c 3021 ## Return the list of vfr files\r
b23414f6
JC
3022 @cached_property\r
3023 def VfrFileList(self):\r
3024 return self.FileTypes.get(TAB_VFR_FILE, [])\r
5b97eb4c 3025\r
333ba578 3026 ## Return the list of Image Definition files\r
b23414f6
JC
3027 @cached_property\r
3028 def IdfFileList(self):\r
3029 return self.FileTypes.get(TAB_IMAGE_FILE,[])\r
333ba578 3030\r
52302d4d
LG
3031 ## Return a list of files which can be built from binary\r
3032 #\r
3033 # "Build" binary files are just to copy them to build directory.\r
3034 #\r
3035 # @retval list The list of files which can be built later\r
3036 #\r
b23414f6
JC
3037 @cached_property\r
3038 def BinaryFileList(self):\r
3039 RetVal = []\r
3040 for F in self.Module.Binaries:\r
3041 if F.Target not in [TAB_ARCH_COMMON, '*'] and F.Target != self.BuildTarget:\r
3042 continue\r
3043 RetVal.append(F)\r
3044 self._ApplyBuildRule(F, F.Type, BinaryFileList=RetVal)\r
3045 return RetVal\r
3046\r
3047 @cached_property\r
3048 def BuildRules(self):\r
3049 RetVal = {}\r
3050 BuildRuleDatabase = self.PlatformInfo.BuildRule\r
3051 for Type in BuildRuleDatabase.FileTypeList:\r
3052 #first try getting build rule by BuildRuleFamily\r
3053 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]\r
3054 if not RuleObject:\r
3055 # build type is always module type, but ...\r
3056 if self.ModuleType != self.BuildType:\r
3057 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]\r
3058 #second try getting build rule by ToolChainFamily\r
3059 if not RuleObject:\r
3060 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]\r
52302d4d
LG
3061 if not RuleObject:\r
3062 # build type is always module type, but ...\r
3063 if self.ModuleType != self.BuildType:\r
b23414f6
JC
3064 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]\r
3065 if not RuleObject:\r
3066 continue\r
3067 RuleObject = RuleObject.Instantiate(self.Macros)\r
3068 RetVal[Type] = RuleObject\r
3069 for Ext in RuleObject.SourceFileExtList:\r
3070 RetVal[Ext] = RuleObject\r
3071 return RetVal\r
3072\r
3073 def _ApplyBuildRule(self, File, FileType, BinaryFileList=None):\r
4231a819 3074 if self._BuildTargets is None:\r
52302d4d
LG
3075 self._IntroBuildTargetList = set()\r
3076 self._FinalBuildTargetList = set()\r
a993dc03
CJ
3077 self._BuildTargets = defaultdict(set)\r
3078 self._FileTypes = defaultdict(set)\r
52302d4d 3079\r
b23414f6
JC
3080 if not BinaryFileList:\r
3081 BinaryFileList = self.BinaryFileList\r
3082\r
fcd4fbf3
YL
3083 SubDirectory = os.path.join(self.OutputDir, File.SubDir)\r
3084 if not os.path.exists(SubDirectory):\r
3085 CreateDirectory(SubDirectory)\r
52302d4d 3086 LastTarget = None\r
caf74495 3087 RuleChain = set()\r
52302d4d
LG
3088 SourceList = [File]\r
3089 Index = 0\r
fe4bf2f9
YL
3090 #\r
3091 # Make sure to get build rule order value\r
3092 #\r
b23414f6 3093 self.BuildOption\r
fe4bf2f9 3094\r
52302d4d
LG
3095 while Index < len(SourceList):\r
3096 Source = SourceList[Index]\r
3097 Index = Index + 1\r
3098\r
3099 if Source != File:\r
3100 CreateDirectory(Source.Dir)\r
3101\r
b23414f6 3102 if File.IsBinary and File == Source and File in BinaryFileList:\r
da92f276
LG
3103 # Skip all files that are not binary libraries\r
3104 if not self.IsLibrary:\r
47fea6af 3105 continue\r
52302d4d
LG
3106 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]\r
3107 elif FileType in self.BuildRules:\r
3108 RuleObject = self.BuildRules[FileType]\r
3109 elif Source.Ext in self.BuildRules:\r
3110 RuleObject = self.BuildRules[Source.Ext]\r
3111 else:\r
3112 # stop at no more rules\r
3113 if LastTarget:\r
3114 self._FinalBuildTargetList.add(LastTarget)\r
3115 break\r
3116\r
3117 FileType = RuleObject.SourceFileType\r
52302d4d
LG
3118 self._FileTypes[FileType].add(Source)\r
3119\r
3120 # stop at STATIC_LIBRARY for library\r
3121 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:\r
3122 if LastTarget:\r
3123 self._FinalBuildTargetList.add(LastTarget)\r
3124 break\r
3125\r
fe4bf2f9 3126 Target = RuleObject.Apply(Source, self.BuildRuleOrder)\r
52302d4d
LG
3127 if not Target:\r
3128 if LastTarget:\r
3129 self._FinalBuildTargetList.add(LastTarget)\r
3130 break\r
3131 elif not Target.Outputs:\r
3132 # Only do build for target with outputs\r
3133 self._FinalBuildTargetList.add(Target)\r
3134\r
52302d4d
LG
3135 self._BuildTargets[FileType].add(Target)\r
3136\r
3137 if not Source.IsBinary and Source == File:\r
3138 self._IntroBuildTargetList.add(Target)\r
3139\r
3140 # to avoid cyclic rule\r
3141 if FileType in RuleChain:\r
3142 break\r
3143\r
caf74495 3144 RuleChain.add(FileType)\r
52302d4d
LG
3145 SourceList.extend(Target.Outputs)\r
3146 LastTarget = Target\r
3147 FileType = TAB_UNKNOWN_FILE\r
3148\r
b23414f6
JC
3149 @cached_property\r
3150 def Targets(self):\r
4231a819 3151 if self._BuildTargets is None:\r
52302d4d
LG
3152 self._IntroBuildTargetList = set()\r
3153 self._FinalBuildTargetList = set()\r
a993dc03
CJ
3154 self._BuildTargets = defaultdict(set)\r
3155 self._FileTypes = defaultdict(set)\r
52302d4d 3156\r
b23414f6
JC
3157 #TRICK: call SourceFileList property to apply build rule for source files\r
3158 self.SourceFileList\r
52302d4d
LG
3159\r
3160 #TRICK: call _GetBinaryFileList to apply build rule for binary files\r
b23414f6 3161 self.BinaryFileList\r
52302d4d
LG
3162\r
3163 return self._BuildTargets\r
3164\r
b23414f6
JC
3165 @cached_property\r
3166 def IntroTargetList(self):\r
3167 self.Targets\r
52302d4d
LG
3168 return self._IntroBuildTargetList\r
3169\r
b23414f6
JC
3170 @cached_property\r
3171 def CodaTargetList(self):\r
3172 self.Targets\r
52302d4d
LG
3173 return self._FinalBuildTargetList\r
3174\r
b23414f6
JC
3175 @cached_property\r
3176 def FileTypes(self):\r
3177 self.Targets\r
52302d4d
LG
3178 return self._FileTypes\r
3179\r
3180 ## Get the list of package object the module depends on\r
3181 #\r
3182 # @retval list The package object list\r
3183 #\r
b23414f6
JC
3184 @cached_property\r
3185 def DependentPackageList(self):\r
52302d4d
LG
3186 return self.Module.Packages\r
3187\r
3188 ## Return the list of auto-generated code file\r
3189 #\r
3190 # @retval list The list of auto-generated file\r
3191 #\r
b23414f6
JC
3192 @cached_property\r
3193 def AutoGenFileList(self):\r
3194 AutoGenUniIdf = self.BuildType != 'UEFI_HII'\r
86379ac4
GL
3195 UniStringBinBuffer = BytesIO()\r
3196 IdfGenBinBuffer = BytesIO()\r
b23414f6
JC
3197 RetVal = {}\r
3198 AutoGenC = TemplateString()\r
3199 AutoGenH = TemplateString()\r
3200 StringH = TemplateString()\r
3201 StringIdf = TemplateString()\r
3202 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, AutoGenUniIdf, UniStringBinBuffer, StringIdf, AutoGenUniIdf, IdfGenBinBuffer)\r
3203 #\r
3204 # AutoGen.c is generated if there are library classes in inf, or there are object files\r
3205 #\r
3206 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0\r
3207 or TAB_OBJECT_FILE in self.FileTypes):\r
3208 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)\r
3209 RetVal[AutoFile] = str(AutoGenC)\r
3210 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3211 if str(AutoGenH) != "":\r
3212 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)\r
3213 RetVal[AutoFile] = str(AutoGenH)\r
3214 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3215 if str(StringH) != "":\r
3216 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)\r
3217 RetVal[AutoFile] = str(StringH)\r
3218 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3219 if UniStringBinBuffer is not None and UniStringBinBuffer.getvalue() != "":\r
3220 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)\r
3221 RetVal[AutoFile] = UniStringBinBuffer.getvalue()\r
3222 AutoFile.IsBinary = True\r
3223 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3224 if UniStringBinBuffer is not None:\r
3225 UniStringBinBuffer.close()\r
3226 if str(StringIdf) != "":\r
3227 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)\r
3228 RetVal[AutoFile] = str(StringIdf)\r
3229 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3230 if IdfGenBinBuffer is not None and IdfGenBinBuffer.getvalue() != "":\r
3231 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)\r
3232 RetVal[AutoFile] = IdfGenBinBuffer.getvalue()\r
3233 AutoFile.IsBinary = True\r
3234 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3235 if IdfGenBinBuffer is not None:\r
3236 IdfGenBinBuffer.close()\r
3237 return RetVal\r
52302d4d
LG
3238\r
3239 ## Return the list of library modules explicitly or implicityly used by this module\r
b23414f6
JC
3240 @cached_property\r
3241 def DependentLibraryList(self):\r
3242 # only merge library classes and PCD for non-library module\r
3243 if self.IsLibrary:\r
3244 return []\r
3245 if self.AutoGenVersion < 0x00010005:\r
3246 return self.PlatformInfo.ResolveLibraryReference(self.Module)\r
3247 return self.PlatformInfo.ApplyLibraryInstance(self.Module)\r
52302d4d
LG
3248\r
3249 ## Get the list of PCDs from current module\r
3250 #\r
3251 # @retval list The list of PCD\r
3252 #\r
b23414f6
JC
3253 @cached_property\r
3254 def ModulePcdList(self):\r
3255 # apply PCD settings from platform\r
3256 RetVal = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)\r
3257 ExtendCopyDictionaryLists(self._PcdComments, self.Module.PcdComments)\r
3258 return RetVal\r
52302d4d
LG
3259\r
3260 ## Get the list of PCDs from dependent libraries\r
3261 #\r
3262 # @retval list The list of PCD\r
3263 #\r
b23414f6
JC
3264 @cached_property\r
3265 def LibraryPcdList(self):\r
3266 if self.IsLibrary:\r
3267 return []\r
3268 RetVal = []\r
3269 Pcds = set()\r
3270 # get PCDs from dependent libraries\r
3271 for Library in self.DependentLibraryList:\r
3272 PcdsInLibrary = OrderedDict()\r
3273 ExtendCopyDictionaryLists(self._PcdComments, Library.PcdComments)\r
3274 for Key in Library.Pcds:\r
3275 # skip duplicated PCDs\r
3276 if Key in self.Module.Pcds or Key in Pcds:\r
3277 continue\r
3278 Pcds.add(Key)\r
3279 PcdsInLibrary[Key] = copy.copy(Library.Pcds[Key])\r
3280 RetVal.extend(self.PlatformInfo.ApplyPcdSetting(self.Module, PcdsInLibrary, Library=Library))\r
3281 return RetVal\r
52302d4d
LG
3282\r
3283 ## Get the GUID value mapping\r
3284 #\r
3285 # @retval dict The mapping between GUID cname and its value\r
3286 #\r
b23414f6
JC
3287 @cached_property\r
3288 def GuidList(self):\r
3289 RetVal = OrderedDict(self.Module.Guids)\r
3290 for Library in self.DependentLibraryList:\r
3291 RetVal.update(Library.Guids)\r
3292 ExtendCopyDictionaryLists(self._GuidComments, Library.GuidComments)\r
3293 ExtendCopyDictionaryLists(self._GuidComments, self.Module.GuidComments)\r
3294 return RetVal\r
3295\r
3296 @cached_property\r
e8a47801 3297 def GetGuidsUsedByPcd(self):\r
b23414f6
JC
3298 RetVal = OrderedDict(self.Module.GetGuidsUsedByPcd())\r
3299 for Library in self.DependentLibraryList:\r
3300 RetVal.update(Library.GetGuidsUsedByPcd())\r
3301 return RetVal\r
52302d4d
LG
3302 ## Get the protocol value mapping\r
3303 #\r
3304 # @retval dict The mapping between protocol cname and its value\r
3305 #\r
b23414f6
JC
3306 @cached_property\r
3307 def ProtocolList(self):\r
3308 RetVal = OrderedDict(self.Module.Protocols)\r
3309 for Library in self.DependentLibraryList:\r
3310 RetVal.update(Library.Protocols)\r
3311 ExtendCopyDictionaryLists(self._ProtocolComments, Library.ProtocolComments)\r
3312 ExtendCopyDictionaryLists(self._ProtocolComments, self.Module.ProtocolComments)\r
3313 return RetVal\r
52302d4d
LG
3314\r
3315 ## Get the PPI value mapping\r
3316 #\r
3317 # @retval dict The mapping between PPI cname and its value\r
3318 #\r
b23414f6
JC
3319 @cached_property\r
3320 def PpiList(self):\r
3321 RetVal = OrderedDict(self.Module.Ppis)\r
3322 for Library in self.DependentLibraryList:\r
3323 RetVal.update(Library.Ppis)\r
3324 ExtendCopyDictionaryLists(self._PpiComments, Library.PpiComments)\r
3325 ExtendCopyDictionaryLists(self._PpiComments, self.Module.PpiComments)\r
3326 return RetVal\r
52302d4d
LG
3327\r
3328 ## Get the list of include search path\r
3329 #\r
3330 # @retval list The list path\r
3331 #\r
b23414f6
JC
3332 @cached_property\r
3333 def IncludePathList(self):\r
3334 RetVal = []\r
3335 if self.AutoGenVersion < 0x00010005:\r
3336 for Inc in self.Module.Includes:\r
3337 if Inc not in RetVal:\r
3338 RetVal.append(Inc)\r
3339 # for Edk modules\r
3340 Inc = path.join(Inc, self.Arch.capitalize())\r
3341 if os.path.exists(Inc) and Inc not in RetVal:\r
3342 RetVal.append(Inc)\r
3343 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time\r
3344 RetVal.append(self.DebugDir)\r
3345 else:\r
3346 RetVal.append(self.MetaFile.Dir)\r
3347 RetVal.append(self.DebugDir)\r
3348\r
3349 for Package in self.Module.Packages:\r
3350 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)\r
3351 if PackageDir not in RetVal:\r
3352 RetVal.append(PackageDir)\r
3353 IncludesList = Package.Includes\r
3354 if Package._PrivateIncludes:\r
3355 if not self.MetaFile.Path.startswith(PackageDir):\r
3356 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))\r
3357 for Inc in IncludesList:\r
3358 if Inc not in RetVal:\r
3359 RetVal.append(str(Inc))\r
3360 return RetVal\r
3361\r
3362 @cached_property\r
3363 def IncludePathLength(self):\r
3364 return sum(len(inc)+1 for inc in self.IncludePathList)\r
725cdb8f 3365\r
97fa0ee9
YL
3366 ## Get HII EX PCDs which maybe used by VFR\r
3367 #\r
3368 # efivarstore used by VFR may relate with HII EX PCDs\r
3369 # Get the variable name and GUID from efivarstore and HII EX PCD\r
3370 # List the HII EX PCDs in As Built INF if both name and GUID match.\r
3371 #\r
3372 # @retval list HII EX PCDs\r
3373 #\r
3374 def _GetPcdsMaybeUsedByVfr(self):\r
3375 if not self.SourceFileList:\r
3376 return []\r
3377\r
29189291 3378 NameGuids = set()\r
97fa0ee9
YL
3379 for SrcFile in self.SourceFileList:\r
3380 if SrcFile.Ext.lower() != '.vfr':\r
3381 continue\r
3382 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')\r
3383 if not os.path.exists(Vfri):\r
3384 continue\r
3385 VfriFile = open(Vfri, 'r')\r
3386 Content = VfriFile.read()\r
3387 VfriFile.close()\r
3388 Pos = Content.find('efivarstore')\r
3389 while Pos != -1:\r
3390 #\r
3391 # Make sure 'efivarstore' is the start of efivarstore statement\r
3392 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'\r
3393 #\r
3394 Index = Pos - 1\r
3395 while Index >= 0 and Content[Index] in ' \t\r\n':\r
3396 Index -= 1\r
3397 if Index >= 0 and Content[Index] != ';':\r
3398 Pos = Content.find('efivarstore', Pos + len('efivarstore'))\r
3399 continue\r
3400 #\r
3401 # 'efivarstore' must be followed by name and guid\r
3402 #\r
3403 Name = gEfiVarStoreNamePattern.search(Content, Pos)\r
3404 if not Name:\r
3405 break\r
3406 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)\r
3407 if not Guid:\r
3408 break\r
3409 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')\r
29189291 3410 NameGuids.add((NameArray, GuidStructureStringToGuidString(Guid.group(1))))\r
97fa0ee9
YL
3411 Pos = Content.find('efivarstore', Name.end())\r
3412 if not NameGuids:\r
3413 return []\r
3414 HiiExPcds = []\r
3415 for Pcd in self.PlatformInfo.Platform.Pcds.values():\r
3416 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:\r
3417 continue\r
caf74495 3418 for SkuInfo in Pcd.SkuInfoList.values():\r
c28d2e10 3419 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)\r
97fa0ee9
YL
3420 if not Value:\r
3421 continue\r
caf74495 3422 Name = ConvertStringToByteArray(SkuInfo.VariableName)\r
97fa0ee9
YL
3423 Guid = GuidStructureStringToGuidString(Value)\r
3424 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:\r
3425 HiiExPcds.append(Pcd)\r
3426 break\r
3427\r
3428 return HiiExPcds\r
3429\r
aeaaf754
YL
3430 def _GenOffsetBin(self):\r
3431 VfrUniBaseName = {}\r
3432 for SourceFile in self.Module.Sources:\r
3433 if SourceFile.Type.upper() == ".VFR" :\r
3434 #\r
f7496d71 3435 # search the .map file to find the offset of vfr binary in the PE32+/TE file.\r
aeaaf754
YL
3436 #\r
3437 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")\r
caf74495 3438 elif SourceFile.Type.upper() == ".UNI" :\r
aeaaf754 3439 #\r
f7496d71 3440 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file.\r
aeaaf754
YL
3441 #\r
3442 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")\r
3443\r
caf74495 3444 if not VfrUniBaseName:\r
aeaaf754
YL
3445 return None\r
3446 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")\r
3447 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")\r
3448 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())\r
3449 if not VfrUniOffsetList:\r
3450 return None\r
3451\r
3452 OutputName = '%sOffset.bin' % self.Name\r
3453 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)\r
3454\r
3455 try:\r
3456 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)\r
3457 except:\r
ccaa7754 3458 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName, None)\r
aeaaf754 3459\r
86379ac4
GL
3460 # Use a instance of BytesIO to cache data\r
3461 fStringIO = BytesIO('')\r
aeaaf754
YL
3462\r
3463 for Item in VfrUniOffsetList:\r
3464 if (Item[0].find("Strings") != -1):\r
3465 #\r
3466 # UNI offset in image.\r
3467 # GUID + Offset\r
3468 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
3469 #\r
3470 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]\r
3471 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]\r
f7496d71 3472 fStringIO.write(''.join(UniGuid))\r
aeaaf754
YL
3473 UniValue = pack ('Q', int (Item[1], 16))\r
3474 fStringIO.write (UniValue)\r
3475 else:\r
3476 #\r
3477 # VFR binary offset in image.\r
3478 # GUID + Offset\r
3479 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };\r
3480 #\r
3481 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]\r
3482 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]\r
f7496d71 3483 fStringIO.write(''.join(VfrGuid))\r
aeaaf754
YL
3484 VfrValue = pack ('Q', int (Item[1], 16))\r
3485 fStringIO.write (VfrValue)\r
3486 #\r
3487 # write data into file.\r
3488 #\r
f7496d71 3489 try :\r
aeaaf754
YL
3490 fInputfile.write (fStringIO.getvalue())\r
3491 except:\r
3492 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "\r
ccaa7754 3493 "file been locked or using by other applications." %UniVfrOffsetFileName, None)\r
aeaaf754
YL
3494\r
3495 fStringIO.close ()\r
3496 fInputfile.close ()\r
3497 return OutputName\r
3498\r
da92f276
LG
3499 ## Create AsBuilt INF file the module\r
3500 #\r
83397f95 3501 def CreateAsBuiltInf(self, IsOnlyCopy = False):\r
ac55e478 3502 self.OutputFile = set()\r
caf74495
JC
3503 if IsOnlyCopy and GlobalData.gBinCacheDest:\r
3504 self.CopyModuleToCache()\r
3505 return\r
83397f95 3506\r
da92f276
LG
3507 if self.IsAsBuiltInfCreated:\r
3508 return\r
f7496d71 3509\r
da92f276
LG
3510 # Skip the following code for EDK I inf\r
3511 if self.AutoGenVersion < 0x00010005:\r
3512 return\r
f7496d71 3513\r
da92f276
LG
3514 # Skip the following code for libraries\r
3515 if self.IsLibrary:\r
3516 return\r
f7496d71 3517\r
da92f276 3518 # Skip the following code for modules with no source files\r
6be94743 3519 if not self.SourceFileList:\r
da92f276
LG
3520 return\r
3521\r
3522 # Skip the following code for modules without any binary files\r
40857777 3523 if self.BinaryFileList:\r
da92f276 3524 return\r
f7496d71 3525\r
da92f276
LG
3526 ### TODO: How to handles mixed source and binary modules\r
3527\r
e8a47801 3528 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries\r
da92f276
LG
3529 # Also find all packages that the DynamicEx PCDs depend on\r
3530 Pcds = []\r
e5cf9198 3531 PatchablePcds = []\r
47fea6af 3532 Packages = []\r
e8a47801
LG
3533 PcdCheckList = []\r
3534 PcdTokenSpaceList = []\r
da92f276 3535 for Pcd in self.ModulePcdList + self.LibraryPcdList:\r
e8a47801 3536 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
caf74495 3537 PatchablePcds.append(Pcd)\r
6b1f2cf4 3538 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_PATCHABLE_IN_MODULE))\r
eece4292 3539 elif Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
e8a47801 3540 if Pcd not in Pcds:\r
caf74495 3541 Pcds.append(Pcd)\r
6b1f2cf4
CJ
3542 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC_EX))\r
3543 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC))\r
e8a47801 3544 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)\r
b23414f6
JC
3545 GuidList = OrderedDict(self.GuidList)\r
3546 for TokenSpace in self.GetGuidsUsedByPcd:\r
e8a47801
LG
3547 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list\r
3548 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs\r
3549 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:\r
3550 GuidList.pop(TokenSpace)\r
3551 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)\r
3552 for Package in self.DerivedPackageList:\r
3553 if Package in Packages:\r
3554 continue\r
3555 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)\r
3556 Found = False\r
3557 for Index in range(len(BeChecked)):\r
3558 for Item in CheckList[Index]:\r
3559 if Item in BeChecked[Index]:\r
caf74495 3560 Packages.append(Package)\r
e8a47801
LG
3561 Found = True\r
3562 break\r
caf74495
JC
3563 if Found:\r
3564 break\r
da92f276 3565\r
97fa0ee9
YL
3566 VfrPcds = self._GetPcdsMaybeUsedByVfr()\r
3567 for Pkg in self.PlatformInfo.PackageList:\r
3568 if Pkg in Packages:\r
3569 continue\r
3570 for VfrPcd in VfrPcds:\r
6b1f2cf4
CJ
3571 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC_EX) in Pkg.Pcds or\r
3572 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, TAB_PCDS_DYNAMIC) in Pkg.Pcds):\r
caf74495 3573 Packages.append(Pkg)\r
97fa0ee9
YL
3574 break\r
3575\r
caf74495
JC
3576 ModuleType = SUP_MODULE_DXE_DRIVER if self.ModuleType == SUP_MODULE_UEFI_DRIVER and self.DepexGenerated else self.ModuleType\r
3577 DriverType = self.PcdIsDriver if self.PcdIsDriver else ''\r
97fa0ee9
YL
3578 Guid = self.Guid\r
3579 MDefs = self.Module.Defines\r
3580\r
da92f276
LG
3581 AsBuiltInfDict = {\r
3582 'module_name' : self.Name,\r
97fa0ee9 3583 'module_guid' : Guid,\r
da92f276 3584 'module_module_type' : ModuleType,\r
97fa0ee9 3585 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],\r
e8a47801 3586 'pcd_is_driver_string' : [],\r
da92f276
LG
3587 'module_uefi_specification_version' : [],\r
3588 'module_pi_specification_version' : [],\r
97fa0ee9
YL
3589 'module_entry_point' : self.Module.ModuleEntryPointList,\r
3590 'module_unload_image' : self.Module.ModuleUnloadImageList,\r
3591 'module_constructor' : self.Module.ConstructorList,\r
3592 'module_destructor' : self.Module.DestructorList,\r
3593 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],\r
3594 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],\r
3595 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],\r
3596 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],\r
3597 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],\r
3598 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],\r
3599 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],\r
3600 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],\r
3601 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],\r
da92f276 3602 'module_arch' : self.Arch,\r
caf74495 3603 'package_item' : [Package.MetaFile.File.replace('\\', '/') for Package in Packages],\r
da92f276 3604 'binary_item' : [],\r
e8a47801 3605 'patchablepcd_item' : [],\r
da92f276 3606 'pcd_item' : [],\r
e8a47801
LG
3607 'protocol_item' : [],\r
3608 'ppi_item' : [],\r
3609 'guid_item' : [],\r
3610 'flags_item' : [],\r
3611 'libraryclasses_item' : []\r
da92f276 3612 }\r
97fa0ee9 3613\r
78bcd52a
YZ
3614 if 'MODULE_UNI_FILE' in MDefs:\r
3615 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])\r
3616 if os.path.isfile(UNIFile):\r
3617 shutil.copy2(UNIFile, self.OutputDir)\r
3618\r
97fa0ee9
YL
3619 if self.AutoGenVersion > int(gInfSpecVersion, 0):\r
3620 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion\r
3621 else:\r
3622 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion\r
3623\r
e8a47801 3624 if DriverType:\r
caf74495 3625 AsBuiltInfDict['pcd_is_driver_string'].append(DriverType)\r
da92f276
LG
3626\r
3627 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:\r
caf74495 3628 AsBuiltInfDict['module_uefi_specification_version'].append(self.Specification['UEFI_SPECIFICATION_VERSION'])\r
da92f276 3629 if 'PI_SPECIFICATION_VERSION' in self.Specification:\r
caf74495 3630 AsBuiltInfDict['module_pi_specification_version'].append(self.Specification['PI_SPECIFICATION_VERSION'])\r
da92f276 3631\r
47fea6af 3632 OutputDir = self.OutputDir.replace('\\', '/').strip('/')\r
c7c5a6c4 3633 DebugDir = self.DebugDir.replace('\\', '/').strip('/')\r
481252bb 3634 for Item in self.CodaTargetList:\r
90456c3c 3635 File = Item.Target.Path.replace('\\', '/').strip('/').replace(DebugDir, '').replace(OutputDir, '').strip('/')\r
ac55e478 3636 self.OutputFile.add(File)\r
5e2c0ecd
YZ
3637 if os.path.isabs(File):\r
3638 File = File.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')\r
47fea6af 3639 if Item.Target.Ext.lower() == '.aml':\r
caf74495 3640 AsBuiltInfDict['binary_item'].append('ASL|' + File)\r
47fea6af 3641 elif Item.Target.Ext.lower() == '.acpi':\r
caf74495 3642 AsBuiltInfDict['binary_item'].append('ACPI|' + File)\r
481252bb 3643 elif Item.Target.Ext.lower() == '.efi':\r
caf74495 3644 AsBuiltInfDict['binary_item'].append('PE32|' + self.Name + '.efi')\r
da92f276 3645 else:\r
caf74495 3646 AsBuiltInfDict['binary_item'].append('BIN|' + File)\r
481252bb 3647 if self.DepexGenerated:\r
ac55e478 3648 self.OutputFile.add(self.Name + '.depex')\r
8bb63e37 3649 if self.ModuleType in [SUP_MODULE_PEIM]:\r
caf74495
JC
3650 AsBuiltInfDict['binary_item'].append('PEI_DEPEX|' + self.Name + '.depex')\r
3651 elif self.ModuleType in [SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER]:\r
3652 AsBuiltInfDict['binary_item'].append('DXE_DEPEX|' + self.Name + '.depex')\r
3653 elif self.ModuleType in [SUP_MODULE_DXE_SMM_DRIVER]:\r
3654 AsBuiltInfDict['binary_item'].append('SMM_DEPEX|' + self.Name + '.depex')\r
da92f276 3655\r
aeaaf754
YL
3656 Bin = self._GenOffsetBin()\r
3657 if Bin:\r
caf74495 3658 AsBuiltInfDict['binary_item'].append('BIN|%s' % Bin)\r
ac55e478 3659 self.OutputFile.add(Bin)\r
aeaaf754 3660\r
e8a47801
LG
3661 for Root, Dirs, Files in os.walk(OutputDir):\r
3662 for File in Files:\r
3663 if File.lower().endswith('.pdb'):\r
caf74495 3664 AsBuiltInfDict['binary_item'].append('DISPOSABLE|' + File)\r
ac55e478 3665 self.OutputFile.add(File)\r
e8a47801
LG
3666 HeaderComments = self.Module.HeaderComments\r
3667 StartPos = 0\r
3668 for Index in range(len(HeaderComments)):\r
3669 if HeaderComments[Index].find('@BinaryHeader') != -1:\r
3670 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')\r
3671 StartPos = Index\r
3672 break\r
3673 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')\r
97fa0ee9
YL
3674 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)\r
3675\r
e8a47801
LG
3676 GenList = [\r
3677 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),\r
3678 (self.PpiList, self._PpiComments, 'ppi_item'),\r
3679 (GuidList, self._GuidComments, 'guid_item')\r
3680 ]\r
3681 for Item in GenList:\r
3682 for CName in Item[0]:\r
caf74495
JC
3683 Comments = '\n '.join(Item[1][CName]) if CName in Item[1] else ''\r
3684 Entry = Comments + '\n ' + CName if Comments else CName\r
e8a47801
LG
3685 AsBuiltInfDict[Item[2]].append(Entry)\r
3686 PatchList = parsePcdInfoFromMapFile(\r
3687 os.path.join(self.OutputDir, self.Name + '.map'),\r
3688 os.path.join(self.OutputDir, self.Name + '.efi')\r
3689 )\r
3690 if PatchList:\r
e5cf9198
YZ
3691 for Pcd in PatchablePcds:\r
3692 TokenCName = Pcd.TokenCName\r
3693 for PcdItem in GlobalData.MixedPcd:\r
3694 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
3695 TokenCName = PcdItem[0]\r
3696 break\r
3697 for PatchPcd in PatchList:\r
3698 if TokenCName == PatchPcd[0]:\r
3699 break\r
2a29017e 3700 else:\r
e8a47801 3701 continue\r
e8a47801 3702 PcdValue = ''\r
7ced8bb4
YZ
3703 if Pcd.DatumType == 'BOOLEAN':\r
3704 BoolValue = Pcd.DefaultValue.upper()\r
3705 if BoolValue == 'TRUE':\r
3706 Pcd.DefaultValue = '1'\r
3707 elif BoolValue == 'FALSE':\r
3708 Pcd.DefaultValue = '0'\r
3709\r
656d2539 3710 if Pcd.DatumType in TAB_PCD_NUMERIC_TYPES:\r
e8a47801 3711 HexFormat = '0x%02x'\r
656d2539 3712 if Pcd.DatumType == TAB_UINT16:\r
e8a47801 3713 HexFormat = '0x%04x'\r
656d2539 3714 elif Pcd.DatumType == TAB_UINT32:\r
e8a47801 3715 HexFormat = '0x%08x'\r
656d2539 3716 elif Pcd.DatumType == TAB_UINT64:\r
e8a47801
LG
3717 HexFormat = '0x%016x'\r
3718 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)\r
3719 else:\r
4231a819 3720 if Pcd.MaxDatumSize is None or Pcd.MaxDatumSize == '':\r
e8a47801 3721 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 3722 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
3723 )\r
3724 ArraySize = int(Pcd.MaxDatumSize, 0)\r
3725 PcdValue = Pcd.DefaultValue\r
3726 if PcdValue[0] != '{':\r
3727 Unicode = False\r
3728 if PcdValue[0] == 'L':\r
3729 Unicode = True\r
3730 PcdValue = PcdValue.lstrip('L')\r
3731 PcdValue = eval(PcdValue)\r
3732 NewValue = '{'\r
3733 for Index in range(0, len(PcdValue)):\r
3734 if Unicode:\r
3735 CharVal = ord(PcdValue[Index])\r
3736 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \\r
3737 + '0x%02x' % (CharVal >> 8) + ', '\r
3738 else:\r
3739 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '\r
3740 Padding = '0x00, '\r
3741 if Unicode:\r
3742 Padding = Padding * 2\r
3743 ArraySize = ArraySize / 2\r
3744 if ArraySize < (len(PcdValue) + 1):\r
c33081c9
YZ
3745 if Pcd.MaxSizeUserSet:\r
3746 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 3747 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801 3748 )\r
c33081c9
YZ
3749 else:\r
3750 ArraySize = len(PcdValue) + 1\r
e8a47801
LG
3751 if ArraySize > len(PcdValue) + 1:\r
3752 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)\r
3753 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'\r
3754 elif len(PcdValue.split(',')) <= ArraySize:\r
3755 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))\r
3756 PcdValue += '}'\r
3757 else:\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 3764 PcdItem = '%s.%s|%s|0x%X' % \\r
2a29017e 3765 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])\r
e8a47801
LG
3766 PcdComments = ''\r
3767 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
3768 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])\r
3769 if PcdComments:\r
3770 PcdItem = PcdComments + '\n ' + PcdItem\r
3771 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)\r
97fa0ee9 3772\r
97fa0ee9 3773 for Pcd in Pcds + VfrPcds:\r
e8a47801
LG
3774 PcdCommentList = []\r
3775 HiiInfo = ''\r
2a29017e
YZ
3776 TokenCName = Pcd.TokenCName\r
3777 for PcdItem in GlobalData.MixedPcd:\r
3778 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
3779 TokenCName = PcdItem[0]\r
3780 break\r
e8a47801
LG
3781 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:\r
3782 for SkuName in Pcd.SkuInfoList:\r
3783 SkuInfo = Pcd.SkuInfoList[SkuName]\r
3784 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)\r
3785 break\r
3786 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
3787 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]\r
3788 if HiiInfo:\r
3789 UsageIndex = -1\r
97fa0ee9 3790 UsageStr = ''\r
e8a47801
LG
3791 for Index, Comment in enumerate(PcdCommentList):\r
3792 for Usage in UsageList:\r
3793 if Comment.find(Usage) != -1:\r
97fa0ee9 3794 UsageStr = Usage\r
e8a47801
LG
3795 UsageIndex = Index\r
3796 break\r
3797 if UsageIndex != -1:\r
f7496d71 3798 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, ''))\r
e8a47801 3799 else:\r
97fa0ee9 3800 PcdCommentList.append('## UNDEFINED ' + HiiInfo)\r
e8a47801 3801 PcdComments = '\n '.join(PcdCommentList)\r
2a29017e 3802 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName\r
e8a47801
LG
3803 if PcdComments:\r
3804 PcdEntry = PcdComments + '\n ' + PcdEntry\r
caf74495 3805 AsBuiltInfDict['pcd_item'].append(PcdEntry)\r
da92f276 3806 for Item in self.BuildOption:\r
481252bb 3807 if 'FLAGS' in self.BuildOption[Item]:\r
caf74495 3808 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
3809\r
3810 # Generated LibraryClasses section in comments.\r
3811 for Library in self.LibraryAutoGenList:\r
caf74495 3812 AsBuiltInfDict['libraryclasses_item'].append(Library.MetaFile.File.replace('\\', '/'))\r
f7496d71 3813\r
dfa41b4a
YZ
3814 # Generated UserExtensions TianoCore section.\r
3815 # All tianocore user extensions are copied.\r
3816 UserExtStr = ''\r
3817 for TianoCore in self._GetTianoCoreUserExtensionList():\r
3818 UserExtStr += '\n'.join(TianoCore)\r
3819 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])\r
3820 if os.path.isfile(ExtensionFile):\r
3821 shutil.copy2(ExtensionFile, self.OutputDir)\r
3822 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr\r
3823\r
97fa0ee9 3824 # Generated depex expression section in comments.\r
97fa0ee9 3825 DepexExpresion = self._GetDepexExpresionString()\r
caf74495 3826 AsBuiltInfDict['depexsection_item'] = DepexExpresion if DepexExpresion else ''\r
f7496d71 3827\r
da92f276
LG
3828 AsBuiltInf = TemplateString()\r
3829 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))\r
f7496d71 3830\r
da92f276 3831 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)\r
f7496d71 3832\r
da92f276 3833 self.IsAsBuiltInfCreated = True\r
36d083ef
YZ
3834 if GlobalData.gBinCacheDest:\r
3835 self.CopyModuleToCache()\r
3836\r
3837 def CopyModuleToCache(self):\r
3838 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
3839 CreateDirectory (FileDir)\r
3840 HashFile = path.join(self.BuildDir, self.Name + '.hash')\r
3841 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')\r
3842 if os.path.exists(HashFile):\r
3843 shutil.copy2(HashFile, FileDir)\r
3844 if os.path.exists(ModuleFile):\r
3845 shutil.copy2(ModuleFile, FileDir)\r
83397f95 3846 if not self.OutputFile:\r
e6c62ab7 3847 Ma = self.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]\r
83397f95 3848 self.OutputFile = Ma.Binaries\r
36d083ef
YZ
3849 if self.OutputFile:\r
3850 for File in self.OutputFile:\r
83397f95 3851 File = str(File)\r
36d083ef
YZ
3852 if not os.path.isabs(File):\r
3853 File = os.path.join(self.OutputDir, File)\r
3854 if os.path.exists(File):\r
3855 shutil.copy2(File, FileDir)\r
3856\r
3857 def AttemptModuleCacheCopy(self):\r
3858 if self.IsBinaryModule:\r
3859 return False\r
3860 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
3861 HashFile = path.join(FileDir, self.Name + '.hash')\r
3862 if os.path.exists(HashFile):\r
3863 f = open(HashFile, 'r')\r
3864 CacheHash = f.read()\r
3865 f.close()\r
3866 if GlobalData.gModuleHash[self.Arch][self.Name]:\r
3867 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:\r
3868 for root, dir, files in os.walk(FileDir):\r
3869 for f in files:\r
3870 if self.Name + '.hash' in f:\r
3871 shutil.copy2(HashFile, self.BuildDir)\r
3872 else:\r
3873 File = path.join(root, f)\r
3874 shutil.copy2(File, self.OutputDir)\r
3875 if self.Name == "PcdPeim" or self.Name == "PcdDxe":\r
3876 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
3877 return True\r
3878 return False\r
3879\r
52302d4d
LG
3880 ## Create makefile for the module and its dependent libraries\r
3881 #\r
3882 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of\r
3883 # dependent libraries will be created\r
3884 #\r
830bf22f 3885 @cached_class_function\r
37de70b7 3886 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):\r
830bf22f
JC
3887 # nest this function inside it's only caller.\r
3888 def CreateTimeStamp():\r
3889 FileSet = {self.MetaFile.Path}\r
3890\r
3891 for SourceFile in self.Module.Sources:\r
3892 FileSet.add (SourceFile.Path)\r
3893\r
3894 for Lib in self.DependentLibraryList:\r
3895 FileSet.add (Lib.MetaFile.Path)\r
3896\r
3897 for f in self.AutoGenDepSet:\r
3898 FileSet.add (f.Path)\r
3899\r
3900 if os.path.exists (self.TimeStampPath):\r
3901 os.remove (self.TimeStampPath)\r
3902 with open(self.TimeStampPath, 'w+') as file:\r
3903 for f in FileSet:\r
3904 print(f, file=file)\r
3905\r
fae62ff2 3906 # Ignore generating makefile when it is a binary module\r
a0a2cd1e
FB
3907 if self.IsBinaryModule:\r
3908 return\r
fae62ff2 3909\r
37de70b7 3910 self.GenFfsList = GenFfsList\r
52302d4d
LG
3911 if not self.IsLibrary and CreateLibraryMakeFile:\r
3912 for LibraryAutoGen in self.LibraryAutoGenList:\r
3913 LibraryAutoGen.CreateMakeFile()\r
3914\r
36513f3a
YZ
3915 if self.CanSkip():\r
3916 return\r
3917\r
52302d4d
LG
3918 if len(self.CustomMakefile) == 0:\r
3919 Makefile = GenMake.ModuleMakefile(self)\r
3920 else:\r
3921 Makefile = GenMake.CustomMakefile(self)\r
3922 if Makefile.Generate():\r
3923 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %\r
3924 (self.Name, self.Arch))\r
3925 else:\r
3926 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %\r
3927 (self.Name, self.Arch))\r
3928\r
830bf22f 3929 CreateTimeStamp()\r
52302d4d 3930\r
a0a2cd1e
FB
3931 def CopyBinaryFiles(self):\r
3932 for File in self.Module.Binaries:\r
3933 SrcPath = File.Path\r
ccaa7754 3934 DstPath = os.path.join(self.OutputDir, os.path.basename(SrcPath))\r
a0a2cd1e 3935 CopyLongFilePath(SrcPath, DstPath)\r
52302d4d
LG
3936 ## Create autogen code for the module and its dependent libraries\r
3937 #\r
3938 # @param CreateLibraryCodeFile Flag indicating if or not the code of\r
3939 # dependent libraries will be created\r
3940 #\r
3941 def CreateCodeFile(self, CreateLibraryCodeFile=True):\r
3942 if self.IsCodeFileCreated:\r
3943 return\r
3944\r
e8a47801
LG
3945 # Need to generate PcdDatabase even PcdDriver is binarymodule\r
3946 if self.IsBinaryModule and self.PcdIsDriver != '':\r
3947 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
3948 return\r
a0a2cd1e 3949 if self.IsBinaryModule:\r
49d9b71d
HC
3950 if self.IsLibrary:\r
3951 self.CopyBinaryFiles()\r
a0a2cd1e 3952 return\r
e8a47801 3953\r
52302d4d
LG
3954 if not self.IsLibrary and CreateLibraryCodeFile:\r
3955 for LibraryAutoGen in self.LibraryAutoGenList:\r
3956 LibraryAutoGen.CreateCodeFile()\r
3957\r
36513f3a
YZ
3958 if self.CanSkip():\r
3959 return\r
3960\r
52302d4d
LG
3961 AutoGenList = []\r
3962 IgoredAutoGenList = []\r
3963\r
3964 for File in self.AutoGenFileList:\r
3965 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):\r
b36d134f 3966 #Ignore Edk AutoGen.c\r
52302d4d
LG
3967 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':\r
3968 continue\r
3969\r
3970 AutoGenList.append(str(File))\r
3971 else:\r
3972 IgoredAutoGenList.append(str(File))\r
3973\r
3974 # Skip the following code for EDK I inf\r
3975 if self.AutoGenVersion < 0x00010005:\r
3976 return\r
3977\r
3978 for ModuleType in self.DepexList:\r
8bb63e37
CJ
3979 # Ignore empty [depex] section or [depex] section for SUP_MODULE_USER_DEFINED module\r
3980 if len(self.DepexList[ModuleType]) == 0 or ModuleType == SUP_MODULE_USER_DEFINED:\r
52302d4d 3981 continue\r
40d841f6 3982\r
52302d4d
LG
3983 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)\r
3984 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}\r
3985\r
87d2afd0 3986 if len(Dpx.PostfixNotation) != 0:\r
0d2711a6 3987 self.DepexGenerated = True\r
da92f276 3988\r
52302d4d
LG
3989 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):\r
3990 AutoGenList.append(str(DpxFile))\r
3991 else:\r
3992 IgoredAutoGenList.append(str(DpxFile))\r
3993\r
3994 if IgoredAutoGenList == []:\r
3995 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %\r
3996 (" ".join(AutoGenList), self.Name, self.Arch))\r
3997 elif AutoGenList == []:\r
3998 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %\r
3999 (" ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4000 else:\r
4001 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %\r
4002 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4003\r
4004 self.IsCodeFileCreated = True\r
4005 return AutoGenList\r
4006\r
4007 ## Summarize the ModuleAutoGen objects of all libraries used by this module\r
b23414f6
JC
4008 @cached_property\r
4009 def LibraryAutoGenList(self):\r
4010 RetVal = []\r
4011 for Library in self.DependentLibraryList:\r
4012 La = ModuleAutoGen(\r
52302d4d
LG
4013 self.Workspace,\r
4014 Library.MetaFile,\r
4015 self.BuildTarget,\r
4016 self.ToolChain,\r
4017 self.Arch,\r
4018 self.PlatformInfo.MetaFile\r
4019 )\r
b23414f6
JC
4020 if La not in RetVal:\r
4021 RetVal.append(La)\r
4022 for Lib in La.CodaTargetList:\r
4023 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)\r
4024 return RetVal\r
52302d4d 4025\r
36d083ef
YZ
4026 def GenModuleHash(self):\r
4027 if self.Arch not in GlobalData.gModuleHash:\r
4028 GlobalData.gModuleHash[self.Arch] = {}\r
4029 m = hashlib.md5()\r
4030 # Add Platform level hash\r
4031 m.update(GlobalData.gPlatformHash)\r
4032 # Add Package level hash\r
4033 if self.DependentPackageList:\r
3f34e36d 4034 for Pkg in sorted(self.DependentPackageList, key=lambda x: x.PackageName):\r
36d083ef
YZ
4035 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:\r
4036 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])\r
4037\r
4038 # Add Library hash\r
4039 if self.LibraryAutoGenList:\r
3f34e36d 4040 for Lib in sorted(self.LibraryAutoGenList, key=lambda x: x.Name):\r
36d083ef
YZ
4041 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:\r
4042 Lib.GenModuleHash()\r
4043 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])\r
4044\r
4045 # Add Module self\r
4046 f = open(str(self.MetaFile), 'r')\r
4047 Content = f.read()\r
4048 f.close()\r
4049 m.update(Content)\r
4050 # Add Module's source files\r
4051 if self.SourceFileList:\r
3f34e36d 4052 for File in sorted(self.SourceFileList, key=lambda x: str(x)):\r
36d083ef
YZ
4053 f = open(str(File), 'r')\r
4054 Content = f.read()\r
4055 f.close()\r
4056 m.update(Content)\r
4057\r
4058 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")\r
4059 if self.Name not in GlobalData.gModuleHash[self.Arch]:\r
4060 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()\r
4061 if GlobalData.gBinCacheSource:\r
caf74495 4062 if self.AttemptModuleCacheCopy():\r
36d083ef
YZ
4063 return False\r
4064 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)\r
4065\r
4066 ## Decide whether we can skip the ModuleAutoGen process\r
4067 def CanSkipbyHash(self):\r
4068 if GlobalData.gUseHashCache:\r
4069 return not self.GenModuleHash()\r
18ef4e71 4070 return False\r
36d083ef 4071\r
c17956e0 4072 ## Decide whether we can skip the ModuleAutoGen process\r
36d083ef 4073 # If any source file is newer than the module than we cannot skip\r
c17956e0
DL
4074 #\r
4075 def CanSkip(self):\r
0a563f3f 4076 if self.MakeFileDir in GlobalData.gSikpAutoGenCache:\r
18ef4e71 4077 return True\r
b23414f6 4078 if not os.path.exists(self.TimeStampPath):\r
c17956e0
DL
4079 return False\r
4080 #last creation time of the module\r
b23414f6 4081 DstTimeStamp = os.stat(self.TimeStampPath)[8]\r
c17956e0
DL
4082\r
4083 SrcTimeStamp = self.Workspace._SrcTimeStamp\r
4084 if SrcTimeStamp > DstTimeStamp:\r
4085 return False\r
4086\r
b23414f6 4087 with open(self.TimeStampPath,'r') as f:\r
c17956e0
DL
4088 for source in f:\r
4089 source = source.rstrip('\n')\r
4a1167df
YZ
4090 if not os.path.exists(source):\r
4091 return False\r
c17956e0
DL
4092 if source not in ModuleAutoGen.TimeDict :\r
4093 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]\r
4094 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:\r
4095 return False\r
0a563f3f 4096 GlobalData.gSikpAutoGenCache.add(self.MakeFileDir)\r
c17956e0
DL
4097 return True\r
4098\r
b23414f6
JC
4099 @cached_property\r
4100 def TimeStampPath(self):\r
4101 return os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')\r