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