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