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