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