BaseTools: fix None comparisons
[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
40d841f6 5# This program and the accompanying materials\r
52302d4d
LG
6# are licensed and made available under the terms and conditions of the BSD License\r
7# which accompanies this distribution. The full text of the license may be found at\r
8# http://opensource.org/licenses/bsd-license.php\r
9#\r
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12#\r
13\r
14## Import Modules\r
15#\r
1be2ed90 16import Common.LongFilePathOs as os\r
52302d4d
LG
17import re\r
18import os.path as path\r
19import copy\r
867d1cd4 20import uuid\r
52302d4d
LG
21\r
22import GenC\r
23import GenMake\r
24import GenDepex\r
25from StringIO import StringIO\r
26\r
27from StrGather import *\r
28from BuildEngine import BuildRule\r
29\r
1be2ed90 30from Common.LongFilePathSupport import CopyLongFilePath\r
52302d4d
LG
31from Common.BuildToolError import *\r
32from Common.DataType import *\r
33from Common.Misc import *\r
34from Common.String import *\r
35import Common.GlobalData as GlobalData\r
36from GenFds.FdfParser import *\r
37from CommonDataClass.CommonClass import SkuInfoClass\r
38from Workspace.BuildClassObject import *\r
e8a47801 39from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile\r
e56468c0 40import Common.VpdInfoFile as VpdInfoFile\r
e8a47801
LG
41from GenPcdDb import CreatePcdDatabaseCode\r
42from Workspace.MetaFileCommentParser import UsageList\r
05cc51ad 43from Common.MultipleWorkspace import MultipleWorkspace as mws\r
97fa0ee9 44import InfSectionParser\r
c17956e0 45import datetime\r
36d083ef 46import hashlib\r
8518bf0b 47from GenVar import VariableMgr,var_info\r
9006a2c6 48from collections import OrderedDict\r
a993dc03 49from collections import defaultdict\r
97fa0ee9 50\r
e8a47801 51## Regular expression for splitting Dependency Expression string into tokens\r
52302d4d
LG
52gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")\r
53\r
c8802c3d
CJ
54## Regular expression for match: PCD(xxxx.yyy)\r
55gPCDAsGuidPattern = re.compile(r"^PCD\(.+\..+\)$")\r
56\r
57#\r
58# Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
59# is the former use /I , the Latter used -I to specify include directories\r
60#\r
61gBuildOptIncludePatternMsft = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
62gBuildOptIncludePatternOther = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
63\r
97fa0ee9
YL
64#\r
65# Match name = variable\r
66#\r
67gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")\r
68#\r
69# The format of guid in efivarstore statement likes following and must be correct:\r
70# guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}\r
71#\r
72gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")\r
73\r
52302d4d
LG
74## Mapping Makefile type\r
75gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}\r
76\r
77\r
78## Build rule configuration file\r
51de5c30 79gDefaultBuildRuleFile = 'build_rule.txt'\r
52302d4d 80\r
86601b78 81## Tools definition configuration file\r
51de5c30 82gDefaultToolsDefFile = 'tools_def.txt'\r
86601b78 83\r
64b2609f
LG
84## Build rule default version\r
85AutoGenReqBuildRuleVerNum = "0.1"\r
86\r
52302d4d
LG
87## default file name for AutoGen\r
88gAutoGenCodeFileName = "AutoGen.c"\r
89gAutoGenHeaderFileName = "AutoGen.h"\r
90gAutoGenStringFileName = "%(module_name)sStrDefs.h"\r
91gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"\r
92gAutoGenDepexFileName = "%(module_name)s.depex"\r
333ba578
YZ
93gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"\r
94gAutoGenIdfFileName = "%(module_name)sIdf.hpk"\r
97fa0ee9
YL
95gInfSpecVersion = "0x00010017"\r
96\r
da92f276
LG
97#\r
98# Template string to generic AsBuilt INF\r
99#\r
e8a47801 100gAsBuiltInfHeaderString = TemplateString("""${header_comments}\r
da92f276 101\r
97fa0ee9
YL
102# DO NOT EDIT\r
103# FILE auto-generated\r
104\r
da92f276 105[Defines]\r
97fa0ee9 106 INF_VERSION = ${module_inf_version}\r
da92f276
LG
107 BASE_NAME = ${module_name}\r
108 FILE_GUID = ${module_guid}\r
97fa0ee9
YL
109 MODULE_TYPE = ${module_module_type}${BEGIN}\r
110 VERSION_STRING = ${module_version_string}${END}${BEGIN}\r
e8a47801 111 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}\r
da92f276 112 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}\r
97fa0ee9
YL
113 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}\r
114 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}\r
115 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}\r
116 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}\r
117 DESTRUCTOR = ${module_destructor}${END}${BEGIN}\r
118 SHADOW = ${module_shadow}${END}${BEGIN}\r
119 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}\r
120 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}\r
121 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}\r
122 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}\r
123 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}\r
124 SPEC = ${module_spec}${END}${BEGIN}\r
125 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}\r
126 MODULE_UNI_FILE = ${module_uni_file}${END}\r
127\r
128[Packages.${module_arch}]${BEGIN}\r
da92f276
LG
129 ${package_item}${END}\r
130\r
131[Binaries.${module_arch}]${BEGIN}\r
132 ${binary_item}${END}\r
133\r
e8a47801
LG
134[PatchPcd.${module_arch}]${BEGIN}\r
135 ${patchablepcd_item}\r
136${END}\r
97fa0ee9 137\r
e8a47801
LG
138[Protocols.${module_arch}]${BEGIN}\r
139 ${protocol_item}\r
140${END}\r
97fa0ee9 141\r
e8a47801
LG
142[Ppis.${module_arch}]${BEGIN}\r
143 ${ppi_item}\r
144${END}\r
97fa0ee9 145\r
e8a47801
LG
146[Guids.${module_arch}]${BEGIN}\r
147 ${guid_item}\r
148${END}\r
97fa0ee9 149\r
e8a47801
LG
150[PcdEx.${module_arch}]${BEGIN}\r
151 ${pcd_item}\r
152${END}\r
da92f276 153\r
97fa0ee9
YL
154[LibraryClasses.${module_arch}]\r
155## @LIB_INSTANCES${BEGIN}\r
156# ${libraryclasses_item}${END}\r
157\r
158${depexsection_item}\r
159\r
dfa41b4a
YZ
160${userextension_tianocore_item}\r
161\r
97fa0ee9
YL
162${tail_comments}\r
163\r
164[BuildOptions.${module_arch}]\r
da92f276
LG
165## @AsBuilt${BEGIN}\r
166## ${flags_item}${END}\r
167""")\r
168\r
52302d4d
LG
169## Base class for AutoGen\r
170#\r
171# This class just implements the cache mechanism of AutoGen objects.\r
172#\r
173class AutoGen(object):\r
b24e99f7
CJ
174 # database to maintain the objects in each child class\r
175 __ObjectCache = {} # (BuildTarget, ToolChain, ARCH, platform file): AutoGen object\r
52302d4d
LG
176\r
177 ## Factory method\r
178 #\r
179 # @param Class class object of real AutoGen class\r
180 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)\r
181 # @param Workspace Workspace directory or WorkspaceAutoGen object\r
182 # @param MetaFile The path of meta file\r
183 # @param Target Build target\r
184 # @param Toolchain Tool chain name\r
185 # @param Arch Target arch\r
186 # @param *args The specific class related parameters\r
187 # @param **kwargs The specific class related dict parameters\r
188 #\r
b24e99f7 189 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
52302d4d 190 # check if the object has been created\r
b24e99f7
CJ
191 Key = (Target, Toolchain, Arch, MetaFile)\r
192 try:\r
193 # if it exists, just return it directly\r
194 return cls.__ObjectCache[Key]\r
195 except:\r
196 # it didnt exist. create it, cache it, then return it\r
197 cls.__ObjectCache[Key] = super(AutoGen, cls).__new__(cls)\r
198 return cls.__ObjectCache[Key]\r
199\r
200 def __init__ (self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
201 super(AutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
52302d4d
LG
202\r
203 ## hash() operator\r
204 #\r
205 # The file path of platform file will be used to represent hash value of this object\r
206 #\r
207 # @retval int Hash value of the file path of platform file\r
208 #\r
209 def __hash__(self):\r
210 return hash(self.MetaFile)\r
211\r
212 ## str() operator\r
213 #\r
214 # The file path of platform file will be used to represent this object\r
215 #\r
216 # @retval string String of platform file path\r
217 #\r
218 def __str__(self):\r
219 return str(self.MetaFile)\r
220\r
221 ## "==" operator\r
222 def __eq__(self, Other):\r
223 return Other and self.MetaFile == Other\r
224\r
225## Workspace AutoGen class\r
226#\r
227# This class is used mainly to control the whole platform build for different\r
228# architecture. This class will generate top level makefile.\r
229#\r
230class WorkspaceAutoGen(AutoGen):\r
b24e99f7
CJ
231 # call super().__init__ then call the worker function with different parameter count\r
232 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
233 try:\r
234 self._Init\r
235 except:\r
236 super(WorkspaceAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
237 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
238 self._Init = True\r
239 \r
240 ## Initialize WorkspaceAutoGen\r
52302d4d
LG
241 #\r
242 # @param WorkspaceDir Root directory of workspace\r
243 # @param ActivePlatform Meta-file of active platform\r
244 # @param Target Build target\r
245 # @param Toolchain Tool chain name\r
246 # @param ArchList List of architecture of current build\r
247 # @param MetaFileDb Database containing meta-files\r
248 # @param BuildConfig Configuration of build\r
249 # @param ToolDefinition Tool chain definitions\r
250 # @param FlashDefinitionFile File of flash definition\r
251 # @param Fds FD list to be generated\r
252 # @param Fvs FV list to be generated\r
4234283c 253 # @param Caps Capsule list to be generated\r
52302d4d
LG
254 # @param SkuId SKU id from command line\r
255 #\r
b24e99f7 256 def _InitWorker(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,\r
47fea6af 257 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,\r
9508d0fa 258 Progress=None, BuildModule=None):\r
0d2711a6
LG
259 self.BuildDatabase = MetaFileDb\r
260 self.MetaFile = ActivePlatform\r
52302d4d 261 self.WorkspaceDir = WorkspaceDir\r
0d2711a6 262 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]\r
d0acc87a 263 GlobalData.gActivePlatform = self.Platform\r
52302d4d
LG
264 self.BuildTarget = Target\r
265 self.ToolChain = Toolchain\r
266 self.ArchList = ArchList\r
267 self.SkuId = SkuId\r
f3decdc3 268 self.UniFlag = UniFlag\r
52302d4d 269\r
52302d4d
LG
270 self.TargetTxt = BuildConfig\r
271 self.ToolDef = ToolDefinition\r
272 self.FdfFile = FlashDefinitionFile\r
066c7154
CJ
273 self.FdTargetList = Fds if Fds else []\r
274 self.FvTargetList = Fvs if Fvs else []\r
275 self.CapTargetList = Caps if Caps else []\r
52302d4d 276 self.AutoGenObjectList = []\r
36d083ef
YZ
277 self._BuildDir = None\r
278 self._FvDir = None\r
279 self._MakeFileDir = None\r
280 self._BuildCommand = None\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
12d37ace 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
622b1758 358 MetaFile_cache = {}\r
2502b735 359 for Arch in self.ArchList:\r
1530ceda 360 Current_Platform_cache = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
b74b419a 361 MetaFile_cache[Arch] = set()\r
1530ceda
CJ
362 for Pkey in Current_Platform_cache.Modules:\r
363 MetaFile_cache[Arch].add(Current_Platform_cache.Modules[Pkey].MetaFile)\r
2502b735
YZ
364 for Inf in self.FdfProfile.InfDict[key]:\r
365 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
366 for Arch in self.ArchList:\r
622b1758 367 if ModuleFile in MetaFile_cache[Arch]:\r
2502b735
YZ
368 break\r
369 else:\r
370 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
371 if not ModuleData.IsBinaryModule:\r
372 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
373\r
374 else:\r
375 for Arch in self.ArchList:\r
376 if Arch == key:\r
377 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
b74b419a
CJ
378 MetaFileList = set()\r
379 for Pkey in Platform.Modules:\r
380 MetaFileList.add(Platform.Modules[Pkey].MetaFile)\r
2502b735
YZ
381 for Inf in self.FdfProfile.InfDict[key]:\r
382 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
622b1758 383 if ModuleFile in MetaFileList:\r
2502b735
YZ
384 continue\r
385 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
386 if not ModuleData.IsBinaryModule:\r
387 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
388\r
52302d4d
LG
389 else:\r
390 PcdSet = {}\r
391 ModuleList = []\r
392 self.FdfProfile = None\r
0d2711a6
LG
393 if self.FdTargetList:\r
394 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))\r
395 self.FdTargetList = []\r
396 if self.FvTargetList:\r
397 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))\r
398 self.FvTargetList = []\r
399 if self.CapTargetList:\r
400 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))\r
401 self.CapTargetList = []\r
47fea6af 402\r
52302d4d
LG
403 # apply SKU and inject PCDs from Flash Definition file\r
404 for Arch in self.ArchList:\r
0d2711a6 405 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
f9fa014e
YZ
406 PlatformPcds = Platform.Pcds\r
407 self._GuidDict = Platform._GuidDict\r
ff5635e9
CJ
408 SourcePcdDict = {'DynamicEx':set(), 'PatchableInModule':set(),'Dynamic':set(),'FixedAtBuild':set()}\r
409 BinaryPcdDict = {'DynamicEx':set(), 'PatchableInModule':set()}\r
2a29017e
YZ
410 SourcePcdDict_Keys = SourcePcdDict.keys()\r
411 BinaryPcdDict_Keys = BinaryPcdDict.keys()\r
412\r
413 # generate the SourcePcdDict and BinaryPcdDict\r
6f49996c 414 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
2a29017e
YZ
415 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
416 if BuildData.Arch != Arch:\r
417 continue\r
418 if BuildData.MetaFile.Ext == '.inf':\r
419 for key in BuildData.Pcds:\r
420 if BuildData.Pcds[key].Pending:\r
421 if key in Platform.Pcds:\r
422 PcdInPlatform = Platform.Pcds[key]\r
423 if PcdInPlatform.Type not in [None, '']:\r
424 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
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
430 if PcdInPlatform.Type not in [None, '']:\r
431 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
432\r
433 if 'DynamicEx' in BuildData.Pcds[key].Type:\r
434 if BuildData.IsBinaryModule:\r
ff5635e9 435 BinaryPcdDict['DynamicEx'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 436 else:\r
ff5635e9 437 SourcePcdDict['DynamicEx'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e
YZ
438\r
439 elif 'PatchableInModule' in BuildData.Pcds[key].Type:\r
440 if BuildData.MetaFile.Ext == '.inf':\r
441 if BuildData.IsBinaryModule:\r
ff5635e9 442 BinaryPcdDict['PatchableInModule'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 443 else:\r
ff5635e9 444 SourcePcdDict['PatchableInModule'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e
YZ
445\r
446 elif 'Dynamic' in BuildData.Pcds[key].Type:\r
ff5635e9 447 SourcePcdDict['Dynamic'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e 448 elif 'FixedAtBuild' in BuildData.Pcds[key].Type:\r
ff5635e9 449 SourcePcdDict['FixedAtBuild'].add((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
2a29017e
YZ
450 else:\r
451 pass\r
97cdb33b
YZ
452 #\r
453 # A PCD can only use one type for all source modules\r
454 #\r
455 for i in SourcePcdDict_Keys:\r
456 for j in SourcePcdDict_Keys:\r
457 if i != j:\r
ff5635e9
CJ
458 Intersections = SourcePcdDict[i].intersection(SourcePcdDict[j])\r
459 if len(Intersections) > 0:\r
97cdb33b
YZ
460 EdkLogger.error(\r
461 'build',\r
462 FORMAT_INVALID,\r
463 "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
ff5635e9 464 ExtraData="%s" % '\n\t'.join([str(P[1]+'.'+P[0]) for P in Intersections])\r
97cdb33b 465 )\r
2a29017e
YZ
466\r
467 #\r
468 # intersection the BinaryPCD for Mixed PCD\r
469 #\r
470 for i in BinaryPcdDict_Keys:\r
471 for j in BinaryPcdDict_Keys:\r
472 if i != j:\r
ff5635e9
CJ
473 Intersections = BinaryPcdDict[i].intersection(BinaryPcdDict[j])\r
474 for item in Intersections:\r
2a29017e
YZ
475 NewPcd1 = (item[0] + '_' + i, item[1])\r
476 NewPcd2 = (item[0] + '_' + j, item[1])\r
477 if item not in GlobalData.MixedPcd:\r
478 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
479 else:\r
480 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
481 GlobalData.MixedPcd[item].append(NewPcd1)\r
482 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
483 GlobalData.MixedPcd[item].append(NewPcd2)\r
2a29017e
YZ
484\r
485 #\r
486 # intersection the SourcePCD and BinaryPCD for Mixed PCD\r
487 #\r
488 for i in SourcePcdDict_Keys:\r
489 for j in BinaryPcdDict_Keys:\r
490 if i != j:\r
ff5635e9
CJ
491 Intersections = SourcePcdDict[i].intersection(BinaryPcdDict[j])\r
492 for item in Intersections:\r
2a29017e
YZ
493 NewPcd1 = (item[0] + '_' + i, item[1])\r
494 NewPcd2 = (item[0] + '_' + j, item[1])\r
495 if item not in GlobalData.MixedPcd:\r
496 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
497 else:\r
498 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
499 GlobalData.MixedPcd[item].append(NewPcd1)\r
500 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
501 GlobalData.MixedPcd[item].append(NewPcd2)\r
2a29017e
YZ
502\r
503 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
504 if BuildData.Arch != Arch:\r
505 continue\r
506 for key in BuildData.Pcds:\r
507 for SinglePcd in GlobalData.MixedPcd:\r
508 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
509 for item in GlobalData.MixedPcd[SinglePcd]:\r
510 Pcd_Type = item[0].split('_')[-1]\r
511 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in GenC.gDynamicExPcd) or \\r
512 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in GenC.gDynamicPcd):\r
513 Value = BuildData.Pcds[key]\r
514 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type\r
515 if len(key) == 2:\r
516 newkey = (Value.TokenCName, key[1])\r
517 elif len(key) == 3:\r
518 newkey = (Value.TokenCName, key[1], key[2])\r
519 del BuildData.Pcds[key]\r
520 BuildData.Pcds[newkey] = Value\r
521 break\r
2a29017e 522 break\r
2a29017e
YZ
523\r
524 # handle the mixed pcd in FDF file\r
525 for key in PcdSet:\r
526 if key in GlobalData.MixedPcd:\r
527 Value = PcdSet[key]\r
528 del PcdSet[key]\r
529 for item in GlobalData.MixedPcd[key]:\r
530 PcdSet[item] = Value\r
531\r
97fa0ee9 532 #Collect package set information from INF of FDF\r
a0a2cd1e
FB
533 PkgSet = set()\r
534 for Inf in ModuleList:\r
535 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
536 if ModuleFile in Platform.Modules:\r
537 continue\r
538 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
539 PkgSet.update(ModuleData.Packages)\r
540 Pkgs = list(PkgSet) + list(PGen.PackageList)\r
6b26dd71 541 DecPcds = set()\r
6f49996c 542 DecPcdsKey = set()\r
64b2609f 543 for Pkg in Pkgs:\r
25918452 544 for Pcd in Pkg.Pcds:\r
6b26dd71 545 DecPcds.add((Pcd[0], Pcd[1]))\r
4afd3d04 546 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))\r
64b2609f 547\r
52302d4d
LG
548 Platform.SkuName = self.SkuId\r
549 for Name, Guid in PcdSet:\r
64b2609f
LG
550 if (Name, Guid) not in DecPcds:\r
551 EdkLogger.error(\r
552 'build',\r
553 PARSER_ERROR,\r
554 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),\r
555 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
556 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
557 )\r
4afd3d04
LG
558 else:\r
559 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.\r
560 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \\r
561 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \\r
562 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:\r
563 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])\r
564 continue\r
565 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:\r
566 EdkLogger.error(\r
567 'build',\r
568 PARSER_ERROR,\r
569 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),\r
570 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
571 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
572 )\r
52302d4d
LG
573\r
574 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
575 #\r
576 # Explicitly collect platform's dynamic PCDs\r
577 #\r
578 Pa.CollectPlatformDynamicPcds()\r
2bc3256c 579 Pa.CollectFixedAtBuildPcds()\r
52302d4d 580 self.AutoGenObjectList.append(Pa)\r
47fea6af 581\r
36d083ef
YZ
582 #\r
583 # Generate Package level hash value\r
584 #\r
585 GlobalData.gPackageHash[Arch] = {}\r
586 if GlobalData.gUseHashCache:\r
587 for Pkg in Pkgs:\r
588 self._GenPkgLevelHash(Pkg)\r
589\r
6780eef1
LG
590 #\r
591 # Check PCDs token value conflict in each DEC file.\r
592 #\r
593 self._CheckAllPcdsTokenValueConflict()\r
47fea6af 594\r
4234283c
LG
595 #\r
596 # Check PCD type and definition between DSC and DEC\r
597 #\r
598 self._CheckPcdDefineAndType()\r
97fa0ee9
YL
599\r
600# if self.FdfFile:\r
601# self._CheckDuplicateInFV(Fdf)\r
602\r
c17956e0 603 #\r
2d499388 604 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.\r
c17956e0
DL
605 #\r
606 content = 'gCommandLineDefines: '\r
607 content += str(GlobalData.gCommandLineDefines)\r
608 content += os.linesep\r
609 content += 'BuildOptionPcd: '\r
610 content += str(GlobalData.BuildOptionPcd)\r
2d499388
YZ
611 content += os.linesep\r
612 content += 'Active Platform: '\r
613 content += str(self.Platform)\r
614 content += os.linesep\r
615 if self.FdfFile:\r
616 content += 'Flash Image Definition: '\r
617 content += str(self.FdfFile)\r
36d083ef 618 content += os.linesep\r
c17956e0
DL
619 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)\r
620\r
99adfe9f
YZ
621 #\r
622 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.\r
623 #\r
624 PcdTokenNumber = 'PcdTokenNumber: '\r
625 if Pa.PcdTokenNumber:\r
626 if Pa.DynamicPcdList:\r
627 for Pcd in Pa.DynamicPcdList:\r
628 PcdTokenNumber += os.linesep\r
629 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))\r
630 PcdTokenNumber += ' : '\r
631 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])\r
632 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)\r
633\r
c17956e0
DL
634 #\r
635 # Get set of workspace metafiles\r
636 #\r
637 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)\r
638\r
639 #\r
640 # Retrieve latest modified time of all metafiles\r
641 #\r
642 SrcTimeStamp = 0\r
643 for f in AllWorkSpaceMetaFiles:\r
644 if os.stat(f)[8] > SrcTimeStamp:\r
645 SrcTimeStamp = os.stat(f)[8]\r
646 self._SrcTimeStamp = SrcTimeStamp\r
647\r
36d083ef
YZ
648 if GlobalData.gUseHashCache:\r
649 m = hashlib.md5()\r
650 for files in AllWorkSpaceMetaFiles:\r
651 if files.endswith('.dec'):\r
652 continue\r
653 f = open(files, 'r')\r
654 Content = f.read()\r
655 f.close()\r
656 m.update(Content)\r
657 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)\r
658 GlobalData.gPlatformHash = m.hexdigest()\r
659\r
c17956e0
DL
660 #\r
661 # Write metafile list to build directory\r
662 #\r
663 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')\r
664 if os.path.exists (AutoGenFilePath):\r
665 os.remove(AutoGenFilePath)\r
666 if not os.path.exists(self.BuildDir):\r
667 os.makedirs(self.BuildDir)\r
668 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:\r
669 for f in AllWorkSpaceMetaFiles:\r
670 print >> file, f\r
52302d4d
LG
671 return True\r
672\r
36d083ef
YZ
673 def _GenPkgLevelHash(self, Pkg):\r
674 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)\r
675 CreateDirectory(PkgDir)\r
676 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')\r
677 m = hashlib.md5()\r
678 # Get .dec file's hash value\r
679 f = open(Pkg.MetaFile.Path, 'r')\r
680 Content = f.read()\r
681 f.close()\r
682 m.update(Content)\r
683 # Get include files hash value\r
684 if Pkg.Includes:\r
685 for inc in Pkg.Includes:\r
686 for Root, Dirs, Files in os.walk(str(inc)):\r
687 for File in Files:\r
688 File_Path = os.path.join(Root, File)\r
689 f = open(File_Path, 'r')\r
690 Content = f.read()\r
691 f.close()\r
692 m.update(Content)\r
693 SaveFileOnChange(HashFile, m.hexdigest(), True)\r
694 if Pkg.PackageName not in GlobalData.gPackageHash[Pkg.Arch]:\r
695 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()\r
763e8edf 696\r
c17956e0
DL
697 def _GetMetaFiles(self, Target, Toolchain, Arch):\r
698 AllWorkSpaceMetaFiles = set()\r
699 #\r
700 # add fdf\r
701 #\r
702 if self.FdfFile:\r
703 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)\r
704 if self.FdfFile:\r
705 FdfFiles = GlobalData.gFdfParser.GetAllIncludedFile()\r
706 for f in FdfFiles:\r
707 AllWorkSpaceMetaFiles.add (f.FileName)\r
708 #\r
709 # add dsc\r
710 #\r
711 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)\r
712\r
713 #\r
86601b78
DL
714 # add build_rule.txt & tools_def.txt\r
715 #\r
51de5c30
YZ
716 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))\r
717 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))\r
86601b78 718\r
c17956e0
DL
719 # add BuildOption metafile\r
720 #\r
721 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))\r
722\r
99adfe9f
YZ
723 # add PcdToken Number file for Dynamic/DynamicEx Pcd\r
724 #\r
725 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))\r
726\r
c17956e0
DL
727 for Arch in self.ArchList:\r
728 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
729 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
730\r
731 #\r
732 # add dec\r
733 #\r
734 for Package in PGen.PackageList:\r
735 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)\r
736\r
737 #\r
738 # add included dsc\r
739 #\r
740 for filePath in Platform._RawData.IncludedFiles:\r
741 AllWorkSpaceMetaFiles.add(filePath.Path)\r
742\r
743 return AllWorkSpaceMetaFiles\r
744\r
79b74a03
LG
745 ## _CheckDuplicateInFV() method\r
746 #\r
747 # Check whether there is duplicate modules/files exist in FV section. \r
748 # The check base on the file GUID;\r
749 #\r
750 def _CheckDuplicateInFV(self, Fdf):\r
751 for Fv in Fdf.Profile.FvDict:\r
752 _GuidDict = {}\r
753 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:\r
4231a819 754 if FfsFile.InfFileName and FfsFile.NameGuid is None:\r
79b74a03
LG
755 #\r
756 # Get INF file GUID\r
757 #\r
47fea6af 758 InfFoundFlag = False\r
79b74a03 759 for Pa in self.AutoGenObjectList:\r
64b2609f
LG
760 if InfFoundFlag:\r
761 break\r
79b74a03
LG
762 for Module in Pa.ModuleAutoGenList:\r
763 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):\r
764 InfFoundFlag = True\r
765 if not Module.Guid.upper() in _GuidDict.keys():\r
766 _GuidDict[Module.Guid.upper()] = FfsFile\r
64b2609f 767 break\r
79b74a03 768 else:\r
47fea6af 769 EdkLogger.error("build",\r
79b74a03 770 FORMAT_INVALID,\r
47fea6af 771 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
772 FfsFile.CurrentLineContent,\r
773 _GuidDict[Module.Guid.upper()].CurrentLineNum,\r
774 _GuidDict[Module.Guid.upper()].CurrentLineContent,\r
775 Module.Guid.upper()),\r
776 ExtraData=self.FdfFile)\r
777 #\r
778 # Some INF files not have entity in DSC file. \r
779 #\r
780 if not InfFoundFlag:\r
781 if FfsFile.InfFileName.find('$') == -1:\r
782 InfPath = NormPath(FfsFile.InfFileName)\r
783 if not os.path.exists(InfPath):\r
784 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))\r
47fea6af 785\r
79b74a03
LG
786 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)\r
787 #\r
788 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use \r
789 # BuildObject from one of AutoGenObjectList is enough.\r
790 #\r
791 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]\r
792 if not InfObj.Guid.upper() in _GuidDict.keys():\r
793 _GuidDict[InfObj.Guid.upper()] = FfsFile\r
794 else:\r
47fea6af 795 EdkLogger.error("build",\r
79b74a03 796 FORMAT_INVALID,\r
47fea6af 797 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
798 FfsFile.CurrentLineContent,\r
799 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,\r
800 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,\r
801 InfObj.Guid.upper()),\r
802 ExtraData=self.FdfFile)\r
803 InfFoundFlag = False\r
47fea6af 804\r
4231a819 805 if FfsFile.NameGuid is not None:\r
79b74a03
LG
806 #\r
807 # If the NameGuid reference a PCD name. \r
808 # The style must match: PCD(xxxx.yyy)\r
809 #\r
c8802c3d 810 if gPCDAsGuidPattern.match(FfsFile.NameGuid):\r
79b74a03
LG
811 #\r
812 # Replace the PCD value.\r
813 #\r
814 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")\r
815 PcdFoundFlag = False\r
816 for Pa in self.AutoGenObjectList:\r
817 if not PcdFoundFlag:\r
818 for PcdItem in Pa.AllPcdList:\r
819 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:\r
820 #\r
821 # First convert from CFormatGuid to GUID string\r
822 #\r
823 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)\r
47fea6af 824\r
79b74a03
LG
825 if not _PcdGuidString:\r
826 #\r
827 # Then try Byte array.\r
828 #\r
829 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)\r
47fea6af 830\r
79b74a03
LG
831 if not _PcdGuidString:\r
832 #\r
833 # Not Byte array or CFormat GUID, raise error.\r
834 #\r
835 EdkLogger.error("build",\r
836 FORMAT_INVALID,\r
47fea6af 837 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName, PcdItem.DefaultValue),\r
79b74a03 838 ExtraData=self.FdfFile)\r
47fea6af
YZ
839\r
840 if not _PcdGuidString.upper() in _GuidDict.keys():\r
79b74a03
LG
841 _GuidDict[_PcdGuidString.upper()] = FfsFile\r
842 PcdFoundFlag = True\r
843 break\r
844 else:\r
47fea6af 845 EdkLogger.error("build",\r
79b74a03 846 FORMAT_INVALID,\r
47fea6af 847 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
848 FfsFile.CurrentLineContent,\r
849 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,\r
850 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,\r
851 FfsFile.NameGuid.upper()),\r
47fea6af
YZ
852 ExtraData=self.FdfFile)\r
853\r
79b74a03
LG
854 if not FfsFile.NameGuid.upper() in _GuidDict.keys():\r
855 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile\r
856 else:\r
857 #\r
858 # Two raw file GUID conflict.\r
859 #\r
47fea6af 860 EdkLogger.error("build",\r
79b74a03 861 FORMAT_INVALID,\r
47fea6af 862 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
863 FfsFile.CurrentLineContent,\r
864 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,\r
865 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,\r
866 FfsFile.NameGuid.upper()),\r
867 ExtraData=self.FdfFile)\r
47fea6af 868\r
79b74a03 869\r
4234283c
LG
870 def _CheckPcdDefineAndType(self):\r
871 PcdTypeList = [\r
872 "FixedAtBuild", "PatchableInModule", "FeatureFlag",\r
873 "Dynamic", #"DynamicHii", "DynamicVpd",\r
874 "DynamicEx", # "DynamicExHii", "DynamicExVpd"\r
875 ]\r
876\r
877 # This dict store PCDs which are not used by any modules with specified arches\r
9006a2c6 878 UnusedPcd = OrderedDict()\r
4234283c
LG
879 for Pa in self.AutoGenObjectList:\r
880 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid\r
881 for Pcd in Pa.Platform.Pcds:\r
882 PcdType = Pa.Platform.Pcds[Pcd].Type\r
47fea6af 883\r
4234283c
LG
884 # If no PCD type, this PCD comes from FDF \r
885 if not PcdType:\r
886 continue\r
47fea6af 887\r
4234283c
LG
888 # Try to remove Hii and Vpd suffix\r
889 if PcdType.startswith("DynamicEx"):\r
890 PcdType = "DynamicEx"\r
891 elif PcdType.startswith("Dynamic"):\r
892 PcdType = "Dynamic"\r
47fea6af 893\r
4234283c
LG
894 for Package in Pa.PackageList:\r
895 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType\r
896 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:\r
897 break\r
898 for Type in PcdTypeList:\r
899 if (Pcd[0], Pcd[1], Type) in Package.Pcds:\r
900 EdkLogger.error(\r
901 'build',\r
902 FORMAT_INVALID,\r
903 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \\r
904 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),\r
905 ExtraData=None\r
906 )\r
907 return\r
908 else:\r
909 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)\r
910\r
911 for Pcd in UnusedPcd:\r
912 EdkLogger.warn(\r
913 'build',\r
914 "The PCD was not specified by any INF module in the platform for the given architecture.\n"\r
915 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"\r
916 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),\r
917 ExtraData=None\r
918 )\r
919\r
52302d4d
LG
920 def __repr__(self):\r
921 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))\r
922\r
923 ## Return the directory to store FV files\r
924 def _GetFvDir(self):\r
4231a819 925 if self._FvDir is None:\r
52302d4d
LG
926 self._FvDir = path.join(self.BuildDir, 'FV')\r
927 return self._FvDir\r
928\r
929 ## Return the directory to store all intermediate and final files built\r
930 def _GetBuildDir(self):\r
4231a819 931 if self._BuildDir is None:\r
36d083ef 932 return self.AutoGenObjectList[0].BuildDir\r
52302d4d
LG
933\r
934 ## Return the build output directory platform specifies\r
935 def _GetOutputDir(self):\r
936 return self.Platform.OutputDirectory\r
937\r
938 ## Return platform name\r
939 def _GetName(self):\r
940 return self.Platform.PlatformName\r
941\r
942 ## Return meta-file GUID\r
943 def _GetGuid(self):\r
944 return self.Platform.Guid\r
945\r
946 ## Return platform version\r
947 def _GetVersion(self):\r
948 return self.Platform.Version\r
949\r
950 ## Return paths of tools\r
951 def _GetToolDefinition(self):\r
952 return self.AutoGenObjectList[0].ToolDefinition\r
953\r
954 ## Return directory of platform makefile\r
955 #\r
956 # @retval string Makefile directory\r
957 #\r
958 def _GetMakeFileDir(self):\r
4231a819 959 if self._MakeFileDir is None:\r
52302d4d
LG
960 self._MakeFileDir = self.BuildDir\r
961 return self._MakeFileDir\r
962\r
963 ## Return build command string\r
964 #\r
965 # @retval string Build command string\r
966 #\r
967 def _GetBuildCommand(self):\r
4231a819 968 if self._BuildCommand is None:\r
52302d4d
LG
969 # BuildCommand should be all the same. So just get one from platform AutoGen\r
970 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand\r
971 return self._BuildCommand\r
47fea6af 972\r
6780eef1
LG
973 ## Check the PCDs token value conflict in each DEC file.\r
974 #\r
975 # Will cause build break and raise error message while two PCDs conflict.\r
976 # \r
977 # @return None\r
978 #\r
979 def _CheckAllPcdsTokenValueConflict(self):\r
b36d134f
LG
980 for Pa in self.AutoGenObjectList:\r
981 for Package in Pa.PackageList:\r
6780eef1 982 PcdList = Package.Pcds.values()\r
f827cd07 983 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0))) \r
6780eef1
LG
984 Count = 0\r
985 while (Count < len(PcdList) - 1) :\r
986 Item = PcdList[Count]\r
987 ItemNext = PcdList[Count + 1]\r
988 #\r
989 # Make sure in the same token space the TokenValue should be unique\r
990 #\r
f827cd07 991 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
992 SameTokenValuePcdList = []\r
993 SameTokenValuePcdList.append(Item)\r
994 SameTokenValuePcdList.append(ItemNext)\r
995 RemainPcdListLength = len(PcdList) - Count - 2\r
996 for ValueSameCount in range(RemainPcdListLength):\r
f827cd07 997 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):\r
6780eef1
LG
998 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])\r
999 else:\r
1000 break;\r
1001 #\r
1002 # Sort same token value PCD list with TokenGuid and TokenCName\r
1003 #\r
47fea6af
YZ
1004 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))\r
1005 SameTokenValuePcdListCount = 0\r
6780eef1 1006 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):\r
2a29017e 1007 Flag = False\r
47fea6af
YZ
1008 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]\r
1009 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]\r
1010\r
6780eef1 1011 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):\r
2a29017e
YZ
1012 for PcdItem in GlobalData.MixedPcd:\r
1013 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \\r
1014 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
1015 Flag = True\r
1016 if not Flag:\r
1017 EdkLogger.error(\r
1018 'build',\r
1019 FORMAT_INVALID,\r
1020 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\\r
1021 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),\r
1022 ExtraData=None\r
1023 )\r
6780eef1
LG
1024 SameTokenValuePcdListCount += 1\r
1025 Count += SameTokenValuePcdListCount\r
1026 Count += 1\r
47fea6af 1027\r
6780eef1 1028 PcdList = Package.Pcds.values()\r
47fea6af 1029 PcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))\r
6780eef1
LG
1030 Count = 0\r
1031 while (Count < len(PcdList) - 1) :\r
1032 Item = PcdList[Count]\r
47fea6af 1033 ItemNext = PcdList[Count + 1]\r
6780eef1
LG
1034 #\r
1035 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.\r
1036 #\r
f827cd07 1037 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
1038 EdkLogger.error(\r
1039 'build',\r
1040 FORMAT_INVALID,\r
1041 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\\r
1042 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),\r
1043 ExtraData=None\r
1044 )\r
1045 Count += 1\r
97fa0ee9 1046 ## Generate fds command\r
03af2753
HC
1047 def _GenFdsCommand(self):\r
1048 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()\r
52302d4d 1049\r
e56468c0 1050 ## Create makefile for the platform and modules in it\r
52302d4d
LG
1051 #\r
1052 # @param CreateDepsMakeFile Flag indicating if the makefile for\r
1053 # modules will be created as well\r
1054 #\r
1055 def CreateMakeFile(self, CreateDepsMakeFile=False):\r
52302d4d
LG
1056 if CreateDepsMakeFile:\r
1057 for Pa in self.AutoGenObjectList:\r
1058 Pa.CreateMakeFile(CreateDepsMakeFile)\r
1059\r
1060 ## Create autogen code for platform and modules\r
1061 #\r
1062 # Since there's no autogen code for platform, this method will do nothing\r
1063 # if CreateModuleCodeFile is set to False.\r
1064 #\r
1065 # @param CreateDepsCodeFile Flag indicating if creating module's\r
1066 # autogen code file or not\r
1067 #\r
1068 def CreateCodeFile(self, CreateDepsCodeFile=False):\r
1069 if not CreateDepsCodeFile:\r
1070 return\r
1071 for Pa in self.AutoGenObjectList:\r
1072 Pa.CreateCodeFile(CreateDepsCodeFile)\r
1073\r
7c1fd323
LG
1074 ## Create AsBuilt INF file the platform\r
1075 #\r
1076 def CreateAsBuiltInf(self):\r
1077 return\r
1078\r
52302d4d
LG
1079 Name = property(_GetName)\r
1080 Guid = property(_GetGuid)\r
1081 Version = property(_GetVersion)\r
1082 OutputDir = property(_GetOutputDir)\r
1083\r
1084 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
1085\r
1086 BuildDir = property(_GetBuildDir)\r
1087 FvDir = property(_GetFvDir)\r
1088 MakeFileDir = property(_GetMakeFileDir)\r
1089 BuildCommand = property(_GetBuildCommand)\r
03af2753 1090 GenFdsCommand = property(_GenFdsCommand)\r
52302d4d
LG
1091\r
1092## AutoGen class for platform\r
1093#\r
1094# PlatformAutoGen class will process the original information in platform\r
1095# file in order to generate makefile for platform.\r
1096#\r
1097class PlatformAutoGen(AutoGen):\r
b24e99f7
CJ
1098 # call super().__init__ then call the worker function with different parameter count\r
1099 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
1100 try:\r
1101 self._Init\r
1102 except:\r
1103 super(PlatformAutoGen, self).__init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
1104 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch)\r
1105 self._Init = True\r
52302d4d
LG
1106 #\r
1107 # Used to store all PCDs for both PEI and DXE phase, in order to generate \r
1108 # correct PCD database\r
1109 # \r
1110 _DynaPcdList_ = []\r
1111 _NonDynaPcdList_ = []\r
61ee1dff 1112 _PlatformPcds = {}\r
6780eef1
LG
1113 \r
1114 #\r
1115 # The priority list while override build option \r
1116 #\r
1117 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)\r
1118 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
1119 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
1120 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE \r
1121 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
1122 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
1123 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE\r
1124 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE\r
1125 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1126 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1127 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE\r
1128 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE\r
1129 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE\r
1130 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE\r
1131 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE\r
1132 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)\r
47fea6af 1133\r
b24e99f7 1134 ## Initialize PlatformAutoGen\r
52302d4d 1135 #\r
52302d4d
LG
1136 #\r
1137 # @param Workspace WorkspaceAutoGen object\r
1138 # @param PlatformFile Platform file (DSC file)\r
1139 # @param Target Build target (DEBUG, RELEASE)\r
1140 # @param Toolchain Name of tool chain\r
1141 # @param Arch arch of the platform supports\r
1142 #\r
b24e99f7 1143 def _InitWorker(self, Workspace, PlatformFile, Target, Toolchain, Arch):\r
52302d4d
LG
1144 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))\r
1145 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)\r
1146\r
1147 self.MetaFile = PlatformFile\r
1148 self.Workspace = Workspace\r
1149 self.WorkspaceDir = Workspace.WorkspaceDir\r
1150 self.ToolChain = Toolchain\r
1151 self.BuildTarget = Target\r
1152 self.Arch = Arch\r
1153 self.SourceDir = PlatformFile.SubDir\r
1154 self.SourceOverrideDir = None\r
1155 self.FdTargetList = self.Workspace.FdTargetList\r
1156 self.FvTargetList = self.Workspace.FvTargetList\r
1157 self.AllPcdList = []\r
a0a2cd1e
FB
1158 # get the original module/package/platform objects\r
1159 self.BuildDatabase = Workspace.BuildDatabase\r
8518bf0b 1160 self.DscBuildDataObj = Workspace.Platform\r
35f613d9 1161 self._GuidDict = Workspace._GuidDict\r
52302d4d
LG
1162\r
1163 # flag indicating if the makefile/C-code file has been created or not\r
1164 self.IsMakeFileCreated = False\r
1165 self.IsCodeFileCreated = False\r
1166\r
1167 self._Platform = None\r
1168 self._Name = None\r
1169 self._Guid = None\r
1170 self._Version = None\r
1171\r
1172 self._BuildRule = None\r
1173 self._SourceDir = None\r
1174 self._BuildDir = None\r
1175 self._OutputDir = None\r
1176 self._FvDir = None\r
1177 self._MakeFileDir = None\r
1178 self._FdfFile = None\r
1179\r
1180 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
1181 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
1182 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2bc3256c 1183 self._NonDynamicPcdDict = {}\r
52302d4d
LG
1184\r
1185 self._ToolDefinitions = None\r
1186 self._ToolDefFile = None # toolcode : tool path\r
1187 self._ToolChainFamily = None\r
1188 self._BuildRuleFamily = None\r
1189 self._BuildOption = None # toolcode : option\r
1190 self._EdkBuildOption = None # edktoolcode : option\r
1191 self._EdkIIBuildOption = None # edkiitoolcode : option\r
1192 self._PackageList = None\r
1193 self._ModuleAutoGenList = None\r
1194 self._LibraryAutoGenList = None\r
1195 self._BuildCommand = None\r
a0a2cd1e
FB
1196 self._AsBuildInfList = []\r
1197 self._AsBuildModuleList = []\r
47854fd5
LG
1198\r
1199 self.VariableInfo = None\r
1200\r
4231a819 1201 if GlobalData.gFdfParser is not None:\r
a0a2cd1e
FB
1202 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList\r
1203 for Inf in self._AsBuildInfList:\r
1204 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)\r
1205 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
1206 if not M.IsSupportedArch:\r
1207 continue\r
1208 self._AsBuildModuleList.append(InfClass)\r
03af2753
HC
1209 # get library/modules for build\r
1210 self.LibraryBuildDirectoryList = []\r
1211 self.ModuleBuildDirectoryList = []\r
47854fd5 1212\r
52302d4d
LG
1213 return True\r
1214\r
1215 def __repr__(self):\r
1216 return "%s [%s]" % (self.MetaFile, self.Arch)\r
1217\r
1218 ## Create autogen code for platform and modules\r
1219 #\r
1220 # Since there's no autogen code for platform, this method will do nothing\r
1221 # if CreateModuleCodeFile is set to False.\r
1222 #\r
1223 # @param CreateModuleCodeFile Flag indicating if creating module's\r
1224 # autogen code file or not\r
1225 #\r
1226 def CreateCodeFile(self, CreateModuleCodeFile=False):\r
1227 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False\r
1228 if self.IsCodeFileCreated or not CreateModuleCodeFile:\r
1229 return\r
1230\r
1231 for Ma in self.ModuleAutoGenList:\r
1232 Ma.CreateCodeFile(True)\r
1233\r
1234 # don't do this twice\r
1235 self.IsCodeFileCreated = True\r
1236\r
03af2753
HC
1237 ## Generate Fds Command\r
1238 def _GenFdsCommand(self):\r
1239 return self.Workspace.GenFdsCommand\r
481252bb 1240\r
52302d4d
LG
1241 ## Create makefile for the platform and mdoules in it\r
1242 #\r
1243 # @param CreateModuleMakeFile Flag indicating if the makefile for\r
1244 # modules will be created as well\r
1245 #\r
37de70b7 1246 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):\r
52302d4d
LG
1247 if CreateModuleMakeFile:\r
1248 for ModuleFile in self.Platform.Modules:\r
1249 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,\r
1250 self.ToolChain, self.Arch, self.MetaFile)\r
37de70b7
YZ
1251 if (ModuleFile.File, self.Arch) in FfsCommand:\r
1252 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])\r
1253 else:\r
1254 Ma.CreateMakeFile(True)\r
97fa0ee9 1255 #Ma.CreateAsBuiltInf()\r
52302d4d
LG
1256\r
1257 # no need to create makefile for the platform more than once\r
1258 if self.IsMakeFileCreated:\r
1259 return\r
1260\r
03af2753 1261 # create library/module build dirs for platform\r
52302d4d 1262 Makefile = GenMake.PlatformMakefile(self)\r
03af2753
HC
1263 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()\r
1264 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()\r
1265\r
52302d4d
LG
1266 self.IsMakeFileCreated = True\r
1267\r
2bc3256c
LG
1268 ## Deal with Shared FixedAtBuild Pcds\r
1269 #\r
1270 def CollectFixedAtBuildPcds(self):\r
1271 for LibAuto in self.LibraryAutoGenList:\r
1272 FixedAtBuildPcds = {} \r
1273 ShareFixedAtBuildPcdsSameValue = {} \r
1274 for Module in LibAuto._ReferenceModules: \r
8b0e6782 1275 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:\r
2bc3256c
LG
1276 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName)) \r
1277 if key not in FixedAtBuildPcds:\r
1278 ShareFixedAtBuildPcdsSameValue[key] = True\r
1279 FixedAtBuildPcds[key] = Pcd.DefaultValue\r
1280 else:\r
1281 if FixedAtBuildPcds[key] != Pcd.DefaultValue:\r
1282 ShareFixedAtBuildPcdsSameValue[key] = False \r
1283 for Pcd in LibAuto.FixedAtBuildPcds:\r
1284 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1285 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:\r
1286 continue\r
1287 else:\r
1288 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]\r
1289 if DscPcd.Type != "FixedAtBuild":\r
1290 continue\r
1291 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]: \r
eca980c0 1292 LibAuto.ConstPcd[key] = FixedAtBuildPcds[key]\r
2bc3256c 1293\r
34952f49 1294 def CollectVariables(self, DynamicPcdSet):\r
47854fd5
LG
1295\r
1296 VpdRegionSize = 0\r
1297 VpdRegionBase = 0\r
1298 if self.Workspace.FdfFile:\r
1299 FdDict = self.Workspace.FdfProfile.FdDict[GlobalData.gFdfParser.CurrentFdName]\r
1300 for FdRegion in FdDict.RegionList:\r
1301 for item in FdRegion.RegionDataList:\r
1302 if self.Platform.VpdToolGuid.strip() and self.Platform.VpdToolGuid in item:\r
1303 VpdRegionSize = FdRegion.Size\r
1304 VpdRegionBase = FdRegion.Offset\r
1305 break\r
1306\r
1307\r
8518bf0b 1308 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(),self.DscBuildDataObj._GetSkuIds())\r
47854fd5
LG
1309 VariableInfo.SetVpdRegionMaxSize(VpdRegionSize)\r
1310 VariableInfo.SetVpdRegionOffset(VpdRegionBase)\r
34952f49
LG
1311 Index = 0\r
1312 for Pcd in DynamicPcdSet:\r
8518bf0b
LG
1313 pcdname = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1314 for SkuName in Pcd.SkuInfoList:\r
1315 Sku = Pcd.SkuInfoList[SkuName]\r
1316 SkuId = Sku.SkuId\r
4231a819 1317 if SkuId is None or SkuId == '':\r
8518bf0b
LG
1318 continue\r
1319 if len(Sku.VariableName) > 0:\r
1320 VariableGuidStructure = Sku.VariableGuidValue\r
1321 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)\r
a3623244 1322 for StorageName in Sku.DefaultStoreDict:\r
e6bf3cfd 1323 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
1324 Index += 1\r
1325 return VariableInfo\r
47854fd5
LG
1326\r
1327 def UpdateNVStoreMaxSize(self,OrgVpdFile):\r
0b6c5954
LG
1328 if self.VariableInfo:\r
1329 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)\r
1330 PcdNvStoreDfBuffer = [item for item in self._DynamicPcdList if item.TokenCName == "PcdNvStoreDefaultValueBuffer" and item.TokenSpaceGuidCName == "gEfiMdeModulePkgTokenSpaceGuid"]\r
1331\r
1332 if PcdNvStoreDfBuffer:\r
1333 if os.path.exists(VpdMapFilePath):\r
1334 OrgVpdFile.Read(VpdMapFilePath)\r
1335 PcdItems = OrgVpdFile.GetOffset(PcdNvStoreDfBuffer[0])\r
8ac16789 1336 NvStoreOffset = PcdItems.values()[0].strip() if PcdItems else '0'\r
0b6c5954
LG
1337 else:\r
1338 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
1339\r
1340 NvStoreOffset = int(NvStoreOffset,16) if NvStoreOffset.upper().startswith("0X") else int(NvStoreOffset)\r
1341 default_skuobj = PcdNvStoreDfBuffer[0].SkuInfoList.get("DEFAULT")\r
1342 maxsize = self.VariableInfo.VpdRegionSize - NvStoreOffset if self.VariableInfo.VpdRegionSize else len(default_skuobj.DefaultValue.split(","))\r
1343 var_data = self.VariableInfo.PatchNVStoreDefaultMaxSize(maxsize)\r
1344\r
1345 if var_data and default_skuobj:\r
1346 default_skuobj.DefaultValue = var_data\r
1347 PcdNvStoreDfBuffer[0].DefaultValue = var_data\r
1348 PcdNvStoreDfBuffer[0].SkuInfoList.clear()\r
1349 PcdNvStoreDfBuffer[0].SkuInfoList['DEFAULT'] = default_skuobj\r
1350 PcdNvStoreDfBuffer[0].MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))\r
47854fd5
LG
1351\r
1352 return OrgVpdFile\r
1353\r
52302d4d
LG
1354 ## Collect dynamic PCDs\r
1355 #\r
1356 # Gather dynamic PCDs list from each module and their settings from platform\r
1357 # This interface should be invoked explicitly when platform action is created.\r
1358 #\r
1359 def CollectPlatformDynamicPcds(self):\r
763e8edf 1360\r
2a29017e
YZ
1361 for key in self.Platform.Pcds:\r
1362 for SinglePcd in GlobalData.MixedPcd:\r
1363 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
1364 for item in GlobalData.MixedPcd[SinglePcd]:\r
1365 Pcd_Type = item[0].split('_')[-1]\r
1366 if (Pcd_Type == self.Platform.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and self.Platform.Pcds[key].Type in GenC.gDynamicExPcd) or \\r
1367 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):\r
1368 Value = self.Platform.Pcds[key]\r
1369 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type\r
1370 if len(key) == 2:\r
1371 newkey = (Value.TokenCName, key[1])\r
1372 elif len(key) == 3:\r
1373 newkey = (Value.TokenCName, key[1], key[2])\r
1374 del self.Platform.Pcds[key]\r
1375 self.Platform.Pcds[newkey] = Value\r
1376 break\r
1377 else:\r
1378 pass\r
1379 break\r
1380 else:\r
1381 pass\r
1382\r
52302d4d
LG
1383 # for gathering error information\r
1384 NoDatumTypePcdList = set()\r
a0a2cd1e
FB
1385 FdfModuleList = []\r
1386 for InfName in self._AsBuildInfList:\r
05cc51ad 1387 InfName = mws.join(self.WorkspaceDir, InfName)\r
a0a2cd1e 1388 FdfModuleList.append(os.path.normpath(InfName))\r
52302d4d
LG
1389 for F in self.Platform.Modules.keys():\r
1390 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)\r
1391 #GuidValue.update(M.Guids)\r
1392 \r
1393 self.Platform.Modules[F].M = M\r
47fea6af
YZ
1394\r
1395 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:\r
52302d4d 1396 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
e8a47801 1397 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:\r
52302d4d
LG
1398 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))\r
1399\r
97fa0ee9 1400 # Check the PCD from Binary INF or Source INF\r
a0a2cd1e
FB
1401 if M.IsBinaryModule == True:\r
1402 PcdFromModule.IsFromBinaryInf = True\r
97fa0ee9
YL
1403\r
1404 # Check the PCD from DSC or not \r
a0a2cd1e
FB
1405 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():\r
1406 PcdFromModule.IsFromDsc = True\r
1407 else:\r
1408 PcdFromModule.IsFromDsc = False\r
52302d4d 1409 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:\r
a0a2cd1e
FB
1410 if F.Path not in FdfModuleList:\r
1411 # If one of the Source built modules listed in the DSC is not listed \r
1412 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic \r
1413 # access method (it is only listed in the DEC file that declares the \r
1414 # PCD as PcdsDynamic), then build tool will report warning message\r
1415 # notify the PI that they are attempting to build a module that must \r
1416 # be included in a flash image in order to be functional. These Dynamic \r
1417 # PCD will not be added into the Database unless it is used by other \r
1418 # modules that are included in the FDF file.\r
1419 if PcdFromModule.Type in GenC.gDynamicPcd and \\r
1420 PcdFromModule.IsFromBinaryInf == False:\r
1421 # Print warning message to let the developer make a determine.\r
a0a2cd1e
FB
1422 continue\r
1423 # If one of the Source built modules listed in the DSC is not listed in \r
1424 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx \r
1425 # access method (it is only listed in the DEC file that declares the \r
1426 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the \r
1427 # PCD to the Platform's PCD Database.\r
1428 if PcdFromModule.Type in GenC.gDynamicExPcd:\r
a0a2cd1e 1429 continue\r
52302d4d
LG
1430 #\r
1431 # If a dynamic PCD used by a PEM module/PEI module & DXE module,\r
1432 # it should be stored in Pcd PEI database, If a dynamic only\r
1433 # used by DXE module, it should be stored in DXE PCD database.\r
1434 # The default Phase is DXE\r
1435 #\r
1436 if M.ModuleType in ["PEIM", "PEI_CORE"]:\r
1437 PcdFromModule.Phase = "PEI"\r
1438 if PcdFromModule not in self._DynaPcdList_:\r
1439 self._DynaPcdList_.append(PcdFromModule)\r
1440 elif PcdFromModule.Phase == 'PEI':\r
1441 # overwrite any the same PCD existing, if Phase is PEI\r
1442 Index = self._DynaPcdList_.index(PcdFromModule)\r
1443 self._DynaPcdList_[Index] = PcdFromModule\r
1444 elif PcdFromModule not in self._NonDynaPcdList_:\r
1445 self._NonDynaPcdList_.append(PcdFromModule)\r
a0a2cd1e
FB
1446 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:\r
1447 Index = self._NonDynaPcdList_.index(PcdFromModule)\r
1448 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:\r
1449 #The PCD from Binary INF will override the same one from source INF\r
1450 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])\r
1451 PcdFromModule.Pending = False\r
1452 self._NonDynaPcdList_.append (PcdFromModule)\r
1563349a 1453 DscModuleSet = {os.path.normpath(ModuleInf.Path) for ModuleInf in self.Platform.Modules}\r
a0a2cd1e
FB
1454 # add the PCD from modules that listed in FDF but not in DSC to Database \r
1455 for InfName in FdfModuleList:\r
1563349a 1456 if InfName not in DscModuleSet:\r
a0a2cd1e
FB
1457 InfClass = PathClass(InfName)\r
1458 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
1459 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source) \r
1460 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here. \r
1461 # For binary module, if in current arch, we need to list the PCDs into database. \r
1462 if not M.IsSupportedArch:\r
1463 continue\r
1464 # Override the module PCD setting by platform setting\r
1465 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)\r
1466 for PcdFromModule in ModulePcdList:\r
1467 PcdFromModule.IsFromBinaryInf = True\r
1468 PcdFromModule.IsFromDsc = False\r
1469 # Only allow the DynamicEx and Patchable PCD in AsBuild INF\r
1470 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1471 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1472 File=self.MetaFile,\r
1473 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"\r
1474 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))\r
1475 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
1476 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:\r
1477 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))\r
1478 if M.ModuleType in ["PEIM", "PEI_CORE"]:\r
1479 PcdFromModule.Phase = "PEI"\r
1480 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:\r
1481 self._DynaPcdList_.append(PcdFromModule)\r
1482 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1483 self._NonDynaPcdList_.append(PcdFromModule)\r
1484 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:\r
97fa0ee9
YL
1485 # Overwrite the phase of any the same PCD existing, if Phase is PEI.\r
1486 # It is to solve the case that a dynamic PCD used by a PEM module/PEI \r
1487 # module & DXE module at a same time.\r
1488 # Overwrite the type of the PCDs in source INF by the type of AsBuild\r
1489 # INF file as DynamicEx. \r
a0a2cd1e
FB
1490 Index = self._DynaPcdList_.index(PcdFromModule)\r
1491 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase\r
1492 self._DynaPcdList_[Index].Type = PcdFromModule.Type\r
1493 for PcdFromModule in self._NonDynaPcdList_:\r
1494 # If a PCD is not listed in the DSC file, but binary INF files used by \r
1495 # this platform all (that use this PCD) list the PCD in a [PatchPcds] \r
1496 # section, AND all source INF files used by this platform the build \r
1497 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds] \r
1498 # section, then the tools must NOT add the PCD to the Platform's PCD\r
1499 # Database; the build must assign the access method for this PCD as \r
1500 # PcdsPatchableInModule.\r
1501 if PcdFromModule not in self._DynaPcdList_:\r
1502 continue\r
1503 Index = self._DynaPcdList_.index(PcdFromModule)\r
1504 if PcdFromModule.IsFromDsc == False and \\r
1505 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \\r
1506 PcdFromModule.IsFromBinaryInf == True and \\r
1507 self._DynaPcdList_[Index].IsFromBinaryInf == False:\r
1508 Index = self._DynaPcdList_.index(PcdFromModule)\r
1509 self._DynaPcdList_.remove (self._DynaPcdList_[Index])\r
52302d4d
LG
1510\r
1511 # print out error information and break the build, if error found\r
1512 if len(NoDatumTypePcdList) > 0:\r
1513 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)\r
1514 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1515 File=self.MetaFile,\r
1516 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"\r
1517 % NoDatumTypePcdListString)\r
1518 self._NonDynamicPcdList = self._NonDynaPcdList_\r
1519 self._DynamicPcdList = self._DynaPcdList_\r
52302d4d
LG
1520 #\r
1521 # Sort dynamic PCD list to:\r
1522 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should \r
1523 # try to be put header of dynamicd List\r
1524 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD\r
1525 #\r
1526 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.\r
1527 #\r
0b6c5954
LG
1528 UnicodePcdArray = set()\r
1529 HiiPcdArray = set()\r
1530 OtherPcdArray = set()\r
6780eef1 1531 VpdPcdDict = {}\r
e56468c0 1532 VpdFile = VpdInfoFile.VpdInfoFile()\r
61ee1dff
YZ
1533 NeedProcessVpdMapFile = False\r
1534\r
1535 for pcd in self.Platform.Pcds.keys():\r
1536 if pcd not in self._PlatformPcds.keys():\r
1537 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]\r
1538\r
ae7b6df8
LG
1539 for item in self._PlatformPcds:\r
1540 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
1541 self._PlatformPcds[item].DatumType = "VOID*"\r
1542\r
e56468c0 1543 if (self.Workspace.ArchList[-1] == self.Arch): \r
1544 for Pcd in self._DynamicPcdList:\r
e56468c0 1545 # just pick the a value to determine whether is unicode string type\r
47fea6af 1546 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]\r
e56468c0 1547 Sku.VpdOffset = Sku.VpdOffset.strip()\r
47fea6af 1548\r
ae7b6df8
LG
1549 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
1550 Pcd.DatumType = "VOID*"\r
1551\r
e56468c0 1552 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
e56468c0 1553 # if found HII type PCD then insert to right of UnicodeIndex\r
e56468c0 1554 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
47fea6af
YZ
1555 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd\r
1556\r
34952f49
LG
1557 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer\r
1558 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))\r
1559 if PcdNvStoreDfBuffer:\r
47854fd5 1560 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)\r
47854fd5 1561 vardump = self.VariableInfo.dump()\r
626bece4 1562 if vardump:\r
2b8a6c44 1563 PcdNvStoreDfBuffer.DefaultValue = vardump\r
626bece4
LG
1564 for skuname in PcdNvStoreDfBuffer.SkuInfoList:\r
1565 PcdNvStoreDfBuffer.SkuInfoList[skuname].DefaultValue = vardump\r
1566 PcdNvStoreDfBuffer.MaxDatumSize = str(len(vardump.split(",")))\r
34952f49 1567\r
61ee1dff 1568 PlatformPcds = self._PlatformPcds.keys()\r
47fea6af 1569 PlatformPcds.sort()\r
6780eef1
LG
1570 #\r
1571 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
1572 #\r
626bece4 1573 VpdSkuMap = {}\r
6780eef1 1574 for PcdKey in PlatformPcds:\r
61ee1dff 1575 Pcd = self._PlatformPcds[PcdKey]\r
e8a47801
LG
1576 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \\r
1577 PcdKey in VpdPcdDict:\r
1578 Pcd = VpdPcdDict[PcdKey]\r
626bece4 1579 SkuValueMap = {}\r
8ac16789
LG
1580 DefaultSku = Pcd.SkuInfoList.get('DEFAULT')\r
1581 if DefaultSku:\r
1582 PcdValue = DefaultSku.DefaultValue\r
1583 if PcdValue not in SkuValueMap:\r
1584 SkuValueMap[PcdValue] = []\r
1585 VpdFile.Add(Pcd, 'DEFAULT',DefaultSku.VpdOffset)\r
1586 SkuValueMap[PcdValue].append(DefaultSku)\r
1587\r
e8a47801
LG
1588 for (SkuName,Sku) in Pcd.SkuInfoList.items():\r
1589 Sku.VpdOffset = Sku.VpdOffset.strip()\r
5a13737a
YZ
1590 PcdValue = Sku.DefaultValue\r
1591 if PcdValue == "":\r
1592 PcdValue = Pcd.DefaultValue\r
1593 if Sku.VpdOffset != '*':\r
1594 if PcdValue.startswith("{"):\r
1595 Alignment = 8\r
1596 elif PcdValue.startswith("L"):\r
1597 Alignment = 2\r
1598 else:\r
1599 Alignment = 1\r
ca85291f
YZ
1600 try:\r
1601 VpdOffset = int(Sku.VpdOffset)\r
1602 except:\r
1603 try:\r
1604 VpdOffset = int(Sku.VpdOffset, 16)\r
1605 except:\r
1606 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1607 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1608 if PcdValue.startswith("{"):\r
1609 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)\r
1610 else:\r
1611 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
1612 if PcdValue not in SkuValueMap:\r
1613 SkuValueMap[PcdValue] = []\r
8ac16789 1614 VpdFile.Add(Pcd, SkuName,Sku.VpdOffset)\r
626bece4 1615 SkuValueMap[PcdValue].append(Sku)\r
e8a47801
LG
1616 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
1617 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1618 NeedProcessVpdMapFile = True\r
4231a819 1619 if self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == '':\r
e8a47801
LG
1620 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
1621 "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 1622\r
626bece4 1623 VpdSkuMap[PcdKey] = SkuValueMap\r
e56468c0 1624 #\r
1625 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
1626 # An example is PCD for signature usage.\r
6780eef1
LG
1627 # \r
1628 for DscPcd in PlatformPcds:\r
61ee1dff 1629 DscPcdEntry = self._PlatformPcds[DscPcd]\r
e56468c0 1630 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
4231a819 1631 if not (self.Platform.VpdToolGuid is None or self.Platform.VpdToolGuid == ''):\r
e56468c0 1632 FoundFlag = False\r
1633 for VpdPcd in VpdFile._VpdArray.keys():\r
1634 # This PCD has been referenced by module\r
1635 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1636 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
1637 FoundFlag = True\r
47fea6af 1638\r
e56468c0 1639 # Not found, it should be signature\r
1640 if not FoundFlag :\r
1641 # just pick the a value to determine whether is unicode string type\r
626bece4 1642 SkuValueMap = {}\r
e827d21d 1643 SkuObjList = DscPcdEntry.SkuInfoList.items()\r
8ac16789
LG
1644 DefaultSku = DscPcdEntry.SkuInfoList.get('DEFAULT')\r
1645 if DefaultSku:\r
e827d21d
B
1646 defaultindex = SkuObjList.index(('DEFAULT',DefaultSku))\r
1647 SkuObjList[0],SkuObjList[defaultindex] = SkuObjList[defaultindex],SkuObjList[0]\r
1648 for (SkuName,Sku) in SkuObjList:\r
e8a47801
LG
1649 Sku.VpdOffset = Sku.VpdOffset.strip() \r
1650 \r
1651 # Need to iterate DEC pcd information to get the value & datumtype\r
1652 for eachDec in self.PackageList:\r
1653 for DecPcd in eachDec.Pcds:\r
1654 DecPcdEntry = eachDec.Pcds[DecPcd]\r
1655 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1656 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
1657 # Print warning message to let the developer make a determine.\r
1658 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
1659 File=self.MetaFile, \\r
1660 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
1661 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path)) \r
1662 \r
1663 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1664 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
1665 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue\r
1666 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]\r
1667 # Only fix the value while no value provided in DSC file.\r
128d435f 1668 if not Sku.DefaultValue:\r
e8a47801
LG
1669 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
1670 \r
1671 if DscPcdEntry not in self._DynamicPcdList:\r
1672 self._DynamicPcdList.append(DscPcdEntry)\r
e8a47801
LG
1673 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1674 PcdValue = Sku.DefaultValue\r
5a13737a
YZ
1675 if PcdValue == "":\r
1676 PcdValue = DscPcdEntry.DefaultValue\r
1677 if Sku.VpdOffset != '*':\r
1678 if PcdValue.startswith("{"):\r
1679 Alignment = 8\r
1680 elif PcdValue.startswith("L"):\r
1681 Alignment = 2\r
1682 else:\r
1683 Alignment = 1\r
ca85291f
YZ
1684 try:\r
1685 VpdOffset = int(Sku.VpdOffset)\r
1686 except:\r
1687 try:\r
1688 VpdOffset = int(Sku.VpdOffset, 16)\r
1689 except:\r
1690 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))\r
1691 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1692 if PcdValue.startswith("{"):\r
1693 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)\r
1694 else:\r
1695 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
1696 if PcdValue not in SkuValueMap:\r
1697 SkuValueMap[PcdValue] = []\r
8ac16789 1698 VpdFile.Add(DscPcdEntry, SkuName,Sku.VpdOffset)\r
626bece4 1699 SkuValueMap[PcdValue].append(Sku)\r
e8a47801
LG
1700 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1701 NeedProcessVpdMapFile = True \r
1702 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
0b6c5954 1703 UnicodePcdArray.add(DscPcdEntry)\r
e8a47801 1704 elif len(Sku.VariableName) > 0:\r
0b6c5954 1705 HiiPcdArray.add(DscPcdEntry)\r
e8a47801 1706 else:\r
0b6c5954
LG
1707 OtherPcdArray.add(DscPcdEntry)\r
1708\r
e8a47801 1709 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
626bece4 1710 VpdSkuMap[DscPcd] = SkuValueMap\r
4231a819 1711 if (self.Platform.FlashDefinition is None or self.Platform.FlashDefinition == '') and \\r
e56468c0 1712 VpdFile.GetCount() != 0:\r
1713 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, \r
1714 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
47fea6af 1715\r
e56468c0 1716 if VpdFile.GetCount() != 0:\r
47854fd5
LG
1717\r
1718 self.FixVpdOffset(VpdFile)\r
1719\r
1720 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))\r
47fea6af 1721\r
e56468c0 1722 # Process VPD map file generated by third party BPDG tool\r
1723 if NeedProcessVpdMapFile:\r
08dd311f 1724 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1725 if os.path.exists(VpdMapFilePath):\r
1726 VpdFile.Read(VpdMapFilePath)\r
47fea6af 1727\r
e56468c0 1728 # Fixup "*" offset\r
626bece4
LG
1729 for pcd in VpdSkuMap:\r
1730 vpdinfo = VpdFile.GetVpdInfo(pcd)\r
1731 if vpdinfo is None:\r
e56468c0 1732 # just pick the a value to determine whether is unicode string type\r
626bece4
LG
1733 continue\r
1734 for pcdvalue in VpdSkuMap[pcd]:\r
1735 for sku in VpdSkuMap[pcd][pcdvalue]:\r
1736 for item in vpdinfo:\r
1737 if item[2] == pcdvalue:\r
1738 sku.VpdOffset = item[1]\r
e56468c0 1739 else:\r
1740 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
47fea6af 1741\r
626bece4
LG
1742 # Delete the DynamicPcdList At the last time enter into this function\r
1743 for Pcd in self._DynamicPcdList:\r
1744 # just pick the a value to determine whether is unicode string type\r
1745 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]\r
1746 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1747\r
1748 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
1749 Pcd.DatumType = "VOID*"\r
1750\r
1751 PcdValue = Sku.DefaultValue\r
1752 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
1753 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
0b6c5954 1754 UnicodePcdArray.add(Pcd)\r
626bece4
LG
1755 elif len(Sku.VariableName) > 0:\r
1756 # if found HII type PCD then insert to right of UnicodeIndex\r
0b6c5954 1757 HiiPcdArray.add(Pcd)\r
626bece4 1758 else:\r
0b6c5954 1759 OtherPcdArray.add(Pcd)\r
47fea6af 1760 del self._DynamicPcdList[:]\r
0b6c5954
LG
1761 self._DynamicPcdList.extend(list(UnicodePcdArray))\r
1762 self._DynamicPcdList.extend(list(HiiPcdArray))\r
1763 self._DynamicPcdList.extend(list(OtherPcdArray))\r
2b8a6c44
LG
1764 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]\r
1765 for pcd in self._DynamicPcdList:\r
1766 if len(pcd.SkuInfoList) == 1:\r
1767 for (SkuName,SkuId) in allskuset:\r
1768 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:\r
1769 continue\r
65eff519
LG
1770 pcd.SkuInfoList[SkuName] = copy.deepcopy(pcd.SkuInfoList['DEFAULT'])\r
1771 pcd.SkuInfoList[SkuName].SkuId = SkuId\r
a0a2cd1e 1772 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
47854fd5
LG
1773\r
1774 def FixVpdOffset(self,VpdFile ):\r
1775 FvPath = os.path.join(self.BuildDir, "FV")\r
1776 if not os.path.exists(FvPath):\r
1777 try:\r
1778 os.makedirs(FvPath)\r
1779 except:\r
1780 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
1781\r
1782 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1783\r
1784 if VpdFile.Write(VpdFilePath):\r
1785 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1786 BPDGToolName = None\r
1787 for ToolDef in self.ToolDefinition.values():\r
1788 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:\r
1789 if not ToolDef.has_key("PATH"):\r
1790 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1791 BPDGToolName = ToolDef["PATH"]\r
1792 break\r
1793 # Call third party GUID BPDG tool.\r
4231a819 1794 if BPDGToolName is not None:\r
47854fd5
LG
1795 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
1796 else:\r
1797 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
1798\r
52302d4d
LG
1799 ## Return the platform build data object\r
1800 def _GetPlatform(self):\r
4231a819 1801 if self._Platform is None:\r
0d2711a6 1802 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1803 return self._Platform\r
1804\r
1805 ## Return platform name\r
1806 def _GetName(self):\r
1807 return self.Platform.PlatformName\r
1808\r
1809 ## Return the meta file GUID\r
1810 def _GetGuid(self):\r
1811 return self.Platform.Guid\r
1812\r
1813 ## Return the platform version\r
1814 def _GetVersion(self):\r
1815 return self.Platform.Version\r
1816\r
1817 ## Return the FDF file name\r
1818 def _GetFdfFile(self):\r
4231a819 1819 if self._FdfFile is None:\r
52302d4d 1820 if self.Workspace.FdfFile != "":\r
05cc51ad 1821 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
52302d4d
LG
1822 else:\r
1823 self._FdfFile = ''\r
1824 return self._FdfFile\r
1825\r
1826 ## Return the build output directory platform specifies\r
1827 def _GetOutputDir(self):\r
1828 return self.Platform.OutputDirectory\r
1829\r
1830 ## Return the directory to store all intermediate and final files built\r
1831 def _GetBuildDir(self):\r
4231a819 1832 if self._BuildDir is None:\r
52302d4d
LG
1833 if os.path.isabs(self.OutputDir):\r
1834 self._BuildDir = path.join(\r
1835 path.abspath(self.OutputDir),\r
1836 self.BuildTarget + "_" + self.ToolChain,\r
1837 )\r
1838 else:\r
1839 self._BuildDir = path.join(\r
1840 self.WorkspaceDir,\r
1841 self.OutputDir,\r
1842 self.BuildTarget + "_" + self.ToolChain,\r
1843 )\r
97058144 1844 GlobalData.gBuildDirectory = self._BuildDir\r
52302d4d
LG
1845 return self._BuildDir\r
1846\r
1847 ## Return directory of platform makefile\r
1848 #\r
1849 # @retval string Makefile directory\r
1850 #\r
1851 def _GetMakeFileDir(self):\r
4231a819 1852 if self._MakeFileDir is None:\r
52302d4d
LG
1853 self._MakeFileDir = path.join(self.BuildDir, self.Arch)\r
1854 return self._MakeFileDir\r
1855\r
1856 ## Return build command string\r
1857 #\r
1858 # @retval string Build command string\r
1859 #\r
1860 def _GetBuildCommand(self):\r
4231a819 1861 if self._BuildCommand is None:\r
52302d4d
LG
1862 self._BuildCommand = []\r
1863 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1864 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1865 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1866 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1867 if NewOption != '':\r
6780eef1 1868 self._BuildCommand += SplitOption(NewOption)\r
02a908fc
YZ
1869 if "MAKE" in self.EdkIIBuildOption:\r
1870 if "FLAGS" in self.EdkIIBuildOption["MAKE"]:\r
1871 Flags = self.EdkIIBuildOption["MAKE"]["FLAGS"]\r
1872 if Flags.startswith('='):\r
1873 self._BuildCommand = [self._BuildCommand[0]] + [Flags[1:]]\r
1874 else:\r
1875 self._BuildCommand += [Flags]\r
52302d4d
LG
1876 return self._BuildCommand\r
1877\r
1878 ## Get tool chain definition\r
1879 #\r
1880 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1881 #\r
1882 def _GetToolDefinition(self):\r
4231a819 1883 if self._ToolDefinitions is None:\r
52302d4d
LG
1884 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1885 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1886 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1887 ExtraData="[%s]" % self.MetaFile)\r
1888 self._ToolDefinitions = {}\r
1889 DllPathList = set()\r
1890 for Def in ToolDefinition:\r
1891 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1892 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1893 continue\r
1894\r
1895 Value = ToolDefinition[Def]\r
1896 # don't record the DLL\r
1897 if Attr == "DLL":\r
1898 DllPathList.add(Value)\r
1899 continue\r
1900\r
1901 if Tool not in self._ToolDefinitions:\r
1902 self._ToolDefinitions[Tool] = {}\r
1903 self._ToolDefinitions[Tool][Attr] = Value\r
1904\r
1905 ToolsDef = ''\r
52302d4d
LG
1906 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:\r
1907 if "FLAGS" not in self._ToolDefinitions["MAKE"]:\r
1908 self._ToolDefinitions["MAKE"]["FLAGS"] = ""\r
1909 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"\r
1910 MakeFlags = ''\r
1911 for Tool in self._ToolDefinitions:\r
1912 for Attr in self._ToolDefinitions[Tool]:\r
1913 Value = self._ToolDefinitions[Tool][Attr]\r
1914 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:\r
1915 # check if override is indicated\r
1916 if self.BuildOption[Tool][Attr].startswith('='):\r
1917 Value = self.BuildOption[Tool][Attr][1:]\r
1918 else:\r
95816356
YZ
1919 if Attr != 'PATH':\r
1920 Value += " " + self.BuildOption[Tool][Attr]\r
1921 else:\r
1922 Value = self.BuildOption[Tool][Attr]\r
52302d4d
LG
1923\r
1924 if Attr == "PATH":\r
1925 # Don't put MAKE definition in the file\r
d98cce8e 1926 if Tool != "MAKE":\r
52302d4d
LG
1927 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1928 elif Attr != "DLL":\r
1929 # Don't put MAKE definition in the file\r
1930 if Tool == "MAKE":\r
1931 if Attr == "FLAGS":\r
1932 MakeFlags = Value\r
1933 else:\r
1934 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1935 ToolsDef += "\n"\r
1936\r
1937 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1938 for DllPath in DllPathList:\r
1939 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1940 os.environ["MAKE_FLAGS"] = MakeFlags\r
1941\r
1942 return self._ToolDefinitions\r
1943\r
1944 ## Return the paths of tools\r
1945 def _GetToolDefFile(self):\r
4231a819 1946 if self._ToolDefFile is None:\r
52302d4d
LG
1947 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
1948 return self._ToolDefFile\r
1949\r
1950 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
1951 def _GetToolChainFamily(self):\r
4231a819 1952 if self._ToolChainFamily is None:\r
52302d4d
LG
1953 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1954 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
1955 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
1956 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
1957 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1958 % self.ToolChain)\r
1959 self._ToolChainFamily = "MSFT"\r
1960 else:\r
1961 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
1962 return self._ToolChainFamily\r
1963\r
1964 def _GetBuildRuleFamily(self):\r
4231a819 1965 if self._BuildRuleFamily is None:\r
52302d4d
LG
1966 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1967 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
1968 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
1969 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
1970 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1971 % self.ToolChain)\r
1972 self._BuildRuleFamily = "MSFT"\r
1973 else:\r
1974 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
1975 return self._BuildRuleFamily\r
1976\r
1977 ## Return the build options specific for all modules in this platform\r
1978 def _GetBuildOptions(self):\r
4231a819 1979 if self._BuildOption is None:\r
52302d4d
LG
1980 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)\r
1981 return self._BuildOption\r
1982\r
1983 ## Return the build options specific for EDK modules in this platform\r
1984 def _GetEdkBuildOptions(self):\r
4231a819 1985 if self._EdkBuildOption is None:\r
52302d4d
LG
1986 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
1987 return self._EdkBuildOption\r
1988\r
1989 ## Return the build options specific for EDKII modules in this platform\r
1990 def _GetEdkIIBuildOptions(self):\r
4231a819 1991 if self._EdkIIBuildOption is None:\r
52302d4d
LG
1992 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
1993 return self._EdkIIBuildOption\r
1994\r
97fa0ee9 1995 ## Parse build_rule.txt in Conf Directory.\r
52302d4d
LG
1996 #\r
1997 # @retval BuildRule object\r
1998 #\r
1999 def _GetBuildRule(self):\r
4231a819 2000 if self._BuildRule is None:\r
52302d4d
LG
2001 BuildRuleFile = None\r
2002 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
2003 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
2004 if BuildRuleFile in [None, '']:\r
97fa0ee9 2005 BuildRuleFile = gDefaultBuildRuleFile\r
52302d4d 2006 self._BuildRule = BuildRule(BuildRuleFile)\r
64b2609f
LG
2007 if self._BuildRule._FileVersion == "":\r
2008 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum\r
2009 else:\r
2010 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :\r
2011 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
47fea6af 2012 EdkLogger.error("build", AUTOGEN_ERROR,\r
64b2609f
LG
2013 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
2014 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))\r
47fea6af 2015\r
52302d4d
LG
2016 return self._BuildRule\r
2017\r
2018 ## Summarize the packages used by modules in this platform\r
2019 def _GetPackageList(self):\r
4231a819 2020 if self._PackageList is None:\r
52302d4d
LG
2021 self._PackageList = set()\r
2022 for La in self.LibraryAutoGenList:\r
2023 self._PackageList.update(La.DependentPackageList)\r
2024 for Ma in self.ModuleAutoGenList:\r
2025 self._PackageList.update(Ma.DependentPackageList)\r
a0a2cd1e
FB
2026 #Collect package set information from INF of FDF\r
2027 PkgSet = set()\r
2028 for ModuleFile in self._AsBuildModuleList:\r
2029 if ModuleFile in self.Platform.Modules:\r
2030 continue\r
2031 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]\r
2032 PkgSet.update(ModuleData.Packages)\r
2033 self._PackageList = list(self._PackageList) + list (PkgSet)\r
52302d4d
LG
2034 return self._PackageList\r
2035\r
2bc3256c
LG
2036 def _GetNonDynamicPcdDict(self):\r
2037 if self._NonDynamicPcdDict:\r
2038 return self._NonDynamicPcdDict\r
2039 for Pcd in self.NonDynamicPcdList:\r
2040 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd\r
2041 return self._NonDynamicPcdDict\r
2042\r
52302d4d
LG
2043 ## Get list of non-dynamic PCDs\r
2044 def _GetNonDynamicPcdList(self):\r
4231a819 2045 if self._NonDynamicPcdList is None:\r
e56468c0 2046 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2047 return self._NonDynamicPcdList\r
2048\r
2049 ## Get list of dynamic PCDs\r
2050 def _GetDynamicPcdList(self):\r
4231a819 2051 if self._DynamicPcdList is None:\r
e56468c0 2052 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2053 return self._DynamicPcdList\r
2054\r
2055 ## Generate Token Number for all PCD\r
2056 def _GetPcdTokenNumbers(self):\r
4231a819 2057 if self._PcdTokenNumber is None:\r
9006a2c6 2058 self._PcdTokenNumber = OrderedDict()\r
52302d4d 2059 TokenNumber = 1\r
d0acc87a
LG
2060 #\r
2061 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area. \r
2062 # Such as:\r
2063 # \r
2064 # Dynamic PCD:\r
2065 # TokenNumber 0 ~ 10\r
2066 # DynamicEx PCD:\r
2067 # TokeNumber 11 ~ 20\r
2068 #\r
52302d4d
LG
2069 for Pcd in self.DynamicPcdList:\r
2070 if Pcd.Phase == "PEI":\r
d0acc87a
LG
2071 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2072 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2073 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2074 TokenNumber += 1\r
47fea6af 2075\r
d0acc87a
LG
2076 for Pcd in self.DynamicPcdList:\r
2077 if Pcd.Phase == "PEI":\r
2078 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2079 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2080 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2081 TokenNumber += 1\r
47fea6af 2082\r
52302d4d
LG
2083 for Pcd in self.DynamicPcdList:\r
2084 if Pcd.Phase == "DXE":\r
d0acc87a
LG
2085 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2086 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2087 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2088 TokenNumber += 1\r
47fea6af 2089\r
d0acc87a
LG
2090 for Pcd in self.DynamicPcdList:\r
2091 if Pcd.Phase == "DXE":\r
2092 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2093 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2094 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2095 TokenNumber += 1\r
47fea6af 2096\r
52302d4d
LG
2097 for Pcd in self.NonDynamicPcdList:\r
2098 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2099 TokenNumber += 1\r
2100 return self._PcdTokenNumber\r
2101\r
2102 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform\r
2103 def _GetAutoGenObjectList(self):\r
2104 self._ModuleAutoGenList = []\r
2105 self._LibraryAutoGenList = []\r
2106 for ModuleFile in self.Platform.Modules:\r
2107 Ma = ModuleAutoGen(\r
2108 self.Workspace,\r
2109 ModuleFile,\r
2110 self.BuildTarget,\r
2111 self.ToolChain,\r
2112 self.Arch,\r
2113 self.MetaFile\r
2114 )\r
2115 if Ma not in self._ModuleAutoGenList:\r
2116 self._ModuleAutoGenList.append(Ma)\r
2117 for La in Ma.LibraryAutoGenList:\r
2118 if La not in self._LibraryAutoGenList:\r
2119 self._LibraryAutoGenList.append(La)\r
2bc3256c
LG
2120 if Ma not in La._ReferenceModules:\r
2121 La._ReferenceModules.append(Ma)\r
52302d4d
LG
2122\r
2123 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
2124 def _GetModuleAutoGenList(self):\r
4231a819 2125 if self._ModuleAutoGenList is None:\r
52302d4d
LG
2126 self._GetAutoGenObjectList()\r
2127 return self._ModuleAutoGenList\r
2128\r
2129 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
2130 def _GetLibraryAutoGenList(self):\r
4231a819 2131 if self._LibraryAutoGenList is None:\r
52302d4d
LG
2132 self._GetAutoGenObjectList()\r
2133 return self._LibraryAutoGenList\r
2134\r
2135 ## Test if a module is supported by the platform\r
2136 #\r
2137 # An error will be raised directly if the module or its arch is not supported\r
2138 # by the platform or current configuration\r
2139 #\r
2140 def ValidModule(self, Module):\r
a0a2cd1e
FB
2141 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \\r
2142 or Module in self._AsBuildModuleList\r
52302d4d
LG
2143\r
2144 ## Resolve the library classes in a module to library instances\r
2145 #\r
2146 # This method will not only resolve library classes but also sort the library\r
2147 # instances according to the dependency-ship.\r
2148 #\r
2149 # @param Module The module from which the library classes will be resolved\r
2150 #\r
2151 # @retval library_list List of library instances sorted\r
2152 #\r
2153 def ApplyLibraryInstance(self, Module):\r
25193a33
YZ
2154 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly\r
2155 if str(Module) not in self.Platform.Modules:\r
2156 return []\r
2157\r
52302d4d
LG
2158 ModuleType = Module.ModuleType\r
2159\r
2160 # for overridding library instances with module specific setting\r
2161 PlatformModule = self.Platform.Modules[str(Module)]\r
2162\r
2163 # add forced library instances (specified under LibraryClasses sections)\r
da92f276
LG
2164 #\r
2165 # If a module has a MODULE_TYPE of USER_DEFINED,\r
2166 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r
2167 #\r
2168 if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r
2169 for LibraryClass in self.Platform.LibraryClasses.GetKeys():\r
2170 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r
2171 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r
52302d4d
LG
2172\r
2173 # add forced library instances (specified in module overrides)\r
2174 for LibraryClass in PlatformModule.LibraryClasses:\r
2175 if LibraryClass.startswith("NULL"):\r
2176 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]\r
2177\r
b36d134f 2178 # EdkII module\r
52302d4d
LG
2179 LibraryConsumerList = [Module]\r
2180 Constructor = []\r
9006a2c6
CJ
2181 ConsumedByList = OrderedDict()\r
2182 LibraryInstance = OrderedDict()\r
52302d4d
LG
2183\r
2184 EdkLogger.verbose("")\r
2185 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2186 while len(LibraryConsumerList) > 0:\r
2187 M = LibraryConsumerList.pop()\r
2188 for LibraryClassName in M.LibraryClasses:\r
2189 if LibraryClassName not in LibraryInstance:\r
2190 # override library instance for this module\r
2191 if LibraryClassName in PlatformModule.LibraryClasses:\r
2192 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]\r
2193 else:\r
2194 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]\r
4231a819 2195 if LibraryPath is None or LibraryPath == "":\r
52302d4d 2196 LibraryPath = M.LibraryClasses[LibraryClassName]\r
4231a819 2197 if LibraryPath is None or LibraryPath == "":\r
52302d4d
LG
2198 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
2199 "Instance of library class [%s] is not found" % LibraryClassName,\r
2200 File=self.MetaFile,\r
2201 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))\r
2202\r
0d2711a6 2203 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2204 # for those forced library instance (NULL library), add a fake library class\r
2205 if LibraryClassName.startswith("NULL"):\r
2206 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r
4231a819 2207 elif LibraryModule.LibraryClass is None \\r
52302d4d
LG
2208 or len(LibraryModule.LibraryClass) == 0 \\r
2209 or (ModuleType != 'USER_DEFINED'\r
2210 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r
2211 # only USER_DEFINED can link against any library instance despite of its SupModList\r
2212 EdkLogger.error("build", OPTION_MISSING,\r
2213 "Module type [%s] is not supported by library instance [%s]" \\r
2214 % (ModuleType, LibraryPath), File=self.MetaFile,\r
2215 ExtraData="consumed by [%s]" % str(Module))\r
2216\r
2217 LibraryInstance[LibraryClassName] = LibraryModule\r
2218 LibraryConsumerList.append(LibraryModule)\r
2219 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r
2220 else:\r
2221 LibraryModule = LibraryInstance[LibraryClassName]\r
2222\r
4231a819 2223 if LibraryModule is None:\r
52302d4d
LG
2224 continue\r
2225\r
2226 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r
2227 Constructor.append(LibraryModule)\r
2228\r
2229 if LibraryModule not in ConsumedByList:\r
2230 ConsumedByList[LibraryModule] = []\r
2231 # don't add current module itself to consumer list\r
2232 if M != Module:\r
2233 if M in ConsumedByList[LibraryModule]:\r
2234 continue\r
2235 ConsumedByList[LibraryModule].append(M)\r
2236 #\r
2237 # Initialize the sorted output list to the empty set\r
2238 #\r
2239 SortedLibraryList = []\r
2240 #\r
2241 # Q <- Set of all nodes with no incoming edges\r
2242 #\r
2243 LibraryList = [] #LibraryInstance.values()\r
2244 Q = []\r
2245 for LibraryClassName in LibraryInstance:\r
2246 M = LibraryInstance[LibraryClassName]\r
2247 LibraryList.append(M)\r
2248 if ConsumedByList[M] == []:\r
2249 Q.append(M)\r
2250\r
2251 #\r
2252 # start the DAG algorithm\r
2253 #\r
2254 while True:\r
2255 EdgeRemoved = True\r
2256 while Q == [] and EdgeRemoved:\r
2257 EdgeRemoved = False\r
2258 # for each node Item with a Constructor\r
2259 for Item in LibraryList:\r
2260 if Item not in Constructor:\r
2261 continue\r
2262 # for each Node without a constructor with an edge e from Item to Node\r
2263 for Node in ConsumedByList[Item]:\r
2264 if Node in Constructor:\r
2265 continue\r
2266 # remove edge e from the graph if Node has no constructor\r
2267 ConsumedByList[Item].remove(Node)\r
2268 EdgeRemoved = True\r
2269 if ConsumedByList[Item] == []:\r
2270 # insert Item into Q\r
2271 Q.insert(0, Item)\r
2272 break\r
2273 if Q != []:\r
2274 break\r
2275 # DAG is done if there's no more incoming edge for all nodes\r
2276 if Q == []:\r
2277 break\r
2278\r
2279 # remove node from Q\r
2280 Node = Q.pop()\r
2281 # output Node\r
2282 SortedLibraryList.append(Node)\r
2283\r
2284 # for each node Item with an edge e from Node to Item do\r
2285 for Item in LibraryList:\r
2286 if Node not in ConsumedByList[Item]:\r
2287 continue\r
2288 # remove edge e from the graph\r
2289 ConsumedByList[Item].remove(Node)\r
2290\r
2291 if ConsumedByList[Item] != []:\r
2292 continue\r
2293 # insert Item into Q, if Item has no other incoming edges\r
2294 Q.insert(0, Item)\r
2295\r
2296 #\r
2297 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r
2298 #\r
2299 for Item in LibraryList:\r
2300 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:\r
2301 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])\r
2302 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r
2303 ExtraData=ErrorMessage, File=self.MetaFile)\r
2304 if Item not in SortedLibraryList:\r
2305 SortedLibraryList.append(Item)\r
2306\r
2307 #\r
2308 # Build the list of constructor and destructir names\r
2309 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r
2310 #\r
2311 SortedLibraryList.reverse()\r
2312 return SortedLibraryList\r
2313\r
2314\r
2315 ## Override PCD setting (type, value, ...)\r
2316 #\r
2317 # @param ToPcd The PCD to be overrided\r
2318 # @param FromPcd The PCD overrideing from\r
2319 #\r
2320 def _OverridePcd(self, ToPcd, FromPcd, Module=""):\r
2321 #\r
2322 # in case there's PCDs coming from FDF file, which have no type given.\r
2323 # at this point, ToPcd.Type has the type found from dependent\r
2324 # package\r
2325 #\r
2a29017e
YZ
2326 TokenCName = ToPcd.TokenCName\r
2327 for PcdItem in GlobalData.MixedPcd:\r
2328 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
2329 TokenCName = PcdItem[0]\r
2330 break\r
4231a819 2331 if FromPcd is not None:\r
52302d4d
LG
2332 if ToPcd.Pending and FromPcd.Type not in [None, '']:\r
2333 ToPcd.Type = FromPcd.Type\r
e56468c0 2334 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\\r
2335 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):\r
2336 if ToPcd.Type.strip() == "DynamicEx":\r
47fea6af 2337 ToPcd.Type = FromPcd.Type\r
52302d4d
LG
2338 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \\r
2339 and ToPcd.Type != FromPcd.Type:\r
2340 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
2341 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\\r
2a29017e 2342 % (ToPcd.TokenSpaceGuidCName, TokenCName,\r
52302d4d
LG
2343 ToPcd.Type, Module, FromPcd.Type),\r
2344 File=self.MetaFile)\r
2345\r
6be94743 2346 if FromPcd.MaxDatumSize:\r
52302d4d 2347 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
c33081c9 2348 ToPcd.MaxSizeUserSet = FromPcd.MaxDatumSize\r
6be94743 2349 if FromPcd.DefaultValue:\r
52302d4d 2350 ToPcd.DefaultValue = FromPcd.DefaultValue\r
6be94743 2351 if FromPcd.TokenValue:\r
52302d4d 2352 ToPcd.TokenValue = FromPcd.TokenValue\r
6be94743 2353 if FromPcd.DatumType:\r
52302d4d 2354 ToPcd.DatumType = FromPcd.DatumType\r
6be94743 2355 if FromPcd.SkuInfoList:\r
52302d4d 2356 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
726c501c 2357 # Add Flexible PCD format parse\r
726c501c 2358 if ToPcd.DefaultValue:\r
726c501c 2359 try:\r
35f613d9 2360 ToPcd.DefaultValue = ValueExpressionEx(ToPcd.DefaultValue, ToPcd.DatumType, self._GuidDict)(True)\r
726c501c
YZ
2361 except BadExpression, Value:\r
2362 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName, ToPcd.DefaultValue, Value),\r
2363 File=self.MetaFile)\r
52302d4d
LG
2364\r
2365 # check the validation of datum\r
2366 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
2367 if not IsValid:\r
2368 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
2a29017e 2369 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
82a6a960
BF
2370 ToPcd.validateranges = FromPcd.validateranges\r
2371 ToPcd.validlists = FromPcd.validlists\r
2372 ToPcd.expressions = FromPcd.expressions\r
52302d4d 2373\r
4231a819 2374 if FromPcd is not None and ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:\r
52302d4d 2375 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
2a29017e 2376 % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
52302d4d
LG
2377 Value = ToPcd.DefaultValue\r
2378 if Value in [None, '']:\r
e8a47801 2379 ToPcd.MaxDatumSize = '1'\r
52302d4d 2380 elif Value[0] == 'L':\r
e8a47801 2381 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
52302d4d
LG
2382 elif Value[0] == '{':\r
2383 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
2384 else:\r
e8a47801 2385 ToPcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2386\r
2387 # apply default SKU for dynamic PCDS if specified one is not available\r
2388 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \\r
2389 and ToPcd.SkuInfoList in [None, {}, '']:\r
2390 if self.Platform.SkuName in self.Platform.SkuIds:\r
2391 SkuName = self.Platform.SkuName\r
2392 else:\r
2393 SkuName = 'DEFAULT'\r
2394 ToPcd.SkuInfoList = {\r
8518bf0b 2395 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)\r
52302d4d
LG
2396 }\r
2397\r
2398 ## Apply PCD setting defined platform to a module\r
2399 #\r
2400 # @param Module The module from which the PCD setting will be overrided\r
2401 #\r
2402 # @retval PCD_list The list PCDs with settings from platform\r
2403 #\r
2404 def ApplyPcdSetting(self, Module, Pcds):\r
2405 # for each PCD in module\r
47fea6af
YZ
2406 for Name, Guid in Pcds:\r
2407 PcdInModule = Pcds[Name, Guid]\r
52302d4d 2408 # find out the PCD setting in platform\r
47fea6af
YZ
2409 if (Name, Guid) in self.Platform.Pcds:\r
2410 PcdInPlatform = self.Platform.Pcds[Name, Guid]\r
52302d4d
LG
2411 else:\r
2412 PcdInPlatform = None\r
2413 # then override the settings if any\r
2414 self._OverridePcd(PcdInModule, PcdInPlatform, Module)\r
2415 # resolve the VariableGuid value\r
2416 for SkuId in PcdInModule.SkuInfoList:\r
2417 Sku = PcdInModule.SkuInfoList[SkuId]\r
2418 if Sku.VariableGuid == '': continue\r
c28d2e10 2419 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)\r
4231a819 2420 if Sku.VariableGuidValue is None:\r
52302d4d
LG
2421 PackageList = "\n\t".join([str(P) for P in self.PackageList])\r
2422 EdkLogger.error(\r
2423 'build',\r
2424 RESOURCE_NOT_AVAILABLE,\r
2425 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
2426 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
2427 % (Guid, Name, str(Module)),\r
2428 File=self.MetaFile\r
2429 )\r
2430\r
2431 # override PCD settings with module specific setting\r
2432 if Module in self.Platform.Modules:\r
2433 PlatformModule = self.Platform.Modules[str(Module)]\r
2434 for Key in PlatformModule.Pcds:\r
aa9aa47e 2435 Flag = False\r
52302d4d 2436 if Key in Pcds:\r
aa9aa47e
YZ
2437 ToPcd = Pcds[Key]\r
2438 Flag = True\r
2439 elif Key in GlobalData.MixedPcd:\r
2440 for PcdItem in GlobalData.MixedPcd[Key]:\r
2441 if PcdItem in Pcds:\r
2442 ToPcd = Pcds[PcdItem]\r
2443 Flag = True\r
2444 break\r
2445 if Flag:\r
2446 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)\r
cdbf45ad
YZ
2447 # use PCD value to calculate the MaxDatumSize when it is not specified\r
2448 for Name, Guid in Pcds:\r
2449 Pcd = Pcds[Name, Guid]\r
2450 if Pcd.DatumType == "VOID*" and Pcd.MaxDatumSize in ['', None]:\r
c33081c9 2451 Pcd.MaxSizeUserSet = None\r
cdbf45ad
YZ
2452 Value = Pcd.DefaultValue\r
2453 if Value in [None, '']:\r
2454 Pcd.MaxDatumSize = '1'\r
2455 elif Value[0] == 'L':\r
2456 Pcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
2457 elif Value[0] == '{':\r
2458 Pcd.MaxDatumSize = str(len(Value.split(',')))\r
2459 else:\r
2460 Pcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2461 return Pcds.values()\r
2462\r
2463 ## Resolve library names to library modules\r
2464 #\r
b36d134f 2465 # (for Edk.x modules)\r
52302d4d
LG
2466 #\r
2467 # @param Module The module from which the library names will be resolved\r
2468 #\r
2469 # @retval library_list The list of library modules\r
2470 #\r
2471 def ResolveLibraryReference(self, Module):\r
2472 EdkLogger.verbose("")\r
2473 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2474 LibraryConsumerList = [Module]\r
2475\r
b36d134f 2476 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
2477 if Module.Libraries:\r
2478 Module.Libraries.append("CompilerStub")\r
2479 LibraryList = []\r
2480 while len(LibraryConsumerList) > 0:\r
2481 M = LibraryConsumerList.pop()\r
2482 for LibraryName in M.Libraries:\r
2483 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
4231a819 2484 if Library is None:\r
52302d4d
LG
2485 for Key in self.Platform.LibraryClasses.data.keys():\r
2486 if LibraryName.upper() == Key.upper():\r
2487 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
2488 break\r
4231a819 2489 if Library is None:\r
52302d4d
LG
2490 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
2491 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
2492 continue\r
2493\r
2494 if Library not in LibraryList:\r
2495 LibraryList.append(Library)\r
2496 LibraryConsumerList.append(Library)\r
2497 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
2498 return LibraryList\r
2499\r
6780eef1
LG
2500 ## Calculate the priority value of the build option\r
2501 #\r
2502 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2503 #\r
2504 # @retval Value Priority value based on the priority list.\r
2505 #\r
2506 def CalculatePriorityValue(self, Key):\r
47fea6af
YZ
2507 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
2508 PriorityValue = 0x11111\r
6780eef1
LG
2509 if Target == "*":\r
2510 PriorityValue &= 0x01111\r
2511 if ToolChain == "*":\r
2512 PriorityValue &= 0x10111\r
2513 if Arch == "*":\r
2514 PriorityValue &= 0x11011\r
2515 if CommandType == "*":\r
2516 PriorityValue &= 0x11101\r
2517 if Attr == "*":\r
2518 PriorityValue &= 0x11110\r
47fea6af
YZ
2519\r
2520 return self.PrioList["0x%0.5x" % PriorityValue]\r
2521\r
6780eef1 2522\r
52302d4d
LG
2523 ## Expand * in build option key\r
2524 #\r
2525 # @param Options Options to be expanded\r
2526 #\r
2527 # @retval options Options expanded\r
6780eef1 2528 # \r
52302d4d
LG
2529 def _ExpandBuildOption(self, Options, ModuleStyle=None):\r
2530 BuildOptions = {}\r
2531 FamilyMatch = False\r
2532 FamilyIsNull = True\r
47fea6af 2533\r
6780eef1
LG
2534 OverrideList = {}\r
2535 #\r
2536 # Construct a list contain the build options which need override.\r
2537 #\r
2538 for Key in Options:\r
2539 #\r
2540 # Key[0] -- tool family\r
2541 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2542 #\r
1ba5124e 2543 if (Key[0] == self.BuildRuleFamily and\r
4231a819 2544 (ModuleStyle is None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):\r
6780eef1
LG
2545 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
2546 if Target == self.BuildTarget or Target == "*":\r
2547 if ToolChain == self.ToolChain or ToolChain == "*":\r
2548 if Arch == self.Arch or Arch == "*":\r
2549 if Options[Key].startswith("="):\r
4231a819 2550 if OverrideList.get(Key[1]) is not None:\r
6780eef1
LG
2551 OverrideList.pop(Key[1])\r
2552 OverrideList[Key[1]] = Options[Key]\r
2553 \r
2554 #\r
2555 # Use the highest priority value. \r
2556 #\r
2557 if (len(OverrideList) >= 2):\r
47fea6af 2558 KeyList = OverrideList.keys()\r
6780eef1 2559 for Index in range(len(KeyList)):\r
47fea6af 2560 NowKey = KeyList[Index]\r
6780eef1
LG
2561 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
2562 for Index1 in range(len(KeyList) - Index - 1):\r
2563 NextKey = KeyList[Index1 + Index + 1]\r
2564 #\r
2565 # Compare two Key, if one is included by another, choose the higher priority one\r
2566 # \r
2567 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
2568 if Target1 == Target2 or Target1 == "*" or Target2 == "*":\r
2569 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":\r
2570 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":\r
2571 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":\r
2572 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":\r
2573 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
4231a819 2574 if Options.get((self.BuildRuleFamily, NextKey)) is not None:\r
6780eef1
LG
2575 Options.pop((self.BuildRuleFamily, NextKey))\r
2576 else:\r
4231a819 2577 if Options.get((self.BuildRuleFamily, NowKey)) is not None:\r
6780eef1
LG
2578 Options.pop((self.BuildRuleFamily, NowKey))\r
2579 \r
52302d4d 2580 for Key in Options:\r
4231a819 2581 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2582 # Check Module style is EDK or EDKII.\r
2583 # Only append build option for the matched style module.\r
2584 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2585 continue\r
2586 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2587 continue\r
2588 Family = Key[0]\r
2589 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2590 # if tool chain family doesn't match, skip it\r
2591 if Tool in self.ToolDefinition and Family != "":\r
2592 FamilyIsNull = False\r
2593 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
2594 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
2595 continue\r
2596 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2597 continue\r
2598 FamilyMatch = True\r
2599 # expand any wildcard\r
2600 if Target == "*" or Target == self.BuildTarget:\r
2601 if Tag == "*" or Tag == self.ToolChain:\r
2602 if Arch == "*" or Arch == self.Arch:\r
2603 if Tool not in BuildOptions:\r
2604 BuildOptions[Tool] = {}\r
5015bee2 2605 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2606 BuildOptions[Tool][Attr] = Options[Key]\r
2607 else:\r
95816356
YZ
2608 # append options for the same tool except PATH\r
2609 if Attr != 'PATH':\r
2610 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2611 else:\r
2612 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2613 # Build Option Family has been checked, which need't to be checked again for family.\r
2614 if FamilyMatch or FamilyIsNull:\r
2615 return BuildOptions\r
1ba5124e 2616\r
52302d4d 2617 for Key in Options:\r
4231a819 2618 if ModuleStyle is not None and len (Key) > 2:\r
52302d4d
LG
2619 # Check Module style is EDK or EDKII.\r
2620 # Only append build option for the matched style module.\r
2621 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2622 continue\r
2623 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2624 continue\r
2625 Family = Key[0]\r
2626 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2627 # if tool chain family doesn't match, skip it\r
47fea6af 2628 if Tool not in self.ToolDefinition or Family == "":\r
52302d4d
LG
2629 continue\r
2630 # option has been added before\r
2631 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2632 continue\r
2633\r
2634 # expand any wildcard\r
2635 if Target == "*" or Target == self.BuildTarget:\r
2636 if Tag == "*" or Tag == self.ToolChain:\r
2637 if Arch == "*" or Arch == self.Arch:\r
2638 if Tool not in BuildOptions:\r
2639 BuildOptions[Tool] = {}\r
5015bee2 2640 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2641 BuildOptions[Tool][Attr] = Options[Key]\r
2642 else:\r
95816356
YZ
2643 # append options for the same tool except PATH\r
2644 if Attr != 'PATH':\r
2645 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2646 else:\r
2647 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2648 return BuildOptions\r
2649\r
2650 ## Append build options in platform to a module\r
2651 #\r
2652 # @param Module The module to which the build options will be appened\r
2653 #\r
2654 # @retval options The options appended with build options in platform\r
2655 #\r
2656 def ApplyBuildOption(self, Module):\r
2657 # Get the different options for the different style module\r
2658 if Module.AutoGenVersion < 0x00010005:\r
2659 PlatformOptions = self.EdkBuildOption\r
35f69db9 2660 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)\r
52302d4d
LG
2661 else:\r
2662 PlatformOptions = self.EdkIIBuildOption\r
35f69db9
YL
2663 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)\r
2664 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)\r
52302d4d
LG
2665 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
2666 if Module in self.Platform.Modules:\r
2667 PlatformModule = self.Platform.Modules[str(Module)]\r
2668 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
2669 else:\r
2670 PlatformModuleOptions = {}\r
2671\r
fe4bf2f9 2672 BuildRuleOrder = None\r
35f69db9 2673 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
fe4bf2f9
YL
2674 for Tool in Options:\r
2675 for Attr in Options[Tool]:\r
2676 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2677 BuildRuleOrder = Options[Tool][Attr]\r
2678\r
35f69db9
YL
2679 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +\r
2680 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +\r
2681 self.ToolDefinition.keys())\r
339fe8dd 2682 BuildOptions = defaultdict(lambda: defaultdict(str))\r
52302d4d 2683 for Tool in AllTools:\r
35f69db9 2684 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
52302d4d
LG
2685 if Tool not in Options:\r
2686 continue\r
2687 for Attr in Options[Tool]:\r
fe4bf2f9
YL
2688 #\r
2689 # Do not generate it in Makefile\r
2690 #\r
2691 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2692 continue\r
339fe8dd 2693 Value = Options[Tool][Attr]\r
52302d4d
LG
2694 # check if override is indicated\r
2695 if Value.startswith('='):\r
339fe8dd 2696 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value[1:])\r
5015bee2 2697 else:\r
95816356 2698 if Attr != 'PATH':\r
339fe8dd 2699 BuildOptions[Tool][Attr] += " " + mws.handleWsMacro(Value)\r
95816356 2700 else:\r
339fe8dd
CJ
2701 BuildOptions[Tool][Attr] = mws.handleWsMacro(Value)\r
2702\r
4231a819 2703 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag is not None:\r
f3decdc3
LG
2704 #\r
2705 # Override UNI flag only for EDK module.\r
2706 #\r
f3decdc3 2707 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
fe4bf2f9 2708 return BuildOptions, BuildRuleOrder\r
52302d4d
LG
2709\r
2710 Platform = property(_GetPlatform)\r
2711 Name = property(_GetName)\r
2712 Guid = property(_GetGuid)\r
2713 Version = property(_GetVersion)\r
2714\r
2715 OutputDir = property(_GetOutputDir)\r
2716 BuildDir = property(_GetBuildDir)\r
2717 MakeFileDir = property(_GetMakeFileDir)\r
2718 FdfFile = property(_GetFdfFile)\r
2719\r
2720 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
2721 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2722 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2bc3256c 2723 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)\r
52302d4d
LG
2724 PackageList = property(_GetPackageList)\r
2725\r
2726 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
2727 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path\r
2728 ToolChainFamily = property(_GetToolChainFamily)\r
2729 BuildRuleFamily = property(_GetBuildRuleFamily)\r
2730 BuildOption = property(_GetBuildOptions) # toolcode : option\r
2731 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option\r
2732 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option\r
2733\r
2734 BuildCommand = property(_GetBuildCommand)\r
2735 BuildRule = property(_GetBuildRule)\r
2736 ModuleAutoGenList = property(_GetModuleAutoGenList)\r
2737 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
0923aa1c 2738 GenFdsCommand = property(_GenFdsCommand)\r
52302d4d
LG
2739\r
2740## ModuleAutoGen class\r
2741#\r
2742# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
2743# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
2744# to the [depex] section in module's inf file.\r
2745#\r
2746class ModuleAutoGen(AutoGen):\r
b24e99f7
CJ
2747 # call super().__init__ then call the worker function with different parameter count\r
2748 def __init__(self, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
2749 try:\r
2750 self._Init\r
2751 except:\r
2752 super(ModuleAutoGen, self).__init__(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
2753 self._InitWorker(Workspace, MetaFile, Target, Toolchain, Arch, *args)\r
2754 self._Init = True\r
2755\r
c17956e0
DL
2756 ## Cache the timestamps of metafiles of every module in a class variable\r
2757 #\r
2758 TimeDict = {}\r
2759\r
b24e99f7
CJ
2760 def __new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
2761 obj = super(ModuleAutoGen, cls).__new__(cls, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs)\r
2762 # check if this module is employed by active platform\r
2763 if not PlatformAutoGen(Workspace, args[0], Target, Toolchain, Arch).ValidModule(MetaFile):\r
2764 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
2765 % (MetaFile, Arch))\r
2766 return None\r
2767 return obj\r
2768 \r
2769 ## Initialize ModuleAutoGen\r
52302d4d
LG
2770 #\r
2771 # @param Workspace EdkIIWorkspaceBuild object\r
2772 # @param ModuleFile The path of module file\r
2773 # @param Target Build target (DEBUG, RELEASE)\r
2774 # @param Toolchain Name of tool chain\r
2775 # @param Arch The arch the module supports\r
2776 # @param PlatformFile Platform meta-file\r
2777 #\r
b24e99f7 2778 def _InitWorker(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
52302d4d
LG
2779 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
2780 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
2781\r
2782 self.Workspace = Workspace\r
2783 self.WorkspaceDir = Workspace.WorkspaceDir\r
f9fa014e 2784 self._GuidDict = Workspace._GuidDict\r
52302d4d
LG
2785 self.MetaFile = ModuleFile\r
2786 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
52302d4d
LG