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