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