]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTools: Support Structure PCD value inherit between the different SKUs
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
CommitLineData
52302d4d
LG
1## @file\r
2# Generate AutoGen.h, AutoGen.c and *.depex files\r
3#\r
5b97eb4c 4# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
40d841f6 5# This program and the accompanying materials\r
52302d4d
LG
6# are licensed and made available under the terms and conditions of the BSD License\r
7# which accompanies this distribution. The full text of the license may be found at\r
8# http://opensource.org/licenses/bsd-license.php\r
9#\r
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12#\r
13\r
14## Import Modules\r
15#\r
1be2ed90 16import Common.LongFilePathOs as os\r
52302d4d
LG
17import re\r
18import os.path as path\r
19import copy\r
867d1cd4 20import uuid\r
52302d4d
LG
21\r
22import GenC\r
23import GenMake\r
24import GenDepex\r
25from StringIO import StringIO\r
26\r
27from StrGather import *\r
28from BuildEngine import BuildRule\r
29\r
1be2ed90 30from Common.LongFilePathSupport import CopyLongFilePath\r
52302d4d
LG
31from Common.BuildToolError import *\r
32from Common.DataType import *\r
33from Common.Misc import *\r
34from Common.String import *\r
35import Common.GlobalData as GlobalData\r
36from GenFds.FdfParser import *\r
37from CommonDataClass.CommonClass import SkuInfoClass\r
38from Workspace.BuildClassObject import *\r
e8a47801 39from GenPatchPcdTable.GenPatchPcdTable import parsePcdInfoFromMapFile\r
e56468c0 40import Common.VpdInfoFile as VpdInfoFile\r
e8a47801
LG
41from GenPcdDb import CreatePcdDatabaseCode\r
42from Workspace.MetaFileCommentParser import UsageList\r
05cc51ad 43from Common.MultipleWorkspace import MultipleWorkspace as mws\r
97fa0ee9 44import InfSectionParser\r
c17956e0 45import datetime\r
36d083ef 46import hashlib\r
8518bf0b 47from GenVar import VariableMgr,var_info\r
97fa0ee9 48\r
e8a47801 49## Regular expression for splitting Dependency Expression string into tokens\r
52302d4d
LG
50gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")\r
51\r
97fa0ee9
YL
52#\r
53# Match name = variable\r
54#\r
55gEfiVarStoreNamePattern = re.compile("\s*name\s*=\s*(\w+)")\r
56#\r
57# The format of guid in efivarstore statement likes following and must be correct:\r
58# guid = {0xA04A27f4, 0xDF00, 0x4D42, {0xB5, 0x52, 0x39, 0x51, 0x13, 0x02, 0x11, 0x3D}}\r
59#\r
60gEfiVarStoreGuidPattern = re.compile("\s*guid\s*=\s*({.*?{.*?}\s*})")\r
61\r
52302d4d
LG
62## Mapping Makefile type\r
63gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}\r
64\r
65\r
66## Build rule configuration file\r
51de5c30 67gDefaultBuildRuleFile = 'build_rule.txt'\r
52302d4d 68\r
86601b78 69## Tools definition configuration file\r
51de5c30 70gDefaultToolsDefFile = 'tools_def.txt'\r
86601b78 71\r
64b2609f
LG
72## Build rule default version\r
73AutoGenReqBuildRuleVerNum = "0.1"\r
74\r
52302d4d
LG
75## default file name for AutoGen\r
76gAutoGenCodeFileName = "AutoGen.c"\r
77gAutoGenHeaderFileName = "AutoGen.h"\r
78gAutoGenStringFileName = "%(module_name)sStrDefs.h"\r
79gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"\r
80gAutoGenDepexFileName = "%(module_name)s.depex"\r
333ba578
YZ
81gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"\r
82gAutoGenIdfFileName = "%(module_name)sIdf.hpk"\r
97fa0ee9
YL
83gInfSpecVersion = "0x00010017"\r
84\r
da92f276
LG
85#\r
86# Template string to generic AsBuilt INF\r
87#\r
e8a47801 88gAsBuiltInfHeaderString = TemplateString("""${header_comments}\r
da92f276 89\r
97fa0ee9
YL
90# DO NOT EDIT\r
91# FILE auto-generated\r
92\r
da92f276 93[Defines]\r
97fa0ee9 94 INF_VERSION = ${module_inf_version}\r
da92f276
LG
95 BASE_NAME = ${module_name}\r
96 FILE_GUID = ${module_guid}\r
97fa0ee9
YL
97 MODULE_TYPE = ${module_module_type}${BEGIN}\r
98 VERSION_STRING = ${module_version_string}${END}${BEGIN}\r
e8a47801 99 PCD_IS_DRIVER = ${pcd_is_driver_string}${END}${BEGIN}\r
da92f276 100 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}\r
97fa0ee9
YL
101 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}${BEGIN}\r
102 ENTRY_POINT = ${module_entry_point}${END}${BEGIN}\r
103 UNLOAD_IMAGE = ${module_unload_image}${END}${BEGIN}\r
104 CONSTRUCTOR = ${module_constructor}${END}${BEGIN}\r
105 DESTRUCTOR = ${module_destructor}${END}${BEGIN}\r
106 SHADOW = ${module_shadow}${END}${BEGIN}\r
107 PCI_VENDOR_ID = ${module_pci_vendor_id}${END}${BEGIN}\r
108 PCI_DEVICE_ID = ${module_pci_device_id}${END}${BEGIN}\r
109 PCI_CLASS_CODE = ${module_pci_class_code}${END}${BEGIN}\r
110 PCI_REVISION = ${module_pci_revision}${END}${BEGIN}\r
111 BUILD_NUMBER = ${module_build_number}${END}${BEGIN}\r
112 SPEC = ${module_spec}${END}${BEGIN}\r
113 UEFI_HII_RESOURCE_SECTION = ${module_uefi_hii_resource_section}${END}${BEGIN}\r
114 MODULE_UNI_FILE = ${module_uni_file}${END}\r
115\r
116[Packages.${module_arch}]${BEGIN}\r
da92f276
LG
117 ${package_item}${END}\r
118\r
119[Binaries.${module_arch}]${BEGIN}\r
120 ${binary_item}${END}\r
121\r
e8a47801
LG
122[PatchPcd.${module_arch}]${BEGIN}\r
123 ${patchablepcd_item}\r
124${END}\r
97fa0ee9 125\r
e8a47801
LG
126[Protocols.${module_arch}]${BEGIN}\r
127 ${protocol_item}\r
128${END}\r
97fa0ee9 129\r
e8a47801
LG
130[Ppis.${module_arch}]${BEGIN}\r
131 ${ppi_item}\r
132${END}\r
97fa0ee9 133\r
e8a47801
LG
134[Guids.${module_arch}]${BEGIN}\r
135 ${guid_item}\r
136${END}\r
97fa0ee9 137\r
e8a47801
LG
138[PcdEx.${module_arch}]${BEGIN}\r
139 ${pcd_item}\r
140${END}\r
da92f276 141\r
97fa0ee9
YL
142[LibraryClasses.${module_arch}]\r
143## @LIB_INSTANCES${BEGIN}\r
144# ${libraryclasses_item}${END}\r
145\r
146${depexsection_item}\r
147\r
dfa41b4a
YZ
148${userextension_tianocore_item}\r
149\r
97fa0ee9
YL
150${tail_comments}\r
151\r
152[BuildOptions.${module_arch}]\r
da92f276
LG
153## @AsBuilt${BEGIN}\r
154## ${flags_item}${END}\r
155""")\r
156\r
52302d4d
LG
157## Base class for AutoGen\r
158#\r
159# This class just implements the cache mechanism of AutoGen objects.\r
160#\r
161class AutoGen(object):\r
162 # database to maintain the objects of xxxAutoGen\r
163 _CACHE_ = {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}\r
164\r
165 ## Factory method\r
166 #\r
167 # @param Class class object of real AutoGen class\r
168 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)\r
169 # @param Workspace Workspace directory or WorkspaceAutoGen object\r
170 # @param MetaFile The path of meta file\r
171 # @param Target Build target\r
172 # @param Toolchain Tool chain name\r
173 # @param Arch Target arch\r
174 # @param *args The specific class related parameters\r
175 # @param **kwargs The specific class related dict parameters\r
176 #\r
177 def __new__(Class, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
178 # check if the object has been created\r
179 Key = (Target, Toolchain)\r
180 if Key not in Class._CACHE_ or Arch not in Class._CACHE_[Key] \\r
181 or MetaFile not in Class._CACHE_[Key][Arch]:\r
182 AutoGenObject = super(AutoGen, Class).__new__(Class)\r
183 # call real constructor\r
184 if not AutoGenObject._Init(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
185 return None\r
186 if Key not in Class._CACHE_:\r
187 Class._CACHE_[Key] = {}\r
188 if Arch not in Class._CACHE_[Key]:\r
189 Class._CACHE_[Key][Arch] = {}\r
190 Class._CACHE_[Key][Arch][MetaFile] = AutoGenObject\r
191 else:\r
192 AutoGenObject = Class._CACHE_[Key][Arch][MetaFile]\r
193\r
194 return AutoGenObject\r
195\r
196 ## hash() operator\r
197 #\r
198 # The file path of platform file will be used to represent hash value of this object\r
199 #\r
200 # @retval int Hash value of the file path of platform file\r
201 #\r
202 def __hash__(self):\r
203 return hash(self.MetaFile)\r
204\r
205 ## str() operator\r
206 #\r
207 # The file path of platform file will be used to represent this object\r
208 #\r
209 # @retval string String of platform file path\r
210 #\r
211 def __str__(self):\r
212 return str(self.MetaFile)\r
213\r
214 ## "==" operator\r
215 def __eq__(self, Other):\r
216 return Other and self.MetaFile == Other\r
217\r
218## Workspace AutoGen class\r
219#\r
220# This class is used mainly to control the whole platform build for different\r
221# architecture. This class will generate top level makefile.\r
222#\r
223class WorkspaceAutoGen(AutoGen):\r
224 ## Real constructor of WorkspaceAutoGen\r
225 #\r
79b74a03 226 # This method behaves the same as __init__ except that it needs explicit invoke\r
52302d4d
LG
227 # (in super class's __new__ method)\r
228 #\r
229 # @param WorkspaceDir Root directory of workspace\r
230 # @param ActivePlatform Meta-file of active platform\r
231 # @param Target Build target\r
232 # @param Toolchain Tool chain name\r
233 # @param ArchList List of architecture of current build\r
234 # @param MetaFileDb Database containing meta-files\r
235 # @param BuildConfig Configuration of build\r
236 # @param ToolDefinition Tool chain definitions\r
237 # @param FlashDefinitionFile File of flash definition\r
238 # @param Fds FD list to be generated\r
239 # @param Fvs FV list to be generated\r
4234283c 240 # @param Caps Capsule list to be generated\r
52302d4d
LG
241 # @param SkuId SKU id from command line\r
242 #\r
243 def _Init(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,\r
47fea6af 244 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None,\r
9508d0fa 245 Progress=None, BuildModule=None):\r
4234283c
LG
246 if Fds is None:\r
247 Fds = []\r
248 if Fvs is None:\r
249 Fvs = []\r
250 if Caps is None:\r
251 Caps = []\r
0d2711a6
LG
252 self.BuildDatabase = MetaFileDb\r
253 self.MetaFile = ActivePlatform\r
52302d4d 254 self.WorkspaceDir = WorkspaceDir\r
0d2711a6 255 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]\r
d0acc87a 256 GlobalData.gActivePlatform = self.Platform\r
52302d4d
LG
257 self.BuildTarget = Target\r
258 self.ToolChain = Toolchain\r
259 self.ArchList = ArchList\r
260 self.SkuId = SkuId\r
f3decdc3 261 self.UniFlag = UniFlag\r
52302d4d 262\r
52302d4d
LG
263 self.TargetTxt = BuildConfig\r
264 self.ToolDef = ToolDefinition\r
265 self.FdfFile = FlashDefinitionFile\r
266 self.FdTargetList = Fds\r
267 self.FvTargetList = Fvs\r
4234283c 268 self.CapTargetList = Caps\r
52302d4d 269 self.AutoGenObjectList = []\r
36d083ef
YZ
270 self._BuildDir = None\r
271 self._FvDir = None\r
272 self._MakeFileDir = None\r
273 self._BuildCommand = None\r
52302d4d
LG
274\r
275 # there's many relative directory operations, so ...\r
276 os.chdir(self.WorkspaceDir)\r
277\r
0d2711a6
LG
278 #\r
279 # Merge Arch\r
280 #\r
281 if not self.ArchList:\r
282 ArchList = set(self.Platform.SupArchList)\r
283 else:\r
284 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)\r
285 if not ArchList:\r
286 EdkLogger.error("build", PARAMETER_INVALID,\r
287 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))\r
288 elif self.ArchList and len(ArchList) != len(self.ArchList):\r
289 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))\r
290 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"\r
291 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))\r
292 self.ArchList = tuple(ArchList)\r
293\r
294 # Validate build target\r
295 if self.BuildTarget not in self.Platform.BuildTargets:\r
47fea6af 296 EdkLogger.error("build", PARAMETER_INVALID,\r
0d2711a6
LG
297 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"\r
298 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))\r
299\r
12d37ace 300 \r
52302d4d 301 # parse FDF file to get PCDs in it, if any\r
0d2711a6
LG
302 if not self.FdfFile:\r
303 self.FdfFile = self.Platform.FlashDefinition\r
47fea6af 304\r
9508d0fa
LG
305 EdkLogger.info("")\r
306 if self.ArchList:\r
307 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))\r
308 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))\r
47fea6af
YZ
309 EdkLogger.info('%-16s = %s' % ("Toolchain", self.ToolChain))\r
310\r
9508d0fa
LG
311 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))\r
312 if BuildModule:\r
313 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))\r
47fea6af 314\r
9508d0fa
LG
315 if self.FdfFile:\r
316 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))\r
0d2711a6 317\r
9508d0fa 318 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)\r
47fea6af 319\r
ae7b6df8
LG
320# if Progress:\r
321# Progress.Start("\nProcessing meta-data")\r
47fea6af 322\r
0d2711a6 323 if self.FdfFile:\r
df692f02
LG
324 #\r
325 # Mark now build in AutoGen Phase\r
326 #\r
47fea6af 327 GlobalData.gAutoGenPhase = True\r
52302d4d
LG
328 Fdf = FdfParser(self.FdfFile.Path)\r
329 Fdf.ParseFile()\r
a0a2cd1e 330 GlobalData.gFdfParser = Fdf\r
0d2711a6 331 GlobalData.gAutoGenPhase = False\r
52302d4d 332 PcdSet = Fdf.Profile.PcdDict\r
cb04330e
YZ
333 if Fdf.CurrentFdName and Fdf.CurrentFdName in Fdf.Profile.FdDict:\r
334 FdDict = Fdf.Profile.FdDict[Fdf.CurrentFdName]\r
335 for FdRegion in FdDict.RegionList:\r
336 if str(FdRegion.RegionType) is 'FILE' and self.Platform.VpdToolGuid in str(FdRegion.RegionDataList):\r
337 if int(FdRegion.Offset) % 8 != 0:\r
338 EdkLogger.error("build", FORMAT_INVALID, 'The VPD Base Address %s must be 8-byte aligned.' % (FdRegion.Offset))\r
52302d4d
LG
339 ModuleList = Fdf.Profile.InfList\r
340 self.FdfProfile = Fdf.Profile\r
0d2711a6
LG
341 for fvname in self.FvTargetList:\r
342 if fvname.upper() not in self.FdfProfile.FvDict:\r
343 EdkLogger.error("build", OPTION_VALUE_INVALID,\r
344 "No such an FV in FDF file: %s" % fvname)\r
2502b735 345\r
622b1758
YZ
346 # In DSC file may use FILE_GUID to override the module, then in the Platform.Modules use FILE_GUIDmodule.inf as key,\r
347 # but the path (self.MetaFile.Path) is the real path\r
2502b735
YZ
348 for key in self.FdfProfile.InfDict:\r
349 if key == 'ArchTBD':\r
350 Platform_cache = {}\r
622b1758 351 MetaFile_cache = {}\r
2502b735
YZ
352 for Arch in self.ArchList:\r
353 Platform_cache[Arch] = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
622b1758
YZ
354 MetaFile_cache[Arch] = []\r
355 for Pkey in Platform_cache[Arch].Modules.keys():\r
356 MetaFile_cache[Arch].append(Platform_cache[Arch].Modules[Pkey].MetaFile)\r
2502b735
YZ
357 for Inf in self.FdfProfile.InfDict[key]:\r
358 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
359 for Arch in self.ArchList:\r
622b1758 360 if ModuleFile in MetaFile_cache[Arch]:\r
2502b735
YZ
361 break\r
362 else:\r
363 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
364 if not ModuleData.IsBinaryModule:\r
365 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
366\r
367 else:\r
368 for Arch in self.ArchList:\r
369 if Arch == key:\r
370 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
622b1758
YZ
371 MetaFileList = []\r
372 for Pkey in Platform.Modules.keys():\r
373 MetaFileList.append(Platform.Modules[Pkey].MetaFile)\r
2502b735
YZ
374 for Inf in self.FdfProfile.InfDict[key]:\r
375 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
622b1758 376 if ModuleFile in MetaFileList:\r
2502b735
YZ
377 continue\r
378 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
379 if not ModuleData.IsBinaryModule:\r
380 EdkLogger.error('build', PARSER_ERROR, "Module %s NOT found in DSC file; Is it really a binary module?" % ModuleFile)\r
381\r
52302d4d
LG
382 else:\r
383 PcdSet = {}\r
384 ModuleList = []\r
385 self.FdfProfile = None\r
0d2711a6
LG
386 if self.FdTargetList:\r
387 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))\r
388 self.FdTargetList = []\r
389 if self.FvTargetList:\r
390 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))\r
391 self.FvTargetList = []\r
392 if self.CapTargetList:\r
393 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))\r
394 self.CapTargetList = []\r
47fea6af 395\r
52302d4d
LG
396 # apply SKU and inject PCDs from Flash Definition file\r
397 for Arch in self.ArchList:\r
0d2711a6 398 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
64b2609f 399\r
25918452 400 DecPcds = {}\r
4afd3d04 401 DecPcdsKey = set()\r
64b2609f 402 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
763e8edf
YZ
403 if GlobalData.BuildOptionPcd:\r
404 for i, pcd in enumerate(GlobalData.BuildOptionPcd):\r
d7cd3356
YZ
405 if type(pcd) is tuple:\r
406 continue\r
763e8edf
YZ
407 (pcdname, pcdvalue) = pcd.split('=')\r
408 if not pcdvalue:\r
409 EdkLogger.error('build', AUTOGEN_ERROR, "No Value specified for the PCD %s." % (pcdname))\r
410 if '.' in pcdname:\r
411 (TokenSpaceGuidCName, TokenCName) = pcdname.split('.')\r
412 HasTokenSpace = True\r
413 else:\r
414 TokenCName = pcdname\r
415 TokenSpaceGuidCName = ''\r
416 HasTokenSpace = False\r
417 TokenSpaceGuidCNameList = []\r
418 FoundFlag = False\r
419 PcdDatumType = ''\r
420 NewValue = ''\r
421 for package in PGen.PackageList:\r
422 for key in package.Pcds:\r
423 PcdItem = package.Pcds[key]\r
424 if HasTokenSpace:\r
425 if (PcdItem.TokenCName, PcdItem.TokenSpaceGuidCName) == (TokenCName, TokenSpaceGuidCName):\r
426 PcdDatumType = PcdItem.DatumType\r
db55dac7 427 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)\r
763e8edf
YZ
428 FoundFlag = True\r
429 else:\r
430 if PcdItem.TokenCName == TokenCName:\r
431 if not PcdItem.TokenSpaceGuidCName in TokenSpaceGuidCNameList:\r
432 if len (TokenSpaceGuidCNameList) < 1:\r
433 TokenSpaceGuidCNameList.append(PcdItem.TokenSpaceGuidCName)\r
434 PcdDatumType = PcdItem.DatumType\r
435 TokenSpaceGuidCName = PcdItem.TokenSpaceGuidCName\r
db55dac7 436 NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)\r
763e8edf
YZ
437 FoundFlag = True\r
438 else:\r
439 EdkLogger.error(\r
440 'build',\r
441 AUTOGEN_ERROR,\r
442 "The Pcd %s is found under multiple different TokenSpaceGuid: %s and %s." % (TokenCName, PcdItem.TokenSpaceGuidCName, TokenSpaceGuidCNameList[0])\r
443 )\r
444\r
445 GlobalData.BuildOptionPcd[i] = (TokenSpaceGuidCName, TokenCName, NewValue)\r
446\r
447 if not FoundFlag:\r
448 if HasTokenSpace:\r
449 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s.%s is not found in the DEC file." % (TokenSpaceGuidCName, TokenCName))\r
450 else:\r
451 EdkLogger.error('build', AUTOGEN_ERROR, "The Pcd %s is not found in the DEC file." % (TokenCName))\r
452\r
453 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
454 if BuildData.Arch != Arch:\r
455 continue\r
456 if BuildData.MetaFile.Ext == '.dec':\r
457 continue\r
458 for key in BuildData.Pcds:\r
459 PcdItem = BuildData.Pcds[key]\r
460 if (TokenSpaceGuidCName, TokenCName) == (PcdItem.TokenSpaceGuidCName, PcdItem.TokenCName):\r
461 PcdItem.DefaultValue = NewValue\r
462\r
463 if (TokenCName, TokenSpaceGuidCName) in PcdSet:\r
464 PcdSet[(TokenCName, TokenSpaceGuidCName)] = NewValue\r
465\r
2a29017e
YZ
466 SourcePcdDict = {'DynamicEx':[], 'PatchableInModule':[],'Dynamic':[],'FixedAtBuild':[]}\r
467 BinaryPcdDict = {'DynamicEx':[], 'PatchableInModule':[]}\r
468 SourcePcdDict_Keys = SourcePcdDict.keys()\r
469 BinaryPcdDict_Keys = BinaryPcdDict.keys()\r
470\r
471 # generate the SourcePcdDict and BinaryPcdDict\r
472 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
473 if BuildData.Arch != Arch:\r
474 continue\r
475 if BuildData.MetaFile.Ext == '.inf':\r
476 for key in BuildData.Pcds:\r
477 if BuildData.Pcds[key].Pending:\r
478 if key in Platform.Pcds:\r
479 PcdInPlatform = Platform.Pcds[key]\r
480 if PcdInPlatform.Type not in [None, '']:\r
481 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
482\r
483 if BuildData.MetaFile in Platform.Modules:\r
484 PlatformModule = Platform.Modules[str(BuildData.MetaFile)]\r
485 if key in PlatformModule.Pcds:\r
486 PcdInPlatform = PlatformModule.Pcds[key]\r
487 if PcdInPlatform.Type not in [None, '']:\r
488 BuildData.Pcds[key].Type = PcdInPlatform.Type\r
489\r
490 if 'DynamicEx' in BuildData.Pcds[key].Type:\r
491 if BuildData.IsBinaryModule:\r
492 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['DynamicEx']:\r
493 BinaryPcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
494 else:\r
495 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['DynamicEx']:\r
496 SourcePcdDict['DynamicEx'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
497\r
498 elif 'PatchableInModule' in BuildData.Pcds[key].Type:\r
499 if BuildData.MetaFile.Ext == '.inf':\r
500 if BuildData.IsBinaryModule:\r
501 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in BinaryPcdDict['PatchableInModule']:\r
502 BinaryPcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
503 else:\r
504 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['PatchableInModule']:\r
505 SourcePcdDict['PatchableInModule'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
506\r
507 elif 'Dynamic' in BuildData.Pcds[key].Type:\r
508 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['Dynamic']:\r
509 SourcePcdDict['Dynamic'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
510 elif 'FixedAtBuild' in BuildData.Pcds[key].Type:\r
511 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) not in SourcePcdDict['FixedAtBuild']:\r
512 SourcePcdDict['FixedAtBuild'].append((BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName))\r
513 else:\r
514 pass\r
97cdb33b
YZ
515 #\r
516 # A PCD can only use one type for all source modules\r
517 #\r
518 for i in SourcePcdDict_Keys:\r
519 for j in SourcePcdDict_Keys:\r
520 if i != j:\r
521 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(SourcePcdDict[j])))\r
522 if len(IntersectionList) > 0:\r
523 EdkLogger.error(\r
524 'build',\r
525 FORMAT_INVALID,\r
526 "Building modules from source INFs, following PCD use %s and %s access method. It must be corrected to use only one access method." % (i, j),\r
527 ExtraData="%s" % '\n\t'.join([str(P[1]+'.'+P[0]) for P in IntersectionList])\r
528 )\r
529 else:\r
530 pass\r
2a29017e
YZ
531\r
532 #\r
533 # intersection the BinaryPCD for Mixed PCD\r
534 #\r
535 for i in BinaryPcdDict_Keys:\r
536 for j in BinaryPcdDict_Keys:\r
537 if i != j:\r
538 IntersectionList = list(set(BinaryPcdDict[i]).intersection(set(BinaryPcdDict[j])))\r
539 for item in IntersectionList:\r
540 NewPcd1 = (item[0] + '_' + i, item[1])\r
541 NewPcd2 = (item[0] + '_' + j, item[1])\r
542 if item not in GlobalData.MixedPcd:\r
543 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
544 else:\r
545 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
546 GlobalData.MixedPcd[item].append(NewPcd1)\r
547 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
548 GlobalData.MixedPcd[item].append(NewPcd2)\r
549 else:\r
550 pass\r
551\r
552 #\r
553 # intersection the SourcePCD and BinaryPCD for Mixed PCD\r
554 #\r
555 for i in SourcePcdDict_Keys:\r
556 for j in BinaryPcdDict_Keys:\r
557 if i != j:\r
558 IntersectionList = list(set(SourcePcdDict[i]).intersection(set(BinaryPcdDict[j])))\r
559 for item in IntersectionList:\r
560 NewPcd1 = (item[0] + '_' + i, item[1])\r
561 NewPcd2 = (item[0] + '_' + j, item[1])\r
562 if item not in GlobalData.MixedPcd:\r
563 GlobalData.MixedPcd[item] = [NewPcd1, NewPcd2]\r
564 else:\r
565 if NewPcd1 not in GlobalData.MixedPcd[item]:\r
566 GlobalData.MixedPcd[item].append(NewPcd1)\r
567 if NewPcd2 not in GlobalData.MixedPcd[item]:\r
568 GlobalData.MixedPcd[item].append(NewPcd2)\r
569 else:\r
570 pass\r
571\r
572 for BuildData in PGen.BuildDatabase._CACHE_.values():\r
573 if BuildData.Arch != Arch:\r
574 continue\r
575 for key in BuildData.Pcds:\r
576 for SinglePcd in GlobalData.MixedPcd:\r
577 if (BuildData.Pcds[key].TokenCName, BuildData.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
578 for item in GlobalData.MixedPcd[SinglePcd]:\r
579 Pcd_Type = item[0].split('_')[-1]\r
580 if (Pcd_Type == BuildData.Pcds[key].Type) or (Pcd_Type == TAB_PCDS_DYNAMIC_EX and BuildData.Pcds[key].Type in GenC.gDynamicExPcd) or \\r
581 (Pcd_Type == TAB_PCDS_DYNAMIC and BuildData.Pcds[key].Type in GenC.gDynamicPcd):\r
582 Value = BuildData.Pcds[key]\r
583 Value.TokenCName = BuildData.Pcds[key].TokenCName + '_' + Pcd_Type\r
584 if len(key) == 2:\r
585 newkey = (Value.TokenCName, key[1])\r
586 elif len(key) == 3:\r
587 newkey = (Value.TokenCName, key[1], key[2])\r
588 del BuildData.Pcds[key]\r
589 BuildData.Pcds[newkey] = Value\r
590 break\r
591 else:\r
592 pass\r
593 break\r
594 else:\r
595 pass\r
596\r
597 # handle the mixed pcd in FDF file\r
598 for key in PcdSet:\r
599 if key in GlobalData.MixedPcd:\r
600 Value = PcdSet[key]\r
601 del PcdSet[key]\r
602 for item in GlobalData.MixedPcd[key]:\r
603 PcdSet[item] = Value\r
604\r
97fa0ee9 605 #Collect package set information from INF of FDF\r
a0a2cd1e
FB
606 PkgSet = set()\r
607 for Inf in ModuleList:\r
608 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch)\r
609 if ModuleFile in Platform.Modules:\r
610 continue\r
611 ModuleData = self.BuildDatabase[ModuleFile, Arch, Target, Toolchain]\r
612 PkgSet.update(ModuleData.Packages)\r
613 Pkgs = list(PkgSet) + list(PGen.PackageList)\r
64b2609f 614 for Pkg in Pkgs:\r
25918452
LG
615 for Pcd in Pkg.Pcds:\r
616 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]\r
4afd3d04 617 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))\r
64b2609f 618\r
52302d4d
LG
619 Platform.SkuName = self.SkuId\r
620 for Name, Guid in PcdSet:\r
64b2609f
LG
621 if (Name, Guid) not in DecPcds:\r
622 EdkLogger.error(\r
623 'build',\r
624 PARSER_ERROR,\r
625 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),\r
626 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
627 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
628 )\r
4afd3d04
LG
629 else:\r
630 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.\r
631 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \\r
632 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \\r
633 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:\r
634 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])\r
635 continue\r
636 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:\r
637 EdkLogger.error(\r
638 'build',\r
639 PARSER_ERROR,\r
640 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),\r
641 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
642 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
643 )\r
52302d4d
LG
644\r
645 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
646 #\r
647 # Explicitly collect platform's dynamic PCDs\r
648 #\r
649 Pa.CollectPlatformDynamicPcds()\r
2bc3256c 650 Pa.CollectFixedAtBuildPcds()\r
52302d4d 651 self.AutoGenObjectList.append(Pa)\r
47fea6af 652\r
36d083ef
YZ
653 #\r
654 # Generate Package level hash value\r
655 #\r
656 GlobalData.gPackageHash[Arch] = {}\r
657 if GlobalData.gUseHashCache:\r
658 for Pkg in Pkgs:\r
659 self._GenPkgLevelHash(Pkg)\r
660\r
6780eef1
LG
661 #\r
662 # Check PCDs token value conflict in each DEC file.\r
663 #\r
664 self._CheckAllPcdsTokenValueConflict()\r
47fea6af 665\r
4234283c
LG
666 #\r
667 # Check PCD type and definition between DSC and DEC\r
668 #\r
669 self._CheckPcdDefineAndType()\r
97fa0ee9
YL
670\r
671# if self.FdfFile:\r
672# self._CheckDuplicateInFV(Fdf)\r
673\r
c17956e0 674 #\r
2d499388 675 # Create BuildOptions Macro & PCD metafile, also add the Active Platform and FDF file.\r
c17956e0
DL
676 #\r
677 content = 'gCommandLineDefines: '\r
678 content += str(GlobalData.gCommandLineDefines)\r
679 content += os.linesep\r
680 content += 'BuildOptionPcd: '\r
681 content += str(GlobalData.BuildOptionPcd)\r
2d499388
YZ
682 content += os.linesep\r
683 content += 'Active Platform: '\r
684 content += str(self.Platform)\r
685 content += os.linesep\r
686 if self.FdfFile:\r
687 content += 'Flash Image Definition: '\r
688 content += str(self.FdfFile)\r
36d083ef 689 content += os.linesep\r
c17956e0
DL
690 SaveFileOnChange(os.path.join(self.BuildDir, 'BuildOptions'), content, False)\r
691\r
99adfe9f
YZ
692 #\r
693 # Create PcdToken Number file for Dynamic/DynamicEx Pcd.\r
694 #\r
695 PcdTokenNumber = 'PcdTokenNumber: '\r
696 if Pa.PcdTokenNumber:\r
697 if Pa.DynamicPcdList:\r
698 for Pcd in Pa.DynamicPcdList:\r
699 PcdTokenNumber += os.linesep\r
700 PcdTokenNumber += str((Pcd.TokenCName, Pcd.TokenSpaceGuidCName))\r
701 PcdTokenNumber += ' : '\r
702 PcdTokenNumber += str(Pa.PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName])\r
703 SaveFileOnChange(os.path.join(self.BuildDir, 'PcdTokenNumber'), PcdTokenNumber, False)\r
704\r
c17956e0
DL
705 #\r
706 # Get set of workspace metafiles\r
707 #\r
708 AllWorkSpaceMetaFiles = self._GetMetaFiles(Target, Toolchain, Arch)\r
709\r
710 #\r
711 # Retrieve latest modified time of all metafiles\r
712 #\r
713 SrcTimeStamp = 0\r
714 for f in AllWorkSpaceMetaFiles:\r
715 if os.stat(f)[8] > SrcTimeStamp:\r
716 SrcTimeStamp = os.stat(f)[8]\r
717 self._SrcTimeStamp = SrcTimeStamp\r
718\r
36d083ef
YZ
719 if GlobalData.gUseHashCache:\r
720 m = hashlib.md5()\r
721 for files in AllWorkSpaceMetaFiles:\r
722 if files.endswith('.dec'):\r
723 continue\r
724 f = open(files, 'r')\r
725 Content = f.read()\r
726 f.close()\r
727 m.update(Content)\r
728 SaveFileOnChange(os.path.join(self.BuildDir, 'AutoGen.hash'), m.hexdigest(), True)\r
729 GlobalData.gPlatformHash = m.hexdigest()\r
730\r
c17956e0
DL
731 #\r
732 # Write metafile list to build directory\r
733 #\r
734 AutoGenFilePath = os.path.join(self.BuildDir, 'AutoGen')\r
735 if os.path.exists (AutoGenFilePath):\r
736 os.remove(AutoGenFilePath)\r
737 if not os.path.exists(self.BuildDir):\r
738 os.makedirs(self.BuildDir)\r
739 with open(os.path.join(self.BuildDir, 'AutoGen'), 'w+') as file:\r
740 for f in AllWorkSpaceMetaFiles:\r
741 print >> file, f\r
52302d4d
LG
742 return True\r
743\r
36d083ef
YZ
744 def _GenPkgLevelHash(self, Pkg):\r
745 PkgDir = os.path.join(self.BuildDir, Pkg.Arch, Pkg.PackageName)\r
746 CreateDirectory(PkgDir)\r
747 HashFile = os.path.join(PkgDir, Pkg.PackageName + '.hash')\r
748 m = hashlib.md5()\r
749 # Get .dec file's hash value\r
750 f = open(Pkg.MetaFile.Path, 'r')\r
751 Content = f.read()\r
752 f.close()\r
753 m.update(Content)\r
754 # Get include files hash value\r
755 if Pkg.Includes:\r
756 for inc in Pkg.Includes:\r
757 for Root, Dirs, Files in os.walk(str(inc)):\r
758 for File in Files:\r
759 File_Path = os.path.join(Root, File)\r
760 f = open(File_Path, 'r')\r
761 Content = f.read()\r
762 f.close()\r
763 m.update(Content)\r
764 SaveFileOnChange(HashFile, m.hexdigest(), True)\r
765 if Pkg.PackageName not in GlobalData.gPackageHash[Pkg.Arch]:\r
766 GlobalData.gPackageHash[Pkg.Arch][Pkg.PackageName] = m.hexdigest()\r
763e8edf 767\r
c17956e0
DL
768 def _GetMetaFiles(self, Target, Toolchain, Arch):\r
769 AllWorkSpaceMetaFiles = set()\r
770 #\r
771 # add fdf\r
772 #\r
773 if self.FdfFile:\r
774 AllWorkSpaceMetaFiles.add (self.FdfFile.Path)\r
775 if self.FdfFile:\r
776 FdfFiles = GlobalData.gFdfParser.GetAllIncludedFile()\r
777 for f in FdfFiles:\r
778 AllWorkSpaceMetaFiles.add (f.FileName)\r
779 #\r
780 # add dsc\r
781 #\r
782 AllWorkSpaceMetaFiles.add(self.MetaFile.Path)\r
783\r
784 #\r
86601b78
DL
785 # add build_rule.txt & tools_def.txt\r
786 #\r
51de5c30
YZ
787 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultBuildRuleFile))\r
788 AllWorkSpaceMetaFiles.add(os.path.join(GlobalData.gConfDirectory, gDefaultToolsDefFile))\r
86601b78 789\r
c17956e0
DL
790 # add BuildOption metafile\r
791 #\r
792 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'BuildOptions'))\r
793\r
99adfe9f
YZ
794 # add PcdToken Number file for Dynamic/DynamicEx Pcd\r
795 #\r
796 AllWorkSpaceMetaFiles.add(os.path.join(self.BuildDir, 'PcdTokenNumber'))\r
797\r
c17956e0
DL
798 for Arch in self.ArchList:\r
799 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
800 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
801\r
802 #\r
803 # add dec\r
804 #\r
805 for Package in PGen.PackageList:\r
806 AllWorkSpaceMetaFiles.add(Package.MetaFile.Path)\r
807\r
808 #\r
809 # add included dsc\r
810 #\r
811 for filePath in Platform._RawData.IncludedFiles:\r
812 AllWorkSpaceMetaFiles.add(filePath.Path)\r
813\r
814 return AllWorkSpaceMetaFiles\r
815\r
79b74a03
LG
816 ## _CheckDuplicateInFV() method\r
817 #\r
818 # Check whether there is duplicate modules/files exist in FV section. \r
819 # The check base on the file GUID;\r
820 #\r
821 def _CheckDuplicateInFV(self, Fdf):\r
822 for Fv in Fdf.Profile.FvDict:\r
823 _GuidDict = {}\r
824 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:\r
825 if FfsFile.InfFileName and FfsFile.NameGuid == None:\r
826 #\r
827 # Get INF file GUID\r
828 #\r
47fea6af 829 InfFoundFlag = False\r
79b74a03 830 for Pa in self.AutoGenObjectList:\r
64b2609f
LG
831 if InfFoundFlag:\r
832 break\r
79b74a03
LG
833 for Module in Pa.ModuleAutoGenList:\r
834 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):\r
835 InfFoundFlag = True\r
836 if not Module.Guid.upper() in _GuidDict.keys():\r
837 _GuidDict[Module.Guid.upper()] = FfsFile\r
64b2609f 838 break\r
79b74a03 839 else:\r
47fea6af 840 EdkLogger.error("build",\r
79b74a03 841 FORMAT_INVALID,\r
47fea6af 842 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
843 FfsFile.CurrentLineContent,\r
844 _GuidDict[Module.Guid.upper()].CurrentLineNum,\r
845 _GuidDict[Module.Guid.upper()].CurrentLineContent,\r
846 Module.Guid.upper()),\r
847 ExtraData=self.FdfFile)\r
848 #\r
849 # Some INF files not have entity in DSC file. \r
850 #\r
851 if not InfFoundFlag:\r
852 if FfsFile.InfFileName.find('$') == -1:\r
853 InfPath = NormPath(FfsFile.InfFileName)\r
854 if not os.path.exists(InfPath):\r
855 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))\r
47fea6af 856\r
79b74a03
LG
857 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)\r
858 #\r
859 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use \r
860 # BuildObject from one of AutoGenObjectList is enough.\r
861 #\r
862 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]\r
863 if not InfObj.Guid.upper() in _GuidDict.keys():\r
864 _GuidDict[InfObj.Guid.upper()] = FfsFile\r
865 else:\r
47fea6af 866 EdkLogger.error("build",\r
79b74a03 867 FORMAT_INVALID,\r
47fea6af 868 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
869 FfsFile.CurrentLineContent,\r
870 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,\r
871 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,\r
872 InfObj.Guid.upper()),\r
873 ExtraData=self.FdfFile)\r
874 InfFoundFlag = False\r
47fea6af 875\r
79b74a03
LG
876 if FfsFile.NameGuid != None:\r
877 _CheckPCDAsGuidPattern = re.compile("^PCD\(.+\..+\)$")\r
47fea6af 878\r
79b74a03
LG
879 #\r
880 # If the NameGuid reference a PCD name. \r
881 # The style must match: PCD(xxxx.yyy)\r
882 #\r
883 if _CheckPCDAsGuidPattern.match(FfsFile.NameGuid):\r
884 #\r
885 # Replace the PCD value.\r
886 #\r
887 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")\r
888 PcdFoundFlag = False\r
889 for Pa in self.AutoGenObjectList:\r
890 if not PcdFoundFlag:\r
891 for PcdItem in Pa.AllPcdList:\r
892 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:\r
893 #\r
894 # First convert from CFormatGuid to GUID string\r
895 #\r
896 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)\r
47fea6af 897\r
79b74a03
LG
898 if not _PcdGuidString:\r
899 #\r
900 # Then try Byte array.\r
901 #\r
902 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)\r
47fea6af 903\r
79b74a03
LG
904 if not _PcdGuidString:\r
905 #\r
906 # Not Byte array or CFormat GUID, raise error.\r
907 #\r
908 EdkLogger.error("build",\r
909 FORMAT_INVALID,\r
47fea6af 910 "The format of PCD value is incorrect. PCD: %s , Value: %s\n" % (_PcdName, PcdItem.DefaultValue),\r
79b74a03 911 ExtraData=self.FdfFile)\r
47fea6af
YZ
912\r
913 if not _PcdGuidString.upper() in _GuidDict.keys():\r
79b74a03
LG
914 _GuidDict[_PcdGuidString.upper()] = FfsFile\r
915 PcdFoundFlag = True\r
916 break\r
917 else:\r
47fea6af 918 EdkLogger.error("build",\r
79b74a03 919 FORMAT_INVALID,\r
47fea6af 920 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
921 FfsFile.CurrentLineContent,\r
922 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,\r
923 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,\r
924 FfsFile.NameGuid.upper()),\r
47fea6af
YZ
925 ExtraData=self.FdfFile)\r
926\r
79b74a03
LG
927 if not FfsFile.NameGuid.upper() in _GuidDict.keys():\r
928 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile\r
929 else:\r
930 #\r
931 # Two raw file GUID conflict.\r
932 #\r
47fea6af 933 EdkLogger.error("build",\r
79b74a03 934 FORMAT_INVALID,\r
47fea6af 935 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s" % (FfsFile.CurrentLineNum,\r
79b74a03
LG
936 FfsFile.CurrentLineContent,\r
937 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,\r
938 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,\r
939 FfsFile.NameGuid.upper()),\r
940 ExtraData=self.FdfFile)\r
47fea6af 941\r
79b74a03 942\r
4234283c
LG
943 def _CheckPcdDefineAndType(self):\r
944 PcdTypeList = [\r
945 "FixedAtBuild", "PatchableInModule", "FeatureFlag",\r
946 "Dynamic", #"DynamicHii", "DynamicVpd",\r
947 "DynamicEx", # "DynamicExHii", "DynamicExVpd"\r
948 ]\r
949\r
950 # This dict store PCDs which are not used by any modules with specified arches\r
951 UnusedPcd = sdict()\r
952 for Pa in self.AutoGenObjectList:\r
953 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid\r
954 for Pcd in Pa.Platform.Pcds:\r
955 PcdType = Pa.Platform.Pcds[Pcd].Type\r
47fea6af 956\r
4234283c
LG
957 # If no PCD type, this PCD comes from FDF \r
958 if not PcdType:\r
959 continue\r
47fea6af 960\r
4234283c
LG
961 # Try to remove Hii and Vpd suffix\r
962 if PcdType.startswith("DynamicEx"):\r
963 PcdType = "DynamicEx"\r
964 elif PcdType.startswith("Dynamic"):\r
965 PcdType = "Dynamic"\r
47fea6af 966\r
4234283c
LG
967 for Package in Pa.PackageList:\r
968 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType\r
969 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:\r
970 break\r
971 for Type in PcdTypeList:\r
972 if (Pcd[0], Pcd[1], Type) in Package.Pcds:\r
973 EdkLogger.error(\r
974 'build',\r
975 FORMAT_INVALID,\r
976 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \\r
977 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),\r
978 ExtraData=None\r
979 )\r
980 return\r
981 else:\r
982 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)\r
983\r
984 for Pcd in UnusedPcd:\r
985 EdkLogger.warn(\r
986 'build',\r
987 "The PCD was not specified by any INF module in the platform for the given architecture.\n"\r
988 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"\r
989 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),\r
990 ExtraData=None\r
991 )\r
992\r
52302d4d
LG
993 def __repr__(self):\r
994 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))\r
995\r
996 ## Return the directory to store FV files\r
997 def _GetFvDir(self):\r
998 if self._FvDir == None:\r
999 self._FvDir = path.join(self.BuildDir, 'FV')\r
1000 return self._FvDir\r
1001\r
1002 ## Return the directory to store all intermediate and final files built\r
1003 def _GetBuildDir(self):\r
36d083ef
YZ
1004 if self._BuildDir == None:\r
1005 return self.AutoGenObjectList[0].BuildDir\r
52302d4d
LG
1006\r
1007 ## Return the build output directory platform specifies\r
1008 def _GetOutputDir(self):\r
1009 return self.Platform.OutputDirectory\r
1010\r
1011 ## Return platform name\r
1012 def _GetName(self):\r
1013 return self.Platform.PlatformName\r
1014\r
1015 ## Return meta-file GUID\r
1016 def _GetGuid(self):\r
1017 return self.Platform.Guid\r
1018\r
1019 ## Return platform version\r
1020 def _GetVersion(self):\r
1021 return self.Platform.Version\r
1022\r
1023 ## Return paths of tools\r
1024 def _GetToolDefinition(self):\r
1025 return self.AutoGenObjectList[0].ToolDefinition\r
1026\r
1027 ## Return directory of platform makefile\r
1028 #\r
1029 # @retval string Makefile directory\r
1030 #\r
1031 def _GetMakeFileDir(self):\r
1032 if self._MakeFileDir == None:\r
1033 self._MakeFileDir = self.BuildDir\r
1034 return self._MakeFileDir\r
1035\r
1036 ## Return build command string\r
1037 #\r
1038 # @retval string Build command string\r
1039 #\r
1040 def _GetBuildCommand(self):\r
1041 if self._BuildCommand == None:\r
1042 # BuildCommand should be all the same. So just get one from platform AutoGen\r
1043 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand\r
1044 return self._BuildCommand\r
47fea6af 1045\r
6780eef1
LG
1046 ## Check the PCDs token value conflict in each DEC file.\r
1047 #\r
1048 # Will cause build break and raise error message while two PCDs conflict.\r
1049 # \r
1050 # @return None\r
1051 #\r
1052 def _CheckAllPcdsTokenValueConflict(self):\r
b36d134f
LG
1053 for Pa in self.AutoGenObjectList:\r
1054 for Package in Pa.PackageList:\r
6780eef1 1055 PcdList = Package.Pcds.values()\r
f827cd07 1056 PcdList.sort(lambda x, y: cmp(int(x.TokenValue, 0), int(y.TokenValue, 0))) \r
6780eef1
LG
1057 Count = 0\r
1058 while (Count < len(PcdList) - 1) :\r
1059 Item = PcdList[Count]\r
1060 ItemNext = PcdList[Count + 1]\r
1061 #\r
1062 # Make sure in the same token space the TokenValue should be unique\r
1063 #\r
f827cd07 1064 if (int(Item.TokenValue, 0) == int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
1065 SameTokenValuePcdList = []\r
1066 SameTokenValuePcdList.append(Item)\r
1067 SameTokenValuePcdList.append(ItemNext)\r
1068 RemainPcdListLength = len(PcdList) - Count - 2\r
1069 for ValueSameCount in range(RemainPcdListLength):\r
f827cd07 1070 if int(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue, 0) == int(Item.TokenValue, 0):\r
6780eef1
LG
1071 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])\r
1072 else:\r
1073 break;\r
1074 #\r
1075 # Sort same token value PCD list with TokenGuid and TokenCName\r
1076 #\r
47fea6af
YZ
1077 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))\r
1078 SameTokenValuePcdListCount = 0\r
6780eef1 1079 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):\r
2a29017e 1080 Flag = False\r
47fea6af
YZ
1081 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]\r
1082 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1]\r
1083\r
6780eef1 1084 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):\r
2a29017e
YZ
1085 for PcdItem in GlobalData.MixedPcd:\r
1086 if (TemListItem.TokenCName, TemListItem.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem] or \\r
1087 (TemListItemNext.TokenCName, TemListItemNext.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
1088 Flag = True\r
1089 if not Flag:\r
1090 EdkLogger.error(\r
1091 'build',\r
1092 FORMAT_INVALID,\r
1093 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\\r
1094 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),\r
1095 ExtraData=None\r
1096 )\r
6780eef1
LG
1097 SameTokenValuePcdListCount += 1\r
1098 Count += SameTokenValuePcdListCount\r
1099 Count += 1\r
47fea6af 1100\r
6780eef1 1101 PcdList = Package.Pcds.values()\r
47fea6af 1102 PcdList.sort(lambda x, y: cmp("%s.%s" % (x.TokenSpaceGuidCName, x.TokenCName), "%s.%s" % (y.TokenSpaceGuidCName, y.TokenCName)))\r
6780eef1
LG
1103 Count = 0\r
1104 while (Count < len(PcdList) - 1) :\r
1105 Item = PcdList[Count]\r
47fea6af 1106 ItemNext = PcdList[Count + 1]\r
6780eef1
LG
1107 #\r
1108 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.\r
1109 #\r
f827cd07 1110 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (int(Item.TokenValue, 0) != int(ItemNext.TokenValue, 0)):\r
6780eef1
LG
1111 EdkLogger.error(\r
1112 'build',\r
1113 FORMAT_INVALID,\r
1114 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\\r
1115 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),\r
1116 ExtraData=None\r
1117 )\r
1118 Count += 1\r
97fa0ee9 1119 ## Generate fds command\r
03af2753
HC
1120 def _GenFdsCommand(self):\r
1121 return (GenMake.TopLevelMakefile(self)._TEMPLATE_.Replace(GenMake.TopLevelMakefile(self)._TemplateDict)).strip()\r
52302d4d 1122\r
e56468c0 1123 ## Create makefile for the platform and modules in it\r
52302d4d
LG
1124 #\r
1125 # @param CreateDepsMakeFile Flag indicating if the makefile for\r
1126 # modules will be created as well\r
1127 #\r
1128 def CreateMakeFile(self, CreateDepsMakeFile=False):\r
52302d4d
LG
1129 if CreateDepsMakeFile:\r
1130 for Pa in self.AutoGenObjectList:\r
1131 Pa.CreateMakeFile(CreateDepsMakeFile)\r
1132\r
1133 ## Create autogen code for platform and modules\r
1134 #\r
1135 # Since there's no autogen code for platform, this method will do nothing\r
1136 # if CreateModuleCodeFile is set to False.\r
1137 #\r
1138 # @param CreateDepsCodeFile Flag indicating if creating module's\r
1139 # autogen code file or not\r
1140 #\r
1141 def CreateCodeFile(self, CreateDepsCodeFile=False):\r
1142 if not CreateDepsCodeFile:\r
1143 return\r
1144 for Pa in self.AutoGenObjectList:\r
1145 Pa.CreateCodeFile(CreateDepsCodeFile)\r
1146\r
7c1fd323
LG
1147 ## Create AsBuilt INF file the platform\r
1148 #\r
1149 def CreateAsBuiltInf(self):\r
1150 return\r
1151\r
52302d4d
LG
1152 Name = property(_GetName)\r
1153 Guid = property(_GetGuid)\r
1154 Version = property(_GetVersion)\r
1155 OutputDir = property(_GetOutputDir)\r
1156\r
1157 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
1158\r
1159 BuildDir = property(_GetBuildDir)\r
1160 FvDir = property(_GetFvDir)\r
1161 MakeFileDir = property(_GetMakeFileDir)\r
1162 BuildCommand = property(_GetBuildCommand)\r
03af2753 1163 GenFdsCommand = property(_GenFdsCommand)\r
52302d4d
LG
1164\r
1165## AutoGen class for platform\r
1166#\r
1167# PlatformAutoGen class will process the original information in platform\r
1168# file in order to generate makefile for platform.\r
1169#\r
1170class PlatformAutoGen(AutoGen):\r
1171 #\r
1172 # Used to store all PCDs for both PEI and DXE phase, in order to generate \r
1173 # correct PCD database\r
1174 # \r
1175 _DynaPcdList_ = []\r
1176 _NonDynaPcdList_ = []\r
61ee1dff 1177 _PlatformPcds = {}\r
6780eef1
LG
1178 \r
1179 #\r
1180 # The priority list while override build option \r
1181 #\r
1182 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)\r
1183 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
1184 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
1185 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE \r
1186 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
1187 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
1188 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE\r
1189 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE\r
1190 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1191 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
1192 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE\r
1193 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE\r
1194 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE\r
1195 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE\r
1196 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE\r
1197 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)\r
47fea6af 1198\r
52302d4d
LG
1199 ## The real constructor of PlatformAutoGen\r
1200 #\r
1201 # This method is not supposed to be called by users of PlatformAutoGen. It's\r
1202 # only used by factory method __new__() to do real initialization work for an\r
1203 # object of PlatformAutoGen\r
1204 #\r
1205 # @param Workspace WorkspaceAutoGen object\r
1206 # @param PlatformFile Platform file (DSC file)\r
1207 # @param Target Build target (DEBUG, RELEASE)\r
1208 # @param Toolchain Name of tool chain\r
1209 # @param Arch arch of the platform supports\r
1210 #\r
1211 def _Init(self, Workspace, PlatformFile, Target, Toolchain, Arch):\r
1212 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))\r
1213 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)\r
1214\r
1215 self.MetaFile = PlatformFile\r
1216 self.Workspace = Workspace\r
1217 self.WorkspaceDir = Workspace.WorkspaceDir\r
1218 self.ToolChain = Toolchain\r
1219 self.BuildTarget = Target\r
1220 self.Arch = Arch\r
1221 self.SourceDir = PlatformFile.SubDir\r
1222 self.SourceOverrideDir = None\r
1223 self.FdTargetList = self.Workspace.FdTargetList\r
1224 self.FvTargetList = self.Workspace.FvTargetList\r
1225 self.AllPcdList = []\r
a0a2cd1e
FB
1226 # get the original module/package/platform objects\r
1227 self.BuildDatabase = Workspace.BuildDatabase\r
8518bf0b 1228 self.DscBuildDataObj = Workspace.Platform\r
52302d4d
LG
1229\r
1230 # flag indicating if the makefile/C-code file has been created or not\r
1231 self.IsMakeFileCreated = False\r
1232 self.IsCodeFileCreated = False\r
1233\r
1234 self._Platform = None\r
1235 self._Name = None\r
1236 self._Guid = None\r
1237 self._Version = None\r
1238\r
1239 self._BuildRule = None\r
1240 self._SourceDir = None\r
1241 self._BuildDir = None\r
1242 self._OutputDir = None\r
1243 self._FvDir = None\r
1244 self._MakeFileDir = None\r
1245 self._FdfFile = None\r
1246\r
1247 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
1248 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
1249 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2bc3256c 1250 self._NonDynamicPcdDict = {}\r
52302d4d
LG
1251\r
1252 self._ToolDefinitions = None\r
1253 self._ToolDefFile = None # toolcode : tool path\r
1254 self._ToolChainFamily = None\r
1255 self._BuildRuleFamily = None\r
1256 self._BuildOption = None # toolcode : option\r
1257 self._EdkBuildOption = None # edktoolcode : option\r
1258 self._EdkIIBuildOption = None # edkiitoolcode : option\r
1259 self._PackageList = None\r
1260 self._ModuleAutoGenList = None\r
1261 self._LibraryAutoGenList = None\r
1262 self._BuildCommand = None\r
a0a2cd1e
FB
1263 self._AsBuildInfList = []\r
1264 self._AsBuildModuleList = []\r
1265 if GlobalData.gFdfParser != None:\r
1266 self._AsBuildInfList = GlobalData.gFdfParser.Profile.InfList\r
1267 for Inf in self._AsBuildInfList:\r
1268 InfClass = PathClass(NormPath(Inf), GlobalData.gWorkspace, self.Arch)\r
1269 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
1270 if not M.IsSupportedArch:\r
1271 continue\r
1272 self._AsBuildModuleList.append(InfClass)\r
03af2753
HC
1273 # get library/modules for build\r
1274 self.LibraryBuildDirectoryList = []\r
1275 self.ModuleBuildDirectoryList = []\r
52302d4d
LG
1276 return True\r
1277\r
1278 def __repr__(self):\r
1279 return "%s [%s]" % (self.MetaFile, self.Arch)\r
1280\r
1281 ## Create autogen code for platform and modules\r
1282 #\r
1283 # Since there's no autogen code for platform, this method will do nothing\r
1284 # if CreateModuleCodeFile is set to False.\r
1285 #\r
1286 # @param CreateModuleCodeFile Flag indicating if creating module's\r
1287 # autogen code file or not\r
1288 #\r
1289 def CreateCodeFile(self, CreateModuleCodeFile=False):\r
1290 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False\r
1291 if self.IsCodeFileCreated or not CreateModuleCodeFile:\r
1292 return\r
1293\r
1294 for Ma in self.ModuleAutoGenList:\r
1295 Ma.CreateCodeFile(True)\r
1296\r
1297 # don't do this twice\r
1298 self.IsCodeFileCreated = True\r
1299\r
03af2753
HC
1300 ## Generate Fds Command\r
1301 def _GenFdsCommand(self):\r
1302 return self.Workspace.GenFdsCommand\r
481252bb 1303\r
52302d4d
LG
1304 ## Create makefile for the platform and mdoules in it\r
1305 #\r
1306 # @param CreateModuleMakeFile Flag indicating if the makefile for\r
1307 # modules will be created as well\r
1308 #\r
37de70b7 1309 def CreateMakeFile(self, CreateModuleMakeFile=False, FfsCommand = {}):\r
52302d4d
LG
1310 if CreateModuleMakeFile:\r
1311 for ModuleFile in self.Platform.Modules:\r
1312 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,\r
1313 self.ToolChain, self.Arch, self.MetaFile)\r
37de70b7
YZ
1314 if (ModuleFile.File, self.Arch) in FfsCommand:\r
1315 Ma.CreateMakeFile(True, FfsCommand[ModuleFile.File, self.Arch])\r
1316 else:\r
1317 Ma.CreateMakeFile(True)\r
97fa0ee9 1318 #Ma.CreateAsBuiltInf()\r
52302d4d
LG
1319\r
1320 # no need to create makefile for the platform more than once\r
1321 if self.IsMakeFileCreated:\r
1322 return\r
1323\r
03af2753 1324 # create library/module build dirs for platform\r
52302d4d 1325 Makefile = GenMake.PlatformMakefile(self)\r
03af2753
HC
1326 self.LibraryBuildDirectoryList = Makefile.GetLibraryBuildDirectoryList()\r
1327 self.ModuleBuildDirectoryList = Makefile.GetModuleBuildDirectoryList()\r
1328\r
52302d4d
LG
1329 self.IsMakeFileCreated = True\r
1330\r
2bc3256c
LG
1331 ## Deal with Shared FixedAtBuild Pcds\r
1332 #\r
1333 def CollectFixedAtBuildPcds(self):\r
1334 for LibAuto in self.LibraryAutoGenList:\r
1335 FixedAtBuildPcds = {} \r
1336 ShareFixedAtBuildPcdsSameValue = {} \r
1337 for Module in LibAuto._ReferenceModules: \r
1338 for Pcd in Module.FixedAtBuildPcds + LibAuto.FixedAtBuildPcds:\r
1339 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName)) \r
1340 if key not in FixedAtBuildPcds:\r
1341 ShareFixedAtBuildPcdsSameValue[key] = True\r
1342 FixedAtBuildPcds[key] = Pcd.DefaultValue\r
1343 else:\r
1344 if FixedAtBuildPcds[key] != Pcd.DefaultValue:\r
1345 ShareFixedAtBuildPcdsSameValue[key] = False \r
1346 for Pcd in LibAuto.FixedAtBuildPcds:\r
1347 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1348 if (Pcd.TokenCName,Pcd.TokenSpaceGuidCName) not in self.NonDynamicPcdDict:\r
1349 continue\r
1350 else:\r
1351 DscPcd = self.NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)]\r
1352 if DscPcd.Type != "FixedAtBuild":\r
1353 continue\r
1354 if key in ShareFixedAtBuildPcdsSameValue and ShareFixedAtBuildPcdsSameValue[key]: \r
1355 LibAuto.ConstPcd[key] = Pcd.DefaultValue\r
1356\r
34952f49 1357 def CollectVariables(self, DynamicPcdSet):\r
8518bf0b 1358 VariableInfo = VariableMgr(self.DscBuildDataObj._GetDefaultStores(),self.DscBuildDataObj._GetSkuIds())\r
34952f49
LG
1359 Index = 0\r
1360 for Pcd in DynamicPcdSet:\r
8518bf0b
LG
1361 pcdname = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1362 for SkuName in Pcd.SkuInfoList:\r
1363 Sku = Pcd.SkuInfoList[SkuName]\r
1364 SkuId = Sku.SkuId\r
1365 if SkuId == None or SkuId == '':\r
1366 continue\r
1367 if len(Sku.VariableName) > 0:\r
1368 VariableGuidStructure = Sku.VariableGuidValue\r
1369 VariableGuid = GuidStructureStringToGuidString(VariableGuidStructure)\r
1370 if Pcd.Phase == "DXE":\r
1371 for StorageName in Sku.DefaultStoreDict:\r
1372 VariableInfo.append_variable(var_info(Index,pcdname,StorageName,SkuName, StringToArray(Sku.VariableName),VariableGuid, Sku.VariableAttribute , Pcd.DefaultValue,Sku.DefaultStoreDict[StorageName],Pcd.DatumType))\r
34952f49
LG
1373 Index += 1\r
1374 return VariableInfo\r
52302d4d
LG
1375 ## Collect dynamic PCDs\r
1376 #\r
1377 # Gather dynamic PCDs list from each module and their settings from platform\r
1378 # This interface should be invoked explicitly when platform action is created.\r
1379 #\r
1380 def CollectPlatformDynamicPcds(self):\r
763e8edf
YZ
1381 # Override the platform Pcd's value by build option\r
1382 if GlobalData.BuildOptionPcd:\r
1383 for key in self.Platform.Pcds:\r
1384 PlatformPcd = self.Platform.Pcds[key]\r
1385 for PcdItem in GlobalData.BuildOptionPcd:\r
1386 if (PlatformPcd.TokenSpaceGuidCName, PlatformPcd.TokenCName) == (PcdItem[0], PcdItem[1]):\r
1387 PlatformPcd.DefaultValue = PcdItem[2]\r
1388 if PlatformPcd.SkuInfoList:\r
1389 Sku = PlatformPcd.SkuInfoList[PlatformPcd.SkuInfoList.keys()[0]]\r
1390 Sku.DefaultValue = PcdItem[2]\r
1391 break\r
1392\r
2a29017e
YZ
1393 for key in self.Platform.Pcds:\r
1394 for SinglePcd in GlobalData.MixedPcd:\r
1395 if (self.Platform.Pcds[key].TokenCName, self.Platform.Pcds[key].TokenSpaceGuidCName) == SinglePcd:\r
1396 for item in GlobalData.MixedPcd[SinglePcd]:\r
1397 Pcd_Type = item[0].split('_')[-1]\r
1398 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
1399 (Pcd_Type == TAB_PCDS_DYNAMIC and self.Platform.Pcds[key].Type in GenC.gDynamicPcd):\r
1400 Value = self.Platform.Pcds[key]\r
1401 Value.TokenCName = self.Platform.Pcds[key].TokenCName + '_' + Pcd_Type\r
1402 if len(key) == 2:\r
1403 newkey = (Value.TokenCName, key[1])\r
1404 elif len(key) == 3:\r
1405 newkey = (Value.TokenCName, key[1], key[2])\r
1406 del self.Platform.Pcds[key]\r
1407 self.Platform.Pcds[newkey] = Value\r
1408 break\r
1409 else:\r
1410 pass\r
1411 break\r
1412 else:\r
1413 pass\r
1414\r
52302d4d
LG
1415 # for gathering error information\r
1416 NoDatumTypePcdList = set()\r
a0a2cd1e 1417 PcdNotInDb = []\r
52302d4d 1418 self._GuidValue = {}\r
a0a2cd1e
FB
1419 FdfModuleList = []\r
1420 for InfName in self._AsBuildInfList:\r
05cc51ad 1421 InfName = mws.join(self.WorkspaceDir, InfName)\r
a0a2cd1e 1422 FdfModuleList.append(os.path.normpath(InfName))\r
52302d4d
LG
1423 for F in self.Platform.Modules.keys():\r
1424 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)\r
1425 #GuidValue.update(M.Guids)\r
1426 \r
1427 self.Platform.Modules[F].M = M\r
47fea6af
YZ
1428\r
1429 for PcdFromModule in M.ModulePcdList + M.LibraryPcdList:\r
52302d4d 1430 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
e8a47801 1431 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:\r
52302d4d
LG
1432 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))\r
1433\r
97fa0ee9 1434 # Check the PCD from Binary INF or Source INF\r
a0a2cd1e
FB
1435 if M.IsBinaryModule == True:\r
1436 PcdFromModule.IsFromBinaryInf = True\r
97fa0ee9
YL
1437\r
1438 # Check the PCD from DSC or not \r
a0a2cd1e
FB
1439 if (PcdFromModule.TokenCName, PcdFromModule.TokenSpaceGuidCName) in self.Platform.Pcds.keys():\r
1440 PcdFromModule.IsFromDsc = True\r
1441 else:\r
1442 PcdFromModule.IsFromDsc = False\r
52302d4d 1443 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:\r
a0a2cd1e
FB
1444 if F.Path not in FdfModuleList:\r
1445 # If one of the Source built modules listed in the DSC is not listed \r
1446 # in FDF modules, and the INF lists a PCD can only use the PcdsDynamic \r
1447 # access method (it is only listed in the DEC file that declares the \r
1448 # PCD as PcdsDynamic), then build tool will report warning message\r
1449 # notify the PI that they are attempting to build a module that must \r
1450 # be included in a flash image in order to be functional. These Dynamic \r
1451 # PCD will not be added into the Database unless it is used by other \r
1452 # modules that are included in the FDF file.\r
1453 if PcdFromModule.Type in GenC.gDynamicPcd and \\r
1454 PcdFromModule.IsFromBinaryInf == False:\r
1455 # Print warning message to let the developer make a determine.\r
1456 if PcdFromModule not in PcdNotInDb:\r
a0a2cd1e
FB
1457 PcdNotInDb.append(PcdFromModule)\r
1458 continue\r
1459 # If one of the Source built modules listed in the DSC is not listed in \r
1460 # FDF modules, and the INF lists a PCD can only use the PcdsDynamicEx \r
1461 # access method (it is only listed in the DEC file that declares the \r
1462 # PCD as PcdsDynamicEx), then DO NOT break the build; DO NOT add the \r
1463 # PCD to the Platform's PCD Database.\r
1464 if PcdFromModule.Type in GenC.gDynamicExPcd:\r
1465 if PcdFromModule not in PcdNotInDb:\r
1466 PcdNotInDb.append(PcdFromModule)\r
1467 continue\r
52302d4d
LG
1468 #\r
1469 # If a dynamic PCD used by a PEM module/PEI module & DXE module,\r
1470 # it should be stored in Pcd PEI database, If a dynamic only\r
1471 # used by DXE module, it should be stored in DXE PCD database.\r
1472 # The default Phase is DXE\r
1473 #\r
1474 if M.ModuleType in ["PEIM", "PEI_CORE"]:\r
1475 PcdFromModule.Phase = "PEI"\r
1476 if PcdFromModule not in self._DynaPcdList_:\r
1477 self._DynaPcdList_.append(PcdFromModule)\r
1478 elif PcdFromModule.Phase == 'PEI':\r
1479 # overwrite any the same PCD existing, if Phase is PEI\r
1480 Index = self._DynaPcdList_.index(PcdFromModule)\r
1481 self._DynaPcdList_[Index] = PcdFromModule\r
1482 elif PcdFromModule not in self._NonDynaPcdList_:\r
1483 self._NonDynaPcdList_.append(PcdFromModule)\r
a0a2cd1e
FB
1484 elif PcdFromModule in self._NonDynaPcdList_ and PcdFromModule.IsFromBinaryInf == True:\r
1485 Index = self._NonDynaPcdList_.index(PcdFromModule)\r
1486 if self._NonDynaPcdList_[Index].IsFromBinaryInf == False:\r
1487 #The PCD from Binary INF will override the same one from source INF\r
1488 self._NonDynaPcdList_.remove (self._NonDynaPcdList_[Index])\r
1489 PcdFromModule.Pending = False\r
1490 self._NonDynaPcdList_.append (PcdFromModule)\r
1491 # Parse the DynamicEx PCD from the AsBuild INF module list of FDF.\r
1492 DscModuleList = []\r
1493 for ModuleInf in self.Platform.Modules.keys():\r
1494 DscModuleList.append (os.path.normpath(ModuleInf.Path))\r
1495 # add the PCD from modules that listed in FDF but not in DSC to Database \r
1496 for InfName in FdfModuleList:\r
1497 if InfName not in DscModuleList:\r
1498 InfClass = PathClass(InfName)\r
1499 M = self.BuildDatabase[InfClass, self.Arch, self.BuildTarget, self.ToolChain]\r
1500 # If a module INF in FDF but not in current arch's DSC module list, it must be module (either binary or source) \r
1501 # for different Arch. PCDs in source module for different Arch is already added before, so skip the source module here. \r
1502 # For binary module, if in current arch, we need to list the PCDs into database. \r
1503 if not M.IsSupportedArch:\r
1504 continue\r
1505 # Override the module PCD setting by platform setting\r
1506 ModulePcdList = self.ApplyPcdSetting(M, M.Pcds)\r
1507 for PcdFromModule in ModulePcdList:\r
1508 PcdFromModule.IsFromBinaryInf = True\r
1509 PcdFromModule.IsFromDsc = False\r
1510 # Only allow the DynamicEx and Patchable PCD in AsBuild INF\r
1511 if PcdFromModule.Type not in GenC.gDynamicExPcd and PcdFromModule.Type not in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1512 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1513 File=self.MetaFile,\r
1514 ExtraData="\n\tExisted %s PCD %s in:\n\t\t%s\n"\r
1515 % (PcdFromModule.Type, PcdFromModule.TokenCName, InfName))\r
1516 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
1517 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize in [None, '']:\r
1518 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, InfName))\r
1519 if M.ModuleType in ["PEIM", "PEI_CORE"]:\r
1520 PcdFromModule.Phase = "PEI"\r
1521 if PcdFromModule not in self._DynaPcdList_ and PcdFromModule.Type in GenC.gDynamicExPcd:\r
1522 self._DynaPcdList_.append(PcdFromModule)\r
1523 elif PcdFromModule not in self._NonDynaPcdList_ and PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE:\r
1524 self._NonDynaPcdList_.append(PcdFromModule)\r
1525 if PcdFromModule in self._DynaPcdList_ and PcdFromModule.Phase == 'PEI' and PcdFromModule.Type in GenC.gDynamicExPcd:\r
97fa0ee9
YL
1526 # Overwrite the phase of any the same PCD existing, if Phase is PEI.\r
1527 # It is to solve the case that a dynamic PCD used by a PEM module/PEI \r
1528 # module & DXE module at a same time.\r
1529 # Overwrite the type of the PCDs in source INF by the type of AsBuild\r
1530 # INF file as DynamicEx. \r
a0a2cd1e
FB
1531 Index = self._DynaPcdList_.index(PcdFromModule)\r
1532 self._DynaPcdList_[Index].Phase = PcdFromModule.Phase\r
1533 self._DynaPcdList_[Index].Type = PcdFromModule.Type\r
1534 for PcdFromModule in self._NonDynaPcdList_:\r
1535 # If a PCD is not listed in the DSC file, but binary INF files used by \r
1536 # this platform all (that use this PCD) list the PCD in a [PatchPcds] \r
1537 # section, AND all source INF files used by this platform the build \r
1538 # that use the PCD list the PCD in either a [Pcds] or [PatchPcds] \r
1539 # section, then the tools must NOT add the PCD to the Platform's PCD\r
1540 # Database; the build must assign the access method for this PCD as \r
1541 # PcdsPatchableInModule.\r
1542 if PcdFromModule not in self._DynaPcdList_:\r
1543 continue\r
1544 Index = self._DynaPcdList_.index(PcdFromModule)\r
1545 if PcdFromModule.IsFromDsc == False and \\r
1546 PcdFromModule.Type in TAB_PCDS_PATCHABLE_IN_MODULE and \\r
1547 PcdFromModule.IsFromBinaryInf == True and \\r
1548 self._DynaPcdList_[Index].IsFromBinaryInf == False:\r
1549 Index = self._DynaPcdList_.index(PcdFromModule)\r
1550 self._DynaPcdList_.remove (self._DynaPcdList_[Index])\r
52302d4d
LG
1551\r
1552 # print out error information and break the build, if error found\r
1553 if len(NoDatumTypePcdList) > 0:\r
1554 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)\r
1555 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
1556 File=self.MetaFile,\r
1557 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"\r
1558 % NoDatumTypePcdListString)\r
1559 self._NonDynamicPcdList = self._NonDynaPcdList_\r
1560 self._DynamicPcdList = self._DynaPcdList_\r
52302d4d
LG
1561 #\r
1562 # Sort dynamic PCD list to:\r
1563 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should \r
1564 # try to be put header of dynamicd List\r
1565 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD\r
1566 #\r
1567 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.\r
1568 #\r
1569 UnicodePcdArray = []\r
1570 HiiPcdArray = []\r
1571 OtherPcdArray = []\r
6780eef1 1572 VpdPcdDict = {}\r
e56468c0 1573 VpdFile = VpdInfoFile.VpdInfoFile()\r
61ee1dff
YZ
1574 NeedProcessVpdMapFile = False\r
1575\r
1576 for pcd in self.Platform.Pcds.keys():\r
1577 if pcd not in self._PlatformPcds.keys():\r
1578 self._PlatformPcds[pcd] = self.Platform.Pcds[pcd]\r
1579\r
ae7b6df8
LG
1580 for item in self._PlatformPcds:\r
1581 if self._PlatformPcds[item].DatumType and self._PlatformPcds[item].DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
1582 self._PlatformPcds[item].DatumType = "VOID*"\r
1583\r
e56468c0 1584 if (self.Workspace.ArchList[-1] == self.Arch): \r
1585 for Pcd in self._DynamicPcdList:\r
e56468c0 1586 # just pick the a value to determine whether is unicode string type\r
47fea6af 1587 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]\r
e56468c0 1588 Sku.VpdOffset = Sku.VpdOffset.strip()\r
47fea6af 1589\r
ae7b6df8
LG
1590 if Pcd.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:\r
1591 Pcd.DatumType = "VOID*"\r
1592\r
e56468c0 1593 PcdValue = Sku.DefaultValue\r
1594 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
1595 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
1596 UnicodePcdArray.append(Pcd)\r
1597 elif len(Sku.VariableName) > 0:\r
1598 # if found HII type PCD then insert to right of UnicodeIndex\r
1599 HiiPcdArray.append(Pcd)\r
1600 else:\r
1601 OtherPcdArray.append(Pcd)\r
e56468c0 1602 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
47fea6af
YZ
1603 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd\r
1604\r
34952f49
LG
1605 #Collect DynamicHii PCD values and assign it to DynamicExVpd PCD gEfiMdeModulePkgTokenSpaceGuid.PcdNvStoreDefaultValueBuffer\r
1606 PcdNvStoreDfBuffer = VpdPcdDict.get(("PcdNvStoreDefaultValueBuffer","gEfiMdeModulePkgTokenSpaceGuid"))\r
1607 if PcdNvStoreDfBuffer:\r
1608 var_info = self.CollectVariables(self._DynamicPcdList)\r
1609 default_skuobj = PcdNvStoreDfBuffer.SkuInfoList.get("DEFAULT")\r
1610 default_skuobj.DefaultValue = var_info.dump()\r
1611 if default_skuobj:\r
1612 PcdNvStoreDfBuffer.SkuInfoList.clear()\r
1613 PcdNvStoreDfBuffer.SkuInfoList['DEFAULT'] = default_skuobj\r
1614 PcdNvStoreDfBuffer.MaxDatumSize = len(default_skuobj.DefaultValue.split(","))\r
1615\r
61ee1dff 1616 PlatformPcds = self._PlatformPcds.keys()\r
47fea6af 1617 PlatformPcds.sort()\r
6780eef1
LG
1618 #\r
1619 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
1620 #\r
1621 for PcdKey in PlatformPcds:\r
61ee1dff 1622 Pcd = self._PlatformPcds[PcdKey]\r
e8a47801
LG
1623 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD] and \\r
1624 PcdKey in VpdPcdDict:\r
1625 Pcd = VpdPcdDict[PcdKey]\r
1626 for (SkuName,Sku) in Pcd.SkuInfoList.items():\r
1627 Sku.VpdOffset = Sku.VpdOffset.strip()\r
5a13737a
YZ
1628 PcdValue = Sku.DefaultValue\r
1629 if PcdValue == "":\r
1630 PcdValue = Pcd.DefaultValue\r
1631 if Sku.VpdOffset != '*':\r
1632 if PcdValue.startswith("{"):\r
1633 Alignment = 8\r
1634 elif PcdValue.startswith("L"):\r
1635 Alignment = 2\r
1636 else:\r
1637 Alignment = 1\r
ca85291f
YZ
1638 try:\r
1639 VpdOffset = int(Sku.VpdOffset)\r
1640 except:\r
1641 try:\r
1642 VpdOffset = int(Sku.VpdOffset, 16)\r
1643 except:\r
1644 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
1645 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1646 if PcdValue.startswith("{"):\r
1647 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(Pcd.TokenSpaceGuidCName, Pcd.TokenCName), File=self.MetaFile)\r
1648 else:\r
1649 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
1650 VpdFile.Add(Pcd, Sku.VpdOffset)\r
1651 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
1652 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1653 NeedProcessVpdMapFile = True\r
1654 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':\r
1655 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
1656 "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
1657\r
1658\r
e56468c0 1659 #\r
1660 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
1661 # An example is PCD for signature usage.\r
6780eef1
LG
1662 # \r
1663 for DscPcd in PlatformPcds:\r
61ee1dff 1664 DscPcdEntry = self._PlatformPcds[DscPcd]\r
e56468c0 1665 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
1666 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):\r
1667 FoundFlag = False\r
1668 for VpdPcd in VpdFile._VpdArray.keys():\r
1669 # This PCD has been referenced by module\r
1670 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1671 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
1672 FoundFlag = True\r
47fea6af 1673\r
e56468c0 1674 # Not found, it should be signature\r
1675 if not FoundFlag :\r
1676 # just pick the a value to determine whether is unicode string type\r
e8a47801
LG
1677 for (SkuName,Sku) in DscPcdEntry.SkuInfoList.items():\r
1678 Sku.VpdOffset = Sku.VpdOffset.strip() \r
1679 \r
1680 # Need to iterate DEC pcd information to get the value & datumtype\r
1681 for eachDec in self.PackageList:\r
1682 for DecPcd in eachDec.Pcds:\r
1683 DecPcdEntry = eachDec.Pcds[DecPcd]\r
1684 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
1685 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
1686 # Print warning message to let the developer make a determine.\r
1687 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
1688 File=self.MetaFile, \\r
1689 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
1690 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path)) \r
1691 \r
1692 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1693 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
1694 DscPcdEntry.TokenValue = DecPcdEntry.TokenValue\r
1695 DscPcdEntry.TokenSpaceGuidValue = eachDec.Guids[DecPcdEntry.TokenSpaceGuidCName]\r
1696 # Only fix the value while no value provided in DSC file.\r
1697 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):\r
1698 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
1699 \r
1700 if DscPcdEntry not in self._DynamicPcdList:\r
1701 self._DynamicPcdList.append(DscPcdEntry)\r
1702# Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]\r
1703 Sku.VpdOffset = Sku.VpdOffset.strip()\r
1704 PcdValue = Sku.DefaultValue\r
5a13737a
YZ
1705 if PcdValue == "":\r
1706 PcdValue = DscPcdEntry.DefaultValue\r
1707 if Sku.VpdOffset != '*':\r
1708 if PcdValue.startswith("{"):\r
1709 Alignment = 8\r
1710 elif PcdValue.startswith("L"):\r
1711 Alignment = 2\r
1712 else:\r
1713 Alignment = 1\r
ca85291f
YZ
1714 try:\r
1715 VpdOffset = int(Sku.VpdOffset)\r
1716 except:\r
1717 try:\r
1718 VpdOffset = int(Sku.VpdOffset, 16)\r
1719 except:\r
1720 EdkLogger.error("build", FORMAT_INVALID, "Invalid offset value %s for PCD %s.%s." % (Sku.VpdOffset, DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName))\r
1721 if VpdOffset % Alignment != 0:\r
815ada26
YZ
1722 if PcdValue.startswith("{"):\r
1723 EdkLogger.warn("build", "The offset value of PCD %s.%s is not 8-byte aligned!" %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName), File=self.MetaFile)\r
1724 else:\r
1725 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
1726 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)\r
1727 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1728 NeedProcessVpdMapFile = True \r
1729 if DscPcdEntry.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
1730 UnicodePcdArray.append(DscPcdEntry)\r
1731 elif len(Sku.VariableName) > 0:\r
1732 HiiPcdArray.append(DscPcdEntry)\r
1733 else:\r
1734 OtherPcdArray.append(DscPcdEntry)\r
1735 \r
1736 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
e56468c0 1737 \r
e56468c0 1738 \r
1739 \r
1740 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \\r
1741 VpdFile.GetCount() != 0:\r
1742 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, \r
1743 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
47fea6af 1744\r
e56468c0 1745 if VpdFile.GetCount() != 0:\r
e56468c0 1746 FvPath = os.path.join(self.BuildDir, "FV")\r
1747 if not os.path.exists(FvPath):\r
1748 try:\r
1749 os.makedirs(FvPath)\r
1750 except:\r
1751 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
47fea6af 1752\r
08dd311f
LG
1753 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1754\r
e459de78 1755 if VpdFile.Write(VpdFilePath):\r
e56468c0 1756 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1757 BPDGToolName = None\r
1758 for ToolDef in self.ToolDefinition.values():\r
1759 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:\r
1760 if not ToolDef.has_key("PATH"):\r
1761 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1762 BPDGToolName = ToolDef["PATH"]\r
1763 break\r
1764 # Call third party GUID BPDG tool.\r
1765 if BPDGToolName != None:\r
08dd311f 1766 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
e56468c0 1767 else:\r
1768 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
47fea6af 1769\r
e56468c0 1770 # Process VPD map file generated by third party BPDG tool\r
1771 if NeedProcessVpdMapFile:\r
08dd311f 1772 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1773 if os.path.exists(VpdMapFilePath):\r
1774 VpdFile.Read(VpdMapFilePath)\r
47fea6af 1775\r
e56468c0 1776 # Fixup "*" offset\r
1777 for Pcd in self._DynamicPcdList:\r
1778 # just pick the a value to determine whether is unicode string type\r
e8a47801
LG
1779 i = 0\r
1780 for (SkuName,Sku) in Pcd.SkuInfoList.items(): \r
1781 if Sku.VpdOffset == "*":\r
1782 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[i].strip()\r
1783 i += 1\r
e56468c0 1784 else:\r
1785 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
47fea6af 1786\r
e56468c0 1787 # Delete the DynamicPcdList At the last time enter into this function \r
47fea6af 1788 del self._DynamicPcdList[:]\r
52302d4d
LG
1789 self._DynamicPcdList.extend(UnicodePcdArray)\r
1790 self._DynamicPcdList.extend(HiiPcdArray)\r
1791 self._DynamicPcdList.extend(OtherPcdArray)\r
a0a2cd1e 1792 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
52302d4d
LG
1793 \r
1794 ## Return the platform build data object\r
1795 def _GetPlatform(self):\r
1796 if self._Platform == None:\r
0d2711a6 1797 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1798 return self._Platform\r
1799\r
1800 ## Return platform name\r
1801 def _GetName(self):\r
1802 return self.Platform.PlatformName\r
1803\r
1804 ## Return the meta file GUID\r
1805 def _GetGuid(self):\r
1806 return self.Platform.Guid\r
1807\r
1808 ## Return the platform version\r
1809 def _GetVersion(self):\r
1810 return self.Platform.Version\r
1811\r
1812 ## Return the FDF file name\r
1813 def _GetFdfFile(self):\r
1814 if self._FdfFile == None:\r
1815 if self.Workspace.FdfFile != "":\r
05cc51ad 1816 self._FdfFile= mws.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
52302d4d
LG
1817 else:\r
1818 self._FdfFile = ''\r
1819 return self._FdfFile\r
1820\r
1821 ## Return the build output directory platform specifies\r
1822 def _GetOutputDir(self):\r
1823 return self.Platform.OutputDirectory\r
1824\r
1825 ## Return the directory to store all intermediate and final files built\r
1826 def _GetBuildDir(self):\r
1827 if self._BuildDir == None:\r
1828 if os.path.isabs(self.OutputDir):\r
1829 self._BuildDir = path.join(\r
1830 path.abspath(self.OutputDir),\r
1831 self.BuildTarget + "_" + self.ToolChain,\r
1832 )\r
1833 else:\r
1834 self._BuildDir = path.join(\r
1835 self.WorkspaceDir,\r
1836 self.OutputDir,\r
1837 self.BuildTarget + "_" + self.ToolChain,\r
1838 )\r
97058144 1839 GlobalData.gBuildDirectory = self._BuildDir\r
52302d4d
LG
1840 return self._BuildDir\r
1841\r
1842 ## Return directory of platform makefile\r
1843 #\r
1844 # @retval string Makefile directory\r
1845 #\r
1846 def _GetMakeFileDir(self):\r
1847 if self._MakeFileDir == None:\r
1848 self._MakeFileDir = path.join(self.BuildDir, self.Arch)\r
1849 return self._MakeFileDir\r
1850\r
1851 ## Return build command string\r
1852 #\r
1853 # @retval string Build command string\r
1854 #\r
1855 def _GetBuildCommand(self):\r
1856 if self._BuildCommand == None:\r
1857 self._BuildCommand = []\r
1858 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1859 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1860 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1861 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1862 if NewOption != '':\r
6780eef1 1863 self._BuildCommand += SplitOption(NewOption)\r
52302d4d
LG
1864 return self._BuildCommand\r
1865\r
1866 ## Get tool chain definition\r
1867 #\r
1868 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1869 #\r
1870 def _GetToolDefinition(self):\r
1871 if self._ToolDefinitions == None:\r
1872 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1873 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1874 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1875 ExtraData="[%s]" % self.MetaFile)\r
1876 self._ToolDefinitions = {}\r
1877 DllPathList = set()\r
1878 for Def in ToolDefinition:\r
1879 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1880 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1881 continue\r
1882\r
1883 Value = ToolDefinition[Def]\r
1884 # don't record the DLL\r
1885 if Attr == "DLL":\r
1886 DllPathList.add(Value)\r
1887 continue\r
1888\r
1889 if Tool not in self._ToolDefinitions:\r
1890 self._ToolDefinitions[Tool] = {}\r
1891 self._ToolDefinitions[Tool][Attr] = Value\r
1892\r
1893 ToolsDef = ''\r
1894 MakePath = ''\r
1895 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:\r
1896 if "FLAGS" not in self._ToolDefinitions["MAKE"]:\r
1897 self._ToolDefinitions["MAKE"]["FLAGS"] = ""\r
1898 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"\r
1899 MakeFlags = ''\r
1900 for Tool in self._ToolDefinitions:\r
1901 for Attr in self._ToolDefinitions[Tool]:\r
1902 Value = self._ToolDefinitions[Tool][Attr]\r
1903 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:\r
1904 # check if override is indicated\r
1905 if self.BuildOption[Tool][Attr].startswith('='):\r
1906 Value = self.BuildOption[Tool][Attr][1:]\r
1907 else:\r
95816356
YZ
1908 if Attr != 'PATH':\r
1909 Value += " " + self.BuildOption[Tool][Attr]\r
1910 else:\r
1911 Value = self.BuildOption[Tool][Attr]\r
52302d4d
LG
1912\r
1913 if Attr == "PATH":\r
1914 # Don't put MAKE definition in the file\r
1915 if Tool == "MAKE":\r
1916 MakePath = Value\r
1917 else:\r
1918 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1919 elif Attr != "DLL":\r
1920 # Don't put MAKE definition in the file\r
1921 if Tool == "MAKE":\r
1922 if Attr == "FLAGS":\r
1923 MakeFlags = Value\r
1924 else:\r
1925 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1926 ToolsDef += "\n"\r
1927\r
1928 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1929 for DllPath in DllPathList:\r
1930 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1931 os.environ["MAKE_FLAGS"] = MakeFlags\r
1932\r
1933 return self._ToolDefinitions\r
1934\r
1935 ## Return the paths of tools\r
1936 def _GetToolDefFile(self):\r
1937 if self._ToolDefFile == None:\r
1938 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
1939 return self._ToolDefFile\r
1940\r
1941 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
1942 def _GetToolChainFamily(self):\r
1943 if self._ToolChainFamily == None:\r
1944 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1945 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
1946 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
1947 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
1948 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1949 % self.ToolChain)\r
1950 self._ToolChainFamily = "MSFT"\r
1951 else:\r
1952 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
1953 return self._ToolChainFamily\r
1954\r
1955 def _GetBuildRuleFamily(self):\r
1956 if self._BuildRuleFamily == None:\r
1957 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1958 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
1959 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
1960 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
1961 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1962 % self.ToolChain)\r
1963 self._BuildRuleFamily = "MSFT"\r
1964 else:\r
1965 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
1966 return self._BuildRuleFamily\r
1967\r
1968 ## Return the build options specific for all modules in this platform\r
1969 def _GetBuildOptions(self):\r
1970 if self._BuildOption == None:\r
1971 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)\r
1972 return self._BuildOption\r
1973\r
1974 ## Return the build options specific for EDK modules in this platform\r
1975 def _GetEdkBuildOptions(self):\r
1976 if self._EdkBuildOption == None:\r
1977 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
1978 return self._EdkBuildOption\r
1979\r
1980 ## Return the build options specific for EDKII modules in this platform\r
1981 def _GetEdkIIBuildOptions(self):\r
1982 if self._EdkIIBuildOption == None:\r
1983 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
1984 return self._EdkIIBuildOption\r
1985\r
97fa0ee9 1986 ## Parse build_rule.txt in Conf Directory.\r
52302d4d
LG
1987 #\r
1988 # @retval BuildRule object\r
1989 #\r
1990 def _GetBuildRule(self):\r
1991 if self._BuildRule == None:\r
1992 BuildRuleFile = None\r
1993 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
1994 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
1995 if BuildRuleFile in [None, '']:\r
97fa0ee9 1996 BuildRuleFile = gDefaultBuildRuleFile\r
52302d4d 1997 self._BuildRule = BuildRule(BuildRuleFile)\r
64b2609f
LG
1998 if self._BuildRule._FileVersion == "":\r
1999 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum\r
2000 else:\r
2001 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :\r
2002 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
47fea6af 2003 EdkLogger.error("build", AUTOGEN_ERROR,\r
64b2609f
LG
2004 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
2005 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))\r
47fea6af 2006\r
52302d4d
LG
2007 return self._BuildRule\r
2008\r
2009 ## Summarize the packages used by modules in this platform\r
2010 def _GetPackageList(self):\r
2011 if self._PackageList == None:\r
2012 self._PackageList = set()\r
2013 for La in self.LibraryAutoGenList:\r
2014 self._PackageList.update(La.DependentPackageList)\r
2015 for Ma in self.ModuleAutoGenList:\r
2016 self._PackageList.update(Ma.DependentPackageList)\r
a0a2cd1e
FB
2017 #Collect package set information from INF of FDF\r
2018 PkgSet = set()\r
2019 for ModuleFile in self._AsBuildModuleList:\r
2020 if ModuleFile in self.Platform.Modules:\r
2021 continue\r
2022 ModuleData = self.BuildDatabase[ModuleFile, self.Arch, self.BuildTarget, self.ToolChain]\r
2023 PkgSet.update(ModuleData.Packages)\r
2024 self._PackageList = list(self._PackageList) + list (PkgSet)\r
52302d4d
LG
2025 return self._PackageList\r
2026\r
2bc3256c
LG
2027 def _GetNonDynamicPcdDict(self):\r
2028 if self._NonDynamicPcdDict:\r
2029 return self._NonDynamicPcdDict\r
2030 for Pcd in self.NonDynamicPcdList:\r
2031 self._NonDynamicPcdDict[(Pcd.TokenCName,Pcd.TokenSpaceGuidCName)] = Pcd\r
2032 return self._NonDynamicPcdDict\r
2033\r
52302d4d
LG
2034 ## Get list of non-dynamic PCDs\r
2035 def _GetNonDynamicPcdList(self):\r
e56468c0 2036 if self._NonDynamicPcdList == None:\r
2037 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2038 return self._NonDynamicPcdList\r
2039\r
2040 ## Get list of dynamic PCDs\r
2041 def _GetDynamicPcdList(self):\r
e56468c0 2042 if self._DynamicPcdList == None:\r
2043 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
2044 return self._DynamicPcdList\r
2045\r
2046 ## Generate Token Number for all PCD\r
2047 def _GetPcdTokenNumbers(self):\r
2048 if self._PcdTokenNumber == None:\r
2049 self._PcdTokenNumber = sdict()\r
2050 TokenNumber = 1\r
d0acc87a
LG
2051 #\r
2052 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area. \r
2053 # Such as:\r
2054 # \r
2055 # Dynamic PCD:\r
2056 # TokenNumber 0 ~ 10\r
2057 # DynamicEx PCD:\r
2058 # TokeNumber 11 ~ 20\r
2059 #\r
52302d4d
LG
2060 for Pcd in self.DynamicPcdList:\r
2061 if Pcd.Phase == "PEI":\r
d0acc87a
LG
2062 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2063 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2064 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2065 TokenNumber += 1\r
47fea6af 2066\r
d0acc87a
LG
2067 for Pcd in self.DynamicPcdList:\r
2068 if Pcd.Phase == "PEI":\r
2069 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2070 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2071 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2072 TokenNumber += 1\r
47fea6af 2073\r
52302d4d
LG
2074 for Pcd in self.DynamicPcdList:\r
2075 if Pcd.Phase == "DXE":\r
d0acc87a
LG
2076 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
2077 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2078 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2079 TokenNumber += 1\r
47fea6af 2080\r
d0acc87a
LG
2081 for Pcd in self.DynamicPcdList:\r
2082 if Pcd.Phase == "DXE":\r
2083 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
2084 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
2085 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2086 TokenNumber += 1\r
47fea6af 2087\r
52302d4d
LG
2088 for Pcd in self.NonDynamicPcdList:\r
2089 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
2090 TokenNumber += 1\r
2091 return self._PcdTokenNumber\r
2092\r
2093 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform\r
2094 def _GetAutoGenObjectList(self):\r
2095 self._ModuleAutoGenList = []\r
2096 self._LibraryAutoGenList = []\r
2097 for ModuleFile in self.Platform.Modules:\r
2098 Ma = ModuleAutoGen(\r
2099 self.Workspace,\r
2100 ModuleFile,\r
2101 self.BuildTarget,\r
2102 self.ToolChain,\r
2103 self.Arch,\r
2104 self.MetaFile\r
2105 )\r
2106 if Ma not in self._ModuleAutoGenList:\r
2107 self._ModuleAutoGenList.append(Ma)\r
2108 for La in Ma.LibraryAutoGenList:\r
2109 if La not in self._LibraryAutoGenList:\r
2110 self._LibraryAutoGenList.append(La)\r
2bc3256c
LG
2111 if Ma not in La._ReferenceModules:\r
2112 La._ReferenceModules.append(Ma)\r
52302d4d
LG
2113\r
2114 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
2115 def _GetModuleAutoGenList(self):\r
2116 if self._ModuleAutoGenList == None:\r
2117 self._GetAutoGenObjectList()\r
2118 return self._ModuleAutoGenList\r
2119\r
2120 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
2121 def _GetLibraryAutoGenList(self):\r
2122 if self._LibraryAutoGenList == None:\r
2123 self._GetAutoGenObjectList()\r
2124 return self._LibraryAutoGenList\r
2125\r
2126 ## Test if a module is supported by the platform\r
2127 #\r
2128 # An error will be raised directly if the module or its arch is not supported\r
2129 # by the platform or current configuration\r
2130 #\r
2131 def ValidModule(self, Module):\r
a0a2cd1e
FB
2132 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances \\r
2133 or Module in self._AsBuildModuleList\r
52302d4d
LG
2134\r
2135 ## Resolve the library classes in a module to library instances\r
2136 #\r
2137 # This method will not only resolve library classes but also sort the library\r
2138 # instances according to the dependency-ship.\r
2139 #\r
2140 # @param Module The module from which the library classes will be resolved\r
2141 #\r
2142 # @retval library_list List of library instances sorted\r
2143 #\r
2144 def ApplyLibraryInstance(self, Module):\r
25193a33
YZ
2145 # Cover the case that the binary INF file is list in the FDF file but not DSC file, return empty list directly\r
2146 if str(Module) not in self.Platform.Modules:\r
2147 return []\r
2148\r
52302d4d
LG
2149 ModuleType = Module.ModuleType\r
2150\r
2151 # for overridding library instances with module specific setting\r
2152 PlatformModule = self.Platform.Modules[str(Module)]\r
2153\r
2154 # add forced library instances (specified under LibraryClasses sections)\r
da92f276
LG
2155 #\r
2156 # If a module has a MODULE_TYPE of USER_DEFINED,\r
2157 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r
2158 #\r
2159 if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r
2160 for LibraryClass in self.Platform.LibraryClasses.GetKeys():\r
2161 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r
2162 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r
52302d4d
LG
2163\r
2164 # add forced library instances (specified in module overrides)\r
2165 for LibraryClass in PlatformModule.LibraryClasses:\r
2166 if LibraryClass.startswith("NULL"):\r
2167 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]\r
2168\r
b36d134f 2169 # EdkII module\r
52302d4d
LG
2170 LibraryConsumerList = [Module]\r
2171 Constructor = []\r
2172 ConsumedByList = sdict()\r
2173 LibraryInstance = sdict()\r
2174\r
2175 EdkLogger.verbose("")\r
2176 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2177 while len(LibraryConsumerList) > 0:\r
2178 M = LibraryConsumerList.pop()\r
2179 for LibraryClassName in M.LibraryClasses:\r
2180 if LibraryClassName not in LibraryInstance:\r
2181 # override library instance for this module\r
2182 if LibraryClassName in PlatformModule.LibraryClasses:\r
2183 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]\r
2184 else:\r
2185 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]\r
2186 if LibraryPath == None or LibraryPath == "":\r
2187 LibraryPath = M.LibraryClasses[LibraryClassName]\r
2188 if LibraryPath == None or LibraryPath == "":\r
2189 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
2190 "Instance of library class [%s] is not found" % LibraryClassName,\r
2191 File=self.MetaFile,\r
2192 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))\r
2193\r
0d2711a6 2194 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2195 # for those forced library instance (NULL library), add a fake library class\r
2196 if LibraryClassName.startswith("NULL"):\r
2197 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r
2198 elif LibraryModule.LibraryClass == None \\r
2199 or len(LibraryModule.LibraryClass) == 0 \\r
2200 or (ModuleType != 'USER_DEFINED'\r
2201 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r
2202 # only USER_DEFINED can link against any library instance despite of its SupModList\r
2203 EdkLogger.error("build", OPTION_MISSING,\r
2204 "Module type [%s] is not supported by library instance [%s]" \\r
2205 % (ModuleType, LibraryPath), File=self.MetaFile,\r
2206 ExtraData="consumed by [%s]" % str(Module))\r
2207\r
2208 LibraryInstance[LibraryClassName] = LibraryModule\r
2209 LibraryConsumerList.append(LibraryModule)\r
2210 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r
2211 else:\r
2212 LibraryModule = LibraryInstance[LibraryClassName]\r
2213\r
2214 if LibraryModule == None:\r
2215 continue\r
2216\r
2217 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r
2218 Constructor.append(LibraryModule)\r
2219\r
2220 if LibraryModule not in ConsumedByList:\r
2221 ConsumedByList[LibraryModule] = []\r
2222 # don't add current module itself to consumer list\r
2223 if M != Module:\r
2224 if M in ConsumedByList[LibraryModule]:\r
2225 continue\r
2226 ConsumedByList[LibraryModule].append(M)\r
2227 #\r
2228 # Initialize the sorted output list to the empty set\r
2229 #\r
2230 SortedLibraryList = []\r
2231 #\r
2232 # Q <- Set of all nodes with no incoming edges\r
2233 #\r
2234 LibraryList = [] #LibraryInstance.values()\r
2235 Q = []\r
2236 for LibraryClassName in LibraryInstance:\r
2237 M = LibraryInstance[LibraryClassName]\r
2238 LibraryList.append(M)\r
2239 if ConsumedByList[M] == []:\r
2240 Q.append(M)\r
2241\r
2242 #\r
2243 # start the DAG algorithm\r
2244 #\r
2245 while True:\r
2246 EdgeRemoved = True\r
2247 while Q == [] and EdgeRemoved:\r
2248 EdgeRemoved = False\r
2249 # for each node Item with a Constructor\r
2250 for Item in LibraryList:\r
2251 if Item not in Constructor:\r
2252 continue\r
2253 # for each Node without a constructor with an edge e from Item to Node\r
2254 for Node in ConsumedByList[Item]:\r
2255 if Node in Constructor:\r
2256 continue\r
2257 # remove edge e from the graph if Node has no constructor\r
2258 ConsumedByList[Item].remove(Node)\r
2259 EdgeRemoved = True\r
2260 if ConsumedByList[Item] == []:\r
2261 # insert Item into Q\r
2262 Q.insert(0, Item)\r
2263 break\r
2264 if Q != []:\r
2265 break\r
2266 # DAG is done if there's no more incoming edge for all nodes\r
2267 if Q == []:\r
2268 break\r
2269\r
2270 # remove node from Q\r
2271 Node = Q.pop()\r
2272 # output Node\r
2273 SortedLibraryList.append(Node)\r
2274\r
2275 # for each node Item with an edge e from Node to Item do\r
2276 for Item in LibraryList:\r
2277 if Node not in ConsumedByList[Item]:\r
2278 continue\r
2279 # remove edge e from the graph\r
2280 ConsumedByList[Item].remove(Node)\r
2281\r
2282 if ConsumedByList[Item] != []:\r
2283 continue\r
2284 # insert Item into Q, if Item has no other incoming edges\r
2285 Q.insert(0, Item)\r
2286\r
2287 #\r
2288 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r
2289 #\r
2290 for Item in LibraryList:\r
2291 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:\r
2292 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])\r
2293 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r
2294 ExtraData=ErrorMessage, File=self.MetaFile)\r
2295 if Item not in SortedLibraryList:\r
2296 SortedLibraryList.append(Item)\r
2297\r
2298 #\r
2299 # Build the list of constructor and destructir names\r
2300 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r
2301 #\r
2302 SortedLibraryList.reverse()\r
2303 return SortedLibraryList\r
2304\r
2305\r
2306 ## Override PCD setting (type, value, ...)\r
2307 #\r
2308 # @param ToPcd The PCD to be overrided\r
2309 # @param FromPcd The PCD overrideing from\r
2310 #\r
2311 def _OverridePcd(self, ToPcd, FromPcd, Module=""):\r
2312 #\r
2313 # in case there's PCDs coming from FDF file, which have no type given.\r
2314 # at this point, ToPcd.Type has the type found from dependent\r
2315 # package\r
2316 #\r
2a29017e
YZ
2317 TokenCName = ToPcd.TokenCName\r
2318 for PcdItem in GlobalData.MixedPcd:\r
2319 if (ToPcd.TokenCName, ToPcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
2320 TokenCName = PcdItem[0]\r
2321 break\r
52302d4d 2322 if FromPcd != None:\r
2a29017e
YZ
2323 if GlobalData.BuildOptionPcd:\r
2324 for pcd in GlobalData.BuildOptionPcd:\r
2325 if (FromPcd.TokenSpaceGuidCName, FromPcd.TokenCName) == (pcd[0], pcd[1]):\r
2326 FromPcd.DefaultValue = pcd[2]\r
2327 break\r
52302d4d
LG
2328 if ToPcd.Pending and FromPcd.Type not in [None, '']:\r
2329 ToPcd.Type = FromPcd.Type\r
e56468c0 2330 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\\r
2331 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):\r
2332 if ToPcd.Type.strip() == "DynamicEx":\r
47fea6af 2333 ToPcd.Type = FromPcd.Type\r
52302d4d
LG
2334 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \\r
2335 and ToPcd.Type != FromPcd.Type:\r
2336 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
2337 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\\r
2a29017e 2338 % (ToPcd.TokenSpaceGuidCName, TokenCName,\r
52302d4d
LG
2339 ToPcd.Type, Module, FromPcd.Type),\r
2340 File=self.MetaFile)\r
2341\r
2342 if FromPcd.MaxDatumSize not in [None, '']:\r
2343 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
2344 if FromPcd.DefaultValue not in [None, '']:\r
2345 ToPcd.DefaultValue = FromPcd.DefaultValue\r
2346 if FromPcd.TokenValue not in [None, '']:\r
2347 ToPcd.TokenValue = FromPcd.TokenValue\r
2348 if FromPcd.MaxDatumSize not in [None, '']:\r
2349 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
2350 if FromPcd.DatumType not in [None, '']:\r
2351 ToPcd.DatumType = FromPcd.DatumType\r
2352 if FromPcd.SkuInfoList not in [None, '', []]:\r
2353 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
2354\r
2355 # check the validation of datum\r
2356 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
2357 if not IsValid:\r
2358 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
2a29017e 2359 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
82a6a960
BF
2360 ToPcd.validateranges = FromPcd.validateranges\r
2361 ToPcd.validlists = FromPcd.validlists\r
2362 ToPcd.expressions = FromPcd.expressions\r
52302d4d
LG
2363\r
2364 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:\r
2365 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
2a29017e 2366 % (ToPcd.TokenSpaceGuidCName, TokenCName))\r
52302d4d
LG
2367 Value = ToPcd.DefaultValue\r
2368 if Value in [None, '']:\r
e8a47801 2369 ToPcd.MaxDatumSize = '1'\r
52302d4d 2370 elif Value[0] == 'L':\r
e8a47801 2371 ToPcd.MaxDatumSize = str((len(Value) - 2) * 2)\r
52302d4d
LG
2372 elif Value[0] == '{':\r
2373 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
2374 else:\r
e8a47801 2375 ToPcd.MaxDatumSize = str(len(Value) - 1)\r
52302d4d
LG
2376\r
2377 # apply default SKU for dynamic PCDS if specified one is not available\r
2378 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \\r
2379 and ToPcd.SkuInfoList in [None, {}, '']:\r
2380 if self.Platform.SkuName in self.Platform.SkuIds:\r
2381 SkuName = self.Platform.SkuName\r
2382 else:\r
2383 SkuName = 'DEFAULT'\r
2384 ToPcd.SkuInfoList = {\r
8518bf0b 2385 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName][0], '', '', '', '', '', ToPcd.DefaultValue)\r
52302d4d
LG
2386 }\r
2387\r
2388 ## Apply PCD setting defined platform to a module\r
2389 #\r
2390 # @param Module The module from which the PCD setting will be overrided\r
2391 #\r
2392 # @retval PCD_list The list PCDs with settings from platform\r
2393 #\r
2394 def ApplyPcdSetting(self, Module, Pcds):\r
2395 # for each PCD in module\r
47fea6af
YZ
2396 for Name, Guid in Pcds:\r
2397 PcdInModule = Pcds[Name, Guid]\r
52302d4d 2398 # find out the PCD setting in platform\r
47fea6af
YZ
2399 if (Name, Guid) in self.Platform.Pcds:\r
2400 PcdInPlatform = self.Platform.Pcds[Name, Guid]\r
52302d4d
LG
2401 else:\r
2402 PcdInPlatform = None\r
2403 # then override the settings if any\r
2404 self._OverridePcd(PcdInModule, PcdInPlatform, Module)\r
2405 # resolve the VariableGuid value\r
2406 for SkuId in PcdInModule.SkuInfoList:\r
2407 Sku = PcdInModule.SkuInfoList[SkuId]\r
2408 if Sku.VariableGuid == '': continue\r
c28d2e10 2409 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList, self.MetaFile.Path)\r
52302d4d
LG
2410 if Sku.VariableGuidValue == None:\r
2411 PackageList = "\n\t".join([str(P) for P in self.PackageList])\r
2412 EdkLogger.error(\r
2413 'build',\r
2414 RESOURCE_NOT_AVAILABLE,\r
2415 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
2416 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
2417 % (Guid, Name, str(Module)),\r
2418 File=self.MetaFile\r
2419 )\r
2420\r
2421 # override PCD settings with module specific setting\r
2422 if Module in self.Platform.Modules:\r
2423 PlatformModule = self.Platform.Modules[str(Module)]\r
2424 for Key in PlatformModule.Pcds:\r
aa9aa47e 2425 Flag = False\r
52302d4d 2426 if Key in Pcds:\r
aa9aa47e
YZ
2427 ToPcd = Pcds[Key]\r
2428 Flag = True\r
2429 elif Key in GlobalData.MixedPcd:\r
2430 for PcdItem in GlobalData.MixedPcd[Key]:\r
2431 if PcdItem in Pcds:\r
2432 ToPcd = Pcds[PcdItem]\r
2433 Flag = True\r
2434 break\r
2435 if Flag:\r
2436 self._OverridePcd(ToPcd, PlatformModule.Pcds[Key], Module)\r
52302d4d
LG
2437 return Pcds.values()\r
2438\r
2439 ## Resolve library names to library modules\r
2440 #\r
b36d134f 2441 # (for Edk.x modules)\r
52302d4d
LG
2442 #\r
2443 # @param Module The module from which the library names will be resolved\r
2444 #\r
2445 # @retval library_list The list of library modules\r
2446 #\r
2447 def ResolveLibraryReference(self, Module):\r
2448 EdkLogger.verbose("")\r
2449 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
2450 LibraryConsumerList = [Module]\r
2451\r
b36d134f 2452 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
2453 if Module.Libraries:\r
2454 Module.Libraries.append("CompilerStub")\r
2455 LibraryList = []\r
2456 while len(LibraryConsumerList) > 0:\r
2457 M = LibraryConsumerList.pop()\r
2458 for LibraryName in M.Libraries:\r
2459 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
2460 if Library == None:\r
2461 for Key in self.Platform.LibraryClasses.data.keys():\r
2462 if LibraryName.upper() == Key.upper():\r
2463 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
2464 break\r
2465 if Library == None:\r
2466 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
2467 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
2468 continue\r
2469\r
2470 if Library not in LibraryList:\r
2471 LibraryList.append(Library)\r
2472 LibraryConsumerList.append(Library)\r
2473 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
2474 return LibraryList\r
2475\r
6780eef1
LG
2476 ## Calculate the priority value of the build option\r
2477 #\r
2478 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2479 #\r
2480 # @retval Value Priority value based on the priority list.\r
2481 #\r
2482 def CalculatePriorityValue(self, Key):\r
47fea6af
YZ
2483 Target, ToolChain, Arch, CommandType, Attr = Key.split('_')\r
2484 PriorityValue = 0x11111\r
6780eef1
LG
2485 if Target == "*":\r
2486 PriorityValue &= 0x01111\r
2487 if ToolChain == "*":\r
2488 PriorityValue &= 0x10111\r
2489 if Arch == "*":\r
2490 PriorityValue &= 0x11011\r
2491 if CommandType == "*":\r
2492 PriorityValue &= 0x11101\r
2493 if Attr == "*":\r
2494 PriorityValue &= 0x11110\r
47fea6af
YZ
2495\r
2496 return self.PrioList["0x%0.5x" % PriorityValue]\r
2497\r
6780eef1 2498\r
52302d4d
LG
2499 ## Expand * in build option key\r
2500 #\r
2501 # @param Options Options to be expanded\r
2502 #\r
2503 # @retval options Options expanded\r
6780eef1 2504 # \r
52302d4d
LG
2505 def _ExpandBuildOption(self, Options, ModuleStyle=None):\r
2506 BuildOptions = {}\r
2507 FamilyMatch = False\r
2508 FamilyIsNull = True\r
47fea6af 2509\r
6780eef1
LG
2510 OverrideList = {}\r
2511 #\r
2512 # Construct a list contain the build options which need override.\r
2513 #\r
2514 for Key in Options:\r
2515 #\r
2516 # Key[0] -- tool family\r
2517 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
2518 #\r
1ba5124e
YL
2519 if (Key[0] == self.BuildRuleFamily and\r
2520 (ModuleStyle == None or len(Key) < 3 or (len(Key) > 2 and Key[2] == ModuleStyle))):\r
6780eef1
LG
2521 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
2522 if Target == self.BuildTarget or Target == "*":\r
2523 if ToolChain == self.ToolChain or ToolChain == "*":\r
2524 if Arch == self.Arch or Arch == "*":\r
2525 if Options[Key].startswith("="):\r
47fea6af 2526 if OverrideList.get(Key[1]) != None:\r
6780eef1
LG
2527 OverrideList.pop(Key[1])\r
2528 OverrideList[Key[1]] = Options[Key]\r
2529 \r
2530 #\r
2531 # Use the highest priority value. \r
2532 #\r
2533 if (len(OverrideList) >= 2):\r
47fea6af 2534 KeyList = OverrideList.keys()\r
6780eef1 2535 for Index in range(len(KeyList)):\r
47fea6af 2536 NowKey = KeyList[Index]\r
6780eef1
LG
2537 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
2538 for Index1 in range(len(KeyList) - Index - 1):\r
2539 NextKey = KeyList[Index1 + Index + 1]\r
2540 #\r
2541 # Compare two Key, if one is included by another, choose the higher priority one\r
2542 # \r
2543 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
2544 if Target1 == Target2 or Target1 == "*" or Target2 == "*":\r
2545 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":\r
2546 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":\r
2547 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":\r
2548 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":\r
2549 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
47fea6af 2550 if Options.get((self.BuildRuleFamily, NextKey)) != None:\r
6780eef1
LG
2551 Options.pop((self.BuildRuleFamily, NextKey))\r
2552 else:\r
47fea6af 2553 if Options.get((self.BuildRuleFamily, NowKey)) != None:\r
6780eef1
LG
2554 Options.pop((self.BuildRuleFamily, NowKey))\r
2555 \r
52302d4d
LG
2556 for Key in Options:\r
2557 if ModuleStyle != None and len (Key) > 2:\r
2558 # Check Module style is EDK or EDKII.\r
2559 # Only append build option for the matched style module.\r
2560 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2561 continue\r
2562 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2563 continue\r
2564 Family = Key[0]\r
2565 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2566 # if tool chain family doesn't match, skip it\r
2567 if Tool in self.ToolDefinition and Family != "":\r
2568 FamilyIsNull = False\r
2569 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
2570 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
2571 continue\r
2572 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2573 continue\r
2574 FamilyMatch = True\r
2575 # expand any wildcard\r
2576 if Target == "*" or Target == self.BuildTarget:\r
2577 if Tag == "*" or Tag == self.ToolChain:\r
2578 if Arch == "*" or Arch == self.Arch:\r
2579 if Tool not in BuildOptions:\r
2580 BuildOptions[Tool] = {}\r
5015bee2 2581 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2582 BuildOptions[Tool][Attr] = Options[Key]\r
2583 else:\r
95816356
YZ
2584 # append options for the same tool except PATH\r
2585 if Attr != 'PATH':\r
2586 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2587 else:\r
2588 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2589 # Build Option Family has been checked, which need't to be checked again for family.\r
2590 if FamilyMatch or FamilyIsNull:\r
2591 return BuildOptions\r
1ba5124e 2592\r
52302d4d
LG
2593 for Key in Options:\r
2594 if ModuleStyle != None and len (Key) > 2:\r
2595 # Check Module style is EDK or EDKII.\r
2596 # Only append build option for the matched style module.\r
2597 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
2598 continue\r
2599 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
2600 continue\r
2601 Family = Key[0]\r
2602 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
2603 # if tool chain family doesn't match, skip it\r
47fea6af 2604 if Tool not in self.ToolDefinition or Family == "":\r
52302d4d
LG
2605 continue\r
2606 # option has been added before\r
2607 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
2608 continue\r
2609\r
2610 # expand any wildcard\r
2611 if Target == "*" or Target == self.BuildTarget:\r
2612 if Tag == "*" or Tag == self.ToolChain:\r
2613 if Arch == "*" or Arch == self.Arch:\r
2614 if Tool not in BuildOptions:\r
2615 BuildOptions[Tool] = {}\r
5015bee2 2616 if Attr != "FLAGS" or Attr not in BuildOptions[Tool] or Options[Key].startswith('='):\r
52302d4d
LG
2617 BuildOptions[Tool][Attr] = Options[Key]\r
2618 else:\r
95816356
YZ
2619 # append options for the same tool except PATH\r
2620 if Attr != 'PATH':\r
2621 BuildOptions[Tool][Attr] += " " + Options[Key]\r
2622 else:\r
2623 BuildOptions[Tool][Attr] = Options[Key]\r
52302d4d
LG
2624 return BuildOptions\r
2625\r
2626 ## Append build options in platform to a module\r
2627 #\r
2628 # @param Module The module to which the build options will be appened\r
2629 #\r
2630 # @retval options The options appended with build options in platform\r
2631 #\r
2632 def ApplyBuildOption(self, Module):\r
2633 # Get the different options for the different style module\r
2634 if Module.AutoGenVersion < 0x00010005:\r
2635 PlatformOptions = self.EdkBuildOption\r
35f69db9 2636 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDK_NAME, Module.ModuleType)\r
52302d4d
LG
2637 else:\r
2638 PlatformOptions = self.EdkIIBuildOption\r
35f69db9
YL
2639 ModuleTypeOptions = self.Platform.GetBuildOptionsByModuleType(EDKII_NAME, Module.ModuleType)\r
2640 ModuleTypeOptions = self._ExpandBuildOption(ModuleTypeOptions)\r
52302d4d
LG
2641 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
2642 if Module in self.Platform.Modules:\r
2643 PlatformModule = self.Platform.Modules[str(Module)]\r
2644 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
2645 else:\r
2646 PlatformModuleOptions = {}\r
2647\r
fe4bf2f9 2648 BuildRuleOrder = None\r
35f69db9 2649 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
fe4bf2f9
YL
2650 for Tool in Options:\r
2651 for Attr in Options[Tool]:\r
2652 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2653 BuildRuleOrder = Options[Tool][Attr]\r
2654\r
35f69db9
YL
2655 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() +\r
2656 PlatformModuleOptions.keys() + ModuleTypeOptions.keys() +\r
2657 self.ToolDefinition.keys())\r
52302d4d
LG
2658 BuildOptions = {}\r
2659 for Tool in AllTools:\r
2660 if Tool not in BuildOptions:\r
2661 BuildOptions[Tool] = {}\r
2662\r
35f69db9 2663 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, ModuleTypeOptions, PlatformModuleOptions]:\r
52302d4d
LG
2664 if Tool not in Options:\r
2665 continue\r
2666 for Attr in Options[Tool]:\r
2667 Value = Options[Tool][Attr]\r
fe4bf2f9
YL
2668 #\r
2669 # Do not generate it in Makefile\r
2670 #\r
2671 if Attr == TAB_TOD_DEFINES_BUILDRULEORDER:\r
2672 continue\r
52302d4d
LG
2673 if Attr not in BuildOptions[Tool]:\r
2674 BuildOptions[Tool][Attr] = ""\r
2675 # check if override is indicated\r
2676 if Value.startswith('='):\r
05cc51ad
LY
2677 ToolPath = Value[1:]\r
2678 ToolPath = mws.handleWsMacro(ToolPath)\r
2679 BuildOptions[Tool][Attr] = ToolPath\r
5015bee2 2680 else:\r
05cc51ad 2681 Value = mws.handleWsMacro(Value)\r
95816356
YZ
2682 if Attr != 'PATH':\r
2683 BuildOptions[Tool][Attr] += " " + Value\r
2684 else:\r
2685 BuildOptions[Tool][Attr] = Value\r
f3decdc3
LG
2686 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:\r
2687 #\r
2688 # Override UNI flag only for EDK module.\r
2689 #\r
2690 if 'BUILD' not in BuildOptions:\r
2691 BuildOptions['BUILD'] = {}\r
2692 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
fe4bf2f9 2693 return BuildOptions, BuildRuleOrder\r
52302d4d
LG
2694\r
2695 Platform = property(_GetPlatform)\r
2696 Name = property(_GetName)\r
2697 Guid = property(_GetGuid)\r
2698 Version = property(_GetVersion)\r
2699\r
2700 OutputDir = property(_GetOutputDir)\r
2701 BuildDir = property(_GetBuildDir)\r
2702 MakeFileDir = property(_GetMakeFileDir)\r
2703 FdfFile = property(_GetFdfFile)\r
2704\r
2705 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
2706 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2707 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
2bc3256c 2708 NonDynamicPcdDict = property(_GetNonDynamicPcdDict)\r
52302d4d
LG
2709 PackageList = property(_GetPackageList)\r
2710\r
2711 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
2712 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path\r
2713 ToolChainFamily = property(_GetToolChainFamily)\r
2714 BuildRuleFamily = property(_GetBuildRuleFamily)\r
2715 BuildOption = property(_GetBuildOptions) # toolcode : option\r
2716 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option\r
2717 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option\r
2718\r
2719 BuildCommand = property(_GetBuildCommand)\r
2720 BuildRule = property(_GetBuildRule)\r
2721 ModuleAutoGenList = property(_GetModuleAutoGenList)\r
2722 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
0923aa1c 2723 GenFdsCommand = property(_GenFdsCommand)\r
52302d4d
LG
2724\r
2725## ModuleAutoGen class\r
2726#\r
2727# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
2728# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
2729# to the [depex] section in module's inf file.\r
2730#\r
2731class ModuleAutoGen(AutoGen):\r
c17956e0
DL
2732 ## Cache the timestamps of metafiles of every module in a class variable\r
2733 #\r
2734 TimeDict = {}\r
2735\r
52302d4d
LG
2736 ## The real constructor of ModuleAutoGen\r
2737 #\r
2738 # This method is not supposed to be called by users of ModuleAutoGen. It's\r
2739 # only used by factory method __new__() to do real initialization work for an\r
2740 # object of ModuleAutoGen\r
2741 #\r
2742 # @param Workspace EdkIIWorkspaceBuild object\r
2743 # @param ModuleFile The path of module file\r
2744 # @param Target Build target (DEBUG, RELEASE)\r
2745 # @param Toolchain Name of tool chain\r
2746 # @param Arch The arch the module supports\r
2747 # @param PlatformFile Platform meta-file\r
2748 #\r
2749 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
2750 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
2751 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
2752\r
2753 self.Workspace = Workspace\r
2754 self.WorkspaceDir = Workspace.WorkspaceDir\r
2755\r
2756 self.MetaFile = ModuleFile\r
2757 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
2758 # check if this module is employed by active platform\r
2759 if not self.PlatformInfo.ValidModule(self.MetaFile):\r
2760 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
2761 % (self.MetaFile, Arch))\r
2762 return False\r
2763\r
2764 self.SourceDir = self.MetaFile.SubDir\r
05cc51ad 2765 self.SourceDir = mws.relpath(self.SourceDir, self.WorkspaceDir)\r
97fa0ee9 2766\r
52302d4d
LG
2767 self.SourceOverrideDir = None\r
2768 # use overrided path defined in DSC file\r
2769 if self.MetaFile.Key in GlobalData.gOverrideDir:\r
2770 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]\r
2771\r
2772 self.ToolChain = Toolchain\r
2773 self.BuildTarget = Target\r
2774 self.Arch = Arch\r
2775 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily\r
2776 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily\r
2777\r
2778 self.IsMakeFileCreated = False\r
2779 self.IsCodeFileCreated = False\r
da92f276
LG
2780 self.IsAsBuiltInfCreated = False\r
2781 self.DepexGenerated = False\r
52302d4d
LG
2782\r
2783 self.BuildDatabase = self.Workspace.BuildDatabase\r
fe4bf2f9 2784 self.BuildRuleOrder = None\r
1b8eca8b 2785 self.BuildTime = 0\r
52302d4d
LG
2786\r
2787 self._Module = None\r
2788 self._Name = None\r
2789 self._Guid = None\r
2790 self._Version = None\r
2791 self._ModuleType = None\r
2792 self._ComponentType = None\r
2793 self._PcdIsDriver = None\r
2794 self._AutoGenVersion = None\r
2795 self._LibraryFlag = None\r
2796 self._CustomMakefile = None\r
2797 self._Macro = None\r
2798\r
2799 self._BuildDir = None\r
2800 self._OutputDir = None\r
37de70b7 2801 self._FfsOutputDir = None\r
52302d4d
LG
2802 self._DebugDir = None\r
2803 self._MakeFileDir = None\r
2804\r
2805 self._IncludePathList = None\r
725cdb8f 2806 self._IncludePathLength = 0\r
52302d4d
LG
2807 self._AutoGenFileList = None\r
2808 self._UnicodeFileList = None\r
5b97eb4c 2809 self._VfrFileList = None\r
333ba578 2810 self._IdfFileList = None\r
52302d4d
LG
2811 self._SourceFileList = None\r
2812 self._ObjectFileList = None\r
2813 self._BinaryFileList = None\r
2814\r
2815 self._DependentPackageList = None\r
2816 self._DependentLibraryList = None\r
2817 self._LibraryAutoGenList = None\r
2818 self._DerivedPackageList = None\r
2819 self._ModulePcdList = None\r
2820 self._LibraryPcdList = None\r
e8a47801 2821 self._PcdComments = sdict()\r
52302d4d 2822 self._GuidList = None\r
e8a47801
LG
2823 self._GuidsUsedByPcd = None\r
2824 self._GuidComments = sdict()\r
52302d4d 2825 self._ProtocolList = None\r
e8a47801 2826 self._ProtocolComments = sdict()\r
52302d4d 2827 self._PpiList = None\r
e8a47801 2828 self._PpiComments = sdict()\r
52302d4d
LG
2829 self._DepexList = None\r
2830 self._DepexExpressionList = None\r
2831 self._BuildOption = None\r
79b74a03 2832 self._BuildOptionIncPathList = None\r
52302d4d
LG
2833 self._BuildTargets = None\r
2834 self._IntroBuildTargetList = None\r
2835 self._FinalBuildTargetList = None\r
2836 self._FileTypes = None\r
2837 self._BuildRules = None\r
c17956e0
DL
2838\r
2839 self._TimeStampPath = None\r
2840\r
2841 self.AutoGenDepSet = set()\r
2842\r
2bc3256c
LG
2843 \r
2844 ## The Modules referenced to this Library\r
2845 # Only Library has this attribute\r
2846 self._ReferenceModules = [] \r
2847 \r
2848 ## Store the FixedAtBuild Pcds\r
2849 # \r
2850 self._FixedAtBuildPcds = []\r
2851 self.ConstPcd = {}\r
52302d4d
LG
2852 return True\r
2853\r
2854 def __repr__(self):\r
2855 return "%s [%s]" % (self.MetaFile, self.Arch)\r
2856\r
2bc3256c
LG
2857 # Get FixedAtBuild Pcds of this Module\r
2858 def _GetFixedAtBuildPcds(self):\r
2859 if self._FixedAtBuildPcds:\r
2860 return self._FixedAtBuildPcds\r
2861 for Pcd in self.ModulePcdList:\r
7256bd55 2862 if Pcd.Type != "FixedAtBuild":\r
2bc3256c
LG
2863 continue\r
2864 if Pcd not in self._FixedAtBuildPcds:\r
2865 self._FixedAtBuildPcds.append(Pcd)\r
2866 \r
2867 return self._FixedAtBuildPcds \r
2868\r
867d1cd4
YL
2869 def _GetUniqueBaseName(self):\r
2870 BaseName = self.Name\r
2871 for Module in self.PlatformInfo.ModuleAutoGenList:\r
2872 if Module.MetaFile == self.MetaFile:\r
2873 continue\r
2874 if Module.Name == self.Name:\r
867d1cd4
YL
2875 if uuid.UUID(Module.Guid) == uuid.UUID(self.Guid):\r
2876 EdkLogger.error("build", FILE_DUPLICATED, 'Modules have same BaseName and FILE_GUID:\n'\r
2877 ' %s\n %s' % (Module.MetaFile, self.MetaFile))\r
2878 BaseName = '%s_%s' % (self.Name, self.Guid)\r
2879 return BaseName\r
2880\r
52302d4d
LG
2881 # Macros could be used in build_rule.txt (also Makefile)\r
2882 def _GetMacros(self):\r
2883 if self._Macro == None:\r
2884 self._Macro = sdict()\r
2885 self._Macro["WORKSPACE" ] = self.WorkspaceDir\r
2886 self._Macro["MODULE_NAME" ] = self.Name\r
867d1cd4 2887 self._Macro["MODULE_NAME_GUID" ] = self._GetUniqueBaseName()\r
52302d4d
LG
2888 self._Macro["MODULE_GUID" ] = self.Guid\r
2889 self._Macro["MODULE_VERSION" ] = self.Version\r
2890 self._Macro["MODULE_TYPE" ] = self.ModuleType\r
2891 self._Macro["MODULE_FILE" ] = str(self.MetaFile)\r
2892 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName\r
2893 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir\r
2894 self._Macro["MODULE_DIR" ] = self.SourceDir\r
2895\r
2896 self._Macro["BASE_NAME" ] = self.Name\r
2897\r
2898 self._Macro["ARCH" ] = self.Arch\r
2899 self._Macro["TOOLCHAIN" ] = self.ToolChain\r
2900 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain\r
0d2711a6 2901 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain\r
52302d4d
LG
2902 self._Macro["TARGET" ] = self.BuildTarget\r
2903\r
2904 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir\r
2905 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2906 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2907 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir\r
2908 self._Macro["OUTPUT_DIR" ] = self.OutputDir\r
2909 self._Macro["DEBUG_DIR" ] = self.DebugDir\r
df1e1b63
YZ
2910 self._Macro["DEST_DIR_OUTPUT" ] = self.OutputDir\r
2911 self._Macro["DEST_DIR_DEBUG" ] = self.DebugDir\r
3570e332
YZ
2912 self._Macro["PLATFORM_NAME" ] = self.PlatformInfo.Name\r
2913 self._Macro["PLATFORM_GUID" ] = self.PlatformInfo.Guid\r
2914 self._Macro["PLATFORM_VERSION" ] = self.PlatformInfo.Version\r
2915 self._Macro["PLATFORM_RELATIVE_DIR" ] = self.PlatformInfo.SourceDir\r
2916 self._Macro["PLATFORM_DIR" ] = mws.join(self.WorkspaceDir, self.PlatformInfo.SourceDir)\r
2917 self._Macro["PLATFORM_OUTPUT_DIR" ] = self.PlatformInfo.OutputDir\r
37de70b7 2918 self._Macro["FFS_OUTPUT_DIR" ] = self.FfsOutputDir\r
52302d4d
LG
2919 return self._Macro\r
2920\r
2921 ## Return the module build data object\r
2922 def _GetModule(self):\r
2923 if self._Module == None:\r
0d2711a6 2924 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2925 return self._Module\r
2926\r
2927 ## Return the module name\r
2928 def _GetBaseName(self):\r
2929 return self.Module.BaseName\r
2930\r
b36d134f
LG
2931 ## Return the module DxsFile if exist\r
2932 def _GetDxsFile(self):\r
2933 return self.Module.DxsFile\r
2934\r
52302d4d
LG
2935 ## Return the module SourceOverridePath\r
2936 def _GetSourceOverridePath(self):\r
2937 return self.Module.SourceOverridePath\r
2938\r
2939 ## Return the module meta-file GUID\r
2940 def _GetGuid(self):\r
97fa0ee9
YL
2941 #\r
2942 # To build same module more than once, the module path with FILE_GUID overridden has\r
2943 # the file name FILE_GUIDmodule.inf, but the relative path (self.MetaFile.File) is the realy path\r
2944 # in DSC. The overridden GUID can be retrieved from file name\r
2945 #\r
2946 if os.path.basename(self.MetaFile.File) != os.path.basename(self.MetaFile.Path):\r
2947 #\r
2948 # Length of GUID is 36\r
2949 #\r
2950 return os.path.basename(self.MetaFile.Path)[:36]\r
52302d4d
LG
2951 return self.Module.Guid\r
2952\r
2953 ## Return the module version\r
2954 def _GetVersion(self):\r
2955 return self.Module.Version\r
2956\r
2957 ## Return the module type\r
2958 def _GetModuleType(self):\r
2959 return self.Module.ModuleType\r
2960\r
b36d134f 2961 ## Return the component type (for Edk.x style of module)\r
52302d4d
LG
2962 def _GetComponentType(self):\r
2963 return self.Module.ComponentType\r
2964\r
2965 ## Return the build type\r
2966 def _GetBuildType(self):\r
2967 return self.Module.BuildType\r
2968\r
2969 ## Return the PCD_IS_DRIVER setting\r
2970 def _GetPcdIsDriver(self):\r
2971 return self.Module.PcdIsDriver\r
2972\r
2973 ## Return the autogen version, i.e. module meta-file version\r
2974 def _GetAutoGenVersion(self):\r
2975 return self.Module.AutoGenVersion\r
2976\r
2977 ## Check if the module is library or not\r
2978 def _IsLibrary(self):\r
2979 if self._LibraryFlag == None:\r
2980 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:\r
2981 self._LibraryFlag = True\r
2982 else:\r
2983 self._LibraryFlag = False\r
2984 return self._LibraryFlag\r
2985\r
e8a47801
LG
2986 ## Check if the module is binary module or not\r
2987 def _IsBinaryModule(self):\r
2988 return self.Module.IsBinaryModule\r
2989\r
52302d4d
LG
2990 ## Return the directory to store intermediate files of the module\r
2991 def _GetBuildDir(self):\r
2992 if self._BuildDir == None:\r
2993 self._BuildDir = path.join(\r
2994 self.PlatformInfo.BuildDir,\r
2995 self.Arch,\r
2996 self.SourceDir,\r
2997 self.MetaFile.BaseName\r
2998 )\r
2999 CreateDirectory(self._BuildDir)\r
3000 return self._BuildDir\r
3001\r
3002 ## Return the directory to store the intermediate object files of the mdoule\r
3003 def _GetOutputDir(self):\r
3004 if self._OutputDir == None:\r
3005 self._OutputDir = path.join(self.BuildDir, "OUTPUT")\r
3006 CreateDirectory(self._OutputDir)\r
3007 return self._OutputDir\r
3008\r
37de70b7
YZ
3009 ## Return the directory to store ffs file\r
3010 def _GetFfsOutputDir(self):\r
3011 if self._FfsOutputDir == None:\r
3012 if GlobalData.gFdfParser != None:\r
3013 self._FfsOutputDir = path.join(self.PlatformInfo.BuildDir, "FV", "Ffs", self.Guid + self.Name)\r
3014 else:\r
3015 self._FfsOutputDir = ''\r
3016 return self._FfsOutputDir\r
3017\r
52302d4d
LG
3018 ## Return the directory to store auto-gened source files of the mdoule\r
3019 def _GetDebugDir(self):\r
3020 if self._DebugDir == None:\r
3021 self._DebugDir = path.join(self.BuildDir, "DEBUG")\r
3022 CreateDirectory(self._DebugDir)\r
3023 return self._DebugDir\r
3024\r
3025 ## Return the path of custom file\r
3026 def _GetCustomMakefile(self):\r
3027 if self._CustomMakefile == None:\r
3028 self._CustomMakefile = {}\r
3029 for Type in self.Module.CustomMakefile:\r
3030 if Type in gMakeTypeMap:\r
3031 MakeType = gMakeTypeMap[Type]\r
3032 else:\r
3033 MakeType = 'nmake'\r
3034 if self.SourceOverrideDir != None:\r
3035 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])\r
3036 if not os.path.exists(File):\r
3037 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
3038 else:\r
3039 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
3040 self._CustomMakefile[MakeType] = File\r
3041 return self._CustomMakefile\r
3042\r
3043 ## Return the directory of the makefile\r
3044 #\r
3045 # @retval string The directory string of module's makefile\r
3046 #\r
3047 def _GetMakeFileDir(self):\r
3048 return self.BuildDir\r
3049\r
3050 ## Return build command string\r
3051 #\r
3052 # @retval string Build command string\r
3053 #\r
3054 def _GetBuildCommand(self):\r
3055 return self.PlatformInfo.BuildCommand\r
3056\r
3057 ## Get object list of all packages the module and its dependent libraries belong to\r
3058 #\r
3059 # @retval list The list of package object\r
3060 #\r
3061 def _GetDerivedPackageList(self):\r
3062 PackageList = []\r
3063 for M in [self.Module] + self.DependentLibraryList:\r
3064 for Package in M.Packages:\r
3065 if Package in PackageList:\r
3066 continue\r
3067 PackageList.append(Package)\r
3068 return PackageList\r
97fa0ee9
YL
3069 \r
3070 ## Get the depex string\r
3071 #\r
3072 # @return : a string contain all depex expresion.\r
3073 def _GetDepexExpresionString(self):\r
3074 DepexStr = ''\r
3075 DepexList = []\r
3076 ## DPX_SOURCE IN Define section.\r
3077 if self.Module.DxsFile:\r
3078 return DepexStr\r
3079 for M in [self.Module] + self.DependentLibraryList:\r
3080 Filename = M.MetaFile.Path\r
3081 InfObj = InfSectionParser.InfSectionParser(Filename)\r
3082 DepexExpresionList = InfObj.GetDepexExpresionList()\r
3083 for DepexExpresion in DepexExpresionList:\r
3084 for key in DepexExpresion.keys():\r
3085 Arch, ModuleType = key\r
518aebe2 3086 DepexExpr = [x for x in DepexExpresion[key] if not str(x).startswith('#')]\r
97fa0ee9
YL
3087 # the type of build module is USER_DEFINED.\r
3088 # All different DEPEX section tags would be copied into the As Built INF file\r
3089 # and there would be separate DEPEX section tags\r
3090 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
3091 if (Arch.upper() == self.Arch.upper()) and (ModuleType.upper() != TAB_ARCH_COMMON):\r
518aebe2 3092 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
3093 else:\r
3094 if Arch.upper() == TAB_ARCH_COMMON or \\r
3095 (Arch.upper() == self.Arch.upper() and \\r
3096 ModuleType.upper() in [TAB_ARCH_COMMON, self.ModuleType.upper()]):\r
518aebe2 3097 DepexList.append({(Arch, ModuleType): DepexExpr})\r
97fa0ee9
YL
3098 \r
3099 #the type of build module is USER_DEFINED.\r
3100 if self.ModuleType.upper() == SUP_MODULE_USER_DEFINED:\r
3101 for Depex in DepexList:\r
3102 for key in Depex.keys():\r
3103 DepexStr += '[Depex.%s.%s]\n' % key\r
3104 DepexStr += '\n'.join(['# '+ val for val in Depex[key]])\r
3105 DepexStr += '\n\n'\r
3106 if not DepexStr:\r
3107 return '[Depex.%s]\n' % self.Arch\r
3108 return DepexStr\r
3109 \r
3110 #the type of build module not is USER_DEFINED.\r
3111 Count = 0\r
3112 for Depex in DepexList:\r
3113 Count += 1\r
3114 if DepexStr != '':\r
3115 DepexStr += ' AND '\r
3116 DepexStr += '('\r
3117 for D in Depex.values():\r
3118 DepexStr += ' '.join([val for val in D])\r
3119 Index = DepexStr.find('END')\r
3120 if Index > -1 and Index == len(DepexStr) - 3:\r
3121 DepexStr = DepexStr[:-3]\r
3122 DepexStr = DepexStr.strip()\r
3123 DepexStr += ')'\r
3124 if Count == 1:\r
3125 DepexStr = DepexStr.lstrip('(').rstrip(')').strip()\r
3126 if not DepexStr:\r
3127 return '[Depex.%s]\n' % self.Arch\r
3128 return '[Depex.%s]\n# ' % self.Arch + DepexStr\r
3129 \r
52302d4d
LG
3130 ## Merge dependency expression\r
3131 #\r
3132 # @retval list The token list of the dependency expression after parsed\r
3133 #\r
3134 def _GetDepexTokenList(self):\r
3135 if self._DepexList == None:\r
3136 self._DepexList = {}\r
b36d134f 3137 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
3138 return self._DepexList\r
3139\r
3140 self._DepexList[self.ModuleType] = []\r
3141\r
3142 for ModuleType in self._DepexList:\r
3143 DepexList = self._DepexList[ModuleType]\r
3144 #\r
3145 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
3146 #\r
3147 for M in [self.Module] + self.DependentLibraryList:\r
3148 Inherited = False\r
3149 for D in M.Depex[self.Arch, ModuleType]:\r
3150 if DepexList != []:\r
3151 DepexList.append('AND')\r
3152 DepexList.append('(')\r
3153 DepexList.extend(D)\r
3154 if DepexList[-1] == 'END': # no need of a END at this time\r
3155 DepexList.pop()\r
3156 DepexList.append(')')\r
3157 Inherited = True\r
3158 if Inherited:\r
3159 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))\r
3160 if 'BEFORE' in DepexList or 'AFTER' in DepexList:\r
3161 break\r
3162 if len(DepexList) > 0:\r
3163 EdkLogger.verbose('')\r
3164 return self._DepexList\r
3165\r
3166 ## Merge dependency expression\r
3167 #\r
3168 # @retval list The token list of the dependency expression after parsed\r
3169 #\r
3170 def _GetDepexExpressionTokenList(self):\r
3171 if self._DepexExpressionList == None:\r
3172 self._DepexExpressionList = {}\r
b36d134f 3173 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
3174 return self._DepexExpressionList\r
3175\r
3176 self._DepexExpressionList[self.ModuleType] = ''\r
3177\r
3178 for ModuleType in self._DepexExpressionList:\r
3179 DepexExpressionList = self._DepexExpressionList[ModuleType]\r
3180 #\r
3181 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
3182 #\r
3183 for M in [self.Module] + self.DependentLibraryList:\r
3184 Inherited = False\r
3185 for D in M.DepexExpression[self.Arch, ModuleType]:\r
3186 if DepexExpressionList != '':\r
3187 DepexExpressionList += ' AND '\r
3188 DepexExpressionList += '('\r
3189 DepexExpressionList += D\r
3190 DepexExpressionList = DepexExpressionList.rstrip('END').strip()\r
3191 DepexExpressionList += ')'\r
3192 Inherited = True\r
3193 if Inherited:\r
3194 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))\r
3195 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:\r
3196 break\r
3197 if len(DepexExpressionList) > 0:\r
3198 EdkLogger.verbose('')\r
3199 self._DepexExpressionList[ModuleType] = DepexExpressionList\r
3200 return self._DepexExpressionList\r
3201\r
dfa41b4a
YZ
3202 # Get the tiano core user extension, it is contain dependent library.\r
3203 # @retval: a list contain tiano core userextension.\r
3204 #\r
3205 def _GetTianoCoreUserExtensionList(self):\r
3206 TianoCoreUserExtentionList = []\r
3207 for M in [self.Module] + self.DependentLibraryList:\r
3208 Filename = M.MetaFile.Path\r
3209 InfObj = InfSectionParser.InfSectionParser(Filename)\r
3210 TianoCoreUserExtenList = InfObj.GetUserExtensionTianoCore()\r
3211 for TianoCoreUserExtent in TianoCoreUserExtenList:\r
3212 for Section in TianoCoreUserExtent.keys():\r
3213 ItemList = Section.split(TAB_SPLIT)\r
3214 Arch = self.Arch\r
3215 if len(ItemList) == 4:\r
3216 Arch = ItemList[3]\r
3217 if Arch.upper() == TAB_ARCH_COMMON or Arch.upper() == self.Arch.upper():\r
3218 TianoCoreList = []\r
3219 TianoCoreList.extend([TAB_SECTION_START + Section + TAB_SECTION_END])\r
3220 TianoCoreList.extend(TianoCoreUserExtent[Section][:])\r
3221 TianoCoreList.append('\n')\r
3222 TianoCoreUserExtentionList.append(TianoCoreList)\r
3223\r
3224 return TianoCoreUserExtentionList\r
3225\r
52302d4d
LG
3226 ## Return the list of specification version required for the module\r
3227 #\r
3228 # @retval list The list of specification defined in module file\r
3229 #\r
3230 def _GetSpecification(self):\r
3231 return self.Module.Specification\r
3232\r
3233 ## Tool option for the module build\r
3234 #\r
3235 # @param PlatformInfo The object of PlatformBuildInfo\r
3236 # @retval dict The dict containing valid options\r
3237 #\r
3238 def _GetModuleBuildOption(self):\r
3239 if self._BuildOption == None:\r
fe4bf2f9
YL
3240 self._BuildOption, self.BuildRuleOrder = self.PlatformInfo.ApplyBuildOption(self.Module)\r
3241 if self.BuildRuleOrder:\r
3242 self.BuildRuleOrder = ['.%s' % Ext for Ext in self.BuildRuleOrder.split()]\r
52302d4d
LG
3243 return self._BuildOption\r
3244\r
79b74a03
LG
3245 ## Get include path list from tool option for the module build\r
3246 #\r
3247 # @retval list The include path list\r
3248 #\r
3249 def _GetBuildOptionIncPathList(self):\r
3250 if self._BuildOptionIncPathList == None:\r
3251 #\r
d40b2ee6 3252 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
79b74a03
LG
3253 # is the former use /I , the Latter used -I to specify include directories\r
3254 #\r
3255 if self.PlatformInfo.ToolChainFamily in ('MSFT'):\r
47fea6af 3256 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
d40b2ee6 3257 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):\r
47fea6af 3258 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE | re.DOTALL)\r
d40b2ee6
LG
3259 else:\r
3260 #\r
3261 # New ToolChainFamily, don't known whether there is option to specify include directories\r
3262 #\r
3263 self._BuildOptionIncPathList = []\r
3264 return self._BuildOptionIncPathList\r
79b74a03
LG
3265 \r
3266 BuildOptionIncPathList = []\r
3267 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):\r
3268 Attr = 'FLAGS'\r
3269 try:\r
3270 FlagOption = self.BuildOption[Tool][Attr]\r
3271 except KeyError:\r
3272 FlagOption = ''\r
3273 \r
d40b2ee6
LG
3274 if self.PlatformInfo.ToolChainFamily != 'RVCT':\r
3275 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]\r
3276 else:\r
3277 #\r
3278 # RVCT may specify a list of directory seperated by commas\r
3279 #\r
3280 IncPathList = []\r
3281 for Path in gBuildOptIncludePattern.findall(FlagOption):\r
3282 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)\r
3283 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]\r
3284\r
79b74a03
LG
3285 #\r
3286 # EDK II modules must not reference header files outside of the packages they depend on or \r
3287 # within the module's directory tree. Report error if violation.\r
3288 #\r
3289 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:\r
3290 for Path in IncPathList:\r
3291 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):\r
47fea6af
YZ
3292 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption)\r
3293 EdkLogger.error("build",\r
79b74a03 3294 PARAMETER_INVALID,\r
47fea6af
YZ
3295 ExtraData=ErrMsg,\r
3296 File=str(self.MetaFile))\r
79b74a03
LG
3297\r
3298 \r
3299 BuildOptionIncPathList += IncPathList\r
3300 \r
3301 self._BuildOptionIncPathList = BuildOptionIncPathList\r
3302 \r
3303 return self._BuildOptionIncPathList\r
3304 \r
52302d4d
LG
3305 ## Return a list of files which can be built from source\r
3306 #\r
3307 # What kind of files can be built is determined by build rules in\r
97fa0ee9 3308 # $(CONF_DIRECTORY)/build_rule.txt and toolchain family.\r
52302d4d
LG
3309 #\r
3310 def _GetSourceFileList(self):\r
3311 if self._SourceFileList == None:\r
3312 self._SourceFileList = []\r
3313 for F in self.Module.Sources:\r
3314 # match tool chain\r
08dd311f 3315 if F.TagName not in ("", "*", self.ToolChain):\r
52302d4d
LG
3316 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "\r
3317 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))\r
3318 continue\r
e2597799
YZ
3319 # match tool chain family or build rule family\r
3320 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily, self.BuildRuleFamily):\r
52302d4d
LG
3321 EdkLogger.debug(\r
3322 EdkLogger.DEBUG_0,\r
3323 "The file [%s] must be built by tools of [%s], " \\r
e2597799
YZ
3324 "but current toolchain family is [%s], buildrule family is [%s]" \\r
3325 % (str(F), F.ToolChainFamily, self.ToolChainFamily, self.BuildRuleFamily))\r
52302d4d
LG
3326 continue\r
3327\r
3328 # add the file path into search path list for file including\r
3329 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:\r
3330 self.IncludePathList.insert(0, F.Dir)\r
3331 self._SourceFileList.append(F)\r
4cb7bade
YZ
3332\r
3333 self._MatchBuildRuleOrder(self._SourceFileList)\r
3334\r
3335 for F in self._SourceFileList:\r
52302d4d
LG
3336 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)\r
3337 return self._SourceFileList\r
3338\r
4cb7bade
YZ
3339 def _MatchBuildRuleOrder(self, FileList):\r
3340 Order_Dict = {}\r
3341 self._GetModuleBuildOption()\r
3342 for SingleFile in FileList:\r
3343 if self.BuildRuleOrder and SingleFile.Ext in self.BuildRuleOrder and SingleFile.Ext in self.BuildRules:\r
3344 key = SingleFile.Path.split(SingleFile.Ext)[0]\r
3345 if key in Order_Dict:\r
3346 Order_Dict[key].append(SingleFile.Ext)\r
3347 else:\r
3348 Order_Dict[key] = [SingleFile.Ext]\r
3349\r
3350 RemoveList = []\r
3351 for F in Order_Dict:\r
3352 if len(Order_Dict[F]) > 1:\r
3353 Order_Dict[F].sort(key=lambda i: self.BuildRuleOrder.index(i))\r
3354 for Ext in Order_Dict[F][1:]:\r
3355 RemoveList.append(F + Ext)\r
3356 \r
3357 for item in RemoveList:\r
3358 FileList.remove(item)\r
3359\r
3360 return FileList\r
3361\r
52302d4d
LG
3362 ## Return the list of unicode files\r
3363 def _GetUnicodeFileList(self):\r
3364 if self._UnicodeFileList == None:\r
3365 if TAB_UNICODE_FILE in self.FileTypes:\r
3366 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]\r
3367 else:\r
3368 self._UnicodeFileList = []\r
3369 return self._UnicodeFileList\r
3370\r
5b97eb4c
YZ
3371 ## Return the list of vfr files\r
3372 def _GetVfrFileList(self):\r
3373 if self._VfrFileList == None:\r
3374 if TAB_VFR_FILE in self.FileTypes:\r
3375 self._VfrFileList = self.FileTypes[TAB_VFR_FILE]\r
3376 else:\r
3377 self._VfrFileList = []\r
3378 return self._VfrFileList\r
3379\r
333ba578
YZ
3380 ## Return the list of Image Definition files\r
3381 def _GetIdfFileList(self):\r
3382 if self._IdfFileList == None:\r
3383 if TAB_IMAGE_FILE in self.FileTypes:\r
3384 self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]\r
3385 else:\r
3386 self._IdfFileList = []\r
3387 return self._IdfFileList\r
3388\r
52302d4d
LG
3389 ## Return a list of files which can be built from binary\r
3390 #\r
3391 # "Build" binary files are just to copy them to build directory.\r
3392 #\r
3393 # @retval list The list of files which can be built later\r
3394 #\r
3395 def _GetBinaryFiles(self):\r
3396 if self._BinaryFileList == None:\r
3397 self._BinaryFileList = []\r
3398 for F in self.Module.Binaries:\r
3399 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:\r
3400 continue\r
3401 self._BinaryFileList.append(F)\r
3402 self._ApplyBuildRule(F, F.Type)\r
3403 return self._BinaryFileList\r
3404\r
3405 def _GetBuildRules(self):\r
3406 if self._BuildRules == None:\r
3407 BuildRules = {}\r
3408 BuildRuleDatabase = self.PlatformInfo.BuildRule\r
3409 for Type in BuildRuleDatabase.FileTypeList:\r
3410 #first try getting build rule by BuildRuleFamily\r
3411 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]\r
3412 if not RuleObject:\r
3413 # build type is always module type, but ...\r
3414 if self.ModuleType != self.BuildType:\r
3415 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]\r
3416 #second try getting build rule by ToolChainFamily\r
3417 if not RuleObject:\r
3418 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]\r
3419 if not RuleObject:\r
3420 # build type is always module type, but ...\r
3421 if self.ModuleType != self.BuildType:\r
3422 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]\r
3423 if not RuleObject:\r
3424 continue\r
3425 RuleObject = RuleObject.Instantiate(self.Macros)\r
3426 BuildRules[Type] = RuleObject\r
3427 for Ext in RuleObject.SourceFileExtList:\r
3428 BuildRules[Ext] = RuleObject\r
3429 self._BuildRules = BuildRules\r
3430 return self._BuildRules\r
3431\r
3432 def _ApplyBuildRule(self, File, FileType):\r
3433 if self._BuildTargets == None:\r
3434 self._IntroBuildTargetList = set()\r
3435 self._FinalBuildTargetList = set()\r
3436 self._BuildTargets = {}\r
3437 self._FileTypes = {}\r
3438\r
fcd4fbf3
YL
3439 SubDirectory = os.path.join(self.OutputDir, File.SubDir)\r
3440 if not os.path.exists(SubDirectory):\r
3441 CreateDirectory(SubDirectory)\r
52302d4d
LG
3442 LastTarget = None\r
3443 RuleChain = []\r
3444 SourceList = [File]\r
3445 Index = 0\r
fe4bf2f9
YL
3446 #\r
3447 # Make sure to get build rule order value\r
3448 #\r
3449 self._GetModuleBuildOption()\r
3450\r
52302d4d
LG
3451 while Index < len(SourceList):\r
3452 Source = SourceList[Index]\r
3453 Index = Index + 1\r
3454\r
3455 if Source != File:\r
3456 CreateDirectory(Source.Dir)\r
3457\r
3458 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:\r
da92f276
LG
3459 # Skip all files that are not binary libraries\r
3460 if not self.IsLibrary:\r
47fea6af 3461 continue\r
52302d4d
LG
3462 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]\r
3463 elif FileType in self.BuildRules:\r
3464 RuleObject = self.BuildRules[FileType]\r
3465 elif Source.Ext in self.BuildRules:\r
3466 RuleObject = self.BuildRules[Source.Ext]\r
3467 else:\r
3468 # stop at no more rules\r
3469 if LastTarget:\r
3470 self._FinalBuildTargetList.add(LastTarget)\r
3471 break\r
3472\r
3473 FileType = RuleObject.SourceFileType\r
3474 if FileType not in self._FileTypes:\r
3475 self._FileTypes[FileType] = set()\r
3476 self._FileTypes[FileType].add(Source)\r
3477\r
3478 # stop at STATIC_LIBRARY for library\r
3479 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:\r
3480 if LastTarget:\r
3481 self._FinalBuildTargetList.add(LastTarget)\r
3482 break\r
3483\r
fe4bf2f9 3484 Target = RuleObject.Apply(Source, self.BuildRuleOrder)\r
52302d4d
LG
3485 if not Target:\r
3486 if LastTarget:\r
3487 self._FinalBuildTargetList.add(LastTarget)\r
3488 break\r
3489 elif not Target.Outputs:\r
3490 # Only do build for target with outputs\r
3491 self._FinalBuildTargetList.add(Target)\r
3492\r
3493 if FileType not in self._BuildTargets:\r
3494 self._BuildTargets[FileType] = set()\r
3495 self._BuildTargets[FileType].add(Target)\r
3496\r
3497 if not Source.IsBinary and Source == File:\r
3498 self._IntroBuildTargetList.add(Target)\r
3499\r
3500 # to avoid cyclic rule\r
3501 if FileType in RuleChain:\r
3502 break\r
3503\r
3504 RuleChain.append(FileType)\r
3505 SourceList.extend(Target.Outputs)\r
3506 LastTarget = Target\r
3507 FileType = TAB_UNKNOWN_FILE\r
3508\r
3509 def _GetTargets(self):\r
3510 if self._BuildTargets == None:\r
3511 self._IntroBuildTargetList = set()\r
3512 self._FinalBuildTargetList = set()\r
3513 self._BuildTargets = {}\r
3514 self._FileTypes = {}\r
3515\r
b36d134f 3516 #TRICK: call _GetSourceFileList to apply build rule for source files\r
52302d4d
LG
3517 if self.SourceFileList:\r
3518 pass\r
3519\r
3520 #TRICK: call _GetBinaryFileList to apply build rule for binary files\r
3521 if self.BinaryFileList:\r
3522 pass\r
3523\r
3524 return self._BuildTargets\r
3525\r
3526 def _GetIntroTargetList(self):\r
3527 self._GetTargets()\r
3528 return self._IntroBuildTargetList\r
3529\r
3530 def _GetFinalTargetList(self):\r
3531 self._GetTargets()\r
3532 return self._FinalBuildTargetList\r
3533\r
3534 def _GetFileTypes(self):\r
3535 self._GetTargets()\r
3536 return self._FileTypes\r
3537\r
3538 ## Get the list of package object the module depends on\r
3539 #\r
3540 # @retval list The package object list\r
3541 #\r
3542 def _GetDependentPackageList(self):\r
3543 return self.Module.Packages\r
3544\r
3545 ## Return the list of auto-generated code file\r
3546 #\r
3547 # @retval list The list of auto-generated file\r
3548 #\r
3549 def _GetAutoGenFileList(self):\r
3550 UniStringAutoGenC = True\r
333ba578 3551 IdfStringAutoGenC = True\r
4234283c 3552 UniStringBinBuffer = StringIO()\r
333ba578 3553 IdfGenBinBuffer = StringIO()\r
52302d4d 3554 if self.BuildType == 'UEFI_HII':\r
52302d4d 3555 UniStringAutoGenC = False\r
333ba578 3556 IdfStringAutoGenC = False\r
52302d4d
LG
3557 if self._AutoGenFileList == None:\r
3558 self._AutoGenFileList = {}\r
3559 AutoGenC = TemplateString()\r
3560 AutoGenH = TemplateString()\r
3561 StringH = TemplateString()\r
333ba578
YZ
3562 StringIdf = TemplateString()\r
3563 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)\r
07b8564b
YL
3564 #\r
3565 # AutoGen.c is generated if there are library classes in inf, or there are object files\r
3566 #\r
3567 if str(AutoGenC) != "" and (len(self.Module.LibraryClasses) > 0\r
3568 or TAB_OBJECT_FILE in self.FileTypes):\r
52302d4d
LG
3569 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)\r
3570 self._AutoGenFileList[AutoFile] = str(AutoGenC)\r
3571 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3572 if str(AutoGenH) != "":\r
3573 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)\r
3574 self._AutoGenFileList[AutoFile] = str(AutoGenH)\r
3575 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3576 if str(StringH) != "":\r
3577 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)\r
3578 self._AutoGenFileList[AutoFile] = str(StringH)\r
3579 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3580 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":\r
3581 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)\r
3582 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()\r
3583 AutoFile.IsBinary = True\r
3584 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3585 if UniStringBinBuffer != None:\r
3586 UniStringBinBuffer.close()\r
333ba578
YZ
3587 if str(StringIdf) != "":\r
3588 AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)\r
3589 self._AutoGenFileList[AutoFile] = str(StringIdf)\r
3590 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3591 if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":\r
3592 AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)\r
3593 self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()\r
3594 AutoFile.IsBinary = True\r
3595 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
3596 if IdfGenBinBuffer != None:\r
3597 IdfGenBinBuffer.close()\r
52302d4d
LG
3598 return self._AutoGenFileList\r
3599\r
3600 ## Return the list of library modules explicitly or implicityly used by this module\r
3601 def _GetLibraryList(self):\r
3602 if self._DependentLibraryList == None:\r
3603 # only merge library classes and PCD for non-library module\r
3604 if self.IsLibrary:\r
3605 self._DependentLibraryList = []\r
3606 else:\r
3607 if self.AutoGenVersion < 0x00010005:\r
3608 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)\r
3609 else:\r
3610 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)\r
3611 return self._DependentLibraryList\r
3612\r
e8a47801
LG
3613 @staticmethod\r
3614 def UpdateComments(Recver, Src):\r
3615 for Key in Src:\r
3616 if Key not in Recver:\r
3617 Recver[Key] = []\r
3618 Recver[Key].extend(Src[Key])\r
52302d4d
LG
3619 ## Get the list of PCDs from current module\r
3620 #\r
3621 # @retval list The list of PCD\r
3622 #\r
3623 def _GetModulePcdList(self):\r
3624 if self._ModulePcdList == None:\r
3625 # apply PCD settings from platform\r
3626 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)\r
e8a47801 3627 self.UpdateComments(self._PcdComments, self.Module.PcdComments)\r
52302d4d
LG
3628 return self._ModulePcdList\r
3629\r
3630 ## Get the list of PCDs from dependent libraries\r
3631 #\r
3632 # @retval list The list of PCD\r
3633 #\r
3634 def _GetLibraryPcdList(self):\r
3635 if self._LibraryPcdList == None:\r
79b74a03 3636 Pcds = sdict()\r
52302d4d
LG
3637 if not self.IsLibrary:\r
3638 # get PCDs from dependent libraries\r
3639 for Library in self.DependentLibraryList:\r
e8a47801 3640 self.UpdateComments(self._PcdComments, Library.PcdComments)\r
52302d4d
LG
3641 for Key in Library.Pcds:\r
3642 # skip duplicated PCDs\r
3643 if Key in self.Module.Pcds or Key in Pcds:\r
3644 continue\r
3645 Pcds[Key] = copy.copy(Library.Pcds[Key])\r
3646 # apply PCD settings from platform\r
3647 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)\r
3648 else:\r
3649 self._LibraryPcdList = []\r
3650 return self._LibraryPcdList\r
3651\r
3652 ## Get the GUID value mapping\r
3653 #\r
3654 # @retval dict The mapping between GUID cname and its value\r
3655 #\r
3656 def _GetGuidList(self):\r
3657 if self._GuidList == None:\r
8200fcfe
YL
3658 self._GuidList = sdict()\r
3659 self._GuidList.update(self.Module.Guids)\r
52302d4d
LG
3660 for Library in self.DependentLibraryList:\r
3661 self._GuidList.update(Library.Guids)\r
e8a47801
LG
3662 self.UpdateComments(self._GuidComments, Library.GuidComments)\r
3663 self.UpdateComments(self._GuidComments, self.Module.GuidComments)\r
52302d4d
LG
3664 return self._GuidList\r
3665\r
e8a47801
LG
3666 def GetGuidsUsedByPcd(self):\r
3667 if self._GuidsUsedByPcd == None:\r
3668 self._GuidsUsedByPcd = sdict()\r
3669 self._GuidsUsedByPcd.update(self.Module.GetGuidsUsedByPcd())\r
3670 for Library in self.DependentLibraryList:\r
3671 self._GuidsUsedByPcd.update(Library.GetGuidsUsedByPcd())\r
3672 return self._GuidsUsedByPcd\r
52302d4d
LG
3673 ## Get the protocol value mapping\r
3674 #\r
3675 # @retval dict The mapping between protocol cname and its value\r
3676 #\r
3677 def _GetProtocolList(self):\r
3678 if self._ProtocolList == None:\r
8200fcfe
YL
3679 self._ProtocolList = sdict()\r
3680 self._ProtocolList.update(self.Module.Protocols)\r
52302d4d
LG
3681 for Library in self.DependentLibraryList:\r
3682 self._ProtocolList.update(Library.Protocols)\r
e8a47801
LG
3683 self.UpdateComments(self._ProtocolComments, Library.ProtocolComments)\r
3684 self.UpdateComments(self._ProtocolComments, self.Module.ProtocolComments)\r
52302d4d
LG
3685 return self._ProtocolList\r
3686\r
3687 ## Get the PPI value mapping\r
3688 #\r
3689 # @retval dict The mapping between PPI cname and its value\r
3690 #\r
3691 def _GetPpiList(self):\r
3692 if self._PpiList == None:\r
8200fcfe
YL
3693 self._PpiList = sdict()\r
3694 self._PpiList.update(self.Module.Ppis)\r
52302d4d
LG
3695 for Library in self.DependentLibraryList:\r
3696 self._PpiList.update(Library.Ppis)\r
e8a47801
LG
3697 self.UpdateComments(self._PpiComments, Library.PpiComments)\r
3698 self.UpdateComments(self._PpiComments, self.Module.PpiComments)\r
52302d4d
LG
3699 return self._PpiList\r
3700\r
3701 ## Get the list of include search path\r
3702 #\r
3703 # @retval list The list path\r
3704 #\r
3705 def _GetIncludePathList(self):\r
3706 if self._IncludePathList == None:\r
3707 self._IncludePathList = []\r
3708 if self.AutoGenVersion < 0x00010005:\r
3709 for Inc in self.Module.Includes:\r
3710 if Inc not in self._IncludePathList:\r
3711 self._IncludePathList.append(Inc)\r
b36d134f 3712 # for Edk modules\r
52302d4d
LG
3713 Inc = path.join(Inc, self.Arch.capitalize())\r
3714 if os.path.exists(Inc) and Inc not in self._IncludePathList:\r
3715 self._IncludePathList.append(Inc)\r
b36d134f 3716 # 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
3717 self._IncludePathList.append(self.DebugDir)\r
3718 else:\r
3719 self._IncludePathList.append(self.MetaFile.Dir)\r
3720 self._IncludePathList.append(self.DebugDir)\r
3721\r
3722 for Package in self.Module.Packages:\r
05cc51ad 3723 PackageDir = mws.join(self.WorkspaceDir, Package.MetaFile.Dir)\r
52302d4d
LG
3724 if PackageDir not in self._IncludePathList:\r
3725 self._IncludePathList.append(PackageDir)\r
c28d2e10
YZ
3726 IncludesList = Package.Includes\r
3727 if Package._PrivateIncludes:\r
3728 if not self.MetaFile.Path.startswith(PackageDir):\r
3729 IncludesList = list(set(Package.Includes).difference(set(Package._PrivateIncludes)))\r
3730 for Inc in IncludesList:\r
52302d4d
LG
3731 if Inc not in self._IncludePathList:\r
3732 self._IncludePathList.append(str(Inc))\r
3733 return self._IncludePathList\r
3734\r
725cdb8f
YZ
3735 def _GetIncludePathLength(self):\r
3736 self._IncludePathLength = 0\r
3737 if self._IncludePathList:\r
3738 for inc in self._IncludePathList:\r
3739 self._IncludePathLength += len(' ' + inc)\r
3740 return self._IncludePathLength\r
3741\r
97fa0ee9
YL
3742 ## Get HII EX PCDs which maybe used by VFR\r
3743 #\r
3744 # efivarstore used by VFR may relate with HII EX PCDs\r
3745 # Get the variable name and GUID from efivarstore and HII EX PCD\r
3746 # List the HII EX PCDs in As Built INF if both name and GUID match.\r
3747 #\r
3748 # @retval list HII EX PCDs\r
3749 #\r
3750 def _GetPcdsMaybeUsedByVfr(self):\r
3751 if not self.SourceFileList:\r
3752 return []\r
3753\r
3754 NameGuids = []\r
3755 for SrcFile in self.SourceFileList:\r
3756 if SrcFile.Ext.lower() != '.vfr':\r
3757 continue\r
3758 Vfri = os.path.join(self.OutputDir, SrcFile.BaseName + '.i')\r
3759 if not os.path.exists(Vfri):\r
3760 continue\r
3761 VfriFile = open(Vfri, 'r')\r
3762 Content = VfriFile.read()\r
3763 VfriFile.close()\r
3764 Pos = Content.find('efivarstore')\r
3765 while Pos != -1:\r
3766 #\r
3767 # Make sure 'efivarstore' is the start of efivarstore statement\r
3768 # In case of the value of 'name' (name = efivarstore) is equal to 'efivarstore'\r
3769 #\r
3770 Index = Pos - 1\r
3771 while Index >= 0 and Content[Index] in ' \t\r\n':\r
3772 Index -= 1\r
3773 if Index >= 0 and Content[Index] != ';':\r
3774 Pos = Content.find('efivarstore', Pos + len('efivarstore'))\r
3775 continue\r
3776 #\r
3777 # 'efivarstore' must be followed by name and guid\r
3778 #\r
3779 Name = gEfiVarStoreNamePattern.search(Content, Pos)\r
3780 if not Name:\r
3781 break\r
3782 Guid = gEfiVarStoreGuidPattern.search(Content, Pos)\r
3783 if not Guid:\r
3784 break\r
3785 NameArray = ConvertStringToByteArray('L"' + Name.group(1) + '"')\r
3786 NameGuids.append((NameArray, GuidStructureStringToGuidString(Guid.group(1))))\r
3787 Pos = Content.find('efivarstore', Name.end())\r
3788 if not NameGuids:\r
3789 return []\r
3790 HiiExPcds = []\r
3791 for Pcd in self.PlatformInfo.Platform.Pcds.values():\r
3792 if Pcd.Type != TAB_PCDS_DYNAMIC_EX_HII:\r
3793 continue\r
3794 for SkuName in Pcd.SkuInfoList:\r
3795 SkuInfo = Pcd.SkuInfoList[SkuName]\r
3796 Name = ConvertStringToByteArray(SkuInfo.VariableName)\r
c28d2e10 3797 Value = GuidValue(SkuInfo.VariableGuid, self.PlatformInfo.PackageList, self.MetaFile.Path)\r
97fa0ee9
YL
3798 if not Value:\r
3799 continue\r
3800 Guid = GuidStructureStringToGuidString(Value)\r
3801 if (Name, Guid) in NameGuids and Pcd not in HiiExPcds:\r
3802 HiiExPcds.append(Pcd)\r
3803 break\r
3804\r
3805 return HiiExPcds\r
3806\r
aeaaf754
YL
3807 def _GenOffsetBin(self):\r
3808 VfrUniBaseName = {}\r
3809 for SourceFile in self.Module.Sources:\r
3810 if SourceFile.Type.upper() == ".VFR" :\r
3811 #\r
3812 # search the .map file to find the offset of vfr binary in the PE32+/TE file. \r
3813 #\r
3814 VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")\r
3815 if SourceFile.Type.upper() == ".UNI" :\r
3816 #\r
3817 # search the .map file to find the offset of Uni strings binary in the PE32+/TE file. \r
3818 #\r
3819 VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")\r
3820\r
3821 if len(VfrUniBaseName) == 0:\r
3822 return None\r
3823 MapFileName = os.path.join(self.OutputDir, self.Name + ".map")\r
3824 EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")\r
3825 VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())\r
3826 if not VfrUniOffsetList:\r
3827 return None\r
3828\r
3829 OutputName = '%sOffset.bin' % self.Name\r
3830 UniVfrOffsetFileName = os.path.join( self.OutputDir, OutputName)\r
3831\r
3832 try:\r
3833 fInputfile = open(UniVfrOffsetFileName, "wb+", 0)\r
3834 except:\r
3835 EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)\r
3836\r
3837 # Use a instance of StringIO to cache data\r
3838 fStringIO = StringIO('') \r
3839\r
3840 for Item in VfrUniOffsetList:\r
3841 if (Item[0].find("Strings") != -1):\r
3842 #\r
3843 # UNI offset in image.\r
3844 # GUID + Offset\r
3845 # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
3846 #\r
3847 UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]\r
3848 UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]\r
3849 fStringIO.write(''.join(UniGuid)) \r
3850 UniValue = pack ('Q', int (Item[1], 16))\r
3851 fStringIO.write (UniValue)\r
3852 else:\r
3853 #\r
3854 # VFR binary offset in image.\r
3855 # GUID + Offset\r
3856 # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };\r
3857 #\r
3858 VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]\r
3859 VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]\r
3860 fStringIO.write(''.join(VfrGuid)) \r
3861 type (Item[1]) \r
3862 VfrValue = pack ('Q', int (Item[1], 16))\r
3863 fStringIO.write (VfrValue)\r
3864 #\r
3865 # write data into file.\r
3866 #\r
3867 try : \r
3868 fInputfile.write (fStringIO.getvalue())\r
3869 except:\r
3870 EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "\r
3871 "file been locked or using by other applications." %UniVfrOffsetFileName,None)\r
3872\r
3873 fStringIO.close ()\r
3874 fInputfile.close ()\r
3875 return OutputName\r
3876\r
da92f276
LG
3877 ## Create AsBuilt INF file the module\r
3878 #\r
83397f95
YZ
3879 def CreateAsBuiltInf(self, IsOnlyCopy = False):\r
3880 self.OutputFile = []\r
3881 if IsOnlyCopy:\r
3882 if GlobalData.gBinCacheDest:\r
3883 self.CopyModuleToCache()\r
3884 return\r
3885\r
da92f276
LG
3886 if self.IsAsBuiltInfCreated:\r
3887 return\r
3888 \r
3889 # Skip the following code for EDK I inf\r
3890 if self.AutoGenVersion < 0x00010005:\r
3891 return\r
3892 \r
3893 # Skip the following code for libraries\r
3894 if self.IsLibrary:\r
3895 return\r
3896 \r
3897 # Skip the following code for modules with no source files\r
3898 if self.SourceFileList == None or self.SourceFileList == []:\r
3899 return\r
3900\r
3901 # Skip the following code for modules without any binary files\r
3902 if self.BinaryFileList <> None and self.BinaryFileList <> []:\r
3903 return\r
3904 \r
3905 ### TODO: How to handles mixed source and binary modules\r
3906\r
e8a47801 3907 # Find all DynamicEx and PatchableInModule PCDs used by this module and dependent libraries\r
da92f276
LG
3908 # Also find all packages that the DynamicEx PCDs depend on\r
3909 Pcds = []\r
e5cf9198 3910 PatchablePcds = []\r
47fea6af 3911 Packages = []\r
e8a47801
LG
3912 PcdCheckList = []\r
3913 PcdTokenSpaceList = []\r
da92f276 3914 for Pcd in self.ModulePcdList + self.LibraryPcdList:\r
e8a47801 3915 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
e5cf9198 3916 PatchablePcds += [Pcd]\r
e8a47801
LG
3917 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'PatchableInModule'))\r
3918 elif Pcd.Type in GenC.gDynamicExPcd:\r
3919 if Pcd not in Pcds:\r
3920 Pcds += [Pcd]\r
3921 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx'))\r
3922 PcdCheckList.append((Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic'))\r
3923 PcdTokenSpaceList.append(Pcd.TokenSpaceGuidCName)\r
3924 GuidList = sdict()\r
3925 GuidList.update(self.GuidList)\r
3926 for TokenSpace in self.GetGuidsUsedByPcd():\r
3927 # If token space is not referred by patch PCD or Ex PCD, remove the GUID from GUID list\r
3928 # The GUIDs in GUIDs section should really be the GUIDs in source INF or referred by Ex an patch PCDs\r
3929 if TokenSpace not in PcdTokenSpaceList and TokenSpace in GuidList:\r
3930 GuidList.pop(TokenSpace)\r
3931 CheckList = (GuidList, self.PpiList, self.ProtocolList, PcdCheckList)\r
3932 for Package in self.DerivedPackageList:\r
3933 if Package in Packages:\r
3934 continue\r
3935 BeChecked = (Package.Guids, Package.Ppis, Package.Protocols, Package.Pcds)\r
3936 Found = False\r
3937 for Index in range(len(BeChecked)):\r
3938 for Item in CheckList[Index]:\r
3939 if Item in BeChecked[Index]:\r
3940 Packages += [Package]\r
3941 Found = True\r
3942 break\r
3943 if Found: break\r
da92f276 3944\r
97fa0ee9
YL
3945 VfrPcds = self._GetPcdsMaybeUsedByVfr()\r
3946 for Pkg in self.PlatformInfo.PackageList:\r
3947 if Pkg in Packages:\r
3948 continue\r
3949 for VfrPcd in VfrPcds:\r
3950 if ((VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'DynamicEx') in Pkg.Pcds or\r
3951 (VfrPcd.TokenCName, VfrPcd.TokenSpaceGuidCName, 'Dynamic') in Pkg.Pcds):\r
3952 Packages += [Pkg]\r
3953 break\r
3954\r
da92f276
LG
3955 ModuleType = self.ModuleType\r
3956 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:\r
e8a47801
LG
3957 ModuleType = 'DXE_DRIVER'\r
3958\r
3959 DriverType = ''\r
3960 if self.PcdIsDriver != '':\r
3961 DriverType = self.PcdIsDriver\r
da92f276 3962\r
97fa0ee9
YL
3963 Guid = self.Guid\r
3964 MDefs = self.Module.Defines\r
3965\r
da92f276
LG
3966 AsBuiltInfDict = {\r
3967 'module_name' : self.Name,\r
97fa0ee9 3968 'module_guid' : Guid,\r
da92f276 3969 'module_module_type' : ModuleType,\r
97fa0ee9 3970 'module_version_string' : [MDefs['VERSION_STRING']] if 'VERSION_STRING' in MDefs else [],\r
e8a47801 3971 'pcd_is_driver_string' : [],\r
da92f276
LG
3972 'module_uefi_specification_version' : [],\r
3973 'module_pi_specification_version' : [],\r
97fa0ee9
YL
3974 'module_entry_point' : self.Module.ModuleEntryPointList,\r
3975 'module_unload_image' : self.Module.ModuleUnloadImageList,\r
3976 'module_constructor' : self.Module.ConstructorList,\r
3977 'module_destructor' : self.Module.DestructorList,\r
3978 'module_shadow' : [MDefs['SHADOW']] if 'SHADOW' in MDefs else [],\r
3979 'module_pci_vendor_id' : [MDefs['PCI_VENDOR_ID']] if 'PCI_VENDOR_ID' in MDefs else [],\r
3980 'module_pci_device_id' : [MDefs['PCI_DEVICE_ID']] if 'PCI_DEVICE_ID' in MDefs else [],\r
3981 'module_pci_class_code' : [MDefs['PCI_CLASS_CODE']] if 'PCI_CLASS_CODE' in MDefs else [],\r
3982 'module_pci_revision' : [MDefs['PCI_REVISION']] if 'PCI_REVISION' in MDefs else [],\r
3983 'module_build_number' : [MDefs['BUILD_NUMBER']] if 'BUILD_NUMBER' in MDefs else [],\r
3984 'module_spec' : [MDefs['SPEC']] if 'SPEC' in MDefs else [],\r
3985 'module_uefi_hii_resource_section' : [MDefs['UEFI_HII_RESOURCE_SECTION']] if 'UEFI_HII_RESOURCE_SECTION' in MDefs else [],\r
3986 'module_uni_file' : [MDefs['MODULE_UNI_FILE']] if 'MODULE_UNI_FILE' in MDefs else [],\r
da92f276 3987 'module_arch' : self.Arch,\r
47fea6af 3988 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\', '/')) for Package in Packages],\r
da92f276 3989 'binary_item' : [],\r
e8a47801 3990 'patchablepcd_item' : [],\r
da92f276 3991 'pcd_item' : [],\r
e8a47801
LG
3992 'protocol_item' : [],\r
3993 'ppi_item' : [],\r
3994 'guid_item' : [],\r
3995 'flags_item' : [],\r
3996 'libraryclasses_item' : []\r
da92f276 3997 }\r
97fa0ee9 3998\r
78bcd52a
YZ
3999 if 'MODULE_UNI_FILE' in MDefs:\r
4000 UNIFile = os.path.join(self.MetaFile.Dir, MDefs['MODULE_UNI_FILE'])\r
4001 if os.path.isfile(UNIFile):\r
4002 shutil.copy2(UNIFile, self.OutputDir)\r
4003\r
97fa0ee9
YL
4004 if self.AutoGenVersion > int(gInfSpecVersion, 0):\r
4005 AsBuiltInfDict['module_inf_version'] = '0x%08x' % self.AutoGenVersion\r
4006 else:\r
4007 AsBuiltInfDict['module_inf_version'] = gInfSpecVersion\r
4008\r
e8a47801
LG
4009 if DriverType:\r
4010 AsBuiltInfDict['pcd_is_driver_string'] += [DriverType]\r
da92f276
LG
4011\r
4012 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:\r
481252bb 4013 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]\r
da92f276 4014 if 'PI_SPECIFICATION_VERSION' in self.Specification:\r
481252bb 4015 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]\r
da92f276 4016\r
47fea6af 4017 OutputDir = self.OutputDir.replace('\\', '/').strip('/')\r
481252bb 4018 for Item in self.CodaTargetList:\r
47fea6af 4019 File = Item.Target.Path.replace('\\', '/').strip('/').replace(OutputDir, '').strip('/')\r
36d083ef
YZ
4020 if File not in self.OutputFile:\r
4021 self.OutputFile.append(File)\r
47fea6af 4022 if Item.Target.Ext.lower() == '.aml':\r
481252bb 4023 AsBuiltInfDict['binary_item'] += ['ASL|' + File]\r
47fea6af 4024 elif Item.Target.Ext.lower() == '.acpi':\r
481252bb
YZ
4025 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]\r
4026 elif Item.Target.Ext.lower() == '.efi':\r
4027 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']\r
da92f276 4028 else:\r
481252bb
YZ
4029 AsBuiltInfDict['binary_item'] += ['BIN|' + File]\r
4030 if self.DepexGenerated:\r
36d083ef
YZ
4031 if self.Name + '.depex' not in self.OutputFile:\r
4032 self.OutputFile.append(self.Name + '.depex')\r
da92f276 4033 if self.ModuleType in ['PEIM']:\r
481252bb 4034 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']\r
47fea6af 4035 if self.ModuleType in ['DXE_DRIVER', 'DXE_RUNTIME_DRIVER', 'DXE_SAL_DRIVER', 'UEFI_DRIVER']:\r
481252bb 4036 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']\r
da92f276 4037 if self.ModuleType in ['DXE_SMM_DRIVER']:\r
481252bb 4038 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']\r
da92f276 4039\r
aeaaf754
YL
4040 Bin = self._GenOffsetBin()\r
4041 if Bin:\r
4042 AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]\r
36d083ef
YZ
4043 if Bin not in self.OutputFile:\r
4044 self.OutputFile.append(Bin)\r
aeaaf754 4045\r
e8a47801
LG
4046 for Root, Dirs, Files in os.walk(OutputDir):\r
4047 for File in Files:\r
4048 if File.lower().endswith('.pdb'):\r
4049 AsBuiltInfDict['binary_item'] += ['DISPOSABLE|' + File]\r
36d083ef
YZ
4050 if File not in self.OutputFile:\r
4051 self.OutputFile.append(File)\r
e8a47801
LG
4052 HeaderComments = self.Module.HeaderComments\r
4053 StartPos = 0\r
4054 for Index in range(len(HeaderComments)):\r
4055 if HeaderComments[Index].find('@BinaryHeader') != -1:\r
4056 HeaderComments[Index] = HeaderComments[Index].replace('@BinaryHeader', '@file')\r
4057 StartPos = Index\r
4058 break\r
4059 AsBuiltInfDict['header_comments'] = '\n'.join(HeaderComments[StartPos:]).replace(':#', '://')\r
97fa0ee9
YL
4060 AsBuiltInfDict['tail_comments'] = '\n'.join(self.Module.TailComments)\r
4061\r
e8a47801
LG
4062 GenList = [\r
4063 (self.ProtocolList, self._ProtocolComments, 'protocol_item'),\r
4064 (self.PpiList, self._PpiComments, 'ppi_item'),\r
4065 (GuidList, self._GuidComments, 'guid_item')\r
4066 ]\r
4067 for Item in GenList:\r
4068 for CName in Item[0]:\r
4069 Comments = ''\r
4070 if CName in Item[1]:\r
4071 Comments = '\n '.join(Item[1][CName])\r
4072 Entry = CName\r
4073 if Comments:\r
4074 Entry = Comments + '\n ' + CName\r
4075 AsBuiltInfDict[Item[2]].append(Entry)\r
4076 PatchList = parsePcdInfoFromMapFile(\r
4077 os.path.join(self.OutputDir, self.Name + '.map'),\r
4078 os.path.join(self.OutputDir, self.Name + '.efi')\r
4079 )\r
4080 if PatchList:\r
e5cf9198
YZ
4081 for Pcd in PatchablePcds:\r
4082 TokenCName = Pcd.TokenCName\r
4083 for PcdItem in GlobalData.MixedPcd:\r
4084 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
4085 TokenCName = PcdItem[0]\r
4086 break\r
4087 for PatchPcd in PatchList:\r
4088 if TokenCName == PatchPcd[0]:\r
4089 break\r
2a29017e 4090 else:\r
e8a47801 4091 continue\r
e8a47801 4092 PcdValue = ''\r
7ced8bb4
YZ
4093 if Pcd.DatumType == 'BOOLEAN':\r
4094 BoolValue = Pcd.DefaultValue.upper()\r
4095 if BoolValue == 'TRUE':\r
4096 Pcd.DefaultValue = '1'\r
4097 elif BoolValue == 'FALSE':\r
4098 Pcd.DefaultValue = '0'\r
4099\r
ae7b6df8 4100 if Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']:\r
e8a47801
LG
4101 HexFormat = '0x%02x'\r
4102 if Pcd.DatumType == 'UINT16':\r
4103 HexFormat = '0x%04x'\r
4104 elif Pcd.DatumType == 'UINT32':\r
4105 HexFormat = '0x%08x'\r
4106 elif Pcd.DatumType == 'UINT64':\r
4107 HexFormat = '0x%016x'\r
4108 PcdValue = HexFormat % int(Pcd.DefaultValue, 0)\r
4109 else:\r
4110 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':\r
4111 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4112 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4113 )\r
4114 ArraySize = int(Pcd.MaxDatumSize, 0)\r
4115 PcdValue = Pcd.DefaultValue\r
4116 if PcdValue[0] != '{':\r
4117 Unicode = False\r
4118 if PcdValue[0] == 'L':\r
4119 Unicode = True\r
4120 PcdValue = PcdValue.lstrip('L')\r
4121 PcdValue = eval(PcdValue)\r
4122 NewValue = '{'\r
4123 for Index in range(0, len(PcdValue)):\r
4124 if Unicode:\r
4125 CharVal = ord(PcdValue[Index])\r
4126 NewValue = NewValue + '0x%02x' % (CharVal & 0x00FF) + ', ' \\r
4127 + '0x%02x' % (CharVal >> 8) + ', '\r
4128 else:\r
4129 NewValue = NewValue + '0x%02x' % (ord(PcdValue[Index]) % 0x100) + ', '\r
4130 Padding = '0x00, '\r
4131 if Unicode:\r
4132 Padding = Padding * 2\r
4133 ArraySize = ArraySize / 2\r
4134 if ArraySize < (len(PcdValue) + 1):\r
4135 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4136 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4137 )\r
4138 if ArraySize > len(PcdValue) + 1:\r
4139 NewValue = NewValue + Padding * (ArraySize - len(PcdValue) - 1)\r
4140 PcdValue = NewValue + Padding.strip().rstrip(',') + '}'\r
4141 elif len(PcdValue.split(',')) <= ArraySize:\r
4142 PcdValue = PcdValue.rstrip('}') + ', 0x00' * (ArraySize - len(PcdValue.split(',')))\r
4143 PcdValue += '}'\r
4144 else:\r
4145 EdkLogger.error("build", AUTOGEN_ERROR,\r
2a29017e 4146 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName)\r
e8a47801
LG
4147 )\r
4148 PcdItem = '%s.%s|%s|0x%X' % \\r
2a29017e 4149 (Pcd.TokenSpaceGuidCName, TokenCName, PcdValue, PatchPcd[1])\r
e8a47801
LG
4150 PcdComments = ''\r
4151 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
4152 PcdComments = '\n '.join(self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName])\r
4153 if PcdComments:\r
4154 PcdItem = PcdComments + '\n ' + PcdItem\r
4155 AsBuiltInfDict['patchablepcd_item'].append(PcdItem)\r
97fa0ee9
YL
4156\r
4157 HiiPcds = []\r
4158 for Pcd in Pcds + VfrPcds:\r
e8a47801
LG
4159 PcdComments = ''\r
4160 PcdCommentList = []\r
4161 HiiInfo = ''\r
97fa0ee9 4162 SkuId = ''\r
2a29017e
YZ
4163 TokenCName = Pcd.TokenCName\r
4164 for PcdItem in GlobalData.MixedPcd:\r
4165 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
4166 TokenCName = PcdItem[0]\r
4167 break\r
e8a47801
LG
4168 if Pcd.Type == TAB_PCDS_DYNAMIC_EX_HII:\r
4169 for SkuName in Pcd.SkuInfoList:\r
4170 SkuInfo = Pcd.SkuInfoList[SkuName]\r
97fa0ee9 4171 SkuId = SkuInfo.SkuId\r
e8a47801
LG
4172 HiiInfo = '## %s|%s|%s' % (SkuInfo.VariableName, SkuInfo.VariableGuid, SkuInfo.VariableOffset)\r
4173 break\r
97fa0ee9
YL
4174 if SkuId:\r
4175 #\r
4176 # Don't generate duplicated HII PCD\r
4177 #\r
4178 if (SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in HiiPcds:\r
4179 continue\r
4180 else:\r
4181 HiiPcds.append((SkuId, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
e8a47801
LG
4182 if (Pcd.TokenSpaceGuidCName, Pcd.TokenCName) in self._PcdComments:\r
4183 PcdCommentList = self._PcdComments[Pcd.TokenSpaceGuidCName, Pcd.TokenCName][:]\r
4184 if HiiInfo:\r
4185 UsageIndex = -1\r
97fa0ee9 4186 UsageStr = ''\r
e8a47801
LG
4187 for Index, Comment in enumerate(PcdCommentList):\r
4188 for Usage in UsageList:\r
4189 if Comment.find(Usage) != -1:\r
97fa0ee9 4190 UsageStr = Usage\r
e8a47801
LG
4191 UsageIndex = Index\r
4192 break\r
4193 if UsageIndex != -1:\r
97fa0ee9 4194 PcdCommentList[UsageIndex] = '## %s %s %s' % (UsageStr, HiiInfo, PcdCommentList[UsageIndex].replace(UsageStr, '')) \r
e8a47801 4195 else:\r
97fa0ee9 4196 PcdCommentList.append('## UNDEFINED ' + HiiInfo)\r
e8a47801 4197 PcdComments = '\n '.join(PcdCommentList)\r
2a29017e 4198 PcdEntry = Pcd.TokenSpaceGuidCName + '.' + TokenCName\r
e8a47801
LG
4199 if PcdComments:\r
4200 PcdEntry = PcdComments + '\n ' + PcdEntry\r
4201 AsBuiltInfDict['pcd_item'] += [PcdEntry]\r
da92f276 4202 for Item in self.BuildOption:\r
481252bb
YZ
4203 if 'FLAGS' in self.BuildOption[Item]:\r
4204 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
4205\r
4206 # Generated LibraryClasses section in comments.\r
4207 for Library in self.LibraryAutoGenList:\r
4208 AsBuiltInfDict['libraryclasses_item'] += [Library.MetaFile.File.replace('\\', '/')]\r
4209 \r
dfa41b4a
YZ
4210 # Generated UserExtensions TianoCore section.\r
4211 # All tianocore user extensions are copied.\r
4212 UserExtStr = ''\r
4213 for TianoCore in self._GetTianoCoreUserExtensionList():\r
4214 UserExtStr += '\n'.join(TianoCore)\r
4215 ExtensionFile = os.path.join(self.MetaFile.Dir, TianoCore[1])\r
4216 if os.path.isfile(ExtensionFile):\r
4217 shutil.copy2(ExtensionFile, self.OutputDir)\r
4218 AsBuiltInfDict['userextension_tianocore_item'] = UserExtStr\r
4219\r
97fa0ee9
YL
4220 # Generated depex expression section in comments.\r
4221 AsBuiltInfDict['depexsection_item'] = ''\r
4222 DepexExpresion = self._GetDepexExpresionString()\r
4223 if DepexExpresion:\r
4224 AsBuiltInfDict['depexsection_item'] = DepexExpresion\r
da92f276
LG
4225 \r
4226 AsBuiltInf = TemplateString()\r
4227 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))\r
4228 \r
4229 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)\r
4230 \r
4231 self.IsAsBuiltInfCreated = True\r
36d083ef
YZ
4232 if GlobalData.gBinCacheDest:\r
4233 self.CopyModuleToCache()\r
4234\r
4235 def CopyModuleToCache(self):\r
4236 FileDir = path.join(GlobalData.gBinCacheDest, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
4237 CreateDirectory (FileDir)\r
4238 HashFile = path.join(self.BuildDir, self.Name + '.hash')\r
4239 ModuleFile = path.join(self.OutputDir, self.Name + '.inf')\r
4240 if os.path.exists(HashFile):\r
4241 shutil.copy2(HashFile, FileDir)\r
4242 if os.path.exists(ModuleFile):\r
4243 shutil.copy2(ModuleFile, FileDir)\r
83397f95
YZ
4244 if not self.OutputFile:\r
4245 Ma = self.Workspace.BuildDatabase[PathClass(ModuleFile), self.Arch, self.BuildTarget, self.ToolChain]\r
4246 self.OutputFile = Ma.Binaries\r
36d083ef
YZ
4247 if self.OutputFile:\r
4248 for File in self.OutputFile:\r
83397f95 4249 File = str(File)\r
36d083ef
YZ
4250 if not os.path.isabs(File):\r
4251 File = os.path.join(self.OutputDir, File)\r
4252 if os.path.exists(File):\r
4253 shutil.copy2(File, FileDir)\r
4254\r
4255 def AttemptModuleCacheCopy(self):\r
4256 if self.IsBinaryModule:\r
4257 return False\r
4258 FileDir = path.join(GlobalData.gBinCacheSource, self.Arch, self.SourceDir, self.MetaFile.BaseName)\r
4259 HashFile = path.join(FileDir, self.Name + '.hash')\r
4260 if os.path.exists(HashFile):\r
4261 f = open(HashFile, 'r')\r
4262 CacheHash = f.read()\r
4263 f.close()\r
4264 if GlobalData.gModuleHash[self.Arch][self.Name]:\r
4265 if CacheHash == GlobalData.gModuleHash[self.Arch][self.Name]:\r
4266 for root, dir, files in os.walk(FileDir):\r
4267 for f in files:\r
4268 if self.Name + '.hash' in f:\r
4269 shutil.copy2(HashFile, self.BuildDir)\r
4270 else:\r
4271 File = path.join(root, f)\r
4272 shutil.copy2(File, self.OutputDir)\r
4273 if self.Name == "PcdPeim" or self.Name == "PcdDxe":\r
4274 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
4275 return True\r
4276 return False\r
4277\r
52302d4d
LG
4278 ## Create makefile for the module and its dependent libraries\r
4279 #\r
4280 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of\r
4281 # dependent libraries will be created\r
4282 #\r
37de70b7 4283 def CreateMakeFile(self, CreateLibraryMakeFile=True, GenFfsList = []):\r
fae62ff2 4284 # Ignore generating makefile when it is a binary module\r
a0a2cd1e
FB
4285 if self.IsBinaryModule:\r
4286 return\r
fae62ff2 4287\r
52302d4d
LG
4288 if self.IsMakeFileCreated:\r
4289 return\r
37de70b7 4290 self.GenFfsList = GenFfsList\r
52302d4d
LG
4291 if not self.IsLibrary and CreateLibraryMakeFile:\r
4292 for LibraryAutoGen in self.LibraryAutoGenList:\r
4293 LibraryAutoGen.CreateMakeFile()\r
4294\r
36513f3a
YZ
4295 if self.CanSkip():\r
4296 return\r
4297\r
52302d4d
LG
4298 if len(self.CustomMakefile) == 0:\r
4299 Makefile = GenMake.ModuleMakefile(self)\r
4300 else:\r
4301 Makefile = GenMake.CustomMakefile(self)\r
4302 if Makefile.Generate():\r
4303 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %\r
4304 (self.Name, self.Arch))\r
4305 else:\r
4306 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %\r
4307 (self.Name, self.Arch))\r
4308\r
c17956e0 4309 self.CreateTimeStamp(Makefile)\r
52302d4d
LG
4310 self.IsMakeFileCreated = True\r
4311\r
a0a2cd1e
FB
4312 def CopyBinaryFiles(self):\r
4313 for File in self.Module.Binaries:\r
4314 SrcPath = File.Path\r
4315 DstPath = os.path.join(self.OutputDir , os.path.basename(SrcPath))\r
4316 CopyLongFilePath(SrcPath, DstPath)\r
52302d4d
LG
4317 ## Create autogen code for the module and its dependent libraries\r
4318 #\r
4319 # @param CreateLibraryCodeFile Flag indicating if or not the code of\r
4320 # dependent libraries will be created\r
4321 #\r
4322 def CreateCodeFile(self, CreateLibraryCodeFile=True):\r
4323 if self.IsCodeFileCreated:\r
4324 return\r
4325\r
e8a47801
LG
4326 # Need to generate PcdDatabase even PcdDriver is binarymodule\r
4327 if self.IsBinaryModule and self.PcdIsDriver != '':\r
4328 CreatePcdDatabaseCode(self, TemplateString(), TemplateString())\r
4329 return\r
a0a2cd1e 4330 if self.IsBinaryModule:\r
49d9b71d
HC
4331 if self.IsLibrary:\r
4332 self.CopyBinaryFiles()\r
a0a2cd1e 4333 return\r
e8a47801 4334\r
52302d4d
LG
4335 if not self.IsLibrary and CreateLibraryCodeFile:\r
4336 for LibraryAutoGen in self.LibraryAutoGenList:\r
4337 LibraryAutoGen.CreateCodeFile()\r
4338\r
36513f3a
YZ
4339 if self.CanSkip():\r
4340 return\r
4341\r
52302d4d
LG
4342 AutoGenList = []\r
4343 IgoredAutoGenList = []\r
4344\r
4345 for File in self.AutoGenFileList:\r
4346 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):\r
b36d134f 4347 #Ignore Edk AutoGen.c\r
52302d4d
LG
4348 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':\r
4349 continue\r
4350\r
4351 AutoGenList.append(str(File))\r
4352 else:\r
4353 IgoredAutoGenList.append(str(File))\r
4354\r
4355 # Skip the following code for EDK I inf\r
4356 if self.AutoGenVersion < 0x00010005:\r
4357 return\r
4358\r
4359 for ModuleType in self.DepexList:\r
40d841f6
LG
4360 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module\r
4361 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":\r
52302d4d 4362 continue\r
40d841f6 4363\r
52302d4d
LG
4364 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)\r
4365 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}\r
4366\r
da92f276 4367 if len(Dpx.PostfixNotation) <> 0:\r
0d2711a6 4368 self.DepexGenerated = True\r
da92f276 4369\r
52302d4d
LG
4370 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):\r
4371 AutoGenList.append(str(DpxFile))\r
4372 else:\r
4373 IgoredAutoGenList.append(str(DpxFile))\r
4374\r
4375 if IgoredAutoGenList == []:\r
4376 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %\r
4377 (" ".join(AutoGenList), self.Name, self.Arch))\r
4378 elif AutoGenList == []:\r
4379 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %\r
4380 (" ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4381 else:\r
4382 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %\r
4383 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))\r
4384\r
4385 self.IsCodeFileCreated = True\r
4386 return AutoGenList\r
4387\r
4388 ## Summarize the ModuleAutoGen objects of all libraries used by this module\r
4389 def _GetLibraryAutoGenList(self):\r
4390 if self._LibraryAutoGenList == None:\r
4391 self._LibraryAutoGenList = []\r
4392 for Library in self.DependentLibraryList:\r
4393 La = ModuleAutoGen(\r
4394 self.Workspace,\r
4395 Library.MetaFile,\r
4396 self.BuildTarget,\r
4397 self.ToolChain,\r
4398 self.Arch,\r
4399 self.PlatformInfo.MetaFile\r
4400 )\r
4401 if La not in self._LibraryAutoGenList:\r
4402 self._LibraryAutoGenList.append(La)\r
4403 for Lib in La.CodaTargetList:\r
4404 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)\r
4405 return self._LibraryAutoGenList\r
4406\r
36d083ef
YZ
4407 def GenModuleHash(self):\r
4408 if self.Arch not in GlobalData.gModuleHash:\r
4409 GlobalData.gModuleHash[self.Arch] = {}\r
4410 m = hashlib.md5()\r
4411 # Add Platform level hash\r
4412 m.update(GlobalData.gPlatformHash)\r
4413 # Add Package level hash\r
4414 if self.DependentPackageList:\r
4415 for Pkg in self.DependentPackageList:\r
4416 if Pkg.PackageName in GlobalData.gPackageHash[self.Arch]:\r
4417 m.update(GlobalData.gPackageHash[self.Arch][Pkg.PackageName])\r
4418\r
4419 # Add Library hash\r
4420 if self.LibraryAutoGenList:\r
4421 for Lib in self.LibraryAutoGenList:\r
4422 if Lib.Name not in GlobalData.gModuleHash[self.Arch]:\r
4423 Lib.GenModuleHash()\r
4424 m.update(GlobalData.gModuleHash[self.Arch][Lib.Name])\r
4425\r
4426 # Add Module self\r
4427 f = open(str(self.MetaFile), 'r')\r
4428 Content = f.read()\r
4429 f.close()\r
4430 m.update(Content)\r
4431 # Add Module's source files\r
4432 if self.SourceFileList:\r
4433 for File in self.SourceFileList:\r
4434 f = open(str(File), 'r')\r
4435 Content = f.read()\r
4436 f.close()\r
4437 m.update(Content)\r
4438\r
4439 ModuleHashFile = path.join(self.BuildDir, self.Name + ".hash")\r
4440 if self.Name not in GlobalData.gModuleHash[self.Arch]:\r
4441 GlobalData.gModuleHash[self.Arch][self.Name] = m.hexdigest()\r
4442 if GlobalData.gBinCacheSource:\r
4443 CacheValid = self.AttemptModuleCacheCopy()\r
4444 if CacheValid:\r
4445 return False\r
4446 return SaveFileOnChange(ModuleHashFile, m.hexdigest(), True)\r
4447\r
4448 ## Decide whether we can skip the ModuleAutoGen process\r
4449 def CanSkipbyHash(self):\r
4450 if GlobalData.gUseHashCache:\r
4451 return not self.GenModuleHash()\r
4452\r
c17956e0 4453 ## Decide whether we can skip the ModuleAutoGen process\r
36d083ef 4454 # If any source file is newer than the module than we cannot skip\r
c17956e0
DL
4455 #\r
4456 def CanSkip(self):\r
4457 if not os.path.exists(self.GetTimeStampPath()):\r
4458 return False\r
4459 #last creation time of the module\r
4460 DstTimeStamp = os.stat(self.GetTimeStampPath())[8]\r
4461\r
4462 SrcTimeStamp = self.Workspace._SrcTimeStamp\r
4463 if SrcTimeStamp > DstTimeStamp:\r
4464 return False\r
4465\r
4466 with open(self.GetTimeStampPath(),'r') as f:\r
4467 for source in f:\r
4468 source = source.rstrip('\n')\r
4a1167df
YZ
4469 if not os.path.exists(source):\r
4470 return False\r
c17956e0
DL
4471 if source not in ModuleAutoGen.TimeDict :\r
4472 ModuleAutoGen.TimeDict[source] = os.stat(source)[8]\r
4473 if ModuleAutoGen.TimeDict[source] > DstTimeStamp:\r
4474 return False\r
4475 return True\r
4476\r
4477 def GetTimeStampPath(self):\r
4478 if self._TimeStampPath == None:\r
4479 self._TimeStampPath = os.path.join(self.MakeFileDir, 'AutoGenTimeStamp')\r
4480 return self._TimeStampPath\r
4481 def CreateTimeStamp(self, Makefile):\r
4482\r
4483 FileSet = set()\r
4484\r
4485 FileSet.add (self.MetaFile.Path)\r
4486\r
4487 for SourceFile in self.Module.Sources:\r
4488 FileSet.add (SourceFile.Path)\r
4489\r
4490 for Lib in self.DependentLibraryList:\r
4491 FileSet.add (Lib.MetaFile.Path)\r
4492\r
4493 for f in self.AutoGenDepSet:\r
4494 FileSet.add (f.Path)\r
4495\r
4496 if os.path.exists (self.GetTimeStampPath()):\r
4497 os.remove (self.GetTimeStampPath())\r
4498 with open(self.GetTimeStampPath(), 'w+') as file:\r
4499 for f in FileSet:\r
4500 print >> file, f\r
4501\r
52302d4d
LG
4502 Module = property(_GetModule)\r
4503 Name = property(_GetBaseName)\r
4504 Guid = property(_GetGuid)\r
4505 Version = property(_GetVersion)\r
4506 ModuleType = property(_GetModuleType)\r
4507 ComponentType = property(_GetComponentType)\r
4508 BuildType = property(_GetBuildType)\r
4509 PcdIsDriver = property(_GetPcdIsDriver)\r
4510 AutoGenVersion = property(_GetAutoGenVersion)\r
4511 Macros = property(_GetMacros)\r
4512 Specification = property(_GetSpecification)\r
4513\r
4514 IsLibrary = property(_IsLibrary)\r
e8a47801 4515 IsBinaryModule = property(_IsBinaryModule)\r
52302d4d
LG
4516 BuildDir = property(_GetBuildDir)\r
4517 OutputDir = property(_GetOutputDir)\r
37de70b7 4518 FfsOutputDir = property(_GetFfsOutputDir)\r
52302d4d
LG
4519 DebugDir = property(_GetDebugDir)\r
4520 MakeFileDir = property(_GetMakeFileDir)\r
4521 CustomMakefile = property(_GetCustomMakefile)\r
4522\r
4523 IncludePathList = property(_GetIncludePathList)\r
725cdb8f 4524 IncludePathLength = property(_GetIncludePathLength)\r
52302d4d
LG
4525 AutoGenFileList = property(_GetAutoGenFileList)\r
4526 UnicodeFileList = property(_GetUnicodeFileList)\r
5b97eb4c 4527 VfrFileList = property(_GetVfrFileList)\r
52302d4d
LG
4528 SourceFileList = property(_GetSourceFileList)\r
4529 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]\r
4530 Targets = property(_GetTargets)\r
4531 IntroTargetList = property(_GetIntroTargetList)\r
4532 CodaTargetList = property(_GetFinalTargetList)\r
4533 FileTypes = property(_GetFileTypes)\r
4534 BuildRules = property(_GetBuildRules)\r
333ba578 4535 IdfFileList = property(_GetIdfFileList)\r
52302d4d
LG
4536\r
4537 DependentPackageList = property(_GetDependentPackageList)\r
4538 DependentLibraryList = property(_GetLibraryList)\r
4539 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
4540 DerivedPackageList = property(_GetDerivedPackageList)\r
4541\r
4542 ModulePcdList = property(_GetModulePcdList)\r
4543 LibraryPcdList = property(_GetLibraryPcdList)\r
4544 GuidList = property(_GetGuidList)\r
4545 ProtocolList = property(_GetProtocolList)\r
4546 PpiList = property(_GetPpiList)\r
4547 DepexList = property(_GetDepexTokenList)\r
b36d134f 4548 DxsFile = property(_GetDxsFile)\r
52302d4d
LG
4549 DepexExpressionList = property(_GetDepexExpressionTokenList)\r
4550 BuildOption = property(_GetModuleBuildOption)\r
79b74a03 4551 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)\r
52302d4d 4552 BuildCommand = property(_GetBuildCommand)\r
2bc3256c
LG
4553 \r
4554 FixedAtBuildPcds = property(_GetFixedAtBuildPcds)\r
52302d4d
LG
4555\r
4556# This acts like the main() function for the script, unless it is 'import'ed into another script.\r
4557if __name__ == '__main__':\r
4558 pass\r
4559\r