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