]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTools: Update NV Default Header format to include the max size
[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 PcdValue = Sku.DefaultValue\r
1641 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
1642 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
1643 UnicodePcdArray.append(Pcd)\r
1644 elif len(Sku.VariableName) > 0:\r
1645 # if found HII type PCD then insert to right of UnicodeIndex\r
1646 HiiPcdArray.append(Pcd)\r
1647 else:\r
1648 OtherPcdArray.append(Pcd)\r
e56468c0 1649 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
47fea6af
YZ
1650 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd\r
1651\r
34952f49
LG
1652 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer\r
1653 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))\r
1654 if PcdNvStoreDfBuffer:\r
47854fd5 1655 self.VariableInfo = self.CollectVariables(self._DynamicPcdList)\r
34952f49 1656 default_skuobj = PcdNvStoreDfBuffer.SkuInfoList.get("DEFAULT")\r
47854fd5
LG
1657 vardump = self.VariableInfo.dump()\r
1658 if vardump and default_skuobj:\r
2b8a6c44
LG
1659 default_skuobj.DefaultValue = vardump\r
1660 PcdNvStoreDfBuffer.DefaultValue = vardump\r
34952f49
LG
1661 PcdNvStoreDfBuffer.SkuInfoList.clear()\r
1662 PcdNvStoreDfBuffer.SkuInfoList['DEFAULT'] = default_skuobj\r
2b8a6c44 1663 PcdNvStoreDfBuffer.MaxDatumSize = str(len(default_skuobj.DefaultValue.split(",")))\r
34952f49 1664\r
61ee1dff 1665 PlatformPcds = self._PlatformPcds.keys()\r
47fea6af 1666 PlatformPcds.sort()\r
6780eef1
LG
1667 #\r
1668 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
1669 #\r
1670 for PcdKey in PlatformPcds:\r
61ee1dff 1671 Pcd = self._PlatformPcds[PcdKey]\r
e8a47801
LG
1672 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \\r
1673 PcdKey in VpdPcdDict:\r
1674 Pcd = VpdPcdDict[PcdKey]\r
1675 for (SkuName,Sku) in Pcd.SkuInfoList.items():\r
1676 Sku.VpdOffset = Sku.VpdOffset.strip()\r
5a13737a
YZ
1677 PcdValue = Sku.DefaultValue\r
1678 if PcdValue == "":\r
1679 PcdValue = Pcd.DefaultValue\r
1680 if Sku.VpdOffset != '*':\r
1681 if PcdValue.startswith("{"):\r
1682 Alignment = 8\r
1683 elif PcdValue.startswith("L"):\r
1684 Alignment = 2\r
1685 else:\r
1686 Alignment = 1\r
ca85291f
YZ
1687 try:\r
1688 VpdOffset = int(Sku.VpdOffset)\r
1689 except:\r
1690 try:\r
1691 VpdOffset = int(Sku.VpdOffset, 16)\r
1692 except:\r
1693 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1694 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1695 if PcdValue.startswith("{"):\r
1696 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)\r
1697 else:\r
1698 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, Alignment))\r
e8a47801
LG
1699 VpdFile.Add(Pcd, Sku.VpdOffset)\r
1700 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
1701 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1702 NeedProcessVpdMapFile = True\r
1703 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':\r
1704 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
1705 "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
YZ
1706\r
1707\r
e56468c0 1708 #\r
1709 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
1710 # An example is PCD for signature usage.\r
6780eef1
LG
1711 # \r
1712 for DscPcd in PlatformPcds:\r
61ee1dff 1713 DscPcdEntry = self._PlatformPcds[DscPcd]\r
e56468c0 1714 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
1715 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):\r
1716 FoundFlag = False\r
1717 for VpdPcd in VpdFile._VpdArray.keys():\r
1718 # This PCD has been referenced by module\r
1719 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1720 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
1721 FoundFlag = True\r
47fea6af 1722\r
e56468c0 1723 # Not found, it should be signature\r
1724 if not FoundFlag :\r
1725 # just pick the a value to determine whether is unicode string type\r
e8a47801
LG
1726 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():\r
1727 Sku.VpdOffset = Sku.VpdOffset.strip() \r
1728 \r
1729 # Need to iterate DEC pcd information to get the value & datumtype\r
1730 for eachDec in self.PackageList:\r
1731 for DecPcd in eachDec.Pcds:\r
1732 DecPcdEntry = eachDec.Pcds[DecPcd]\r
1733 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1734 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
1735 # Print warning message to let the developer make a determine.\r
1736 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
1737 File=self.MetaFile, \\r
1738 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
1739 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path)) \r
1740 \r
1741 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1742 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
1743 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue\r
1744 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]\r
1745 # Only fix the value while no value provided in DSC file.\r
1746 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):\r
1747 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
1748 \r
1749 if DscPcdEntry not in self._DynamicPcdList:\r
1750 self._DynamicPcdList.append(DscPcdEntry)\r
1751# Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]\r
1752 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1753 PcdValue = Sku.DefaultValue\r
5a13737a
YZ
1754 if PcdValue == "":\r
1755 PcdValue = DscPcdEntry.DefaultValue\r
1756 if Sku.VpdOffset != '*':\r
1757 if PcdValue.startswith("{"):\r
1758 Alignment = 8\r
1759 elif PcdValue.startswith("L"):\r
1760 Alignment = 2\r
1761 else:\r
1762 Alignment = 1\r
ca85291f
YZ
1763 try:\r
1764 VpdOffset = int(Sku.VpdOffset)\r
1765 except:\r
1766 try:\r
1767 VpdOffset = int(Sku.VpdOffset, 16)\r
1768 except:\r
1769 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))\r
1770 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1771 if PcdValue.startswith("{"):\r
1772 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)\r
1773 else:\r
1774 EdkLogger.error("build", FORMAT_INVALID, 'The offset value of PCD %s.%s should be %s-byte aligned.' % (DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, Alignment))\r
e8a47801
LG
1775 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)\r
1776 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1777 NeedProcessVpdMapFile = True \r
1778 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
1779 UnicodePcdArray.append(DscPcdEntry)\r
1780 elif len(Sku.VariableName) > 0:\r
1781 HiiPcdArray.append(DscPcdEntry)\r
1782 else:\r
1783 OtherPcdArray.append(DscPcdEntry)\r
1784 \r
1785 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
e56468c0 1786 \r
e56468c0 1787 \r
1788 \r
1789 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \\r
1790 VpdFile.GetCount() != 0:\r
1791 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, \r
1792 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
47fea6af 1793\r
e56468c0 1794 if VpdFile.GetCount() != 0:\r
47854fd5
LG
1795\r
1796 self.FixVpdOffset(VpdFile)\r
1797\r
1798 self.FixVpdOffset(self.UpdateNVStoreMaxSize(VpdFile))\r
47fea6af 1799\r
e56468c0 1800 # Process VPD map file generated by third party BPDG tool\r
1801 if NeedProcessVpdMapFile:\r
08dd311f 1802 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1803 if os.path.exists(VpdMapFilePath):\r
1804 VpdFile.Read(VpdMapFilePath)\r
47fea6af 1805\r
e56468c0 1806 # Fixup "*" offset\r
1807 for Pcd in self._DynamicPcdList:\r
1808 # just pick the a value to determine whether is unicode string type\r
e8a47801
LG
1809 i = 0\r
1810 for (SkuName,Sku) in Pcd.SkuInfoList.items(): \r
1811 if Sku.VpdOffset == "*":\r
1812 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[i].strip()\r
1813 i += 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
e56468c0 1817 # Delete the DynamicPcdList At the last time enter into this function \r
47fea6af 1818 del self._DynamicPcdList[:]\r
52302d4d
LG
1819 self._DynamicPcdList.extend(UnicodePcdArray)\r
1820 self._DynamicPcdList.extend(HiiPcdArray)\r
1821 self._DynamicPcdList.extend(OtherPcdArray)\r
2b8a6c44
LG
1822 allskuset = [(SkuName,Sku.SkuId) for pcd in self._DynamicPcdList for (SkuName,Sku) in pcd.SkuInfoList.items()]\r
1823 for pcd in self._DynamicPcdList:\r
1824 if len(pcd.SkuInfoList) == 1:\r
1825 for (SkuName,SkuId) in allskuset:\r
1826 if type(SkuId) in (str,unicode) and eval(SkuId) == 0 or SkuId == 0:\r
1827 continue\r
1828 pcd.SkuInfoList[SkuName] = pcd.SkuInfoList['DEFAULT']\r
a0a2cd1e 1829 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
47854fd5
LG
1830\r
1831 def FixVpdOffset(self,VpdFile ):\r
1832 FvPath = os.path.join(self.BuildDir, "FV")\r
1833 if not os.path.exists(FvPath):\r
1834 try:\r
1835 os.makedirs(FvPath)\r
1836 except:\r
1837 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
1838\r
1839 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1840\r
1841 if VpdFile.Write(VpdFilePath):\r
1842 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1843 BPDGToolName = None\r
1844 for ToolDef in self.ToolDefinition.values():\r
1845 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:\r
1846 if not ToolDef.has_key("PATH"):\r
1847 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1848 BPDGToolName = ToolDef["PATH"]\r
1849 break\r
1850 # Call third party GUID BPDG tool.\r
1851 if BPDGToolName != None:\r
1852 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
1853 else:\r
1854 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
1855\r
52302d4d
LG
1856 ## Return the platform build data object\r
1857 def _GetPlatform(self):\r
1858 if self._Platform == None:\r
0d2711a6 1859 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1860 return self._Platform\r
1861\r
1862 ## Return platform name\r
1863 def _GetName(self):\r
1864 return self.Platform.PlatformName\r
1865\r
1866 ## Return the meta file GUID\r
1867 def _GetGuid(self):\r
1868 return self.Platform.Guid\r
1869\r
1870 ## Return the platform version\r
1871 def _GetVersion(self):\r
1872 return self.Platform.Version\r
1873\r
1874 ## Return the FDF file name\r
1875 def _GetFdfFile(self):\r
1876 if self._FdfFile == None:\r
1877 if self.Workspace.FdfFile != "":\r
05cc51ad 1878 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
52302d4d
LG
1879 else:\r
1880 self._FdfFile = ''\r
1881 return self._FdfFile\r
1882\r
1883 ## Return the build output directory platform specifies\r
1884 def _GetOutputDir(self):\r
1885 return self.Platform.OutputDirectory\r
1886\r
1887 ## Return the directory to store all intermediate and final files built\r
1888 def _GetBuildDir(self):\r
1889 if self._BuildDir == None:\r
1890 if os.path.isabs(self.OutputDir):\r
1891 self._BuildDir = path.join(\r
1892 path.abspath(self.OutputDir),\r
1893 self.BuildTarget + "_" + self.ToolChain,\r
1894 )\r
1895 else:\r
1896 self._BuildDir = path.join(\r
1897 self.WorkspaceDir,\r
1898 self.OutputDir,\r
1899 self.BuildTarget + "_" + self.ToolChain,\r
1900 )\r
97058144 1901 GlobalData.gBuildDirectory = self._BuildDir\r
52302d4d
LG
1902 return self._BuildDir\r
1903\r
1904 ## Return directory of platform makefile\r
1905 #\r
1906 # @retval string Makefile directory\r
1907 #\r
1908 def _GetMakeFileDir(self):\r
1909 if self._MakeFileDir == None:\r
1910 self._MakeFileDir = path.join(self.BuildDir, self.Arch)\r
1911 return self._MakeFileDir\r
1912\r
1913 ## Return build command string\r
1914 #\r
1915 # @retval string Build command string\r
1916 #\r
1917 def _GetBuildCommand(self):\r
1918 if self._BuildCommand == None:\r
1919 self._BuildCommand = []\r
1920 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1921 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1922 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1923 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1924 if NewOption != '':\r
6780eef1 1925 self._BuildCommand += SplitOption(NewOption)\r
52302d4d
LG
1926 return self._BuildCommand\r
1927\r
1928 ## Get tool chain definition\r
1929 #\r
1930 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1931 #\r
1932 def _GetToolDefinition(self):\r
1933 if self._ToolDefinitions == None:\r
1934 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1935 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1936 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1937 ExtraData="[%s]" % self.MetaFile)\r
1938 self._ToolDefinitions = {}\r
1939 DllPathList = set()\r
1940 for Def in ToolDefinition:\r
1941 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1942 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1943 continue\r
1944\r
1945 Value = ToolDefinition[Def]\r
1946 # don't record the DLL\r
1947 if Attr == "DLL":\r
1948 DllPathList.add(Value)\r
1949 continue\r
1950\r
1951 if Tool not in self._ToolDefinitions:\r
1952 self._ToolDefinitions[Tool] = {}\r
1953 self._ToolDefinitions[Tool][Attr] = Value\r
1954\r
1955 ToolsDef = ''\r
1956 MakePath = ''\r
1957 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:\r
1958 if "FLAGS" not in self._ToolDefinitions["MAKE"]:\r
1959 self._ToolDefinitions["MAKE"]["FLAGS"] = ""\r
1960 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"\r
1961 MakeFlags = ''\r
1962 for Tool in self._ToolDefinitions:\r
1963 for Attr in self._ToolDefinitions[Tool]:\r
1964 Value = self._ToolDefinitions[Tool][Attr]\r
1965 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:\r
1966 # check if override is indicated\r
1967 if self.BuildOption[Tool][Attr].startswith('='):\r
1968 Value = self.BuildOption[Tool][Attr][1:]\r
1969 else:\r
95816356
YZ
1970 if Attr != 'PATH':\r
1971 Value += " " + self.BuildOption[Tool][Attr]\r
1972 else:\r
1973 Value = self.BuildOption[Tool][Attr]\r
52302d4d
LG
1974\r
1975 if Attr == "PATH":\r
1976 # Don't put MAKE definition in the file\r
1977 if Tool == "MAKE":\r
1978 MakePath = Value\r
1979 else:\r
1980 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1981 elif Attr != "DLL":\r
1982 # Don't put MAKE definition in the file\r
1983 if Tool == "MAKE":\r
1984 if Attr == "FLAGS":\r
1985 MakeFlags = Value\r
1986 else:\r
1987 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1988 ToolsDef += "\n"\r
1989\r
1990 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1991 for DllPath in DllPathList:\r
1992 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1993 os.environ["MAKE_FLAGS"] = MakeFlags\r
1994\r
1995 return self._ToolDefinitions\r
1996\r
1997 ## Return the paths of tools\r
1998 def _GetToolDefFile(self):\r
1999 if self._ToolDefFile == None:\r
2000 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
2001 return self._ToolDefFile\r
2002\r
2003 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
2004 def _GetToolChainFamily(self):\r
2005 if self._ToolChainFamily == None:\r
2006 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
2007 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
2008 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
2009 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
2010 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
2011 % self.ToolChain)\r
2012 self._ToolChainFamily = "MSFT"\r
2013 else:\r
2014 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
2015 return self._ToolChainFamily\r
2016\r
2017 def _GetBuildRuleFamily(self):\r
2018 if self._BuildRuleFamily == None:\r
2019 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
2020 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
2021 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
2022 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
2023 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
2024 % self.ToolChain)\r
2025 self._BuildRuleFamily = "MSFT"\r
2026 else:\r
2027 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
2028 return self._BuildRuleFamily\r
2029\r
2030 ## Return the build options specific for all modules in this platform\r
2031 def _GetBuildOptions(self):\r
2032 if self._BuildOption == None:\r
2033 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)\r
2034 return self._BuildOption\r
2035\r
2036 ## Return the build options specific for EDK modules in this platform\r
2037 def _GetEdkBuildOptions(self):\r
2038 if self._EdkBuildOption == None:\r
2039 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
2040 return self._EdkBuildOption\r
2041\r
2042 ## Return the build options specific for EDKII modules in this platform\r
2043 def _GetEdkIIBuildOptions(self):\r
2044 if self._EdkIIBuildOption == None:\r
2045 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
2046 return self._EdkIIBuildOption\r
2047\r
97fa0ee9 2048 ## Parse build_rule.txt in Conf Directory.\r
52302d4d
LG
2049 #\r
2050 # @retval BuildRule object\r
2051 #\r
2052 def _GetBuildRule(self):\r
2053 if self._BuildRule == None:\r
2054 BuildRuleFile = None\r
2055 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
2056 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
2057 if BuildRuleFile in [None, '']:\r
97fa0ee9 2058 BuildRuleFile = gDefaultBuildRuleFile\r
52302d4d 2059 self._BuildRule = BuildRule(BuildRuleFile)\r
64b2609f
LG
2060 if self._BuildRule._FileVersion == "":\r
2061 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum\r
2062 else:\r
2063 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :\r
2064 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
47fea6af 2065 EdkLogger.error("build", AUTOGEN_ERROR,\r
64b2609f
LG
2066 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
2067 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))\r
47fea6af 2068\r
52302d4d
LG
2069 return self._BuildRule\r
2070\r
2071 ## Summarize the packages used by modules in this platform\r
2072 def _GetPackageList(self):\r
2073 if self._PackageList == None:\r
2074 self._PackageList = set()\r
2075 for La in self.LibraryAutoGenList:\r
2076 self._PackageList.update(La.DependentPackageList)\r
2077 for Ma in self.ModuleAutoGenList:\r
2078 self._PackageList.update(Ma.DependentPackageList)\r
a0a2cd1e
FB
2079 #Collect package set information from INF of FDF\r
2080 PkgSet = set()\r
2081 for ModuleFile in self._AsBuildModuleList:\r
2082 if ModuleFile in self.Platform.Modules:\r
2083 continue\r
2084 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]\r
2085 PkgSet.update(ModuleData.Packages)\r
2086 self._PackageList = list(self._PackageList) + list (PkgSet)\r
52302d4d
LG
2087 return self._PackageList\r
2088\r
2bc3256c
LG
2089 def _GetNonDynamicPcdDict(self):\r
2090 if self._NonDynamicPcdDict:\r
2091 return self._NonDynamicPcdDict\r
2092 for Pcd in self.NonDynamicPcdList:\r
2093 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd\r
2094 return self._NonDynamicPcdDict\r
2095\r
52302d4d
LG
2096 ## Get list of non-dynamic PCDs\r
2097 def _GetNonDynamicPcdList(self):\r
e56468c0 2098 if self._NonDynamicPcdList == None:\r
2099 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2100 return self._NonDynamicPcdList\r
2101\r
2102 ## Get list of dynamic PCDs\r
2103 def _GetDynamicPcdList(self):\r
e56468c0 2104 if self._DynamicPcdList == None:\r
2105 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2106 return self._DynamicPcdList\r
2107\r
2108 ## Generate Token Number for all PCD\r
2109 def _GetPcdTokenNumbers(self):\r
2110 if self._PcdTokenNumber == None:\r
2111 self._PcdTokenNumber = sdict()\r
2112 TokenNumber = 1\r
d0acc87a
LG
2113 #\r
2114 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area. \r
2115 # Such as:\r
2116 # \r
2117 # Dynamic PCD:\r
2118 # TokenNumber 0 ~ 10\r
2119 # DynamicEx PCD:\r
2120 # TokeNumber 11 ~ 20\r
2121 #\r
52302d4d
LG
2122 for Pcd in self.DynamicPcdList:\r
2123 if Pcd.Phase == "PEI":\r
d0acc87a
LG
2124 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2125 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2126 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2127 TokenNumber += 1\r
47fea6af 2128\r
d0acc87a
LG
2129 for Pcd in self.DynamicPcdList:\r
2130 if Pcd.Phase == "PEI":\r
2131 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2132 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2133 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2134 TokenNumber += 1\r
47fea6af 2135\r
52302d4d
LG
2136 for Pcd in self.DynamicPcdList:\r
2137 if Pcd.Phase == "DXE":\r
d0acc87a
LG
2138 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2139 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2140 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2141 TokenNumber += 1\r
47fea6af 2142\r
d0acc87a
LG
2143 for Pcd in self.DynamicPcdList:\r
2144 if Pcd.Phase == "DXE":\r
2145 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2146 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2147 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2148 TokenNumber += 1\r
47fea6af 2149\r
52302d4d
LG
2150 for Pcd in self.NonDynamicPcdList:\r
2151 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2152 TokenNumber += 1\r
2153 return self._PcdTokenNumber\r
2154\r
2155 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform\r
2156 def _GetAutoGenObjectList(self):\r
2157 self._ModuleAutoGenList = []\r
2158 self._LibraryAutoGenList = []\r
2159 for ModuleFile in self.Platform.Modules:\r
2160 Ma = ModuleAutoGen(\r
2161 self.Workspace,\r
2162 ModuleFile,\r
2163 self.BuildTarget,\r
2164 self.ToolChain,\r
2165 self.Arch,\r
2166 self.MetaFile\r
2167 )\r
2168 if Ma not in self._ModuleAutoGenList:\r
2169 self._ModuleAutoGenList.append(Ma)\r
2170 for La in Ma.LibraryAutoGenList:\r
2171 if La not in self._LibraryAutoGenList:\r
2172 self._LibraryAutoGenList.append(La)\r
2bc3256c
LG
2173 if Ma not in La._ReferenceModules:\r
2174 La._ReferenceModules.append(Ma)\r
52302d4d
LG
2175\r
2176 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
2177 def _GetModuleAutoGenList(self):\r
2178 if self._ModuleAutoGenList == None:\r
2179 self._GetAutoGenObjectList()\r
2180 return self._ModuleAutoGenList\r
2181\r
2182 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
2183 def _GetLibraryAutoGenList(self):\r
2184 if self._LibraryAutoGenList == None:\r
2185 self._GetAutoGenObjectList()\r
2186 return self._LibraryAutoGenList\r
2187\r
2188 ## Test if a module is supported by the platform\r
2189 #\r
2190 # An error will be raised directly if the module or its arch is not supported\r
2191 # by the platform or current configuration\r
2192 #\r
2193 def ValidModule(self, Module):\r
a0a2cd1e
FB
2194 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \\r
2195 or Module in self._AsBuildModuleList\r
52302d4d
LG
2196\r
2197 ## Resolve the library classes in a module to library instances\r
2198 #\r
2199 # This method will not only resolve library classes but also sort the library\r
2200 # instances according to the dependency-ship.\r
2201 #\r
2202 # @param Module The module from which the library classes will be resolved\r
2203 #\r
2204 # @retval library_list List of library instances sorted\r
2205 #\r
2206 def ApplyLibraryInstance(self, Module):\r
25193a33
YZ
2207 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly\r
2208 if str(Module) not in self.Platform.Modules:\r
2209 return []\r
2210\r
52302d4d
LG
2211 ModuleType = Module.ModuleType\r
2212\r
2213 # for overridding library instances with module specific setting\r
2214 PlatformModule = self.Platform.Modules[str(Module)]\r
2215\r
2216 # add forced library instances (specified under LibraryClasses sections)\r
da92f276
LG
2217 #\r
2218 # If a module has a MODULE_TYPE of USER_DEFINED,\r
2219 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r
2220 #\r
2221 if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r
2222 for LibraryClass in self.Platform.LibraryClasses.GetKeys():\r
2223 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r
2224 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r
52302d4d
LG
2225\r
2226 # add forced library instances (specified in module overrides)\r
2227 for LibraryClass in PlatformModule.LibraryClasses:\r
2228 if LibraryClass.startswith("NULL"):\r
2229 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]\r
2230\r
b36d134f 2231 # EdkII module\r
52302d4d
LG
2232 LibraryConsumerList = [Module]\r
2233 Constructor = []\r
2234 ConsumedByList = sdict()\r
2235 LibraryInstance = sdict()\r
2236\r
2237 EdkLogger.verbose("")\r
2238 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2239 while len(LibraryConsumerList) > 0:\r
2240 M = LibraryConsumerList.pop()\r
2241 for LibraryClassName in M.LibraryClasses:\r
2242 if LibraryClassName not in LibraryInstance:\r
2243 # override library instance for this module\r
2244 if LibraryClassName in PlatformModule.LibraryClasses:\r
2245 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]\r
2246 else:\r
2247 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]\r
2248 if LibraryPath == None or LibraryPath == "":\r
2249 LibraryPath = M.LibraryClasses[LibraryClassName]\r
2250 if LibraryPath == None or LibraryPath == "":\r
2251 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
2252 "Instance of library class [%s] is not found" % LibraryClassName,\r
2253 File=self.MetaFile,\r
2254 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))\r
2255\r
0d2711a6 2256 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2257 # for those forced library instance (NULL library), add a fake library class\r
2258 if LibraryClassName.startswith("NULL"):\r
2259 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r
2260 elif LibraryModule.LibraryClass == None \\r
2261 or len(LibraryModule.LibraryClass) == 0 \\r
2262 or (ModuleType != 'USER_DEFINED'\r
2263 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r
2264 # only USER_DEFINED can link against any library instance despite of its SupModList\r
2265 EdkLogger.error("build", OPTION_MISSING,\r
2266 "Module type [%s] is not supported by library instance [%s]" \\r
2267 % (ModuleType, LibraryPath), File=self.MetaFile,\r
2268 ExtraData="consumed by [%s]" % str(Module))\r
2269\r
2270 LibraryInstance[LibraryClassName] = LibraryModule\r
2271 LibraryConsumerList.append(LibraryModule)\r
2272 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r
2273 else:\r
2274 LibraryModule = LibraryInstance[LibraryClassName]\r
2275\r
2276 if LibraryModule == None:\r
2277 continue\r
2278\r
2279 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r
2280 Constructor.append(LibraryModule)\r
2281\r
2282 if LibraryModule not in ConsumedByList:\r
2283 ConsumedByList[LibraryModule] = []\r
2284 # don't add current module itself to consumer list\r
2285 if M != Module:\r
2286 if M in ConsumedByList[LibraryModule]:\r
2287 continue\r
2288 ConsumedByList[LibraryModule].append(M)\r
2289 #\r
2290 # Initialize the sorted output list to the empty set\r
2291 #\r
2292 SortedLibraryList = []\r
2293 #\r
2294 # Q <- Set of all nodes with no incoming edges\r
2295 #\r
2296 LibraryList = [] #LibraryInstance.values()\r
2297 Q = []\r
2298 for LibraryClassName in LibraryInstance:\r
2299 M = LibraryInstance[LibraryClassName]\r
2300 LibraryList.append(M)\r
2301 if ConsumedByList[M] == []:\r
2302 Q.append(M)\r
2303\r
2304 #\r
2305 # start the DAG algorithm\r
2306 #\r
2307 while True:\r
2308 EdgeRemoved = True\r
2309 while Q == [] and EdgeRemoved:\r
2310 EdgeRemoved = False\r
2311 # for each node Item with a Constructor\r
2312 for Item in LibraryList:\r
2313 if Item not in Constructor:\r
2314 continue\r
2315 # for each Node without a constructor with an edge e from Item to Node\r
2316 for Node in ConsumedByList[Item]:\r
2317 if Node in Constructor:\r
2318 continue\r
2319 # remove edge e from the graph if Node has no constructor\r
2320 ConsumedByList[Item].remove(Node)\r
2321 EdgeRemoved = True\r
2322 if ConsumedByList[Item] == []:\r
2323 # insert Item into Q\r
2324 Q.insert(0, Item)\r
2325 break\r
2326 if Q != []:\r
2327 break\r
2328 # DAG is done if there's no more incoming edge for all nodes\r
2329 if Q == []:\r
2330 break\r
2331\r
2332 # remove node from Q\r
2333 Node = Q.pop()\r
2334 # output Node\r
2335 SortedLibraryList.append(Node)\r
2336\r
2337 # for each node Item with an edge e from Node to Item do\r
2338 for Item in LibraryList:\r
2339 if Node not in ConsumedByList[Item]:\r
2340 continue\r
2341 # remove edge e from the graph\r
2342 ConsumedByList[Item].remove(Node)\r
2343\r
2344 if ConsumedByList[Item] != []:\r
2345 continue\r
2346 # insert Item into Q, if Item has no other incoming edges\r
2347 Q.insert(0, Item)\r
2348\r
2349 #\r
2350 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r
2351 #\r
2352 for Item in LibraryList:\r
2353 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:\r
2354 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])\r
2355 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r
2356 ExtraData=ErrorMessage, File=self.MetaFile)\r
2357 if Item not in SortedLibraryList:\r
2358 SortedLibraryList.append(Item)\r
2359\r
2360 #\r
2361 # Build the list of constructor and destructir names\r
2362 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r
2363 #\r
2364 SortedLibraryList.reverse()\r
2365 return SortedLibraryList\r
2366\r
2367\r
2368 ## Override PCD setting (type, value, ...)\r
2369 #\r
2370 # @param ToPcd The PCD to be overrided\r
2371 # @param FromPcd The PCD overrideing from\r
2372 #\r
2373 def _OverridePcd(self, ToPcd, FromPcd, Module=""):\r
2374 #\r
2375 # in case there's PCDs coming from FDF file, which have no type given.\r
2376 # at this point, ToPcd.Type has the type found from dependent\r
2377 # package\r
2378 #\r
2a29017e
YZ
2379 TokenCName = ToPcd.TokenCName\r
2380 for PcdItem in GlobalData.MixedPcd:\r
2381 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
2382 TokenCName = PcdItem[0]\r
2383 break\r
52302d4d 2384 if FromPcd != None:\r
2a29017e
YZ
2385 if GlobalData.BuildOptionPcd:\r
2386 for pcd in GlobalData.BuildOptionPcd:\r
2387 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):\r
2388 FromPcd.DefaultValue = pcd[2]\r
2389 break\r
52302d4d
LG
2390 if ToPcd.Pending and FromPcd.Type not in [None, '']:\r
2391 ToPcd.Type = FromPcd.Type\r
e56468c0 2392 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\\r
2393 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):\r
2394 if ToPcd.Type.strip() == "DynamicEx":\r
47fea6af 2395 ToPcd.Type = FromPcd.Type\r
52302d4d
LG
2396 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \\r
2397 and ToPcd.Type != FromPcd.Type:\r
2398 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
2399 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\\r
2a29017e 2400 % (ToPcd.TokenSpaceGuidCName, TokenCName,\r
52302d4d
LG
2401 ToPcd.Type, Module, FromPcd.Type),\r
2402 File=self.MetaFile)\r
2403\r
2404 if FromPcd.MaxDatumSize not in [None, '']:\r
2405 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
2406 if FromPcd.DefaultValue not in [None, '']:\r
2407 ToPcd.DefaultValue = FromPcd.DefaultValue\r
2408 if FromPcd.TokenValue not in [None, '']:\r
2409 ToPcd.TokenValue = FromPcd.TokenValue\r
2410 if FromPcd.MaxDatumSize not in [None, '']:\r
2411 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
2412 if FromPcd.DatumType not in [None, '']:\r
2413 ToPcd.DatumType = FromPcd.DatumType\r
2414 if FromPcd.SkuInfoList not in [None, '', []]:\r
2415 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
2416\r
2417 # check the validation of datum\r
2418 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
2419 if not IsValid:\r
2420 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
2a29017e 2421 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
82a6a960
BF
2422 ToPcd.validateranges = FromPcd.validateranges\r
2423 ToPcd.validlists = FromPcd.validlists\r
2424 ToPcd.expressions = FromPcd.expressions\r
52302d4d
LG
2425\r
2426 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:\r
2427 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
2a29017e 2428 % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
52302d4d
LG
2429 Value = ToPcd.DefaultValue\r
2430 if Value in [None, '']:\r
e8a47801 2431 ToPcd.MaxDatumSize = '1'\r
52302d4d 2432 elif Value[0] == 'L':\r
e8a47801 2433 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
52302d4d
LG
2434 elif Value[0] == '{':\r
2435 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
2436 else:\r
e8a47801 2437 ToPcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2438\r
2439 # apply default SKU for dynamic PCDS if specified one is not available\r
2440 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \\r
2441 and ToPcd.SkuInfoList in [None, {}, '']:\r
2442 if self.Platform.SkuName in self.Platform.SkuIds:\r
2443 SkuName = self.Platform.SkuName\r
2444 else:\r
2445 SkuName = 'DEFAULT'\r
2446 ToPcd.SkuInfoList = {\r
8518bf0b 2447 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)\r
52302d4d
LG
2448 }\r
2449\r
2450 ## Apply PCD setting defined platform to a module\r
2451 #\r
2452 # @param Module The module from which the PCD setting will be overrided\r
2453 #\r
2454 # @retval PCD_list The list PCDs with settings from platform\r
2455 #\r
2456 def ApplyPcdSetting(self, Module, Pcds):\r
2457 # for each PCD in module\r
47fea6af
YZ
2458 for Name, Guid in Pcds:\r
2459 PcdInModule = Pcds[Name, Guid]\r
52302d4d 2460 # find out the PCD setting in platform\r
47fea6af
YZ
2461 if (Name, Guid) in self.Platform.Pcds:\r
2462 PcdInPlatform = self.Platform.Pcds[Name, Guid]\r
52302d4d
LG
2463 else:\r
2464 PcdInPlatform = None\r
2465 # then override the settings if any\r
2466 self._OverridePcd(PcdInModule, PcdInPlatform, Module)\r
2467 # resolve the VariableGuid value\r
2468 for SkuId in PcdInModule.SkuInfoList:\r
2469 Sku = PcdInModule.SkuInfoList[SkuId]\r
2470 if Sku.VariableGuid == '': continue\r
c28d2e10 2471 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)\r
52302d4d
LG
2472 if Sku.VariableGuidValue == None:\r
2473 PackageList = "\n\t".join([str(P) for P in self.PackageList])\r
2474 EdkLogger.error(\r
2475 'build',\r
2476 RESOURCE_NOT_AVAILABLE,\r
2477 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
2478 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
2479 % (Guid, Name, str(Module)),\r
2480 File=self.MetaFile\r
2481 )\r
2482\r
2483 # override PCD settings with module specific setting\r
2484 if Module in self.Platform.Modules:\r
2485 PlatformModule = self.Platform.Modules[str(Module)]\r
2486 for Key in PlatformModule.Pcds:\r
aa9aa47e 2487 Flag = False\r
52302d4d 2488 if Key in Pcds:\r
aa9aa47e
YZ
2489 ToPcd = Pcds[Key]\r
2490 Flag = True\r
2491 elif Key in GlobalData.MixedPcd:\r
2492 for PcdItem in GlobalData.MixedPcd[Key]:\r
2493 if PcdItem in Pcds:\r
2494 ToPcd = Pcds[PcdItem]\r
2495 Flag = True\r
2496 break\r
2497 if Flag:\r
2498 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)\r
52302d4d
LG
2499 return Pcds.values()\r
2500\r
2501 ## Resolve library names to library modules\r
2502 #\r
b36d134f 2503 # (for Edk.x modules)\r
52302d4d
LG
2504 #\r
2505 # @param Module The module from which the library names will be resolved\r
2506 #\r
2507 # @retval library_list The list of library modules\r
2508 #\r
2509 def ResolveLibraryReference(self, Module):\r
2510 EdkLogger.verbose("")\r
2511 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2512 LibraryConsumerList = [Module]\r
2513\r
b36d134f 2514 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
2515 if Module.Libraries:\r
2516 Module.Libraries.append("CompilerStub")\r
2517 LibraryList = []\r
2518 while len(LibraryConsumerList) > 0:\r
2519 M = LibraryConsumerList.pop()\r
2520 for LibraryName in M.Libraries:\r
2521 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
2522 if Library == None:\r
2523 for Key in self.Platform.LibraryClasses.data.keys():\r
2524 if LibraryName.upper() == Key.upper():\r
2525 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
2526 break\r
2527 if Library == None:\r
2528 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
2529 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
2530 continue\r
2531\r
2532 if Library not in LibraryList:\r
2533 LibraryList.append(Library)\r
2534 LibraryConsumerList.append(Library)\r
2535 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
2536 return LibraryList\r
2537\r
6780eef1
LG
2538 ## Calculate the priority value of the build option\r
2539 #\r
2540 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2541 #\r
2542 # @retval Value Priority value based on the priority list.\r
2543 #\r
2544 def CalculatePriorityValue(self, Key):\r
47fea6af
YZ
2545 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
2546 PriorityValue = 0x11111\r
6780eef1
LG
2547 if Target == "*":\r
2548 PriorityValue &= 0x01111\r
2549 if ToolChain == "*":\r
2550 PriorityValue &= 0x10111\r
2551 if Arch == "*":\r
2552 PriorityValue &= 0x11011\r
2553 if CommandType == "*":\r
2554 PriorityValue &= 0x11101\r
2555 if Attr == "*":\r
2556 PriorityValue &= 0x11110\r
47fea6af
YZ
2557\r
2558 return self.PrioList["0x%0.5x" % PriorityValue]\r
2559\r
6780eef1 2560\r
52302d4d
LG
2561 ## Expand * in build option key\r
2562 #\r
2563 # @param Options Options to be expanded\r
2564 #\r
2565 # @retval options Options expanded\r
6780eef1 2566 # \r
52302d4d
LG
2567 def _ExpandBuildOption(self, Options, ModuleStyle=None):\r
2568 BuildOptions = {}\r
2569 FamilyMatch = False\r
2570 FamilyIsNull = True\r
47fea6af 2571\r
6780eef1
LG
2572 OverrideList = {}\r
2573 #\r
2574 # Construct a list contain the build options which need override.\r
2575 #\r
2576 for Key in Options:\r
2577 #\r
2578 # Key[0] -- tool family\r
2579 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2580 #\r
1ba5124e
YL
2581 if (Key[0] == self.BuildRuleFamily and\r
2582 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):\r
6780eef1
LG
2583 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
2584 if Target == self.BuildTarget or Target == "*":\r
2585 if ToolChain == self.ToolChain or ToolChain == "*":\r
2586 if Arch == self.Arch or Arch == "*":\r
2587 if Options[Key].startswith("="):\r
47fea6af 2588 if OverrideList.get(Key[1]) != None:\r
6780eef1
LG
2589 OverrideList.pop(Key[1])\r
2590 OverrideList[Key[1]] = Options[Key]\r
2591 \r
2592 #\r
2593 # Use the highest priority value. \r
2594 #\r
2595 if (len(OverrideList) >= 2):\r
47fea6af 2596 KeyList = OverrideList.keys()\r
6780eef1 2597 for Index in range(len(KeyList)):\r
47fea6af 2598 NowKey = KeyList[Index]\r
6780eef1
LG
2599 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
2600 for Index1 in range(len(KeyList) - Index - 1):\r
2601 NextKey = KeyList[Index1 + Index + 1]\r
2602 #\r
2603 # Compare two Key, if one is included by another, choose the higher priority one\r
2604 # \r
2605 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
2606 if Target1 == Target2 or Target1 == "*" or Target2 == "*":\r
2607 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":\r
2608 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":\r
2609 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":\r
2610 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":\r
2611 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
47fea6af 2612 if Options.get((self.BuildRuleFamily, NextKey)) != None:\r
6780eef1
LG
2613 Options.pop((self.BuildRuleFamily, NextKey))\r
2614 else:\r
47fea6af 2615 if Options.get((self.BuildRuleFamily, NowKey)) != None:\r
6780eef1
LG
2616 Options.pop((self.BuildRuleFamily, NowKey))\r
2617 \r
52302d4d
LG
2618 for Key in Options:\r
2619 if ModuleStyle != None and len (Key) > 2:\r
2620 # Check Module style is EDK or EDKII.\r
2621 # Only append build option for the matched style module.\r
2622 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2623 continue\r
2624 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2625 continue\r
2626 Family = Key[0]\r
2627 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2628 # if tool chain family doesn't match, skip it\r
2629 if Tool in self.ToolDefinition and Family != "":\r
2630 FamilyIsNull = False\r
2631 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
2632 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
2633 continue\r
2634 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2635 continue\r
2636 FamilyMatch = True\r
2637 # expand any wildcard\r
2638 if Target == "*" or Target == self.BuildTarget:\r
2639 if Tag == "*" or Tag == self.ToolChain:\r
2640 if Arch == "*" or Arch == self.Arch:\r
2641 if Tool not in BuildOptions:\r
2642 BuildOptions[Tool] = {}\r
5015bee2 2643 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2644 BuildOptions[Tool][Attr] = Options[Key]\r
2645 else:\r
95816356
YZ
2646 # append options for the same tool except PATH\r
2647 if Attr != 'PATH':\r
2648 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2649 else:\r
2650 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2651 # Build Option Family has been checked, which need't to be checked again for family.\r
2652 if FamilyMatch or FamilyIsNull:\r
2653 return BuildOptions\r
1ba5124e 2654\r
52302d4d
LG
2655 for Key in Options:\r
2656 if ModuleStyle != None and len (Key) > 2:\r
2657 # Check Module style is EDK or EDKII.\r
2658 # Only append build option for the matched style module.\r
2659 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2660 continue\r
2661 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2662 continue\r
2663 Family = Key[0]\r
2664 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2665 # if tool chain family doesn't match, skip it\r
47fea6af 2666 if Tool not in self.ToolDefinition or Family == "":\r
52302d4d
LG
2667 continue\r
2668 # option has been added before\r
2669 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2670 continue\r
2671\r
2672 # expand any wildcard\r
2673 if Target == "*" or Target == self.BuildTarget:\r
2674 if Tag == "*" or Tag == self.ToolChain:\r
2675 if Arch == "*" or Arch == self.Arch:\r
2676 if Tool not in BuildOptions:\r
2677 BuildOptions[Tool] = {}\r
5015bee2 2678 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2679 BuildOptions[Tool][Attr] = Options[Key]\r
2680 else:\r
95816356
YZ
2681 # append options for the same tool except PATH\r
2682 if Attr != 'PATH':\r
2683 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2684 else:\r
2685 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2686 return BuildOptions\r
2687\r
2688 ## Append build options in platform to a module\r
2689 #\r
2690 # @param Module The module to which the build options will be appened\r
2691 #\r
2692 # @retval options The options appended with build options in platform\r
2693 #\r
2694 def ApplyBuildOption(self, Module):\r
2695 # Get the different options for the different style module\r
2696 if Module.AutoGenVersion < 0x00010005:\r
2697 PlatformOptions = self.EdkBuildOption\r
35f69db9 2698 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)\r
52302d4d
LG
2699 else:\r
2700 PlatformOptions = self.EdkIIBuildOption\r
35f69db9
YL
2701 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)\r
2702 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)\r
52302d4d
LG
2703 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
2704 if Module in self.Platform.Modules:\r
2705 PlatformModule = self.Platform.Modules[str(Module)]\r
2706 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
2707 else:\r
2708 PlatformModuleOptions = {}\r
2709\r
fe4bf2f9 2710 BuildRuleOrder = None\r
35f69db9 2711 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
fe4bf2f9
YL
2712 for Tool in Options:\r
2713 for Attr in Options[Tool]:\r
2714 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2715 BuildRuleOrder = Options[Tool][Attr]\r
2716\r
35f69db9
YL
2717 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +\r
2718 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +\r
2719 self.ToolDefinition.keys())\r
52302d4d
LG
2720 BuildOptions = {}\r
2721 for Tool in AllTools:\r
2722 if Tool not in BuildOptions:\r
2723 BuildOptions[Tool] = {}\r
2724\r
35f69db9 2725 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
52302d4d
LG
2726 if Tool not in Options:\r
2727 continue\r
2728 for Attr in Options[Tool]:\r
2729 Value = Options[Tool][Attr]\r
fe4bf2f9
YL
2730 #\r
2731 # Do not generate it in Makefile\r
2732 #\r
2733 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2734 continue\r
52302d4d
LG
2735 if Attr not in BuildOptions[Tool]:\r
2736 BuildOptions[Tool][Attr] = ""\r
2737 # check if override is indicated\r
2738 if Value.startswith('='):\r
05cc51ad
LY
2739 ToolPath = Value[1:]\r
2740 ToolPath = mws.handleWsMacro(ToolPath)\r
2741 BuildOptions[Tool][Attr] = ToolPath\r
5015bee2 2742 else:\r
05cc51ad 2743 Value = mws.handleWsMacro(Value)\r
95816356
YZ
2744 if Attr != 'PATH':\r
2745 BuildOptions[Tool][Attr] += " " + Value\r
2746 else:\r
2747 BuildOptions[Tool][Attr] = Value\r
f3decdc3
LG
2748 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:\r
2749 #\r
2750 # Override UNI flag only for EDK module.\r
2751 #\r
2752 if 'BUILD' not in BuildOptions:\r
2753 BuildOptions['BUILD'] = {}\r
2754 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
fe4bf2f9 2755 return BuildOptions, BuildRuleOrder\r
52302d4d
LG
2756\r
2757 Platform = property(_GetPlatform)\r
2758 Name = property(_GetName)\r
2759 Guid = property(_GetGuid)\r
2760 Version = property(_GetVersion)\r
2761\r
2762 OutputDir = property(_GetOutputDir)\r
2763 BuildDir = property(_GetBuildDir)\r
2764 MakeFileDir = property(_GetMakeFileDir)\r
2765 FdfFile = property(_GetFdfFile)\r
2766\r
2767 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
2768 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2769 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2bc3256c 2770 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)\r
52302d4d
LG
2771 PackageList = property(_GetPackageList)\r
2772\r
2773 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
2774 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path\r
2775 ToolChainFamily = property(_GetToolChainFamily)\r
2776 BuildRuleFamily = property(_GetBuildRuleFamily)\r
2777 BuildOption = property(_GetBuildOptions) # toolcode : option\r
2778 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option\r
2779 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option\r
2780\r
2781 BuildCommand = property(_GetBuildCommand)\r
2782 BuildRule = property(_GetBuildRule)\r
2783 ModuleAutoGenList = property(_GetModuleAutoGenList)\r
2784 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
0923aa1c 2785 GenFdsCommand = property(_GenFdsCommand)\r
52302d4d
LG
2786\r
2787## ModuleAutoGen class\r
2788#\r
2789# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
2790# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
2791# to the [depex] section in module's inf file.\r
2792#\r
2793class ModuleAutoGen(AutoGen):\r
c17956e0
DL
2794 ## Cache the timestamps of metafiles of every module in a class variable\r
2795 #\r
2796 TimeDict = {}\r
2797\r
52302d4d
LG
2798 ## The real constructor of ModuleAutoGen\r
2799 #\r
2800 # This method is not supposed to be called by users of ModuleAutoGen. It's\r
2801 # only used by factory method __new__() to do real initialization work for an\r
2802 # object of ModuleAutoGen\r
2803 #\r
2804 # @param Workspace EdkIIWorkspaceBuild object\r
2805 # @param ModuleFile The path of module file\r
2806 # @param Target Build target (DEBUG, RELEASE)\r
2807 # @param Toolchain Name of tool chain\r
2808 # @param Arch The arch the module supports\r
2809 # @param PlatformFile Platform meta-file\r
2810 #\r
2811 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
2812 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
2813 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
2814\r
2815 self.Workspace = Workspace\r
2816 self.WorkspaceDir = Workspace.WorkspaceDir\r
2817\r
2818 self.MetaFile = ModuleFile\r
2819 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
2820 # check if this module is employed by active platform\r
2821 if not self.PlatformInfo.ValidModule(self.MetaFile):\r
2822 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
2823 % (self.MetaFile, Arch))\r
2824 return False\r
2825\r
2826 self.SourceDir = self.MetaFile.SubDir\r
05cc51ad 2827 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)\r
97fa0ee9 2828\r
52302d4d
LG
2829 self.SourceOverrideDir = None\r
2830 # use overrided path defined in DSC file\r
2831 if self.MetaFile.Key in GlobalData.gOverrideDir:\r
2832 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]\r
2833\r
2834 self.ToolChain = Toolchain\r
2835 self.BuildTarget = Target\r
2836 self.Arch = Arch\r
2837 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily\r
2838 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily\r
2839\r
2840 self.IsMakeFileCreated = False\r
2841 self.IsCodeFileCreated = False\r
da92f276
LG
2842 self.IsAsBuiltInfCreated = False\r
2843 self.DepexGenerated = False\r
52302d4d
LG
2844\r
2845 self.BuildDatabase = self.Workspace.BuildDatabase\r
fe4bf2f9 2846 self.BuildRuleOrder = None\r
1b8eca8b 2847 self.BuildTime = 0\r
52302d4d
LG
2848\r
2849 self._Module = None\r
2850 self._Name = None\r
2851 self._Guid = None\r
2852 self._Version = None\r
2853 self._ModuleType = None\r
2854 self._ComponentType = None\r
2855 self._PcdIsDriver = None\r
2856 self._AutoGenVersion = None\r
2857 self._LibraryFlag = None\r
2858 self._CustomMakefile = None\r
2859 self._Macro = None\r
2860\r
2861 self._BuildDir = None\r
2862 self._OutputDir = None\r
37de70b7 2863 self._FfsOutputDir = None\r
52302d4d
LG
2864 self._DebugDir = None\r
2865 self._MakeFileDir = None\r
2866\r
2867 self._IncludePathList = None\r
725cdb8f 2868 self._IncludePathLength = 0\r
52302d4d
LG
2869 self._AutoGenFileList = None\r
2870 self._UnicodeFileList = None\r
5b97eb4c 2871 self._VfrFileList = None\r
333ba578 2872 self._IdfFileList = None\r
52302d4d
LG
2873 self._SourceFileList = None\r
2874 self._ObjectFileList = None\r
2875 self._BinaryFileList = None\r
2876\r
2877 self._DependentPackageList = None\r
2878 self._DependentLibraryList = None\r
2879 self._LibraryAutoGenList = None\r
2880 self._DerivedPackageList = None\r
2881 self._ModulePcdList = None\r
2882 self._LibraryPcdList = None\r
e8a47801 2883 self._PcdComments = sdict()\r
52302d4d 2884 self._GuidList = None\r
e8a47801
LG
2885 self._GuidsUsedByPcd = None\r
2886 self._GuidComments = sdict()\r
52302d4d 2887 self._ProtocolList = None\r
e8a47801 2888 self._ProtocolComments = sdict()\r
52302d4d 2889 self._PpiList = None\r
e8a47801 2890 self._PpiComments = sdict()\r
52302d4d
LG
2891 self._DepexList = None\r
2892 self._DepexExpressionList = None\r
2893 self._BuildOption = None\r
79b74a03 2894 self._BuildOptionIncPathList = None\r
52302d4d
LG
2895 self._BuildTargets = None\r
2896 self._IntroBuildTargetList = None\r
2897 self._FinalBuildTargetList = None\r
2898 self._FileTypes = None\r
2899 self._BuildRules = None\r
c17956e0
DL
2900\r
2901 self._TimeStampPath = None\r
2902\r
2903 self.AutoGenDepSet = set()\r
2904\r
2bc3256c
LG
2905 \r
2906 ## The Modules referenced to this Library\r
2907 # Only Library has this attribute\r
2908 self._ReferenceModules = [] \r
2909 \r
2910 ## Store the FixedAtBuild Pcds\r
2911 # \r
2912 self._FixedAtBuildPcds = []\r
2913 self.ConstPcd = {}\r
52302d4d
LG
2914 return True\r
2915\r
2916 def __repr__(self):\r
2917 return "%s [%s]" % (self.MetaFile, self.Arch)\r
2918\r
2bc3256c
LG
2919 # Get FixedAtBuild Pcds of this Module\r
2920 def _GetFixedAtBuildPcds(self):\r
2921 if self._FixedAtBuildPcds:\r
2922 return self._FixedAtBuildPcds\r
2923 for Pcd in self.ModulePcdList:\r
7256bd55 2924 if Pcd.Type != "FixedAtBuild":\r
2bc3256c
LG
2925 continue\r
2926 if Pcd not in self._FixedAtBuildPcds:\r
2927 self._FixedAtBuildPcds.append(Pcd)\r
2928 \r
2929 return self._FixedAtBuildPcds \r
2930\r
867d1cd4
YL
2931 def _GetUniqueBaseName(self):\r
2932 BaseName = self.Name\r
2933 for Module in self.PlatformInfo.ModuleAutoGenList:\r
2934 if Module.MetaFile == self.MetaFile:\r
2935 continue\r
2936 if Module.Name == self.Name:\r
867d1cd4
YL
2937 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):\r
2938 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'\r
2939 ' %s\n %s' % (Module.MetaFile, self.MetaFile))\r
2940 BaseName = '%s_%s' % (self.Name, self.Guid)\r
2941 return BaseName\r
2942\r
52302d4d
LG
2943 # Macros could be used in build_rule.txt (also Makefile)\r
2944 def _GetMacros(self):\r
2945 if self._Macro == None:\r
2946 self._Macro = sdict()\r
2947 self._Macro["WORKSPACE" ] = self.WorkspaceDir\r
2948 self._Macro["MODULE_NAME" ] = self.Name\r
867d1cd4 2949 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()\r
52302d4d
LG
2950 self._Macro["MODULE_GUID" ] = self.Guid\r
2951 self._Macro["MODULE_VERSION" ] = self.Version\r
2952 self._Macro["MODULE_TYPE" ] = self.ModuleType\r
2953 self._Macro["MODULE_FILE" ] = str(self.MetaFile)\r
2954 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName\r
2955 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir\r
2956 self._Macro["MODULE_DIR" ] = self.SourceDir\r
2957\r
2958 self._Macro["BASE_NAME" ] = self.Name\r
2959\r
2960 self._Macro["ARCH" ] = self.Arch\r
2961 self._Macro["TOOLCHAIN" ] = self.ToolChain\r
2962 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain\r
0d2711a6 2963 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain\r
52302d4d
LG
2964 self._Macro["TARGET" ] = self.BuildTarget\r
2965\r
2966 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir\r
2967 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2968 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2969 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir\r
2970 self._Macro["OUTPUT_DIR" ] = self.OutputDir\r
2971 self._Macro["DEBUG_DIR" ] = self.DebugDir\r
df1e1b63
YZ
2972 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir\r
2973 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir\r
3570e332
YZ
2974 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name\r
2975 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid\r
2976 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version\r
2977 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir\r
2978 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)\r
2979 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir\r
37de70b7 2980 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir\r
52302d4d
LG
2981 return self._Macro\r
2982\r
2983 ## Return the module build data object\r
2984 def _GetModule(self):\r
2985 if self._Module == None:\r
0d2711a6 2986 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2987 return self._Module\r
2988\r
2989 ## Return the module name\r
2990 def _GetBaseName(self):\r
2991 return self.Module.BaseName\r
2992\r
b36d134f
LG
2993 ## Return the module DxsFile if exist\r
2994 def _GetDxsFile(self):\r
2995 return self.Module.DxsFile\r
2996\r
52302d4d
LG
2997 ## Return the module SourceOverridePath\r
2998 def _GetSourceOverridePath(self):\r
2999 return self.Module.SourceOverridePath\r
3000\r
3001 ## Return the module meta-file GUID\r
3002 def _GetGuid(self):\r
97fa0ee9
YL
3003 #\r
3004 # To build same module more than once, the module path with FILE_GUID overridden has\r
3005 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path\r
3006 # in DSC. The overridden GUID can be retrieved from file name\r
3007 #\r
3008 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):\r
3009 #\r
3010 # Length of GUID is 36\r
3011 #\r
3012 return os.path.basename(self.MetaFile.Path)[:36]\r
52302d4d
LG
3013 return self.Module.Guid\r
3014\r
3015 ## Return the module version\r
3016 def _GetVersion(self):\r
3017 return self.Module.Version\r
3018\r
3019 ## Return the module type\r
3020 def _GetModuleType(self):\r
3021 return self.Module.ModuleType\r
3022\r
b36d134f 3023 ## Return the component type (for Edk.x style of module)\r
52302d4d
LG
3024 def _GetComponentType(self):\r
3025 return self.Module.ComponentType\r
3026\r
3027 ## Return the build type\r
3028 def _GetBuildType(self):\r
3029 return self.Module.BuildType\r
3030\r
3031 ## Return the PCD_IS_DRIVER setting\r
3032 def _GetPcdIsDriver(self):\r
3033 return self.Module.PcdIsDriver\r
3034\r
3035 ## Return the autogen version, i.e. module meta-file version\r
3036 def _GetAutoGenVersion(self):\r
3037 return self.Module.AutoGenVersion\r
3038\r
3039 ## Check if the module is library or not\r
3040 def _IsLibrary(self):\r
3041 if self._LibraryFlag == None:\r
3042 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:\r
3043 self._LibraryFlag = True\r
3044 else:\r
3045 self._LibraryFlag = False\r
3046 return self._LibraryFlag\r
3047\r
e8a47801
LG
3048 ## Check if the module is binary module or not\r
3049 def _IsBinaryModule(self):\r
3050 return self.Module.IsBinaryModule\r
3051\r
52302d4d
LG
3052 ## Return the directory to store intermediate files of the module\r
3053 def _GetBuildDir(self):\r
3054 if self._BuildDir == None:\r
3055 self._BuildDir = path.join(\r
3056 self.PlatformInfo.BuildDir,\r
3057 self.Arch,\r
3058 self.SourceDir,\r
3059 self.MetaFile.BaseName\r
3060 )\r
3061 CreateDirectory(self._BuildDir)\r
3062 return self._BuildDir\r
3063\r
3064 ## Return the directory to store the intermediate object files of the mdoule\r
3065 def _GetOutputDir(self):\r
3066 if self._OutputDir == None:\r
3067 self._OutputDir = path.join(self.BuildDir, "OUTPUT")\r
3068 CreateDirectory(self._OutputDir)\r
3069 return self._OutputDir\r
3070\r
37de70b7
YZ
3071 ## Return the directory to store ffs file\r
3072 def _GetFfsOutputDir(self):\r
3073 if self._FfsOutputDir == None:\r
3074 if GlobalData.gFdfParser != None:\r
3075 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)\r
3076 else:\r
3077 self._FfsOutputDir = ''\r
3078 return self._FfsOutputDir\r
3079\r
52302d4d
LG
3080 ## Return the directory to store auto-gened source files of the mdoule\r
3081 def _GetDebugDir(self):\r
3082 if self._DebugDir == None:\r
3083 self._DebugDir = path.join(self.BuildDir, "DEBUG")\r
3084 CreateDirectory(self._DebugDir)\r
3085 return self._DebugDir\r
3086\r
3087 ## Return the path of custom file\r
3088 def _GetCustomMakefile(self):\r
3089 if self._CustomMakefile == None:\r
3090 self._CustomMakefile = {}\r
3091 for Type in self.Module.CustomMakefile:\r
3092 if Type in gMakeTypeMap:\r
3093 MakeType = gMakeTypeMap[Type]\r
3094 else:\r
3095 MakeType = 'nmake'\r
3096 if self.SourceOverrideDir != None:\r
3097 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])\r
3098 if not os.path.exists(File):\r
3099 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
3100 else:\r
3101 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
3102 self._CustomMakefile[MakeType] = File\r
3103 return self._CustomMakefile\r
3104\r
3105 ## Return the directory of the makefile\r
3106 #\r
3107 # @retval string The directory string of module's makefile\r
3108 #\r
3109 def _GetMakeFileDir(self):\r
3110 return self.BuildDir\r
3111\r
3112 ## Return build command string\r
3113 #\r
3114 # @retval string Build command string\r
3115 #\r
3116 def _GetBuildCommand(self):\r
3117 return self.PlatformInfo.BuildCommand\r
3118\r
3119 ## Get object list of all packages the module and its dependent libraries belong to\r
3120 #\r
3121 # @retval list The list of package object\r
3122 #\r
3123 def _GetDerivedPackageList(self):\r
3124 PackageList = []\r
3125 for M in [self.Module] + self.DependentLibraryList:\r
3126 for Package in M.Packages:\r
3127 if Package in PackageList:\r
3128 continue\r
3129 PackageList.append(Package)\r
3130 return PackageList\r
97fa0ee9
YL
3131 \r
3132 ## Get the depex string\r
3133 #\r
3134 # @return : a string contain all depex expresion.\r
3135 def _GetDepexExpresionString(self):\r
3136 DepexStr = ''\r
3137 DepexList = []\r
3138 ## DPX_SOURCE IN Define section.\r
3139 if self.Module.DxsFile:\r
3140 return DepexStr\r
3141 for M in [self.Module] + self.DependentLibraryList:\r
3142 Filename = M.MetaFile.Path\r
3143 InfObj = InfSectionParser.InfSectionParser(Filename)\r
3144 DepexExpresionList = InfObj.GetDepexExpresionList()\r
3145 for DepexExpresion in DepexExpresionList:\r
3146 for key in DepexExpresion.keys():\r
3147 Arch, ModuleType = key\r
518aebe2 3148 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]\r
97fa0ee9
YL
3149 # the type of build module is USER_DEFINED.\r
3150 # All different DEPEX section tags would be copied into the As Built INF file\r
3151 # and there would be separate DEPEX section tags\r
3152 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
3153 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):\r
518aebe2 3154 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
3155 else:\r
3156 if Arch.upper() == TAB_ARCH_COMMON or \\r
3157 (Arch.upper() == self.Arch.upper() and \\r
3158 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):\r
518aebe2 3159 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
3160 \r
3161 #the type of build module is USER_DEFINED.\r
3162 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
3163 for Depex in DepexList:\r
3164 for key in Depex.keys():\r
3165 DepexStr += '[Depex.%s.%s]\n' % key\r
3166 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])\r
3167 DepexStr += '\n\n'\r
3168 if not DepexStr:\r
3169 return '[Depex.%s]\n' % self.Arch\r
3170 return DepexStr\r
3171 \r
3172 #the type of build module not is USER_DEFINED.\r
3173 Count = 0\r
3174 for Depex in DepexList:\r
3175 Count += 1\r
3176 if DepexStr != '':\r
3177 DepexStr += ' AND '\r
3178 DepexStr += '('\r
3179 for D in Depex.values():\r
3180 DepexStr += ' '.join([val for val in D])\r
3181 Index = DepexStr.find('END')\r
3182 if Index > -1 and Index == len(DepexStr) - 3:\r
3183 DepexStr = DepexStr[:-3]\r
3184 DepexStr = DepexStr.strip()\r
3185 DepexStr += ')'\r
3186 if Count == 1:\r
3187 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()\r
3188 if not DepexStr:\r
3189 return '[Depex.%s]\n' % self.Arch\r
3190 return '[Depex.%s]\n# ' % self.Arch + DepexStr\r
3191 \r
52302d4d
LG
3192 ## Merge dependency expression\r
3193 #\r
3194 # @retval list The token list of the dependency expression after parsed\r
3195 #\r
3196 def _GetDepexTokenList(self):\r
3197 if self._DepexList == None:\r
3198 self._DepexList = {}\r
b36d134f 3199 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
3200 return self._DepexList\r
3201\r
3202 self._DepexList[self.ModuleType] = []\r
3203\r
3204 for ModuleType in self._DepexList:\r
3205 DepexList = self._DepexList[ModuleType]\r
3206 #\r
3207 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
3208 #\r
3209 for M in [self.Module] + self.DependentLibraryList:\r
3210 Inherited = False\r
3211 for D in M.Depex[self.Arch, ModuleType]:\r
3212 if DepexList != []:\r
3213 DepexList.append('AND')\r
3214 DepexList.append('(')\r
3215 DepexList.extend(D)\r
3216 if DepexList[-1] == 'END': # no need of a END at this time\r
3217 DepexList.pop()\r
3218 DepexList.append(')')\r
3219 Inherited = True\r
3220 if Inherited:\r
3221 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))\r
3222 if 'BEFORE' in DepexList or 'AFTER' in DepexList:\r
3223 break\r
3224 if len(DepexList) > 0:\r
3225 EdkLogger.verbose('')\r
3226 return self._DepexList\r
3227\r
3228 ## Merge dependency expression\r
3229 #\r
3230 # @retval list The token list of the dependency expression after parsed\r
3231 #\r
3232 def _GetDepexExpressionTokenList(self):\r
3233 if self._DepexExpressionList == None:\r
3234 self._DepexExpressionList = {}\r
b36d134f 3235 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
3236 return self._DepexExpressionList\r
3237\r
3238 self._DepexExpressionList[self.ModuleType] = ''\r
3239\r
3240 for ModuleType in self._DepexExpressionList:\r
3241 DepexExpressionList = self._DepexExpressionList[ModuleType]\r
3242 #\r
3243 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
3244 #\r
3245 for M in [self.Module] + self.DependentLibraryList:\r
3246 Inherited = False\r
3247 for D in M.DepexExpression[self.Arch, ModuleType]:\r
3248 if DepexExpressionList != '':\r
3249 DepexExpressionList += ' AND '\r
3250 DepexExpressionList += '('\r
3251 DepexExpressionList += D\r
3252 DepexExpressionList = DepexExpressionList.rstrip('END').strip()\r
3253 DepexExpressionList += ')'\r
3254 Inherited = True\r
3255 if Inherited:\r
3256 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))\r
3257 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:\r
3258 break\r
3259 if len(DepexExpressionList) > 0:\r
3260 EdkLogger.verbose('')\r
3261 self._DepexExpressionList[ModuleType] = DepexExpressionList\r
3262 return self._DepexExpressionList\r
3263\r
dfa41b4a
YZ
3264 # Get the tiano core user extension, it is contain dependent library.\r
3265 # @retval: a list contain tiano core userextension.\r
3266 #\r
3267 def _GetTianoCoreUserExtensionList(self):\r
3268 TianoCoreUserExtentionList = []\r
3269 for M in [self.Module] + self.DependentLibraryList:\r
3270 Filename = M.MetaFile.Path\r
3271 InfObj = InfSectionParser.InfSectionParser(Filename)\r
3272 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()\r
3273 for TianoCoreUserExtent in TianoCoreUserExtenList:\r
3274 for Section in TianoCoreUserExtent.keys():\r
3275 ItemList = Section.split(TAB_SPLIT)\r
3276 Arch = self.Arch\r
3277 if len(ItemList) == 4:\r
3278 Arch = ItemList[3]\r
3279 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():\r
3280 TianoCoreList = []\r
3281 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])\r
3282 TianoCoreList.extend(TianoCoreUserExtent[Section][:])\r
3283 TianoCoreList.append('\n')\r
3284 TianoCoreUserExtentionList.append(TianoCoreList)\r
3285\r
3286 return TianoCoreUserExtentionList\r
3287\r
52302d4d
LG
3288 ## Return the list of specification version required for the module\r
3289 #\r
3290 # @retval list The list of specification defined in module file\r
3291 #\r
3292 def _GetSpecification(self):\r
3293 return self.Module.Specification\r
3294\r
3295 ## Tool option for the module build\r
3296 #\r
3297 # @param PlatformInfo The object of PlatformBuildInfo\r
3298 # @retval dict The dict containing valid options\r
3299 #\r
3300 def _GetModuleBuildOption(self):\r
3301 if self._BuildOption == None:\r
fe4bf2f9
YL
3302 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)\r
3303 if self.BuildRuleOrder:\r
3304 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]\r
52302d4d
LG
3305 return self._BuildOption\r
3306\r
79b74a03
LG
3307 ## Get include path list from tool option for the module build\r
3308 #\r
3309 # @retval list The include path list\r
3310 #\r
3311 def _GetBuildOptionIncPathList(self):\r
3312 if self._BuildOptionIncPathList == None:\r
3313 #\r
d40b2ee6 3314 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
79b74a03
LG
3315 # is the former use /I , the Latter used -I to specify include directories\r
3316 #\r
3317 if self.PlatformInfo.ToolChainFamily in ('MSFT'):\r
47fea6af 3318 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
d40b2ee6 3319 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):\r
47fea6af 3320 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
d40b2ee6
LG
3321 else:\r
3322 #\r
3323 # New ToolChainFamily, don't known whether there is option to specify include directories\r
3324 #\r
3325 self._BuildOptionIncPathList = []\r
3326 return self._BuildOptionIncPathList\r
79b74a03
LG
3327 \r
3328 BuildOptionIncPathList = []\r
3329 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):\r
3330 Attr = 'FLAGS'\r
3331 try:\r
3332 FlagOption = self.BuildOption[Tool][Attr]\r
3333 except KeyError:\r
3334 FlagOption = ''\r
3335 \r
d40b2ee6
LG
3336 if self.PlatformInfo.ToolChainFamily != 'RVCT':\r
3337 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]\r
3338 else:\r
3339 #\r
3340 # RVCT may specify a list of directory seperated by commas\r
3341 #\r
3342 IncPathList = []\r
3343 for Path in gBuildOptIncludePattern.findall(FlagOption):\r
3344 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)\r
3345 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]\r
3346\r
79b74a03
LG
3347 #\r
3348 # EDK II modules must not reference header files outside of the packages they depend on or \r
3349 # within the module's directory tree. Report error if violation.\r
3350 #\r
3351 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:\r
3352 for Path in IncPathList:\r
3353 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):\r
47fea6af
YZ
3354 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)\r
3355 EdkLogger.error("build",\r
79b74a03 3356 PARAMETER_INVALID,\r
47fea6af
YZ
3357 ExtraData=ErrMsg,\r
3358 File=str(self.MetaFile))\r
79b74a03
LG
3359\r
3360 \r
3361 BuildOptionIncPathList += IncPathList\r
3362 \r
3363 self._BuildOptionIncPathList = BuildOptionIncPathList\r
3364 \r
3365 return self._BuildOptionIncPathList\r
3366 \r
52302d4d
LG
3367 ## Return a list of files which can be built from source\r
3368 #\r
3369 # What kind of files can be built is determined by build rules in\r
97fa0ee9 3370 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.\r
52302d4d
LG
3371 #\r
3372 def _GetSourceFileList(self):\r
3373 if self._SourceFileList == None:\r
3374 self._SourceFileList = []\r
3375 for F in self.Module.Sources:\r
3376 # match tool chain\r
08dd311f 3377 if F.TagName not in ("", "*", self.ToolChain):\r
52302d4d
LG
3378 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "\r
3379 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))\r
3380 continue\r
e2597799
YZ
3381 # match tool chain family or build rule family\r
3382 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):\r
52302d4d
LG
3383 EdkLogger.debug(\r
3384 EdkLogger.DEBUG_0,\r
3385 "The file [%s] must be built by tools of [%s], " \\r
e2597799
YZ
3386 "but current toolchain family is [%s], buildrule family is [%s]" \\r
3387 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))\r
52302d4d
LG
3388 continue\r
3389\r
3390 # add the file path into search path list for file including\r
3391 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:\r
3392 self.IncludePathList.insert(0, F.Dir)\r
3393 self._SourceFileList.append(F)\r
4cb7bade
YZ
3394\r
3395 self._MatchBuildRuleOrder(self._SourceFileList)\r
3396\r
3397 for F in self._SourceFileList:\r
52302d4d
LG
3398 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)\r
3399 return self._SourceFileList\r
3400\r
4cb7bade
YZ
3401 def _MatchBuildRuleOrder(self, FileList):\r
3402 Order_Dict = {}\r
3403 self._GetModuleBuildOption()\r
3404 for SingleFile in FileList:\r
3405 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:\r
3406 key = SingleFile.Path.split(SingleFile.Ext)[0]\r
3407 if key in Order_Dict:\r
3408 Order_Dict[key].append(SingleFile.Ext)\r
3409 else:\r
3410 Order_Dict[key] = [SingleFile.Ext]\r
3411\r
3412 RemoveList = []\r
3413 for F in Order_Dict:\r
3414 if len(Order_Dict[F]) > 1:\r
3415 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))\r
3416 for Ext in Order_Dict[F][1:]:\r
3417 RemoveList.append(F + Ext)\r
3418 \r
3419 for item in RemoveList:\r
3420 FileList.remove(item)\r
3421\r
3422 return FileList\r
3423\r
52302d4d
LG
3424 ## Return the list of unicode files\r
3425 def _GetUnicodeFileList(self):\r
3426 if self._UnicodeFileList == None:\r
3427 if TAB_UNICODE_FILE in self.FileTypes:\r
3428 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]\r
3429 else:\r
3430 self._UnicodeFileList = []\r
3431 return self._UnicodeFileList\r
3432\r
5b97eb4c
YZ
3433 ## Return the list of vfr files\r
3434 def _GetVfrFileList(self):\r
3435 if self._VfrFileList == None:\r
3436 if TAB_VFR_FILE in self.FileTypes:\r
3437 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]\r
3438 else:\r
3439 self._VfrFileList = []\r
3440 return self._VfrFileList\r
3441\r
333ba578
YZ
3442 ## Return the list of Image Definition files\r
3443 def _GetIdfFileList(self):\r
3444 if self._IdfFileList == None:\r
3445 if TAB_IMAGE_FILE in self.FileTypes:\r
3446 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]\r
3447 else:\r
3448 self._IdfFileList = []\r
3449 return self._IdfFileList\r
3450\r
52302d4d
LG
3451 ## Return a list of files which can be built from binary\r
3452 #\r
3453 # "Build" binary files are just to copy them to build directory.\r
3454 #\r
3455 # @retval list The list of files which can be built later\r
3456 #\r
3457 def _GetBinaryFiles(self):\r
3458 if self._BinaryFileList == None:\r
3459 self._BinaryFileList = []\r
3460 for F in self.Module.Binaries:\r
3461 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:\r
3462 continue\r
3463 self._BinaryFileList.append(F)\r
3464 self._ApplyBuildRule(F, F.Type)\r
3465 return self._BinaryFileList\r
3466\r
3467 def _GetBuildRules(self):\r
3468 if self._BuildRules == None:\r
3469 BuildRules = {}\r
3470 BuildRuleDatabase = self.PlatformInfo.BuildRule\r
3471 for Type in BuildRuleDatabase.FileTypeList:\r
3472 #first try getting build rule by BuildRuleFamily\r
3473 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]\r
3474 if not RuleObject:\r
3475 # build type is always module type, but ...\r
3476 if self.ModuleType != self.BuildType:\r
3477 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]\r
3478 #second try getting build rule by ToolChainFamily\r
3479 if not RuleObject:\r
3480 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]\r
3481 if not RuleObject:\r
3482 # build type is always module type, but ...\r
3483 if self.ModuleType != self.BuildType:\r
3484 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]\r
3485 if not RuleObject:\r
3486 continue\r
3487 RuleObject = RuleObject.Instantiate(self.Macros)\r
3488 BuildRules[Type] = RuleObject\r
3489 for Ext in RuleObject.SourceFileExtList:\r
3490 BuildRules[Ext] = RuleObject\r
3491 self._BuildRules = BuildRules\r
3492 return self._BuildRules\r
3493\r
3494 def _ApplyBuildRule(self, File, FileType):\r
3495 if self._BuildTargets == None:\r
3496 self._IntroBuildTargetList = set()\r
3497 self._FinalBuildTargetList = set()\r
3498 self._BuildTargets = {}\r
3499 self._FileTypes = {}\r
3500\r
fcd4fbf3
YL
3501 SubDirectory = os.path.join(self.OutputDir, File.SubDir)\r
3502 if not os.path.exists(SubDirectory):\r
3503 CreateDirectory(SubDirectory)\r
52302d4d
LG
3504 LastTarget = None\r
3505 RuleChain = []\r
3506 SourceList = [File]\r
3507 Index = 0\r
fe4bf2f9
YL
3508 #\r
3509 # Make sure to get build rule order value\r
3510 #\r
3511 self._GetModuleBuildOption()\r
3512\r
52302d4d
LG
3513 while Index < len(SourceList):\r
3514 Source = SourceList[Index]\r
3515 Index = Index + 1\r
3516\r
3517 if Source != File:\r
3518 CreateDirectory(Source.Dir)\r
3519\r
3520 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:\r
da92f276
LG
3521 # Skip all files that are not binary libraries\r
3522 if not self.IsLibrary:\r
47fea6af 3523 continue\r
52302d4d
LG
3524 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]\r
3525 elif FileType in self.BuildRules:\r
3526 RuleObject = self.BuildRules[FileType]\r
3527 elif Source.Ext in self.BuildRules:\r
3528 RuleObject = self.BuildRules[Source.Ext]\r
3529 else:\r
3530 # stop at no more rules\r
3531 if LastTarget:\r
3532 self._FinalBuildTargetList.add(LastTarget)\r
3533 break\r
3534\r
3535 FileType = RuleObject.SourceFileType\r
3536 if FileType not in self._FileTypes:\r
3537 self._FileTypes[FileType] = set()\r
3538 self._FileTypes[FileType].add(Source)\r
3539\r
3540 # stop at STATIC_LIBRARY for library\r
3541 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:\r
3542 if LastTarget:\r
3543 self._FinalBuildTargetList.add(LastTarget)\r
3544 break\r
3545\r
fe4bf2f9 3546 Target = RuleObject.Apply(Source, self.BuildRuleOrder)\r
52302d4d
LG
3547 if not Target:\r
3548 if LastTarget:\r
3549 self._FinalBuildTargetList.add(LastTarget)\r
3550 break\r
3551 elif not Target.Outputs:\r
3552 # Only do build for target with outputs\r
3553 self._FinalBuildTargetList.add(Target)\r
3554\r
3555 if FileType not in self._BuildTargets:\r
3556 self._BuildTargets[FileType] = set()\r
3557 self._BuildTargets[FileType].add(Target)\r
3558\r
3559 if not Source.IsBinary and Source == File:\r
3560 self._IntroBuildTargetList.add(Target)\r
3561\r
3562 # to avoid cyclic rule\r
3563 if FileType in RuleChain:\r
3564 break\r
3565\r
3566 RuleChain.append(FileType)\r
3567 SourceList.extend(Target.Outputs)\r
3568 LastTarget = Target\r
3569 FileType = TAB_UNKNOWN_FILE\r
3570\r
3571 def _GetTargets(self):\r
3572 if self._BuildTargets == None:\r
3573 self._IntroBuildTargetList = set()\r
3574 self._FinalBuildTargetList = set()\r
3575 self._BuildTargets = {}\r
3576 self._FileTypes = {}\r
3577\r
b36d134f 3578 #TRICK: call _GetSourceFileList to apply build rule for source files\r
52302d4d
LG
3579 if self.SourceFileList:\r
3580 pass\r
3581\r
3582 #TRICK: call _GetBinaryFileList to apply build rule for binary files\r
3583 if self.BinaryFileList:\r
3584 pass\r
3585\r
3586 return self._BuildTargets\r
3587\r
3588 def _GetIntroTargetList(self):\r
3589 self._GetTargets()\r
3590 return self._IntroBuildTargetList\r
3591\r
3592 def _GetFinalTargetList(self):\r
3593 self._GetTargets()\r
3594 return self._FinalBuildTargetList\r
3595\r
3596 def _GetFileTypes(self):\r
3597 self._GetTargets()\r
3598 return self._FileTypes\r
3599\r
3600 ## Get the list of package object the module depends on\r
3601 #\r
3602 # @retval list The package object list\r
3603 #\r
3604 def _GetDependentPackageList(self):\r
3605 return self.Module.Packages\r
3606\r
3607 ## Return the list of auto-generated code file\r
3608 #\r
3609 # @retval list The list of auto-generated file\r
3610 #\r
3611 def _GetAutoGenFileList(self):\r
3612 UniStringAutoGenC = True\r
333ba578 3613 IdfStringAutoGenC = True\r
4234283c 3614 UniStringBinBuffer = StringIO()\r
333ba578 3615 IdfGenBinBuffer = StringIO()\r
52302d4d 3616 if self.BuildType == 'UEFI_HII':\r
52302d4d 3617 UniStringAutoGenC = False\r
333ba578 3618 IdfStringAutoGenC = False\r
52302d4d
LG
3619 if self._AutoGenFileList == None:\r
3620 self._AutoGenFileList = {}\r
3621 AutoGenC = TemplateString()\r
3622 AutoGenH = TemplateString()\r
3623 StringH = TemplateString()\r
333ba578
YZ
3624 StringIdf = TemplateString()\r
3625 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)\r
07b8564b
YL
3626 #\r
3627 # AutoGen.c is generated if there are library classes in inf, or there are object files\r
3628 #\r
3629 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0\r
3630 or TAB_OBJECT_FILE in self.FileTypes):\r
52302d4d
LG
3631 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)\r
3632 self._AutoGenFileList[AutoFile] = str(AutoGenC)\r
3633 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3634 if str(AutoGenH) != "":\r
3635 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)\r
3636 self._AutoGenFileList[AutoFile] = str(AutoGenH)\r
3637 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3638 if str(StringH) != "":\r
3639 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)\r
3640 self._AutoGenFileList[AutoFile] = str(StringH)\r
3641 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3642 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":\r
3643 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)\r
3644 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()\r
3645 AutoFile.IsBinary = True\r
3646 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3647 if UniStringBinBuffer != None:\r
3648 UniStringBinBuffer.close()\r
333ba578
YZ
3649 if str(StringIdf) != "":\r
3650 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)\r
3651 self._AutoGenFileList[AutoFile] = str(StringIdf)\r
3652 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3653 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":\r
3654 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)\r
3655 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()\r
3656 AutoFile.IsBinary = True\r
3657 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3658 if IdfGenBinBuffer != None:\r
3659 IdfGenBinBuffer.close()\r
52302d4d
LG
3660 return self._AutoGenFileList\r
3661\r
3662 ## Return the list of library modules explicitly or implicityly used by this module\r
3663 def _GetLibraryList(self):\r
3664 if self._DependentLibraryList == None:\r
3665 # only merge library classes and PCD for non-library module\r
3666 if self.IsLibrary:\r
3667 self._DependentLibraryList = []\r
3668 else:\r
3669 if self.AutoGenVersion < 0x00010005:\r
3670 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)\r
3671 else:\r
3672 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)\r
3673 return self._DependentLibraryList\r
3674\r
e8a47801
LG
3675 @staticmethod\r
3676 def UpdateComments(Recver, Src):\r
3677 for Key in Src:\r
3678 if Key not in Recver:\r
3679 Recver[Key] = []\r
3680 Recver[Key].extend(Src[Key])\r
52302d4d
LG
3681 ## Get the list of PCDs from current module\r
3682 #\r
3683 # @retval list The list of PCD\r
3684 #\r
3685 def _GetModulePcdList(self):\r
3686 if self._ModulePcdList == None:\r
3687 # apply PCD settings from platform\r
3688 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)\r
e8a47801 3689 self.UpdateComments(self._PcdComments, self.Module.PcdComments)\r
52302d4d
LG
3690 return self._ModulePcdList\r
3691\r
3692 ## Get the list of PCDs from dependent libraries\r
3693 #\r
3694 # @retval list The list of PCD\r
3695 #\r
3696 def _GetLibraryPcdList(self):\r
3697 if self._LibraryPcdList == None:\r
79b74a03 3698 Pcds = sdict()\r
52302d4d
LG
3699 if not self.IsLibrary:\r
3700 # get PCDs from dependent libraries\r
3701 for Library in self.DependentLibraryList:\r
e8a47801 3702 self.UpdateComments(self._PcdComments, Library.PcdComments)\r
52302d4d
LG
3703 for Key in Library.Pcds:\r
3704 # skip duplicated PCDs\r
3705 if Key in self.Module.Pcds or Key in Pcds:\r
3706 continue\r
3707 Pcds[Key] = copy.copy(Library.Pcds[Key])\r
3708 # apply PCD settings from platform\r
3709 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)\r
3710 else:\r
3711 self._LibraryPcdList = []\r
3712 return self._LibraryPcdList\r
3713\r
3714 ## Get the GUID value mapping\r
3715 #\r
3716 # @retval dict The mapping between GUID cname and its value\r
3717 #\r
3718 def _GetGuidList(self):\r
3719 if self._GuidList == None:\r
8200fcfe
YL
3720 self._GuidList = sdict()\r
3721 self._GuidList.update(self.Module.Guids)\r
52302d4d
LG
3722 for Library in self.DependentLibraryList:\r
3723 self._GuidList.update(Library.Guids)\r
e8a47801
LG
3724 self.UpdateComments(self._GuidComments, Library.GuidComments)\r
3725 self.UpdateComments(self._GuidComments, self.Module.GuidComments)\r
52302d4d
LG
3726 return self._GuidList\r
3727\r
e8a47801
LG
3728 def GetGuidsUsedByPcd(self):\r
3729 if self._GuidsUsedByPcd == None:\r
3730 self._GuidsUsedByPcd = sdict()\r
3731 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())\r
3732 for Library in self.DependentLibraryList:\r
3733 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())\r
3734 return self._GuidsUsedByPcd\r
52302d4d
LG
3735 ## Get the protocol value mapping\r
3736 #\r
3737 # @retval dict The mapping between protocol cname and its value\r
3738 #\r
3739 def _GetProtocolList(self):\r
3740 if self._ProtocolList == None:\r
8200fcfe
YL
3741 self._ProtocolList = sdict()\r
3742 self._ProtocolList.update(self.Module.Protocols)\r
52302d4d
LG
3743 for Library in self.DependentLibraryList:\r
3744 self._ProtocolList.update(Library.Protocols)\r
e8a47801
LG
3745 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)\r
3746 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)\r
52302d4d
LG
3747 return self._ProtocolList\r
3748\r
3749 ## Get the PPI value mapping\r
3750 #\r
3751 # @retval dict The mapping between PPI cname and its value\r
3752 #\r
3753 def _GetPpiList(self):\r
3754 if self._PpiList == None:\r
8200fcfe
YL
3755 self._PpiList = sdict()\r
3756 self._PpiList.update(self.Module.Ppis)\r
52302d4d
LG
3757 for Library in self.DependentLibraryList:\r
3758 self._PpiList.update(Library.Ppis)\r
e8a47801
LG
3759 self.UpdateComments(self._PpiComments, Library.PpiComments)\r
3760 self.UpdateComments(self._PpiComments, self.Module.PpiComments)\r
52302d4d
LG
3761 return self._PpiList\r
3762\r
3763 ## Get the list of include search path\r
3764 #\r
3765 # @retval list The list path\r
3766 #\r
3767 def _GetIncludePathList(self):\r
3768 if self._IncludePathList == None:\r
3769 self._IncludePathList = []\r
3770 if self.AutoGenVersion < 0x00010005:\r
3771 for Inc in self.Module.Includes:\r
3772 if Inc not in self._IncludePathList:\r
3773 self._IncludePathList.append(Inc)\r
b36d134f 3774 # for Edk modules\r
52302d4d
LG
3775 Inc = path.join(Inc, self.Arch.capitalize())\r
3776 if os.path.exists(Inc) and Inc not in self._IncludePathList:\r
3777 self._IncludePathList.append(Inc)\r
b36d134f 3778 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time\r
52302d4d
LG
3779 self._IncludePathList.append(self.DebugDir)\r
3780 else:\r
3781 self._IncludePathList.append(self.MetaFile.Dir)\r
3782 self._IncludePathList.append(self.DebugDir)\r
3783\r
3784 for Package in self.Module.Packages:\r
05cc51ad 3785 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)\r
52302d4d
LG
3786 if PackageDir not in self._IncludePathList:\r
3787 self._IncludePathList.append(PackageDir)\r
c28d2e10
YZ
3788 IncludesList = Package.Includes\r
3789 if Package._PrivateIncludes:\r
3790 if not self.MetaFile.Path.startswith(PackageDir):\r
3791 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))\r
3792 for Inc in IncludesList:\r
52302d4d
LG
3793 if Inc not in self._IncludePathList:\r
3794 self._IncludePathList.append(str(Inc))\r
3795 return self._IncludePathList\r
3796\r
725cdb8f
YZ
3797 def _GetIncludePathLength(self):\r
3798 self._IncludePathLength = 0\r
3799 if self._IncludePathList:\r
3800 for inc in self._IncludePathList:\r
3801 self._IncludePathLength += len(' ' + inc)\r
3802 return self._IncludePathLength\r
3803\r
97fa0ee9
YL
3804 ## Get HII EX PCDs which maybe used by VFR\r
3805 #\r
3806 # efivarstore used by VFR may relate with HII EX PCDs\r
3807 # Get the variable name and GUID from efivarstore and HII EX PCD\r
3808 # List the HII EX PCDs in As Built INF if both name and GUID match.\r
3809 #\r
3810 # @retval list HII EX PCDs\r
3811 #\r
3812 def _GetPcdsMaybeUsedByVfr(self):\r
3813 if not self.SourceFileList:\r
3814 return []\r
3815\r
3816 NameGuids = []\r
3817 for SrcFile in self.SourceFileList:\r
3818 if SrcFile.Ext.lower() != '.vfr':\r
3819 continue\r
3820 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')\r
3821 if not os.path.exists(Vfri):\r
3822 continue\r
3823 VfriFile = open(Vfri, 'r')\r
3824 Content = VfriFile.read()\r
3825 VfriFile.close()\r
3826 Pos = Content.find('efivarstore')\r
3827 while Pos != -1:\r
3828 #\r
3829 # Make sure 'efivarstore' is the start of efivarstore statement\r
3830 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'\r
3831 #\r
3832 Index = Pos - 1\r
3833 while Index >= 0 and Content[Index] in ' \t\r\n':\r
3834 Index -= 1\r
3835 if Index >= 0 and Content[Index] != ';':\r
3836 Pos = Content.find('efivarstore', Pos + len('efivarstore'))\r
3837 continue\r
3838 #\r
3839 # 'efivarstore' must be followed by name and guid\r
3840 #\r
3841 Name = gEfiVarStoreNamePattern.search(Content, Pos)\r
3842 if not Name:\r
3843 break\r
3844 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)\r
3845 if not Guid:\r
3846 break\r
3847 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')\r
3848 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))\r
3849 Pos = Content.find('efivarstore', Name.end())\r
3850 if not NameGuids:\r
3851 return []\r
3852 HiiExPcds = []\r
3853 for Pcd in self.PlatformInfo.Platform.Pcds.values():\r
3854 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:\r
3855 continue\r
3856 for SkuName in Pcd.SkuInfoList:\r
3857 SkuInfo = Pcd.SkuInfoList[SkuName]\r
3858 Name = ConvertStringToByteArray(SkuInfo.VariableName)\r
c28d2e10 3859 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)\r
97fa0ee9
YL
3860 if not Value:\r
3861 continue\r
3862 Guid = GuidStructureStringToGuidString(Value)\r
3863 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:\r
3864 HiiExPcds.append(Pcd)\r
3865 break\r
3866\r
3867 return HiiExPcds\r
3868\r
aeaaf754
YL
3869 def _GenOffsetBin(self):\r
3870 VfrUniBaseName = {}\r
3871 for SourceFile in self.Module.Sources:\r
3872 if SourceFile.Type.upper() == ".VFR" :\r
3873 #\r
3874 # search the .map file to find the offset of vfr binary in the PE32+/TE file. \r
3875 #\r
3876 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")\r
3877 if SourceFile.Type.upper() == ".UNI" :\r
3878 #\r
3879 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file. \r
3880 #\r
3881 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")\r
3882\r
3883 if len(VfrUniBaseName) == 0:\r
3884 return None\r
3885 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")\r
3886 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")\r
3887 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())\r
3888 if not VfrUniOffsetList:\r
3889 return None\r
3890\r
3891 OutputName = '%sOffset.bin' % self.Name\r
3892 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)\r
3893\r
3894 try:\r
3895 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)\r
3896 except:\r
3897 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)\r
3898\r
3899 # Use a instance of StringIO to cache data\r
3900 fStringIO = StringIO('') \r
3901\r
3902 for Item in VfrUniOffsetList:\r
3903 if (Item[0].find("Strings") != -1):\r
3904 #\r
3905 # UNI offset in image.\r
3906 # GUID + Offset\r
3907 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
3908 #\r
3909 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]\r
3910 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]\r
3911 fStringIO.write(''.join(UniGuid)) \r
3912 UniValue = pack ('Q', int (Item[1], 16))\r
3913 fStringIO.write (UniValue)\r
3914 else:\r
3915 #\r
3916 # VFR binary offset in image.\r
3917 # GUID + Offset\r
3918 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };\r
3919 #\r
3920 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]\r
3921 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]\r
3922 fStringIO.write(''.join(VfrGuid)) \r
3923 type (Item[1]) \r
3924 VfrValue = pack ('Q', int (Item[1], 16))\r
3925 fStringIO.write (VfrValue)\r
3926 #\r
3927 # write data into file.\r
3928 #\r
3929 try : \r
3930 fInputfile.write (fStringIO.getvalue())\r
3931 except:\r
3932 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "\r
3933 "file been locked or using by other applications." %UniVfrOffsetFileName,None)\r
3934\r
3935 fStringIO.close ()\r
3936 fInputfile.close ()\r
3937 return OutputName\r
3938\r
da92f276
LG
3939 ## Create AsBuilt INF file the module\r
3940 #\r
83397f95
YZ
3941 def CreateAsBuiltInf(self, IsOnlyCopy = False):\r
3942 self.OutputFile = []\r
3943 if IsOnlyCopy:\r
3944 if GlobalData.gBinCacheDest:\r
3945 self.CopyModuleToCache()\r
3946 return\r
3947\r
da92f276
LG
3948 if self.IsAsBuiltInfCreated:\r
3949 return\r
3950 \r
3951 # Skip the following code for EDK I inf\r
3952 if self.AutoGenVersion < 0x00010005:\r
3953 return\r
3954 \r
3955 # Skip the following code for libraries\r
3956 if self.IsLibrary:\r
3957 return\r
3958 \r
3959 # Skip the following code for modules with no source files\r
3960 if self.SourceFileList == None or self.SourceFileList == []:\r
3961 return\r
3962\r
3963 # Skip the following code for modules without any binary files\r
3964 if self.BinaryFileList <> None and self.BinaryFileList <> []:\r
3965 return\r
3966 \r
3967 ### TODO: How to handles mixed source and binary modules\r
3968\r
e8a47801 3969 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries\r
da92f276
LG
3970 # Also find all packages that the DynamicEx PCDs depend on\r
3971 Pcds = []\r
e5cf9198 3972 PatchablePcds = []\r
47fea6af 3973 Packages = []\r
e8a47801
LG
3974 PcdCheckList = []\r
3975 PcdTokenSpaceList = []\r
da92f276 3976 for Pcd in self.ModulePcdList + self.LibraryPcdList:\r
e8a47801 3977 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
e5cf9198 3978 PatchablePcds += [Pcd]\r
e8a47801
LG
3979 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))\r
3980 elif Pcd.Type in GenC.gDynamicExPcd:\r
3981 if Pcd not in Pcds:\r
3982 Pcds += [Pcd]\r
3983 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))\r
3984 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))\r
3985 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)\r
3986 GuidList = sdict()\r
3987 GuidList.update(self.GuidList)\r
3988 for TokenSpace in self.GetGuidsUsedByPcd():\r
3989 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list\r
3990 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs\r
3991 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:\r
3992 GuidList.pop(TokenSpace)\r
3993 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)\r
3994 for Package in self.DerivedPackageList:\r
3995 if Package in Packages:\r
3996 continue\r
3997 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)\r
3998 Found = False\r
3999 for Index in range(len(BeChecked)):\r
4000 for Item in CheckList[Index]:\r
4001 if Item in BeChecked[Index]:\r
4002 Packages += [Package]\r
4003 Found = True\r
4004 break\r
4005 if Found: break\r
da92f276 4006\r
97fa0ee9
YL
4007 VfrPcds = self._GetPcdsMaybeUsedByVfr()\r
4008 for Pkg in self.PlatformInfo.PackageList:\r
4009 if Pkg in Packages:\r
4010 continue\r
4011 for VfrPcd in VfrPcds:\r
4012 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or\r
4013 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):\r
4014 Packages += [Pkg]\r
4015 break\r
4016\r
da92f276
LG
4017 ModuleType = self.ModuleType\r
4018 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:\r
e8a47801
LG
4019 ModuleType = 'DXE_DRIVER'\r
4020\r
4021 DriverType = ''\r
4022 if self.PcdIsDriver != '':\r
4023 DriverType = self.PcdIsDriver\r
da92f276 4024\r
97fa0ee9
YL
4025 Guid = self.Guid\r
4026 MDefs = self.Module.Defines\r
4027\r
da92f276
LG
4028 AsBuiltInfDict = {\r
4029 'module_name' : self.Name,\r
97fa0ee9 4030 'module_guid' : Guid,\r
da92f276 4031 'module_module_type' : ModuleType,\r
97fa0ee9 4032 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],\r
e8a47801 4033 'pcd_is_driver_string' : [],\r
da92f276
LG
4034 'module_uefi_specification_version' : [],\r
4035 'module_pi_specification_version' : [],\r
97fa0ee9
YL
4036 'module_entry_point' : self.Module.ModuleEntryPointList,\r
4037 'module_unload_image' : self.Module.ModuleUnloadImageList,\r
4038 'module_constructor' : self.Module.ConstructorList,\r
4039 'module_destructor' : self.Module.DestructorList,\r
4040 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],\r
4041 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],\r
4042 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],\r
4043 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],\r
4044 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],\r
4045 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],\r
4046 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],\r
4047 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],\r
4048 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],\r
da92f276 4049 'module_arch' : self.Arch,\r
47fea6af 4050 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],\r
da92f276 4051 'binary_item' : [],\r
e8a47801 4052 'patchablepcd_item' : [],\r
da92f276 4053 'pcd_item' : [],\r
e8a47801
LG
4054 'protocol_item' : [],\r
4055 'ppi_item' : [],\r
4056 'guid_item' : [],\r
4057 'flags_item' : [],\r
4058 'libraryclasses_item' : []\r
da92f276 4059 }\r
97fa0ee9 4060\r
78bcd52a
YZ
4061 if 'MODULE_UNI_FILE' in MDefs:\r
4062 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])\r
4063 if os.path.isfile(UNIFile):\r
4064 shutil.copy2(UNIFile, self.OutputDir)\r
4065\r
97fa0ee9
YL
4066 if self.AutoGenVersion > int(gInfSpecVersion, 0):\r
4067 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion\r
4068 else:\r
4069 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion\r
4070\r
e8a47801
LG
4071 if DriverType:\r
4072 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]\r
da92f276
LG
4073\r
4074 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:\r
481252bb 4075 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]\r
da92f276 4076 if 'PI_SPECIFICATION_VERSION' in self.Specification:\r
481252bb 4077 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]\r
da92f276 4078\r
47fea6af 4079 OutputDir = self.OutputDir.replace('\\', '/').strip('/')\r
481252bb 4080 for Item in self.CodaTargetList:\r
47fea6af 4081 File = Item.Target.Path.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')\r
36d083ef
YZ
4082 if File not in self.OutputFile:\r
4083 self.OutputFile.append(File)\r
47fea6af 4084 if Item.Target.Ext.lower() == '.aml':\r
481252bb 4085 AsBuiltInfDict['binary_item'] += ['ASL|' + File]\r
47fea6af 4086 elif Item.Target.Ext.lower() == '.acpi':\r
481252bb
YZ
4087 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]\r
4088 elif Item.Target.Ext.lower() == '.efi':\r
4089 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']\r
da92f276 4090 else:\r
481252bb
YZ
4091 AsBuiltInfDict['binary_item'] += ['BIN|' + File]\r
4092 if self.DepexGenerated:\r
36d083ef
YZ
4093 if self.Name + '.depex' not in self.OutputFile:\r
4094 self.OutputFile.append(self.Name + '.depex')\r
da92f276 4095 if self.ModuleType in ['PEIM']:\r
481252bb 4096 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']\r
47fea6af 4097 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:\r
481252bb 4098 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']\r
da92f276 4099 if self.ModuleType in ['DXE_SMM_DRIVER']:\r
481252bb 4100 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']\r
da92f276 4101\r
aeaaf754
YL
4102 Bin = self._GenOffsetBin()\r
4103 if Bin:\r
4104 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]\r
36d083ef
YZ
4105 if Bin not in self.OutputFile:\r
4106 self.OutputFile.append(Bin)\r
aeaaf754 4107\r
e8a47801
LG
4108 for Root, Dirs, Files in os.walk(OutputDir):\r
4109 for File in Files:\r
4110 if File.lower().endswith('.pdb'):\r
4111 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]\r
36d083ef
YZ
4112 if File not in self.OutputFile:\r
4113 self.OutputFile.append(File)\r
e8a47801
LG
4114 HeaderComments = self.Module.HeaderComments\r
4115 StartPos = 0\r
4116 for Index in range(len(HeaderComments)):\r
4117 if HeaderComments[Index].find('@BinaryHeader') != -1:\r
4118 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')\r
4119 StartPos = Index\r
4120 break\r
4121 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')\r
97fa0ee9
YL
4122 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)\r
4123\r
e8a47801
LG
4124 GenList = [\r
4125 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),\r
4126 (self.PpiList, self._PpiComments, 'ppi_item'),\r
4127 (GuidList, self._GuidComments, 'guid_item')\r
4128 ]\r
4129 for Item in GenList:\r
4130 for CName in Item[0]:\r
4131 Comments = ''\r
4132 if CName in Item[1]:\r
4133 Comments = '\n '.join(Item[1][CName])\r
4134 Entry = CName\r
4135 if Comments:\r
4136 Entry = Comments + '\n ' + CName\r
4137 AsBuiltInfDict[Item[2]].append(Entry)\r
4138 PatchList = parsePcdInfoFromMapFile(\r
4139 os.path.join(self.OutputDir, self.Name + '.map'),\r
4140 os.path.join(self.OutputDir, self.Name + '.efi')\r
4141 )\r
4142 if PatchList:\r
e5cf9198
YZ
4143 for Pcd in PatchablePcds:\r
4144 TokenCName = Pcd.TokenCName\r
4145 for PcdItem in GlobalData.MixedPcd:\r
4146 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
4147 TokenCName = PcdItem[0]\r
4148 break\r
4149 for PatchPcd in PatchList:\r
4150 if TokenCName == PatchPcd[0]:\r
4151 break\r
2a29017e 4152 else:\r
e8a47801 4153 continue\r
e8a47801 4154 PcdValue = ''\r
7ced8bb4
YZ
4155 if Pcd.DatumType == 'BOOLEAN':\r
4156 BoolValue = Pcd.DefaultValue.upper()\r
4157 if BoolValue == 'TRUE':\r
4158 Pcd.DefaultValue = '1'\r
4159 elif BoolValue == 'FALSE':\r
4160 Pcd.DefaultValue = '0'\r
4161\r
ae7b6df8 4162 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:\r
e8a47801
LG
4163 HexFormat = '0x%02x'\r
4164 if Pcd.DatumType == 'UINT16':\r
4165 HexFormat = '0x%04x'\r
4166 elif Pcd.DatumType == 'UINT32':\r
4167 HexFormat = '0x%08x'\r
4168 elif Pcd.DatumType == 'UINT64':\r
4169 HexFormat = '0x%016x'\r
4170 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)\r
4171 else:\r
4172 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':\r
4173 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4174 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4175 )\r
4176 ArraySize = int(Pcd.MaxDatumSize, 0)\r
4177 PcdValue = Pcd.DefaultValue\r
4178 if PcdValue[0] != '{':\r
4179 Unicode = False\r
4180 if PcdValue[0] == 'L':\r
4181 Unicode = True\r
4182 PcdValue = PcdValue.lstrip('L')\r
4183 PcdValue = eval(PcdValue)\r
4184 NewValue = '{'\r
4185 for Index in range(0, len(PcdValue)):\r
4186 if Unicode:\r
4187 CharVal = ord(PcdValue[Index])\r
4188 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \\r
4189 + '0x%02x' % (CharVal >> 8) + ', '\r
4190 else:\r
4191 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '\r
4192 Padding = '0x00, '\r
4193 if Unicode:\r
4194 Padding = Padding * 2\r
4195 ArraySize = ArraySize / 2\r
4196 if ArraySize < (len(PcdValue) + 1):\r
4197 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4198 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4199 )\r
4200 if ArraySize > len(PcdValue) + 1:\r
4201 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)\r
4202 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'\r
4203 elif len(PcdValue.split(',')) <= ArraySize:\r
4204 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))\r
4205 PcdValue += '}'\r
4206 else:\r
4207 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4208 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4209 )\r
4210 PcdItem = '%s.%s|%s|0x%X' % \\r
2a29017e 4211 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])\r
e8a47801
LG
4212 PcdComments = ''\r
4213 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
4214 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])\r
4215 if PcdComments:\r
4216 PcdItem = PcdComments + '\n ' + PcdItem\r
4217 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)\r
97fa0ee9
YL
4218\r
4219 HiiPcds = []\r
4220 for Pcd in Pcds + VfrPcds:\r
e8a47801
LG
4221 PcdComments = ''\r
4222 PcdCommentList = []\r
4223 HiiInfo = ''\r
97fa0ee9 4224 SkuId = ''\r
2a29017e
YZ
4225 TokenCName = Pcd.TokenCName\r
4226 for PcdItem in GlobalData.MixedPcd:\r
4227 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
4228 TokenCName = PcdItem[0]\r
4229 break\r
e8a47801
LG
4230 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:\r
4231 for SkuName in Pcd.SkuInfoList:\r
4232 SkuInfo = Pcd.SkuInfoList[SkuName]\r
97fa0ee9 4233 SkuId = SkuInfo.SkuId\r
e8a47801
LG
4234 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)\r
4235 break\r
97fa0ee9
YL
4236 if SkuId:\r
4237 #\r
4238 # Don't generate duplicated HII PCD\r
4239 #\r
4240 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:\r
4241 continue\r
4242 else:\r
4243 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
e8a47801
LG
4244 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
4245 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]\r
4246 if HiiInfo:\r
4247 UsageIndex = -1\r
97fa0ee9 4248 UsageStr = ''\r
e8a47801
LG
4249 for Index, Comment in enumerate(PcdCommentList):\r
4250 for Usage in UsageList:\r
4251 if Comment.find(Usage) != -1:\r
97fa0ee9 4252 UsageStr = Usage\r
e8a47801
LG
4253 UsageIndex = Index\r
4254 break\r
4255 if UsageIndex != -1:\r
97fa0ee9 4256 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, '')) \r
e8a47801 4257 else:\r
97fa0ee9 4258 PcdCommentList.append('## UNDEFINED ' + HiiInfo)\r
e8a47801 4259 PcdComments = '\n '.join(PcdCommentList)\r
2a29017e 4260 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName\r
e8a47801
LG
4261 if PcdComments:\r
4262 PcdEntry = PcdComments + '\n ' + PcdEntry\r
4263 AsBuiltInfDict['pcd_item'] += [PcdEntry]\r
da92f276 4264 for Item in self.BuildOption:\r
481252bb
YZ
4265 if 'FLAGS' in self.BuildOption[Item]:\r
4266 AsBuiltInfDict['flags_item'] += ['%s:%s_%s_%s_%s_FLAGS = %s' % (self.ToolChainFamily, self.BuildTarget, self.ToolChain, self.Arch, Item, self.BuildOption[Item]['FLAGS'].strip())]\r
97fa0ee9
YL
4267\r
4268 # Generated LibraryClasses section in comments.\r
4269 for Library in self.LibraryAutoGenList:\r
4270 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]\r
4271 \r
dfa41b4a
YZ
4272 # Generated UserExtensions TianoCore section.\r
4273 # All tianocore user extensions are copied.\r
4274 UserExtStr = ''\r
4275 for TianoCore in self._GetTianoCoreUserExtensionList():\r
4276 UserExtStr += '\n'.join(TianoCore)\r
4277 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])\r
4278 if os.path.isfile(ExtensionFile):\r
4279 shutil.copy2(ExtensionFile, self.OutputDir)\r
4280 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr\r
4281\r
97fa0ee9
YL
4282 # Generated depex expression section in comments.\r
4283 AsBuiltInfDict['depexsection_item'] = ''\r
4284 DepexExpresion = self._GetDepexExpresionString()\r
4285 if DepexExpresion:\r
4286 AsBuiltInfDict['depexsection_item'] = DepexExpresion\r
da92f276
LG
4287 \r
4288 AsBuiltInf = TemplateString()\r
4289 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))\r
4290 \r
4291 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)\r
4292 \r
4293 self.IsAsBuiltInfCreated = True\r
36d083ef
YZ
4294 if GlobalData.gBinCacheDest:\r
4295 self.CopyModuleToCache()\r
4296\r
4297 def CopyModuleToCache(self):\r
4298 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
4299 CreateDirectory (FileDir)\r
4300 HashFile = path.join(self.BuildDir, self.Name + '.hash')\r
4301 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')\r
4302 if os.path.exists(HashFile):\r
4303 shutil.copy2(HashFile, FileDir)\r
4304 if os.path.exists(ModuleFile):\r
4305 shutil.copy2(ModuleFile, FileDir)\r
83397f95
YZ
4306 if not self.OutputFile:\r
4307 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]\r
4308 self.OutputFile = Ma.Binaries\r
36d083ef
YZ
4309 if self.OutputFile:\r
4310 for File in self.OutputFile:\r
83397f95 4311 File = str(File)\r
36d083ef
YZ
4312 if not os.path.isabs(File):\r
4313 File = os.path.join(self.OutputDir, File)\r
4314 if os.path.exists(File):\r
4315 shutil.copy2(File, FileDir)\r
4316\r
4317 def AttemptModuleCacheCopy(self):\r
4318 if self.IsBinaryModule:\r
4319 return False\r
4320 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
4321 HashFile = path.join(FileDir, self.Name + '.hash')\r
4322 if os.path.exists(HashFile):\r
4323 f = open(HashFile, 'r')\r
4324 CacheHash = f.read()\r
4325 f.close()\r
4326 if GlobalData.gModuleHash[self.Arch][self.Name]:\r
4327 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:\r
4328 for root, dir, files in os.walk(FileDir):\r
4329 for f in files:\r
4330 if self.Name + '.hash' in f:\r
4331 shutil.copy2(HashFile, self.BuildDir)\r
4332 else:\r
4333 File = path.join(root, f)\r
4334 shutil.copy2(File, self.OutputDir)\r
4335 if self.Name == "PcdPeim" or self.Name == "PcdDxe":\r
4336 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
4337 return True\r
4338 return False\r
4339\r
52302d4d
LG
4340 ## Create makefile for the module and its dependent libraries\r
4341 #\r
4342 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of\r
4343 # dependent libraries will be created\r
4344 #\r
37de70b7 4345 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):\r
fae62ff2 4346 # Ignore generating makefile when it is a binary module\r
a0a2cd1e
FB
4347 if self.IsBinaryModule:\r
4348 return\r
fae62ff2 4349\r
52302d4d
LG
4350 if self.IsMakeFileCreated:\r
4351 return\r
37de70b7 4352 self.GenFfsList = GenFfsList\r
52302d4d
LG
4353 if not self.IsLibrary and CreateLibraryMakeFile:\r
4354 for LibraryAutoGen in self.LibraryAutoGenList:\r
4355 LibraryAutoGen.CreateMakeFile()\r
4356\r
36513f3a
YZ
4357 if self.CanSkip():\r
4358 return\r
4359\r
52302d4d
LG
4360 if len(self.CustomMakefile) == 0:\r
4361 Makefile = GenMake.ModuleMakefile(self)\r
4362 else:\r
4363 Makefile = GenMake.CustomMakefile(self)\r
4364 if Makefile.Generate():\r
4365 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %\r
4366 (self.Name, self.Arch))\r
4367 else:\r
4368 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %\r
4369 (self.Name, self.Arch))\r
4370\r
c17956e0 4371 self.CreateTimeStamp(Makefile)\r
52302d4d
LG
4372 self.IsMakeFileCreated = True\r
4373\r
a0a2cd1e
FB
4374 def CopyBinaryFiles(self):\r
4375 for File in self.Module.Binaries:\r
4376 SrcPath = File.Path\r
4377 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))\r
4378 CopyLongFilePath(SrcPath, DstPath)\r
52302d4d
LG
4379 ## Create autogen code for the module and its dependent libraries\r
4380 #\r
4381 # @param CreateLibraryCodeFile Flag indicating if or not the code of\r
4382 # dependent libraries will be created\r
4383 #\r
4384 def CreateCodeFile(self, CreateLibraryCodeFile=True):\r
4385 if self.IsCodeFileCreated:\r
4386 return\r
4387\r
e8a47801
LG
4388 # Need to generate PcdDatabase even PcdDriver is binarymodule\r
4389 if self.IsBinaryModule and self.PcdIsDriver != '':\r
4390 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
4391 return\r
a0a2cd1e 4392 if self.IsBinaryModule:\r
49d9b71d
HC
4393 if self.IsLibrary:\r
4394 self.CopyBinaryFiles()\r
a0a2cd1e 4395 return\r
e8a47801 4396\r
52302d4d
LG
4397 if not self.IsLibrary and CreateLibraryCodeFile:\r
4398 for LibraryAutoGen in self.LibraryAutoGenList:\r
4399 LibraryAutoGen.CreateCodeFile()\r
4400\r
36513f3a
YZ
4401 if self.CanSkip():\r
4402 return\r
4403\r
52302d4d
LG
4404 AutoGenList = []\r
4405 IgoredAutoGenList = []\r
4406\r
4407 for File in self.AutoGenFileList:\r
4408 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):\r
b36d134f 4409 #Ignore Edk AutoGen.c\r
52302d4d
LG
4410 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':\r
4411 continue\r
4412\r
4413 AutoGenList.append(str(File))\r
4414 else:\r
4415 IgoredAutoGenList.append(str(File))\r
4416\r
4417 # Skip the following code for EDK I inf\r
4418 if self.AutoGenVersion < 0x00010005:\r
4419 return\r
4420\r
4421 for ModuleType in self.DepexList:\r
40d841f6
LG
4422 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module\r
4423 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":\r
52302d4d 4424 continue\r
40d841f6 4425\r
52302d4d
LG
4426 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)\r
4427 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}\r
4428\r
da92f276 4429 if len(Dpx.PostfixNotation) <> 0:\r
0d2711a6 4430 self.DepexGenerated = True\r
da92f276 4431\r
52302d4d
LG
4432 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):\r
4433 AutoGenList.append(str(DpxFile))\r
4434 else:\r
4435 IgoredAutoGenList.append(str(DpxFile))\r
4436\r
4437 if IgoredAutoGenList == []:\r
4438 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %\r
4439 (" ".join(AutoGenList), self.Name, self.Arch))\r
4440 elif AutoGenList == []:\r
4441 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %\r
4442 (" ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4443 else:\r
4444 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %\r
4445 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4446\r
4447 self.IsCodeFileCreated = True\r
4448 return AutoGenList\r
4449\r
4450 ## Summarize the ModuleAutoGen objects of all libraries used by this module\r
4451 def _GetLibraryAutoGenList(self):\r
4452 if self._LibraryAutoGenList == None:\r
4453 self._LibraryAutoGenList = []\r
4454 for Library in self.DependentLibraryList:\r
4455 La = ModuleAutoGen(\r
4456 self.Workspace,\r
4457 Library.MetaFile,\r
4458 self.BuildTarget,\r
4459 self.ToolChain,\r
4460 self.Arch,\r
4461 self.PlatformInfo.MetaFile\r
4462 )\r
4463 if La not in self._LibraryAutoGenList:\r
4464 self._LibraryAutoGenList.append(La)\r
4465 for Lib in La.CodaTargetList:\r
4466 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)\r
4467 return self._LibraryAutoGenList\r
4468\r
36d083ef
YZ
4469 def GenModuleHash(self):\r
4470 if self.Arch not in GlobalData.gModuleHash:\r
4471 GlobalData.gModuleHash[self.Arch] = {}\r
4472 m = hashlib.md5()\r
4473 # Add Platform level hash\r
4474 m.update(GlobalData.gPlatformHash)\r
4475 # Add Package level hash\r
4476 if self.DependentPackageList:\r
4477 for Pkg in self.DependentPackageList:\r
4478 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:\r
4479 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])\r
4480\r
4481 # Add Library hash\r
4482 if self.LibraryAutoGenList:\r
4483 for Lib in self.LibraryAutoGenList:\r
4484 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:\r
4485 Lib.GenModuleHash()\r
4486 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])\r
4487\r
4488 # Add Module self\r
4489 f = open(str(self.MetaFile), 'r')\r
4490 Content = f.read()\r
4491 f.close()\r
4492 m.update(Content)\r
4493 # Add Module's source files\r
4494 if self.SourceFileList:\r
4495 for File in self.SourceFileList:\r
4496 f = open(str(File), 'r')\r
4497 Content = f.read()\r
4498 f.close()\r
4499 m.update(Content)\r
4500\r
4501 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")\r
4502 if self.Name not in GlobalData.gModuleHash[self.Arch]:\r
4503 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()\r
4504 if GlobalData.gBinCacheSource:\r
4505 CacheValid = self.AttemptModuleCacheCopy()\r
4506 if CacheValid:\r
4507 return False\r
4508 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)\r
4509\r
4510 ## Decide whether we can skip the ModuleAutoGen process\r
4511 def CanSkipbyHash(self):\r
4512 if GlobalData.gUseHashCache:\r
4513 return not self.GenModuleHash()\r
4514\r
c17956e0 4515 ## Decide whether we can skip the ModuleAutoGen process\r
36d083ef 4516 # If any source file is newer than the module than we cannot skip\r
c17956e0
DL
4517 #\r
4518 def CanSkip(self):\r
4519 if not os.path.exists(self.GetTimeStampPath()):\r
4520 return False\r
4521 #last creation time of the module\r
4522 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]\r
4523\r
4524 SrcTimeStamp = self.Workspace._SrcTimeStamp\r
4525 if SrcTimeStamp > DstTimeStamp:\r
4526 return False\r
4527\r
4528 with open(self.GetTimeStampPath(),'r') as f:\r
4529 for source in f:\r
4530 source = source.rstrip('\n')\r
4a1167df
YZ
4531 if not os.path.exists(source):\r
4532 return False\r
c17956e0
DL
4533 if source not in ModuleAutoGen.TimeDict :\r
4534 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]\r
4535 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:\r
4536 return False\r
4537 return True\r
4538\r
4539 def GetTimeStampPath(self):\r
4540 if self._TimeStampPath == None:\r
4541 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')\r
4542 return self._TimeStampPath\r
4543 def CreateTimeStamp(self, Makefile):\r
4544\r
4545 FileSet = set()\r
4546\r
4547 FileSet.add (self.MetaFile.Path)\r
4548\r
4549 for SourceFile in self.Module.Sources:\r
4550 FileSet.add (SourceFile.Path)\r
4551\r
4552 for Lib in self.DependentLibraryList:\r
4553 FileSet.add (Lib.MetaFile.Path)\r
4554\r
4555 for f in self.AutoGenDepSet:\r
4556 FileSet.add (f.Path)\r
4557\r
4558 if os.path.exists (self.GetTimeStampPath()):\r
4559 os.remove (self.GetTimeStampPath())\r
4560 with open(self.GetTimeStampPath(), 'w+') as file:\r
4561 for f in FileSet:\r
4562 print >> file, f\r
4563\r
52302d4d
LG
4564 Module = property(_GetModule)\r
4565 Name = property(_GetBaseName)\r
4566 Guid = property(_GetGuid)\r
4567 Version = property(_GetVersion)\r
4568 ModuleType = property(_GetModuleType)\r
4569 ComponentType = property(_GetComponentType)\r
4570 BuildType = property(_GetBuildType)\r
4571 PcdIsDriver = property(_GetPcdIsDriver)\r
4572 AutoGenVersion = property(_GetAutoGenVersion)\r
4573 Macros = property(_GetMacros)\r
4574 Specification = property(_GetSpecification)\r
4575\r
4576 IsLibrary = property(_IsLibrary)\r
e8a47801 4577 IsBinaryModule = property(_IsBinaryModule)\r
52302d4d
LG
4578 BuildDir = property(_GetBuildDir)\r
4579 OutputDir = property(_GetOutputDir)\r
37de70b7 4580 FfsOutputDir = property(_GetFfsOutputDir)\r
52302d4d
LG
4581 DebugDir = property(_GetDebugDir)\r
4582 MakeFileDir = property(_GetMakeFileDir)\r
4583 CustomMakefile = property(_GetCustomMakefile)\r
4584\r
4585 IncludePathList = property(_GetIncludePathList)\r
725cdb8f 4586 IncludePathLength = property(_GetIncludePathLength)\r
52302d4d
LG
4587 AutoGenFileList = property(_GetAutoGenFileList)\r
4588 UnicodeFileList = property(_GetUnicodeFileList)\r
5b97eb4c 4589 VfrFileList = property(_GetVfrFileList)\r
52302d4d
LG
4590 SourceFileList = property(_GetSourceFileList)\r
4591 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]\r
4592 Targets = property(_GetTargets)\r
4593 IntroTargetList = property(_GetIntroTargetList)\r
4594 CodaTargetList = property(_GetFinalTargetList)\r
4595 FileTypes = property(_GetFileTypes)\r
4596 BuildRules = property(_GetBuildRules)\r
333ba578 4597 IdfFileList = property(_GetIdfFileList)\r
52302d4d
LG
4598\r
4599 DependentPackageList = property(_GetDependentPackageList)\r
4600 DependentLibraryList = property(_GetLibraryList)\r
4601 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
4602 DerivedPackageList = property(_GetDerivedPackageList)\r
4603\r
4604 ModulePcdList = property(_GetModulePcdList)\r
4605 LibraryPcdList = property(_GetLibraryPcdList)\r
4606 GuidList = property(_GetGuidList)\r
4607 ProtocolList = property(_GetProtocolList)\r
4608 PpiList = property(_GetPpiList)\r
4609 DepexList = property(_GetDepexTokenList)\r
b36d134f 4610 DxsFile = property(_GetDxsFile)\r
52302d4d
LG
4611 DepexExpressionList = property(_GetDepexExpressionTokenList)\r
4612 BuildOption = property(_GetModuleBuildOption)\r
79b74a03 4613 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)\r
52302d4d 4614 BuildCommand = property(_GetBuildCommand)\r
2bc3256c
LG
4615 \r
4616 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)\r
52302d4d
LG
4617\r
4618# This acts like the main() function for the script, unless it is 'import'ed into another script.\r
4619if __name__ == '__main__':\r
4620 pass\r
4621\r