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