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