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