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