SecurityPkg Variable: Remove mStorageData buffer allocation and use Scratch buffer...
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / AutoGen.py
CommitLineData
52302d4d
LG
1## @file\r
2# Generate AutoGen.h, AutoGen.c and *.depex files\r
3#\r
da92f276 4# Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
40d841f6 5# This program and the accompanying materials\r
52302d4d
LG
6# are licensed and made available under the terms and conditions of the BSD License\r
7# which accompanies this distribution. The full text of the license may be found at\r
8# http://opensource.org/licenses/bsd-license.php\r
9#\r
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12#\r
13\r
14## Import Modules\r
15#\r
16import os\r
17import re\r
18import os.path as path\r
19import copy\r
20\r
21import GenC\r
22import GenMake\r
23import GenDepex\r
24from StringIO import StringIO\r
25\r
26from StrGather import *\r
27from BuildEngine import BuildRule\r
28\r
29from Common.BuildToolError import *\r
30from Common.DataType import *\r
31from Common.Misc import *\r
32from Common.String import *\r
33import Common.GlobalData as GlobalData\r
34from GenFds.FdfParser import *\r
35from CommonDataClass.CommonClass import SkuInfoClass\r
36from Workspace.BuildClassObject import *\r
e56468c0 37import Common.VpdInfoFile as VpdInfoFile\r
52302d4d
LG
38\r
39## Regular expression for splitting Dependency Expression stirng into tokens\r
40gDepexTokenPattern = re.compile("(\(|\)|\w+| \S+\.inf)")\r
41\r
42## Mapping Makefile type\r
43gMakeTypeMap = {"MSFT":"nmake", "GCC":"gmake"}\r
44\r
45\r
46## Build rule configuration file\r
47gBuildRuleFile = 'Conf/build_rule.txt'\r
48\r
64b2609f
LG
49## Build rule default version\r
50AutoGenReqBuildRuleVerNum = "0.1"\r
51\r
52302d4d
LG
52## default file name for AutoGen\r
53gAutoGenCodeFileName = "AutoGen.c"\r
54gAutoGenHeaderFileName = "AutoGen.h"\r
55gAutoGenStringFileName = "%(module_name)sStrDefs.h"\r
56gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"\r
57gAutoGenDepexFileName = "%(module_name)s.depex"\r
58\r
da92f276
LG
59#\r
60# Template string to generic AsBuilt INF\r
61#\r
62gAsBuiltInfHeaderString = TemplateString("""## @file\r
63# ${module_name}\r
64#\r
65# DO NOT EDIT\r
66# FILE auto-generated Binary INF\r
67#\r
68##\r
69\r
70[Defines]\r
71 INF_VERSION = 0x00010016\r
72 BASE_NAME = ${module_name}\r
73 FILE_GUID = ${module_guid}\r
74 MODULE_TYPE = ${module_module_type}\r
75 VERSION_STRING = ${module_version_string}${BEGIN}\r
76 UEFI_SPECIFICATION_VERSION = ${module_uefi_specification_version}${END}${BEGIN}\r
77 PI_SPECIFICATION_VERSION = ${module_pi_specification_version}${END}\r
78\r
79[Packages]${BEGIN}\r
80 ${package_item}${END}\r
81\r
82[Binaries.${module_arch}]${BEGIN}\r
83 ${binary_item}${END}\r
84\r
85[PcdEx]${BEGIN}\r
86 ${pcd_item}${END}\r
87\r
88## @AsBuilt${BEGIN}\r
89## ${flags_item}${END}\r
90""")\r
91\r
52302d4d
LG
92## Base class for AutoGen\r
93#\r
94# This class just implements the cache mechanism of AutoGen objects.\r
95#\r
96class AutoGen(object):\r
97 # database to maintain the objects of xxxAutoGen\r
98 _CACHE_ = {} # (BuildTarget, ToolChain) : {ARCH : {platform file: AutoGen object}}}\r
99\r
100 ## Factory method\r
101 #\r
102 # @param Class class object of real AutoGen class\r
103 # (WorkspaceAutoGen, ModuleAutoGen or PlatformAutoGen)\r
104 # @param Workspace Workspace directory or WorkspaceAutoGen object\r
105 # @param MetaFile The path of meta file\r
106 # @param Target Build target\r
107 # @param Toolchain Tool chain name\r
108 # @param Arch Target arch\r
109 # @param *args The specific class related parameters\r
110 # @param **kwargs The specific class related dict parameters\r
111 #\r
112 def __new__(Class, Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
113 # check if the object has been created\r
114 Key = (Target, Toolchain)\r
115 if Key not in Class._CACHE_ or Arch not in Class._CACHE_[Key] \\r
116 or MetaFile not in Class._CACHE_[Key][Arch]:\r
117 AutoGenObject = super(AutoGen, Class).__new__(Class)\r
118 # call real constructor\r
119 if not AutoGenObject._Init(Workspace, MetaFile, Target, Toolchain, Arch, *args, **kwargs):\r
120 return None\r
121 if Key not in Class._CACHE_:\r
122 Class._CACHE_[Key] = {}\r
123 if Arch not in Class._CACHE_[Key]:\r
124 Class._CACHE_[Key][Arch] = {}\r
125 Class._CACHE_[Key][Arch][MetaFile] = AutoGenObject\r
126 else:\r
127 AutoGenObject = Class._CACHE_[Key][Arch][MetaFile]\r
128\r
129 return AutoGenObject\r
130\r
131 ## hash() operator\r
132 #\r
133 # The file path of platform file will be used to represent hash value of this object\r
134 #\r
135 # @retval int Hash value of the file path of platform file\r
136 #\r
137 def __hash__(self):\r
138 return hash(self.MetaFile)\r
139\r
140 ## str() operator\r
141 #\r
142 # The file path of platform file will be used to represent this object\r
143 #\r
144 # @retval string String of platform file path\r
145 #\r
146 def __str__(self):\r
147 return str(self.MetaFile)\r
148\r
149 ## "==" operator\r
150 def __eq__(self, Other):\r
151 return Other and self.MetaFile == Other\r
152\r
153## Workspace AutoGen class\r
154#\r
155# This class is used mainly to control the whole platform build for different\r
156# architecture. This class will generate top level makefile.\r
157#\r
158class WorkspaceAutoGen(AutoGen):\r
159 ## Real constructor of WorkspaceAutoGen\r
160 #\r
79b74a03 161 # This method behaves the same as __init__ except that it needs explicit invoke\r
52302d4d
LG
162 # (in super class's __new__ method)\r
163 #\r
164 # @param WorkspaceDir Root directory of workspace\r
165 # @param ActivePlatform Meta-file of active platform\r
166 # @param Target Build target\r
167 # @param Toolchain Tool chain name\r
168 # @param ArchList List of architecture of current build\r
169 # @param MetaFileDb Database containing meta-files\r
170 # @param BuildConfig Configuration of build\r
171 # @param ToolDefinition Tool chain definitions\r
172 # @param FlashDefinitionFile File of flash definition\r
173 # @param Fds FD list to be generated\r
174 # @param Fvs FV list to be generated\r
4234283c 175 # @param Caps Capsule list to be generated\r
52302d4d
LG
176 # @param SkuId SKU id from command line\r
177 #\r
178 def _Init(self, WorkspaceDir, ActivePlatform, Target, Toolchain, ArchList, MetaFileDb,\r
9508d0fa
LG
179 BuildConfig, ToolDefinition, FlashDefinitionFile='', Fds=None, Fvs=None, Caps=None, SkuId='', UniFlag=None, \r
180 Progress=None, BuildModule=None):\r
4234283c
LG
181 if Fds is None:\r
182 Fds = []\r
183 if Fvs is None:\r
184 Fvs = []\r
185 if Caps is None:\r
186 Caps = []\r
0d2711a6
LG
187 self.BuildDatabase = MetaFileDb\r
188 self.MetaFile = ActivePlatform\r
52302d4d 189 self.WorkspaceDir = WorkspaceDir\r
0d2711a6 190 self.Platform = self.BuildDatabase[self.MetaFile, 'COMMON', Target, Toolchain]\r
d0acc87a 191 GlobalData.gActivePlatform = self.Platform\r
52302d4d
LG
192 self.BuildTarget = Target\r
193 self.ToolChain = Toolchain\r
194 self.ArchList = ArchList\r
195 self.SkuId = SkuId\r
f3decdc3 196 self.UniFlag = UniFlag\r
52302d4d 197\r
52302d4d
LG
198 self.TargetTxt = BuildConfig\r
199 self.ToolDef = ToolDefinition\r
200 self.FdfFile = FlashDefinitionFile\r
201 self.FdTargetList = Fds\r
202 self.FvTargetList = Fvs\r
4234283c 203 self.CapTargetList = Caps\r
52302d4d
LG
204 self.AutoGenObjectList = []\r
205\r
206 # there's many relative directory operations, so ...\r
207 os.chdir(self.WorkspaceDir)\r
208\r
0d2711a6
LG
209 #\r
210 # Merge Arch\r
211 #\r
212 if not self.ArchList:\r
213 ArchList = set(self.Platform.SupArchList)\r
214 else:\r
215 ArchList = set(self.ArchList) & set(self.Platform.SupArchList)\r
216 if not ArchList:\r
217 EdkLogger.error("build", PARAMETER_INVALID,\r
218 ExtraData = "Invalid ARCH specified. [Valid ARCH: %s]" % (" ".join(self.Platform.SupArchList)))\r
219 elif self.ArchList and len(ArchList) != len(self.ArchList):\r
220 SkippedArchList = set(self.ArchList).symmetric_difference(set(self.Platform.SupArchList))\r
221 EdkLogger.verbose("\nArch [%s] is ignored because the platform supports [%s] only!"\r
222 % (" ".join(SkippedArchList), " ".join(self.Platform.SupArchList)))\r
223 self.ArchList = tuple(ArchList)\r
224\r
225 # Validate build target\r
226 if self.BuildTarget not in self.Platform.BuildTargets:\r
227 EdkLogger.error("build", PARAMETER_INVALID, \r
228 ExtraData="Build target [%s] is not supported by the platform. [Valid target: %s]"\r
229 % (self.BuildTarget, " ".join(self.Platform.BuildTargets)))\r
230\r
231 # Validate SKU ID\r
232 if not self.SkuId:\r
233 self.SkuId = 'DEFAULT'\r
234\r
235 if self.SkuId not in self.Platform.SkuIds:\r
236 EdkLogger.error("build", PARAMETER_INVALID, \r
237 ExtraData="SKU-ID [%s] is not supported by the platform. [Valid SKU-ID: %s]"\r
238 % (self.SkuId, " ".join(self.Platform.SkuIds.keys())))\r
239\r
52302d4d 240 # parse FDF file to get PCDs in it, if any\r
0d2711a6
LG
241 if not self.FdfFile:\r
242 self.FdfFile = self.Platform.FlashDefinition\r
9508d0fa
LG
243 \r
244 EdkLogger.info("")\r
245 if self.ArchList:\r
246 EdkLogger.info('%-16s = %s' % ("Architecture(s)", ' '.join(self.ArchList)))\r
247 EdkLogger.info('%-16s = %s' % ("Build target", self.BuildTarget))\r
248 EdkLogger.info('%-16s = %s' % ("Toolchain",self.ToolChain)) \r
249 \r
250 EdkLogger.info('\n%-24s = %s' % ("Active Platform", self.Platform))\r
251 if BuildModule:\r
252 EdkLogger.info('%-24s = %s' % ("Active Module", BuildModule))\r
253 \r
254 if self.FdfFile:\r
255 EdkLogger.info('%-24s = %s' % ("Flash Image Definition", self.FdfFile))\r
0d2711a6 256\r
9508d0fa
LG
257 EdkLogger.verbose("\nFLASH_DEFINITION = %s" % self.FdfFile)\r
258 \r
259 if Progress:\r
260 Progress.Start("\nProcessing meta-data")\r
261 \r
0d2711a6 262 if self.FdfFile:\r
df692f02
LG
263 #\r
264 # Mark now build in AutoGen Phase\r
265 #\r
0d2711a6 266 GlobalData.gAutoGenPhase = True \r
52302d4d
LG
267 Fdf = FdfParser(self.FdfFile.Path)\r
268 Fdf.ParseFile()\r
0d2711a6 269 GlobalData.gAutoGenPhase = False\r
52302d4d
LG
270 PcdSet = Fdf.Profile.PcdDict\r
271 ModuleList = Fdf.Profile.InfList\r
272 self.FdfProfile = Fdf.Profile\r
0d2711a6
LG
273 for fvname in self.FvTargetList:\r
274 if fvname.upper() not in self.FdfProfile.FvDict:\r
275 EdkLogger.error("build", OPTION_VALUE_INVALID,\r
276 "No such an FV in FDF file: %s" % fvname)\r
52302d4d
LG
277 else:\r
278 PcdSet = {}\r
279 ModuleList = []\r
280 self.FdfProfile = None\r
0d2711a6
LG
281 if self.FdTargetList:\r
282 EdkLogger.info("No flash definition file found. FD [%s] will be ignored." % " ".join(self.FdTargetList))\r
283 self.FdTargetList = []\r
284 if self.FvTargetList:\r
285 EdkLogger.info("No flash definition file found. FV [%s] will be ignored." % " ".join(self.FvTargetList))\r
286 self.FvTargetList = []\r
287 if self.CapTargetList:\r
288 EdkLogger.info("No flash definition file found. Capsule [%s] will be ignored." % " ".join(self.CapTargetList))\r
289 self.CapTargetList = []\r
52302d4d
LG
290 \r
291 # apply SKU and inject PCDs from Flash Definition file\r
292 for Arch in self.ArchList:\r
0d2711a6 293 Platform = self.BuildDatabase[self.MetaFile, Arch, Target, Toolchain]\r
64b2609f 294\r
25918452 295 DecPcds = {}\r
4afd3d04 296 DecPcdsKey = set()\r
64b2609f
LG
297 PGen = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
298 Pkgs = PGen.PackageList\r
299 for Pkg in Pkgs:\r
25918452
LG
300 for Pcd in Pkg.Pcds:\r
301 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]\r
4afd3d04 302 DecPcdsKey.add((Pcd[0], Pcd[1], Pcd[2]))\r
64b2609f 303\r
52302d4d
LG
304 Platform.SkuName = self.SkuId\r
305 for Name, Guid in PcdSet:\r
64b2609f
LG
306 if (Name, Guid) not in DecPcds:\r
307 EdkLogger.error(\r
308 'build',\r
309 PARSER_ERROR,\r
310 "PCD (%s.%s) used in FDF is not declared in DEC files." % (Guid, Name),\r
311 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
312 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
313 )\r
4afd3d04
LG
314 else:\r
315 # Check whether Dynamic or DynamicEx PCD used in FDF file. If used, build break and give a error message.\r
316 if (Name, Guid, TAB_PCDS_FIXED_AT_BUILD) in DecPcdsKey \\r
317 or (Name, Guid, TAB_PCDS_PATCHABLE_IN_MODULE) in DecPcdsKey \\r
318 or (Name, Guid, TAB_PCDS_FEATURE_FLAG) in DecPcdsKey:\r
319 Platform.AddPcd(Name, Guid, PcdSet[Name, Guid])\r
320 continue\r
321 elif (Name, Guid, TAB_PCDS_DYNAMIC) in DecPcdsKey or (Name, Guid, TAB_PCDS_DYNAMIC_EX) in DecPcdsKey:\r
322 EdkLogger.error(\r
323 'build',\r
324 PARSER_ERROR,\r
325 "Using Dynamic or DynamicEx type of PCD [%s.%s] in FDF file is not allowed." % (Guid, Name),\r
326 File = self.FdfProfile.PcdFileLineDict[Name, Guid][0],\r
327 Line = self.FdfProfile.PcdFileLineDict[Name, Guid][1]\r
328 )\r
52302d4d
LG
329\r
330 Pa = PlatformAutoGen(self, self.MetaFile, Target, Toolchain, Arch)\r
331 #\r
332 # Explicitly collect platform's dynamic PCDs\r
333 #\r
334 Pa.CollectPlatformDynamicPcds()\r
335 self.AutoGenObjectList.append(Pa)\r
6780eef1
LG
336 \r
337 #\r
338 # Check PCDs token value conflict in each DEC file.\r
339 #\r
340 self._CheckAllPcdsTokenValueConflict()\r
341 \r
4234283c
LG
342 #\r
343 # Check PCD type and definition between DSC and DEC\r
344 #\r
345 self._CheckPcdDefineAndType()\r
346 \r
79b74a03
LG
347 if self.FdfFile:\r
348 self._CheckDuplicateInFV(Fdf)\r
349 \r
52302d4d
LG
350 self._BuildDir = None\r
351 self._FvDir = None\r
352 self._MakeFileDir = None\r
353 self._BuildCommand = None\r
354\r
355 return True\r
356\r
79b74a03
LG
357 ## _CheckDuplicateInFV() method\r
358 #\r
359 # Check whether there is duplicate modules/files exist in FV section. \r
360 # The check base on the file GUID;\r
361 #\r
362 def _CheckDuplicateInFV(self, Fdf):\r
363 for Fv in Fdf.Profile.FvDict:\r
364 _GuidDict = {}\r
365 for FfsFile in Fdf.Profile.FvDict[Fv].FfsList:\r
366 if FfsFile.InfFileName and FfsFile.NameGuid == None:\r
367 #\r
368 # Get INF file GUID\r
369 #\r
370 InfFoundFlag = False \r
371 for Pa in self.AutoGenObjectList:\r
64b2609f
LG
372 if InfFoundFlag:\r
373 break\r
79b74a03
LG
374 for Module in Pa.ModuleAutoGenList:\r
375 if path.normpath(Module.MetaFile.File) == path.normpath(FfsFile.InfFileName):\r
376 InfFoundFlag = True\r
377 if not Module.Guid.upper() in _GuidDict.keys():\r
378 _GuidDict[Module.Guid.upper()] = FfsFile\r
64b2609f 379 break\r
79b74a03
LG
380 else:\r
381 EdkLogger.error("build", \r
382 FORMAT_INVALID,\r
383 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,\r
384 FfsFile.CurrentLineContent,\r
385 _GuidDict[Module.Guid.upper()].CurrentLineNum,\r
386 _GuidDict[Module.Guid.upper()].CurrentLineContent,\r
387 Module.Guid.upper()),\r
388 ExtraData=self.FdfFile)\r
389 #\r
390 # Some INF files not have entity in DSC file. \r
391 #\r
392 if not InfFoundFlag:\r
393 if FfsFile.InfFileName.find('$') == -1:\r
394 InfPath = NormPath(FfsFile.InfFileName)\r
395 if not os.path.exists(InfPath):\r
396 EdkLogger.error('build', GENFDS_ERROR, "Non-existant Module %s !" % (FfsFile.InfFileName))\r
397 \r
398 PathClassObj = PathClass(FfsFile.InfFileName, self.WorkspaceDir)\r
399 #\r
400 # Here we just need to get FILE_GUID from INF file, use 'COMMON' as ARCH attribute. and use \r
401 # BuildObject from one of AutoGenObjectList is enough.\r
402 #\r
403 InfObj = self.AutoGenObjectList[0].BuildDatabase.WorkspaceDb.BuildObject[PathClassObj, 'COMMON', self.BuildTarget, self.ToolChain]\r
404 if not InfObj.Guid.upper() in _GuidDict.keys():\r
405 _GuidDict[InfObj.Guid.upper()] = FfsFile\r
406 else:\r
407 EdkLogger.error("build", \r
408 FORMAT_INVALID,\r
409 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,\r
410 FfsFile.CurrentLineContent,\r
411 _GuidDict[InfObj.Guid.upper()].CurrentLineNum,\r
412 _GuidDict[InfObj.Guid.upper()].CurrentLineContent,\r
413 InfObj.Guid.upper()),\r
414 ExtraData=self.FdfFile)\r
415 InfFoundFlag = False\r
416 \r
417 if FfsFile.NameGuid != None:\r
418 _CheckPCDAsGuidPattern = re.compile("^PCD\(.+\..+\)$")\r
419 \r
420 #\r
421 # If the NameGuid reference a PCD name. \r
422 # The style must match: PCD(xxxx.yyy)\r
423 #\r
424 if _CheckPCDAsGuidPattern.match(FfsFile.NameGuid):\r
425 #\r
426 # Replace the PCD value.\r
427 #\r
428 _PcdName = FfsFile.NameGuid.lstrip("PCD(").rstrip(")")\r
429 PcdFoundFlag = False\r
430 for Pa in self.AutoGenObjectList:\r
431 if not PcdFoundFlag:\r
432 for PcdItem in Pa.AllPcdList:\r
433 if (PcdItem.TokenSpaceGuidCName + "." + PcdItem.TokenCName) == _PcdName:\r
434 #\r
435 # First convert from CFormatGuid to GUID string\r
436 #\r
437 _PcdGuidString = GuidStructureStringToGuidString(PcdItem.DefaultValue)\r
438 \r
439 if not _PcdGuidString:\r
440 #\r
441 # Then try Byte array.\r
442 #\r
443 _PcdGuidString = GuidStructureByteArrayToGuidString(PcdItem.DefaultValue)\r
444 \r
445 if not _PcdGuidString:\r
446 #\r
447 # Not Byte array or CFormat GUID, raise error.\r
448 #\r
449 EdkLogger.error("build",\r
450 FORMAT_INVALID,\r
451 "The format of PCD value is incorrect. PCD: %s , Value: %s\n"%(_PcdName, PcdItem.DefaultValue),\r
452 ExtraData=self.FdfFile)\r
453 \r
454 if not _PcdGuidString.upper() in _GuidDict.keys(): \r
455 _GuidDict[_PcdGuidString.upper()] = FfsFile\r
456 PcdFoundFlag = True\r
457 break\r
458 else:\r
459 EdkLogger.error("build", \r
460 FORMAT_INVALID,\r
461 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,\r
462 FfsFile.CurrentLineContent,\r
463 _GuidDict[_PcdGuidString.upper()].CurrentLineNum,\r
464 _GuidDict[_PcdGuidString.upper()].CurrentLineContent,\r
465 FfsFile.NameGuid.upper()),\r
466 ExtraData=self.FdfFile) \r
467 \r
468 if not FfsFile.NameGuid.upper() in _GuidDict.keys():\r
469 _GuidDict[FfsFile.NameGuid.upper()] = FfsFile\r
470 else:\r
471 #\r
472 # Two raw file GUID conflict.\r
473 #\r
474 EdkLogger.error("build", \r
475 FORMAT_INVALID,\r
476 "Duplicate GUID found for these lines: Line %d: %s and Line %d: %s. GUID: %s"%(FfsFile.CurrentLineNum,\r
477 FfsFile.CurrentLineContent,\r
478 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineNum,\r
479 _GuidDict[FfsFile.NameGuid.upper()].CurrentLineContent,\r
480 FfsFile.NameGuid.upper()),\r
481 ExtraData=self.FdfFile)\r
482 \r
483\r
4234283c
LG
484 def _CheckPcdDefineAndType(self):\r
485 PcdTypeList = [\r
486 "FixedAtBuild", "PatchableInModule", "FeatureFlag",\r
487 "Dynamic", #"DynamicHii", "DynamicVpd",\r
488 "DynamicEx", # "DynamicExHii", "DynamicExVpd"\r
489 ]\r
490\r
491 # This dict store PCDs which are not used by any modules with specified arches\r
492 UnusedPcd = sdict()\r
493 for Pa in self.AutoGenObjectList:\r
494 # Key of DSC's Pcds dictionary is PcdCName, TokenSpaceGuid\r
495 for Pcd in Pa.Platform.Pcds:\r
496 PcdType = Pa.Platform.Pcds[Pcd].Type\r
497 \r
498 # If no PCD type, this PCD comes from FDF \r
499 if not PcdType:\r
500 continue\r
501 \r
502 # Try to remove Hii and Vpd suffix\r
503 if PcdType.startswith("DynamicEx"):\r
504 PcdType = "DynamicEx"\r
505 elif PcdType.startswith("Dynamic"):\r
506 PcdType = "Dynamic"\r
507 \r
508 for Package in Pa.PackageList:\r
509 # Key of DEC's Pcds dictionary is PcdCName, TokenSpaceGuid, PcdType\r
510 if (Pcd[0], Pcd[1], PcdType) in Package.Pcds:\r
511 break\r
512 for Type in PcdTypeList:\r
513 if (Pcd[0], Pcd[1], Type) in Package.Pcds:\r
514 EdkLogger.error(\r
515 'build',\r
516 FORMAT_INVALID,\r
517 "Type [%s] of PCD [%s.%s] in DSC file doesn't match the type [%s] defined in DEC file." \\r
518 % (Pa.Platform.Pcds[Pcd].Type, Pcd[1], Pcd[0], Type),\r
519 ExtraData=None\r
520 )\r
521 return\r
522 else:\r
523 UnusedPcd.setdefault(Pcd, []).append(Pa.Arch)\r
524\r
525 for Pcd in UnusedPcd:\r
526 EdkLogger.warn(\r
527 'build',\r
528 "The PCD was not specified by any INF module in the platform for the given architecture.\n"\r
529 "\tPCD: [%s.%s]\n\tPlatform: [%s]\n\tArch: %s"\r
530 % (Pcd[1], Pcd[0], os.path.basename(str(self.MetaFile)), str(UnusedPcd[Pcd])),\r
531 ExtraData=None\r
532 )\r
533\r
52302d4d
LG
534 def __repr__(self):\r
535 return "%s [%s]" % (self.MetaFile, ", ".join(self.ArchList))\r
536\r
537 ## Return the directory to store FV files\r
538 def _GetFvDir(self):\r
539 if self._FvDir == None:\r
540 self._FvDir = path.join(self.BuildDir, 'FV')\r
541 return self._FvDir\r
542\r
543 ## Return the directory to store all intermediate and final files built\r
544 def _GetBuildDir(self):\r
545 return self.AutoGenObjectList[0].BuildDir\r
546\r
547 ## Return the build output directory platform specifies\r
548 def _GetOutputDir(self):\r
549 return self.Platform.OutputDirectory\r
550\r
551 ## Return platform name\r
552 def _GetName(self):\r
553 return self.Platform.PlatformName\r
554\r
555 ## Return meta-file GUID\r
556 def _GetGuid(self):\r
557 return self.Platform.Guid\r
558\r
559 ## Return platform version\r
560 def _GetVersion(self):\r
561 return self.Platform.Version\r
562\r
563 ## Return paths of tools\r
564 def _GetToolDefinition(self):\r
565 return self.AutoGenObjectList[0].ToolDefinition\r
566\r
567 ## Return directory of platform makefile\r
568 #\r
569 # @retval string Makefile directory\r
570 #\r
571 def _GetMakeFileDir(self):\r
572 if self._MakeFileDir == None:\r
573 self._MakeFileDir = self.BuildDir\r
574 return self._MakeFileDir\r
575\r
576 ## Return build command string\r
577 #\r
578 # @retval string Build command string\r
579 #\r
580 def _GetBuildCommand(self):\r
581 if self._BuildCommand == None:\r
582 # BuildCommand should be all the same. So just get one from platform AutoGen\r
583 self._BuildCommand = self.AutoGenObjectList[0].BuildCommand\r
584 return self._BuildCommand\r
6780eef1
LG
585 \r
586 ## Check the PCDs token value conflict in each DEC file.\r
587 #\r
588 # Will cause build break and raise error message while two PCDs conflict.\r
589 # \r
590 # @return None\r
591 #\r
592 def _CheckAllPcdsTokenValueConflict(self):\r
b36d134f
LG
593 for Pa in self.AutoGenObjectList:\r
594 for Package in Pa.PackageList:\r
6780eef1
LG
595 PcdList = Package.Pcds.values()\r
596 PcdList.sort(lambda x, y: cmp(x.TokenValue, y.TokenValue)) \r
597 Count = 0\r
598 while (Count < len(PcdList) - 1) :\r
599 Item = PcdList[Count]\r
600 ItemNext = PcdList[Count + 1]\r
601 #\r
602 # Make sure in the same token space the TokenValue should be unique\r
603 #\r
604 if (Item.TokenValue == ItemNext.TokenValue):\r
605 SameTokenValuePcdList = []\r
606 SameTokenValuePcdList.append(Item)\r
607 SameTokenValuePcdList.append(ItemNext)\r
608 RemainPcdListLength = len(PcdList) - Count - 2\r
609 for ValueSameCount in range(RemainPcdListLength):\r
610 if PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount].TokenValue == Item.TokenValue:\r
611 SameTokenValuePcdList.append(PcdList[len(PcdList) - RemainPcdListLength + ValueSameCount])\r
612 else:\r
613 break;\r
614 #\r
615 # Sort same token value PCD list with TokenGuid and TokenCName\r
616 #\r
617 SameTokenValuePcdList.sort(lambda x, y: cmp("%s.%s"%(x.TokenSpaceGuidCName, x.TokenCName), "%s.%s"%(y.TokenSpaceGuidCName, y.TokenCName))) \r
618 SameTokenValuePcdListCount = 0 \r
619 while (SameTokenValuePcdListCount < len(SameTokenValuePcdList) - 1):\r
620 TemListItem = SameTokenValuePcdList[SameTokenValuePcdListCount]\r
621 TemListItemNext = SameTokenValuePcdList[SameTokenValuePcdListCount + 1] \r
622 \r
623 if (TemListItem.TokenSpaceGuidCName == TemListItemNext.TokenSpaceGuidCName) and (TemListItem.TokenCName != TemListItemNext.TokenCName):\r
624 EdkLogger.error(\r
625 'build',\r
626 FORMAT_INVALID,\r
627 "The TokenValue [%s] of PCD [%s.%s] is conflict with: [%s.%s] in %s"\\r
628 % (TemListItem.TokenValue, TemListItem.TokenSpaceGuidCName, TemListItem.TokenCName, TemListItemNext.TokenSpaceGuidCName, TemListItemNext.TokenCName, Package),\r
629 ExtraData=None\r
630 )\r
631 SameTokenValuePcdListCount += 1\r
632 Count += SameTokenValuePcdListCount\r
633 Count += 1\r
634 \r
635 PcdList = Package.Pcds.values()\r
636 PcdList.sort(lambda x, y: cmp("%s.%s"%(x.TokenSpaceGuidCName, x.TokenCName), "%s.%s"%(y.TokenSpaceGuidCName, y.TokenCName)))\r
637 Count = 0\r
638 while (Count < len(PcdList) - 1) :\r
639 Item = PcdList[Count]\r
640 ItemNext = PcdList[Count + 1] \r
641 #\r
642 # Check PCDs with same TokenSpaceGuidCName.TokenCName have same token value as well.\r
643 #\r
644 if (Item.TokenSpaceGuidCName == ItemNext.TokenSpaceGuidCName) and (Item.TokenCName == ItemNext.TokenCName) and (Item.TokenValue != ItemNext.TokenValue):\r
645 EdkLogger.error(\r
646 'build',\r
647 FORMAT_INVALID,\r
648 "The TokenValue [%s] of PCD [%s.%s] in %s defined in two places should be same as well."\\r
649 % (Item.TokenValue, Item.TokenSpaceGuidCName, Item.TokenCName, Package),\r
650 ExtraData=None\r
651 )\r
652 Count += 1\r
653 \r
52302d4d 654\r
e56468c0 655 ## Create makefile for the platform and modules in it\r
52302d4d
LG
656 #\r
657 # @param CreateDepsMakeFile Flag indicating if the makefile for\r
658 # modules will be created as well\r
659 #\r
660 def CreateMakeFile(self, CreateDepsMakeFile=False):\r
661 # create makefile for platform\r
662 Makefile = GenMake.TopLevelMakefile(self)\r
663 if Makefile.Generate():\r
664 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for platform [%s] %s\n" %\r
665 (self.MetaFile, self.ArchList))\r
666 else:\r
667 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for platform [%s] %s\n" %\r
668 (self.MetaFile, self.ArchList))\r
669\r
670 if CreateDepsMakeFile:\r
671 for Pa in self.AutoGenObjectList:\r
672 Pa.CreateMakeFile(CreateDepsMakeFile)\r
673\r
674 ## Create autogen code for platform and modules\r
675 #\r
676 # Since there's no autogen code for platform, this method will do nothing\r
677 # if CreateModuleCodeFile is set to False.\r
678 #\r
679 # @param CreateDepsCodeFile Flag indicating if creating module's\r
680 # autogen code file or not\r
681 #\r
682 def CreateCodeFile(self, CreateDepsCodeFile=False):\r
683 if not CreateDepsCodeFile:\r
684 return\r
685 for Pa in self.AutoGenObjectList:\r
686 Pa.CreateCodeFile(CreateDepsCodeFile)\r
687\r
7c1fd323
LG
688 ## Create AsBuilt INF file the platform\r
689 #\r
690 def CreateAsBuiltInf(self):\r
691 return\r
692\r
52302d4d
LG
693 Name = property(_GetName)\r
694 Guid = property(_GetGuid)\r
695 Version = property(_GetVersion)\r
696 OutputDir = property(_GetOutputDir)\r
697\r
698 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
699\r
700 BuildDir = property(_GetBuildDir)\r
701 FvDir = property(_GetFvDir)\r
702 MakeFileDir = property(_GetMakeFileDir)\r
703 BuildCommand = property(_GetBuildCommand)\r
704\r
705## AutoGen class for platform\r
706#\r
707# PlatformAutoGen class will process the original information in platform\r
708# file in order to generate makefile for platform.\r
709#\r
710class PlatformAutoGen(AutoGen):\r
711 #\r
712 # Used to store all PCDs for both PEI and DXE phase, in order to generate \r
713 # correct PCD database\r
714 # \r
715 _DynaPcdList_ = []\r
716 _NonDynaPcdList_ = []\r
6780eef1
LG
717 \r
718 #\r
719 # The priority list while override build option \r
720 #\r
721 PrioList = {"0x11111" : 16, # TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE (Highest)\r
722 "0x01111" : 15, # ******_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
723 "0x10111" : 14, # TARGET_*********_ARCH_COMMANDTYPE_ATTRIBUTE\r
724 "0x00111" : 13, # ******_*********_ARCH_COMMANDTYPE_ATTRIBUTE \r
725 "0x11011" : 12, # TARGET_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
726 "0x01011" : 11, # ******_TOOLCHAIN_****_COMMANDTYPE_ATTRIBUTE\r
727 "0x10011" : 10, # TARGET_*********_****_COMMANDTYPE_ATTRIBUTE\r
728 "0x00011" : 9, # ******_*********_****_COMMANDTYPE_ATTRIBUTE\r
729 "0x11101" : 8, # TARGET_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
730 "0x01101" : 7, # ******_TOOLCHAIN_ARCH_***********_ATTRIBUTE\r
731 "0x10101" : 6, # TARGET_*********_ARCH_***********_ATTRIBUTE\r
732 "0x00101" : 5, # ******_*********_ARCH_***********_ATTRIBUTE\r
733 "0x11001" : 4, # TARGET_TOOLCHAIN_****_***********_ATTRIBUTE\r
734 "0x01001" : 3, # ******_TOOLCHAIN_****_***********_ATTRIBUTE\r
735 "0x10001" : 2, # TARGET_*********_****_***********_ATTRIBUTE\r
736 "0x00001" : 1} # ******_*********_****_***********_ATTRIBUTE (Lowest)\r
737 \r
52302d4d
LG
738 ## The real constructor of PlatformAutoGen\r
739 #\r
740 # This method is not supposed to be called by users of PlatformAutoGen. It's\r
741 # only used by factory method __new__() to do real initialization work for an\r
742 # object of PlatformAutoGen\r
743 #\r
744 # @param Workspace WorkspaceAutoGen object\r
745 # @param PlatformFile Platform file (DSC file)\r
746 # @param Target Build target (DEBUG, RELEASE)\r
747 # @param Toolchain Name of tool chain\r
748 # @param Arch arch of the platform supports\r
749 #\r
750 def _Init(self, Workspace, PlatformFile, Target, Toolchain, Arch):\r
751 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen platform [%s] [%s]" % (PlatformFile, Arch))\r
752 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (PlatformFile, Arch, Toolchain, Target)\r
753\r
754 self.MetaFile = PlatformFile\r
755 self.Workspace = Workspace\r
756 self.WorkspaceDir = Workspace.WorkspaceDir\r
757 self.ToolChain = Toolchain\r
758 self.BuildTarget = Target\r
759 self.Arch = Arch\r
760 self.SourceDir = PlatformFile.SubDir\r
761 self.SourceOverrideDir = None\r
762 self.FdTargetList = self.Workspace.FdTargetList\r
763 self.FvTargetList = self.Workspace.FvTargetList\r
764 self.AllPcdList = []\r
765\r
766 # flag indicating if the makefile/C-code file has been created or not\r
767 self.IsMakeFileCreated = False\r
768 self.IsCodeFileCreated = False\r
769\r
770 self._Platform = None\r
771 self._Name = None\r
772 self._Guid = None\r
773 self._Version = None\r
774\r
775 self._BuildRule = None\r
776 self._SourceDir = None\r
777 self._BuildDir = None\r
778 self._OutputDir = None\r
779 self._FvDir = None\r
780 self._MakeFileDir = None\r
781 self._FdfFile = None\r
782\r
783 self._PcdTokenNumber = None # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
784 self._DynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
785 self._NonDynamicPcdList = None # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
786\r
787 self._ToolDefinitions = None\r
788 self._ToolDefFile = None # toolcode : tool path\r
789 self._ToolChainFamily = None\r
790 self._BuildRuleFamily = None\r
791 self._BuildOption = None # toolcode : option\r
792 self._EdkBuildOption = None # edktoolcode : option\r
793 self._EdkIIBuildOption = None # edkiitoolcode : option\r
794 self._PackageList = None\r
795 self._ModuleAutoGenList = None\r
796 self._LibraryAutoGenList = None\r
797 self._BuildCommand = None\r
798\r
799 # get the original module/package/platform objects\r
800 self.BuildDatabase = Workspace.BuildDatabase\r
801 return True\r
802\r
803 def __repr__(self):\r
804 return "%s [%s]" % (self.MetaFile, self.Arch)\r
805\r
806 ## Create autogen code for platform and modules\r
807 #\r
808 # Since there's no autogen code for platform, this method will do nothing\r
809 # if CreateModuleCodeFile is set to False.\r
810 #\r
811 # @param CreateModuleCodeFile Flag indicating if creating module's\r
812 # autogen code file or not\r
813 #\r
814 def CreateCodeFile(self, CreateModuleCodeFile=False):\r
815 # only module has code to be greated, so do nothing if CreateModuleCodeFile is False\r
816 if self.IsCodeFileCreated or not CreateModuleCodeFile:\r
817 return\r
818\r
819 for Ma in self.ModuleAutoGenList:\r
820 Ma.CreateCodeFile(True)\r
821\r
822 # don't do this twice\r
823 self.IsCodeFileCreated = True\r
824\r
825 ## Create makefile for the platform and mdoules in it\r
826 #\r
827 # @param CreateModuleMakeFile Flag indicating if the makefile for\r
828 # modules will be created as well\r
829 #\r
830 def CreateMakeFile(self, CreateModuleMakeFile=False):\r
831 if CreateModuleMakeFile:\r
832 for ModuleFile in self.Platform.Modules:\r
833 Ma = ModuleAutoGen(self.Workspace, ModuleFile, self.BuildTarget,\r
834 self.ToolChain, self.Arch, self.MetaFile)\r
835 Ma.CreateMakeFile(True)\r
da92f276 836 Ma.CreateAsBuiltInf()\r
52302d4d
LG
837\r
838 # no need to create makefile for the platform more than once\r
839 if self.IsMakeFileCreated:\r
840 return\r
841\r
842 # create makefile for platform\r
843 Makefile = GenMake.PlatformMakefile(self)\r
844 if Makefile.Generate():\r
845 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for platform [%s] [%s]\n" %\r
846 (self.MetaFile, self.Arch))\r
847 else:\r
848 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for platform [%s] [%s]\n" %\r
849 (self.MetaFile, self.Arch))\r
850 self.IsMakeFileCreated = True\r
851\r
852 ## Collect dynamic PCDs\r
853 #\r
854 # Gather dynamic PCDs list from each module and their settings from platform\r
855 # This interface should be invoked explicitly when platform action is created.\r
856 #\r
857 def CollectPlatformDynamicPcds(self):\r
858 # for gathering error information\r
859 NoDatumTypePcdList = set()\r
860\r
861 self._GuidValue = {}\r
862 for F in self.Platform.Modules.keys():\r
863 M = ModuleAutoGen(self.Workspace, F, self.BuildTarget, self.ToolChain, self.Arch, self.MetaFile)\r
864 #GuidValue.update(M.Guids)\r
865 \r
866 self.Platform.Modules[F].M = M\r
867 \r
868 for PcdFromModule in M.ModulePcdList+M.LibraryPcdList:\r
869 # make sure that the "VOID*" kind of datum has MaxDatumSize set\r
870 if PcdFromModule.DatumType == "VOID*" and PcdFromModule.MaxDatumSize == None:\r
871 NoDatumTypePcdList.add("%s.%s [%s]" % (PcdFromModule.TokenSpaceGuidCName, PcdFromModule.TokenCName, F))\r
872\r
873 if PcdFromModule.Type in GenC.gDynamicPcd or PcdFromModule.Type in GenC.gDynamicExPcd:\r
874 #\r
875 # If a dynamic PCD used by a PEM module/PEI module & DXE module,\r
876 # it should be stored in Pcd PEI database, If a dynamic only\r
877 # used by DXE module, it should be stored in DXE PCD database.\r
878 # The default Phase is DXE\r
879 #\r
880 if M.ModuleType in ["PEIM", "PEI_CORE"]:\r
881 PcdFromModule.Phase = "PEI"\r
882 if PcdFromModule not in self._DynaPcdList_:\r
883 self._DynaPcdList_.append(PcdFromModule)\r
884 elif PcdFromModule.Phase == 'PEI':\r
885 # overwrite any the same PCD existing, if Phase is PEI\r
886 Index = self._DynaPcdList_.index(PcdFromModule)\r
887 self._DynaPcdList_[Index] = PcdFromModule\r
888 elif PcdFromModule not in self._NonDynaPcdList_:\r
889 self._NonDynaPcdList_.append(PcdFromModule)\r
890\r
891 # print out error information and break the build, if error found\r
892 if len(NoDatumTypePcdList) > 0:\r
893 NoDatumTypePcdListString = "\n\t\t".join(NoDatumTypePcdList)\r
894 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
895 File=self.MetaFile,\r
896 ExtraData="\n\tPCD(s) without MaxDatumSize:\n\t\t%s\n"\r
897 % NoDatumTypePcdListString)\r
898 self._NonDynamicPcdList = self._NonDynaPcdList_\r
899 self._DynamicPcdList = self._DynaPcdList_\r
900 self.AllPcdList = self._NonDynamicPcdList + self._DynamicPcdList\r
901 \r
902 #\r
903 # Sort dynamic PCD list to:\r
904 # 1) If PCD's datum type is VOID* and value is unicode string which starts with L, the PCD item should \r
905 # try to be put header of dynamicd List\r
906 # 2) If PCD is HII type, the PCD item should be put after unicode type PCD\r
907 #\r
908 # The reason of sorting is make sure the unicode string is in double-byte alignment in string table.\r
909 #\r
910 UnicodePcdArray = []\r
911 HiiPcdArray = []\r
912 OtherPcdArray = []\r
6780eef1 913 VpdPcdDict = {}\r
e56468c0 914 VpdFile = VpdInfoFile.VpdInfoFile()\r
915 NeedProcessVpdMapFile = False \r
916 \r
917 if (self.Workspace.ArchList[-1] == self.Arch): \r
918 for Pcd in self._DynamicPcdList:\r
e56468c0 919 # just pick the a value to determine whether is unicode string type\r
920 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]\r
921 Sku.VpdOffset = Sku.VpdOffset.strip()\r
922 \r
923 PcdValue = Sku.DefaultValue\r
924 if Pcd.DatumType == 'VOID*' and PcdValue.startswith("L"):\r
925 # if found PCD which datum value is unicode string the insert to left size of UnicodeIndex\r
926 UnicodePcdArray.append(Pcd)\r
927 elif len(Sku.VariableName) > 0:\r
928 # if found HII type PCD then insert to right of UnicodeIndex\r
929 HiiPcdArray.append(Pcd)\r
930 else:\r
931 OtherPcdArray.append(Pcd)\r
e56468c0 932 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
6780eef1
LG
933 VpdPcdDict[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName)] = Pcd \r
934 \r
935 PlatformPcds = self.Platform.Pcds.keys()\r
936 PlatformPcds.sort() \r
937 #\r
938 # Add VPD type PCD into VpdFile and determine whether the VPD PCD need to be fixed up.\r
939 #\r
940 for PcdKey in PlatformPcds:\r
941 Pcd = self.Platform.Pcds[PcdKey] \r
942 if Pcd.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
943 Pcd = VpdPcdDict[PcdKey]\r
944 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]]\r
945 Sku.VpdOffset = Sku.VpdOffset.strip() \r
946 #\r
947 # Fix the optional data of VPD PCD.\r
948 #\r
949 if (Pcd.DatumType.strip() != "VOID*"):\r
950 if Sku.DefaultValue == '':\r
951 Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]].DefaultValue = Pcd.MaxDatumSize\r
952 Pcd.MaxDatumSize = None\r
953 else:\r
954 EdkLogger.error("build", AUTOGEN_ERROR, "PCD setting error",\r
955 File=self.MetaFile,\r
956 ExtraData="\n\tPCD: %s.%s format incorrect in DSC: %s\n\t\t\n"\r
957 % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, self.Platform.MetaFile.Path)) \r
958 \r
959 VpdFile.Add(Pcd, Sku.VpdOffset)\r
960 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
961 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
962 NeedProcessVpdMapFile = True\r
963 if self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == '':\r
964 EdkLogger.error("Build", FILE_NOT_FOUND, \\r
965 "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
966 \r
e56468c0 967 \r
968 #\r
969 # Fix the PCDs define in VPD PCD section that never referenced by module.\r
970 # An example is PCD for signature usage.\r
6780eef1
LG
971 # \r
972 for DscPcd in PlatformPcds:\r
e56468c0 973 DscPcdEntry = self.Platform.Pcds[DscPcd]\r
974 if DscPcdEntry.Type in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:\r
975 if not (self.Platform.VpdToolGuid == None or self.Platform.VpdToolGuid == ''):\r
976 FoundFlag = False\r
977 for VpdPcd in VpdFile._VpdArray.keys():\r
978 # This PCD has been referenced by module\r
979 if (VpdPcd.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
980 (VpdPcd.TokenCName == DscPcdEntry.TokenCName):\r
981 FoundFlag = True\r
982 \r
983 # Not found, it should be signature\r
984 if not FoundFlag :\r
985 # just pick the a value to determine whether is unicode string type\r
986 Sku = DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]]\r
987 Sku.VpdOffset = Sku.VpdOffset.strip() \r
988 \r
989 # Need to iterate DEC pcd information to get the value & datumtype\r
990 for eachDec in self.PackageList:\r
991 for DecPcd in eachDec.Pcds:\r
992 DecPcdEntry = eachDec.Pcds[DecPcd]\r
993 if (DecPcdEntry.TokenSpaceGuidCName == DscPcdEntry.TokenSpaceGuidCName) and \\r
994 (DecPcdEntry.TokenCName == DscPcdEntry.TokenCName):\r
08dd311f
LG
995 # Print warning message to let the developer make a determine.\r
996 EdkLogger.warn("build", "Unreferenced vpd pcd used!",\r
997 File=self.MetaFile, \\r
998 ExtraData = "PCD: %s.%s used in the DSC file %s is unreferenced." \\r
999 %(DscPcdEntry.TokenSpaceGuidCName, DscPcdEntry.TokenCName, self.Platform.MetaFile.Path)) \r
1000 \r
e56468c0 1001 DscPcdEntry.DatumType = DecPcdEntry.DatumType\r
1002 DscPcdEntry.DefaultValue = DecPcdEntry.DefaultValue\r
08dd311f
LG
1003 # Only fix the value while no value provided in DSC file.\r
1004 if (Sku.DefaultValue == "" or Sku.DefaultValue==None):\r
1005 DscPcdEntry.SkuInfoList[DscPcdEntry.SkuInfoList.keys()[0]].DefaultValue = DecPcdEntry.DefaultValue\r
1006 \r
e56468c0 1007 \r
1008 VpdFile.Add(DscPcdEntry, Sku.VpdOffset)\r
1009 # if the offset of a VPD is *, then it need to be fixed up by third party tool.\r
1010 if not NeedProcessVpdMapFile and Sku.VpdOffset == "*":\r
1011 NeedProcessVpdMapFile = True \r
1012 \r
1013 \r
1014 if (self.Platform.FlashDefinition == None or self.Platform.FlashDefinition == '') and \\r
1015 VpdFile.GetCount() != 0:\r
1016 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, \r
1017 "Fail to get FLASH_DEFINITION definition in DSC file %s which is required when DSC contains VPD PCD." % str(self.Platform.MetaFile))\r
1018 \r
1019 if VpdFile.GetCount() != 0:\r
d0acc87a 1020 DscTimeStamp = self.Platform.MetaFile.TimeStamp\r
e56468c0 1021 FvPath = os.path.join(self.BuildDir, "FV")\r
1022 if not os.path.exists(FvPath):\r
1023 try:\r
1024 os.makedirs(FvPath)\r
1025 except:\r
1026 EdkLogger.error("build", FILE_WRITE_FAILURE, "Fail to create FV folder under %s" % self.BuildDir)\r
1027 \r
08dd311f
LG
1028 \r
1029 VpdFilePath = os.path.join(FvPath, "%s.txt" % self.Platform.VpdToolGuid)\r
1030\r
e56468c0 1031 \r
1032 if not os.path.exists(VpdFilePath) or os.path.getmtime(VpdFilePath) < DscTimeStamp:\r
1033 VpdFile.Write(VpdFilePath)\r
1034 \r
1035 # retrieve BPDG tool's path from tool_def.txt according to VPD_TOOL_GUID defined in DSC file.\r
1036 BPDGToolName = None\r
1037 for ToolDef in self.ToolDefinition.values():\r
1038 if ToolDef.has_key("GUID") and ToolDef["GUID"] == self.Platform.VpdToolGuid:\r
1039 if not ToolDef.has_key("PATH"):\r
1040 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "PATH attribute was not provided for BPDG guid tool %s in tools_def.txt" % self.Platform.VpdToolGuid)\r
1041 BPDGToolName = ToolDef["PATH"]\r
1042 break\r
1043 # Call third party GUID BPDG tool.\r
1044 if BPDGToolName != None:\r
08dd311f 1045 VpdInfoFile.CallExtenalBPDGTool(BPDGToolName, VpdFilePath)\r
e56468c0 1046 else:\r
1047 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
1048 \r
1049 # Process VPD map file generated by third party BPDG tool\r
1050 if NeedProcessVpdMapFile:\r
08dd311f 1051 VpdMapFilePath = os.path.join(self.BuildDir, "FV", "%s.map" % self.Platform.VpdToolGuid)\r
e56468c0 1052 if os.path.exists(VpdMapFilePath):\r
1053 VpdFile.Read(VpdMapFilePath)\r
1054 \r
1055 # Fixup "*" offset\r
1056 for Pcd in self._DynamicPcdList:\r
1057 # just pick the a value to determine whether is unicode string type\r
1058 Sku = Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]] \r
1059 if Sku.VpdOffset == "*":\r
d0acc87a 1060 Sku.VpdOffset = VpdFile.GetOffset(Pcd)[0].strip()\r
e56468c0 1061 else:\r
1062 EdkLogger.error("build", FILE_READ_FAILURE, "Can not find VPD map file %s to fix up VPD offset." % VpdMapFilePath)\r
1063 \r
1064 # Delete the DynamicPcdList At the last time enter into this function \r
1065 del self._DynamicPcdList[:] \r
52302d4d
LG
1066 self._DynamicPcdList.extend(UnicodePcdArray)\r
1067 self._DynamicPcdList.extend(HiiPcdArray)\r
1068 self._DynamicPcdList.extend(OtherPcdArray)\r
1069 \r
1070 \r
1071 ## Return the platform build data object\r
1072 def _GetPlatform(self):\r
1073 if self._Platform == None:\r
0d2711a6 1074 self._Platform = self.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1075 return self._Platform\r
1076\r
1077 ## Return platform name\r
1078 def _GetName(self):\r
1079 return self.Platform.PlatformName\r
1080\r
1081 ## Return the meta file GUID\r
1082 def _GetGuid(self):\r
1083 return self.Platform.Guid\r
1084\r
1085 ## Return the platform version\r
1086 def _GetVersion(self):\r
1087 return self.Platform.Version\r
1088\r
1089 ## Return the FDF file name\r
1090 def _GetFdfFile(self):\r
1091 if self._FdfFile == None:\r
1092 if self.Workspace.FdfFile != "":\r
1093 self._FdfFile= path.join(self.WorkspaceDir, self.Workspace.FdfFile)\r
1094 else:\r
1095 self._FdfFile = ''\r
1096 return self._FdfFile\r
1097\r
1098 ## Return the build output directory platform specifies\r
1099 def _GetOutputDir(self):\r
1100 return self.Platform.OutputDirectory\r
1101\r
1102 ## Return the directory to store all intermediate and final files built\r
1103 def _GetBuildDir(self):\r
1104 if self._BuildDir == None:\r
1105 if os.path.isabs(self.OutputDir):\r
1106 self._BuildDir = path.join(\r
1107 path.abspath(self.OutputDir),\r
1108 self.BuildTarget + "_" + self.ToolChain,\r
1109 )\r
1110 else:\r
1111 self._BuildDir = path.join(\r
1112 self.WorkspaceDir,\r
1113 self.OutputDir,\r
1114 self.BuildTarget + "_" + self.ToolChain,\r
1115 )\r
1116 return self._BuildDir\r
1117\r
1118 ## Return directory of platform makefile\r
1119 #\r
1120 # @retval string Makefile directory\r
1121 #\r
1122 def _GetMakeFileDir(self):\r
1123 if self._MakeFileDir == None:\r
1124 self._MakeFileDir = path.join(self.BuildDir, self.Arch)\r
1125 return self._MakeFileDir\r
1126\r
1127 ## Return build command string\r
1128 #\r
1129 # @retval string Build command string\r
1130 #\r
1131 def _GetBuildCommand(self):\r
1132 if self._BuildCommand == None:\r
1133 self._BuildCommand = []\r
1134 if "MAKE" in self.ToolDefinition and "PATH" in self.ToolDefinition["MAKE"]:\r
1135 self._BuildCommand += SplitOption(self.ToolDefinition["MAKE"]["PATH"])\r
1136 if "FLAGS" in self.ToolDefinition["MAKE"]:\r
1137 NewOption = self.ToolDefinition["MAKE"]["FLAGS"].strip()\r
1138 if NewOption != '':\r
6780eef1 1139 self._BuildCommand += SplitOption(NewOption)\r
52302d4d
LG
1140 return self._BuildCommand\r
1141\r
1142 ## Get tool chain definition\r
1143 #\r
1144 # Get each tool defition for given tool chain from tools_def.txt and platform\r
1145 #\r
1146 def _GetToolDefinition(self):\r
1147 if self._ToolDefinitions == None:\r
1148 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDictionary\r
1149 if TAB_TOD_DEFINES_COMMAND_TYPE not in self.Workspace.ToolDef.ToolsDefTxtDatabase:\r
1150 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No tools found in configuration",\r
1151 ExtraData="[%s]" % self.MetaFile)\r
1152 self._ToolDefinitions = {}\r
1153 DllPathList = set()\r
1154 for Def in ToolDefinition:\r
1155 Target, Tag, Arch, Tool, Attr = Def.split("_")\r
1156 if Target != self.BuildTarget or Tag != self.ToolChain or Arch != self.Arch:\r
1157 continue\r
1158\r
1159 Value = ToolDefinition[Def]\r
1160 # don't record the DLL\r
1161 if Attr == "DLL":\r
1162 DllPathList.add(Value)\r
1163 continue\r
1164\r
1165 if Tool not in self._ToolDefinitions:\r
1166 self._ToolDefinitions[Tool] = {}\r
1167 self._ToolDefinitions[Tool][Attr] = Value\r
1168\r
1169 ToolsDef = ''\r
1170 MakePath = ''\r
1171 if GlobalData.gOptions.SilentMode and "MAKE" in self._ToolDefinitions:\r
1172 if "FLAGS" not in self._ToolDefinitions["MAKE"]:\r
1173 self._ToolDefinitions["MAKE"]["FLAGS"] = ""\r
1174 self._ToolDefinitions["MAKE"]["FLAGS"] += " -s"\r
1175 MakeFlags = ''\r
1176 for Tool in self._ToolDefinitions:\r
1177 for Attr in self._ToolDefinitions[Tool]:\r
1178 Value = self._ToolDefinitions[Tool][Attr]\r
1179 if Tool in self.BuildOption and Attr in self.BuildOption[Tool]:\r
1180 # check if override is indicated\r
1181 if self.BuildOption[Tool][Attr].startswith('='):\r
1182 Value = self.BuildOption[Tool][Attr][1:]\r
1183 else:\r
1184 Value += " " + self.BuildOption[Tool][Attr]\r
1185\r
1186 if Attr == "PATH":\r
1187 # Don't put MAKE definition in the file\r
1188 if Tool == "MAKE":\r
1189 MakePath = Value\r
1190 else:\r
1191 ToolsDef += "%s = %s\n" % (Tool, Value)\r
1192 elif Attr != "DLL":\r
1193 # Don't put MAKE definition in the file\r
1194 if Tool == "MAKE":\r
1195 if Attr == "FLAGS":\r
1196 MakeFlags = Value\r
1197 else:\r
1198 ToolsDef += "%s_%s = %s\n" % (Tool, Attr, Value)\r
1199 ToolsDef += "\n"\r
1200\r
1201 SaveFileOnChange(self.ToolDefinitionFile, ToolsDef)\r
1202 for DllPath in DllPathList:\r
1203 os.environ["PATH"] = DllPath + os.pathsep + os.environ["PATH"]\r
1204 os.environ["MAKE_FLAGS"] = MakeFlags\r
1205\r
1206 return self._ToolDefinitions\r
1207\r
1208 ## Return the paths of tools\r
1209 def _GetToolDefFile(self):\r
1210 if self._ToolDefFile == None:\r
1211 self._ToolDefFile = os.path.join(self.MakeFileDir, "TOOLS_DEF." + self.Arch)\r
1212 return self._ToolDefFile\r
1213\r
1214 ## Retrieve the toolchain family of given toolchain tag. Default to 'MSFT'.\r
1215 def _GetToolChainFamily(self):\r
1216 if self._ToolChainFamily == None:\r
1217 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1218 if TAB_TOD_DEFINES_FAMILY not in ToolDefinition \\r
1219 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_FAMILY] \\r
1220 or not ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]:\r
1221 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1222 % self.ToolChain)\r
1223 self._ToolChainFamily = "MSFT"\r
1224 else:\r
1225 self._ToolChainFamily = ToolDefinition[TAB_TOD_DEFINES_FAMILY][self.ToolChain]\r
1226 return self._ToolChainFamily\r
1227\r
1228 def _GetBuildRuleFamily(self):\r
1229 if self._BuildRuleFamily == None:\r
1230 ToolDefinition = self.Workspace.ToolDef.ToolsDefTxtDatabase\r
1231 if TAB_TOD_DEFINES_BUILDRULEFAMILY not in ToolDefinition \\r
1232 or self.ToolChain not in ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY] \\r
1233 or not ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]:\r
1234 EdkLogger.verbose("No tool chain family found in configuration for %s. Default to MSFT." \\r
1235 % self.ToolChain)\r
1236 self._BuildRuleFamily = "MSFT"\r
1237 else:\r
1238 self._BuildRuleFamily = ToolDefinition[TAB_TOD_DEFINES_BUILDRULEFAMILY][self.ToolChain]\r
1239 return self._BuildRuleFamily\r
1240\r
1241 ## Return the build options specific for all modules in this platform\r
1242 def _GetBuildOptions(self):\r
1243 if self._BuildOption == None:\r
1244 self._BuildOption = self._ExpandBuildOption(self.Platform.BuildOptions)\r
1245 return self._BuildOption\r
1246\r
1247 ## Return the build options specific for EDK modules in this platform\r
1248 def _GetEdkBuildOptions(self):\r
1249 if self._EdkBuildOption == None:\r
1250 self._EdkBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDK_NAME)\r
1251 return self._EdkBuildOption\r
1252\r
1253 ## Return the build options specific for EDKII modules in this platform\r
1254 def _GetEdkIIBuildOptions(self):\r
1255 if self._EdkIIBuildOption == None:\r
1256 self._EdkIIBuildOption = self._ExpandBuildOption(self.Platform.BuildOptions, EDKII_NAME)\r
1257 return self._EdkIIBuildOption\r
1258\r
1259 ## Parse build_rule.txt in $(WORKSPACE)/Conf/build_rule.txt\r
1260 #\r
1261 # @retval BuildRule object\r
1262 #\r
1263 def _GetBuildRule(self):\r
1264 if self._BuildRule == None:\r
1265 BuildRuleFile = None\r
1266 if TAB_TAT_DEFINES_BUILD_RULE_CONF in self.Workspace.TargetTxt.TargetTxtDictionary:\r
1267 BuildRuleFile = self.Workspace.TargetTxt.TargetTxtDictionary[TAB_TAT_DEFINES_BUILD_RULE_CONF]\r
1268 if BuildRuleFile in [None, '']:\r
1269 BuildRuleFile = gBuildRuleFile\r
1270 self._BuildRule = BuildRule(BuildRuleFile)\r
64b2609f
LG
1271 if self._BuildRule._FileVersion == "":\r
1272 self._BuildRule._FileVersion = AutoGenReqBuildRuleVerNum\r
1273 else:\r
1274 if self._BuildRule._FileVersion < AutoGenReqBuildRuleVerNum :\r
1275 # If Build Rule's version is less than the version number required by the tools, halting the build.\r
1276 EdkLogger.error("build", AUTOGEN_ERROR, \r
1277 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
1278 % (self._BuildRule._FileVersion, AutoGenReqBuildRuleVerNum))\r
1279 \r
52302d4d
LG
1280 return self._BuildRule\r
1281\r
1282 ## Summarize the packages used by modules in this platform\r
1283 def _GetPackageList(self):\r
1284 if self._PackageList == None:\r
1285 self._PackageList = set()\r
1286 for La in self.LibraryAutoGenList:\r
1287 self._PackageList.update(La.DependentPackageList)\r
1288 for Ma in self.ModuleAutoGenList:\r
1289 self._PackageList.update(Ma.DependentPackageList)\r
1290 self._PackageList = list(self._PackageList)\r
1291 return self._PackageList\r
1292\r
1293 ## Get list of non-dynamic PCDs\r
1294 def _GetNonDynamicPcdList(self):\r
e56468c0 1295 if self._NonDynamicPcdList == None:\r
1296 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1297 return self._NonDynamicPcdList\r
1298\r
1299 ## Get list of dynamic PCDs\r
1300 def _GetDynamicPcdList(self):\r
e56468c0 1301 if self._DynamicPcdList == None:\r
1302 self.CollectPlatformDynamicPcds()\r
52302d4d
LG
1303 return self._DynamicPcdList\r
1304\r
1305 ## Generate Token Number for all PCD\r
1306 def _GetPcdTokenNumbers(self):\r
1307 if self._PcdTokenNumber == None:\r
1308 self._PcdTokenNumber = sdict()\r
1309 TokenNumber = 1\r
d0acc87a
LG
1310 #\r
1311 # Make the Dynamic and DynamicEx PCD use within different TokenNumber area. \r
1312 # Such as:\r
1313 # \r
1314 # Dynamic PCD:\r
1315 # TokenNumber 0 ~ 10\r
1316 # DynamicEx PCD:\r
1317 # TokeNumber 11 ~ 20\r
1318 #\r
52302d4d
LG
1319 for Pcd in self.DynamicPcdList:\r
1320 if Pcd.Phase == "PEI":\r
d0acc87a
LG
1321 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
1322 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1323 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1324 TokenNumber += 1\r
1325 \r
1326 for Pcd in self.DynamicPcdList:\r
1327 if Pcd.Phase == "PEI":\r
1328 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
1329 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1330 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1331 TokenNumber += 1\r
1332 \r
52302d4d
LG
1333 for Pcd in self.DynamicPcdList:\r
1334 if Pcd.Phase == "DXE":\r
d0acc87a
LG
1335 if Pcd.Type in ["Dynamic", "DynamicDefault", "DynamicVpd", "DynamicHii"]:\r
1336 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1337 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1338 TokenNumber += 1\r
1339 \r
1340 for Pcd in self.DynamicPcdList:\r
1341 if Pcd.Phase == "DXE":\r
1342 if Pcd.Type in ["DynamicEx", "DynamicExDefault", "DynamicExVpd", "DynamicExHii"]:\r
1343 EdkLogger.debug(EdkLogger.DEBUG_5, "%s %s (%s) -> %d" % (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, Pcd.Phase, TokenNumber))\r
1344 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1345 TokenNumber += 1\r
1346 \r
52302d4d
LG
1347 for Pcd in self.NonDynamicPcdList:\r
1348 self._PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName] = TokenNumber\r
1349 TokenNumber += 1\r
1350 return self._PcdTokenNumber\r
1351\r
1352 ## Summarize ModuleAutoGen objects of all modules/libraries to be built for this platform\r
1353 def _GetAutoGenObjectList(self):\r
1354 self._ModuleAutoGenList = []\r
1355 self._LibraryAutoGenList = []\r
1356 for ModuleFile in self.Platform.Modules:\r
1357 Ma = ModuleAutoGen(\r
1358 self.Workspace,\r
1359 ModuleFile,\r
1360 self.BuildTarget,\r
1361 self.ToolChain,\r
1362 self.Arch,\r
1363 self.MetaFile\r
1364 )\r
1365 if Ma not in self._ModuleAutoGenList:\r
1366 self._ModuleAutoGenList.append(Ma)\r
1367 for La in Ma.LibraryAutoGenList:\r
1368 if La not in self._LibraryAutoGenList:\r
1369 self._LibraryAutoGenList.append(La)\r
1370\r
1371 ## Summarize ModuleAutoGen objects of all modules to be built for this platform\r
1372 def _GetModuleAutoGenList(self):\r
1373 if self._ModuleAutoGenList == None:\r
1374 self._GetAutoGenObjectList()\r
1375 return self._ModuleAutoGenList\r
1376\r
1377 ## Summarize ModuleAutoGen objects of all libraries to be built for this platform\r
1378 def _GetLibraryAutoGenList(self):\r
1379 if self._LibraryAutoGenList == None:\r
1380 self._GetAutoGenObjectList()\r
1381 return self._LibraryAutoGenList\r
1382\r
1383 ## Test if a module is supported by the platform\r
1384 #\r
1385 # An error will be raised directly if the module or its arch is not supported\r
1386 # by the platform or current configuration\r
1387 #\r
1388 def ValidModule(self, Module):\r
1389 return Module in self.Platform.Modules or Module in self.Platform.LibraryInstances\r
1390\r
1391 ## Resolve the library classes in a module to library instances\r
1392 #\r
1393 # This method will not only resolve library classes but also sort the library\r
1394 # instances according to the dependency-ship.\r
1395 #\r
1396 # @param Module The module from which the library classes will be resolved\r
1397 #\r
1398 # @retval library_list List of library instances sorted\r
1399 #\r
1400 def ApplyLibraryInstance(self, Module):\r
1401 ModuleType = Module.ModuleType\r
1402\r
1403 # for overridding library instances with module specific setting\r
1404 PlatformModule = self.Platform.Modules[str(Module)]\r
1405\r
1406 # add forced library instances (specified under LibraryClasses sections)\r
da92f276
LG
1407 #\r
1408 # If a module has a MODULE_TYPE of USER_DEFINED,\r
1409 # do not link in NULL library class instances from the global [LibraryClasses.*] sections.\r
1410 #\r
1411 if Module.ModuleType != SUP_MODULE_USER_DEFINED:\r
1412 for LibraryClass in self.Platform.LibraryClasses.GetKeys():\r
1413 if LibraryClass.startswith("NULL") and self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]:\r
1414 Module.LibraryClasses[LibraryClass] = self.Platform.LibraryClasses[LibraryClass, Module.ModuleType]\r
52302d4d
LG
1415\r
1416 # add forced library instances (specified in module overrides)\r
1417 for LibraryClass in PlatformModule.LibraryClasses:\r
1418 if LibraryClass.startswith("NULL"):\r
1419 Module.LibraryClasses[LibraryClass] = PlatformModule.LibraryClasses[LibraryClass]\r
1420\r
b36d134f 1421 # EdkII module\r
52302d4d
LG
1422 LibraryConsumerList = [Module]\r
1423 Constructor = []\r
1424 ConsumedByList = sdict()\r
1425 LibraryInstance = sdict()\r
1426\r
1427 EdkLogger.verbose("")\r
1428 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
1429 while len(LibraryConsumerList) > 0:\r
1430 M = LibraryConsumerList.pop()\r
1431 for LibraryClassName in M.LibraryClasses:\r
1432 if LibraryClassName not in LibraryInstance:\r
1433 # override library instance for this module\r
1434 if LibraryClassName in PlatformModule.LibraryClasses:\r
1435 LibraryPath = PlatformModule.LibraryClasses[LibraryClassName]\r
1436 else:\r
1437 LibraryPath = self.Platform.LibraryClasses[LibraryClassName, ModuleType]\r
1438 if LibraryPath == None or LibraryPath == "":\r
1439 LibraryPath = M.LibraryClasses[LibraryClassName]\r
1440 if LibraryPath == None or LibraryPath == "":\r
1441 EdkLogger.error("build", RESOURCE_NOT_AVAILABLE,\r
1442 "Instance of library class [%s] is not found" % LibraryClassName,\r
1443 File=self.MetaFile,\r
1444 ExtraData="in [%s] [%s]\n\tconsumed by module [%s]" % (str(M), self.Arch, str(Module)))\r
1445\r
0d2711a6 1446 LibraryModule = self.BuildDatabase[LibraryPath, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
1447 # for those forced library instance (NULL library), add a fake library class\r
1448 if LibraryClassName.startswith("NULL"):\r
1449 LibraryModule.LibraryClass.append(LibraryClassObject(LibraryClassName, [ModuleType]))\r
1450 elif LibraryModule.LibraryClass == None \\r
1451 or len(LibraryModule.LibraryClass) == 0 \\r
1452 or (ModuleType != 'USER_DEFINED'\r
1453 and ModuleType not in LibraryModule.LibraryClass[0].SupModList):\r
1454 # only USER_DEFINED can link against any library instance despite of its SupModList\r
1455 EdkLogger.error("build", OPTION_MISSING,\r
1456 "Module type [%s] is not supported by library instance [%s]" \\r
1457 % (ModuleType, LibraryPath), File=self.MetaFile,\r
1458 ExtraData="consumed by [%s]" % str(Module))\r
1459\r
1460 LibraryInstance[LibraryClassName] = LibraryModule\r
1461 LibraryConsumerList.append(LibraryModule)\r
1462 EdkLogger.verbose("\t" + str(LibraryClassName) + " : " + str(LibraryModule))\r
1463 else:\r
1464 LibraryModule = LibraryInstance[LibraryClassName]\r
1465\r
1466 if LibraryModule == None:\r
1467 continue\r
1468\r
1469 if LibraryModule.ConstructorList != [] and LibraryModule not in Constructor:\r
1470 Constructor.append(LibraryModule)\r
1471\r
1472 if LibraryModule not in ConsumedByList:\r
1473 ConsumedByList[LibraryModule] = []\r
1474 # don't add current module itself to consumer list\r
1475 if M != Module:\r
1476 if M in ConsumedByList[LibraryModule]:\r
1477 continue\r
1478 ConsumedByList[LibraryModule].append(M)\r
1479 #\r
1480 # Initialize the sorted output list to the empty set\r
1481 #\r
1482 SortedLibraryList = []\r
1483 #\r
1484 # Q <- Set of all nodes with no incoming edges\r
1485 #\r
1486 LibraryList = [] #LibraryInstance.values()\r
1487 Q = []\r
1488 for LibraryClassName in LibraryInstance:\r
1489 M = LibraryInstance[LibraryClassName]\r
1490 LibraryList.append(M)\r
1491 if ConsumedByList[M] == []:\r
1492 Q.append(M)\r
1493\r
1494 #\r
1495 # start the DAG algorithm\r
1496 #\r
1497 while True:\r
1498 EdgeRemoved = True\r
1499 while Q == [] and EdgeRemoved:\r
1500 EdgeRemoved = False\r
1501 # for each node Item with a Constructor\r
1502 for Item in LibraryList:\r
1503 if Item not in Constructor:\r
1504 continue\r
1505 # for each Node without a constructor with an edge e from Item to Node\r
1506 for Node in ConsumedByList[Item]:\r
1507 if Node in Constructor:\r
1508 continue\r
1509 # remove edge e from the graph if Node has no constructor\r
1510 ConsumedByList[Item].remove(Node)\r
1511 EdgeRemoved = True\r
1512 if ConsumedByList[Item] == []:\r
1513 # insert Item into Q\r
1514 Q.insert(0, Item)\r
1515 break\r
1516 if Q != []:\r
1517 break\r
1518 # DAG is done if there's no more incoming edge for all nodes\r
1519 if Q == []:\r
1520 break\r
1521\r
1522 # remove node from Q\r
1523 Node = Q.pop()\r
1524 # output Node\r
1525 SortedLibraryList.append(Node)\r
1526\r
1527 # for each node Item with an edge e from Node to Item do\r
1528 for Item in LibraryList:\r
1529 if Node not in ConsumedByList[Item]:\r
1530 continue\r
1531 # remove edge e from the graph\r
1532 ConsumedByList[Item].remove(Node)\r
1533\r
1534 if ConsumedByList[Item] != []:\r
1535 continue\r
1536 # insert Item into Q, if Item has no other incoming edges\r
1537 Q.insert(0, Item)\r
1538\r
1539 #\r
1540 # if any remaining node Item in the graph has a constructor and an incoming edge, then the graph has a cycle\r
1541 #\r
1542 for Item in LibraryList:\r
1543 if ConsumedByList[Item] != [] and Item in Constructor and len(Constructor) > 1:\r
1544 ErrorMessage = "\tconsumed by " + "\n\tconsumed by ".join([str(L) for L in ConsumedByList[Item]])\r
1545 EdkLogger.error("build", BUILD_ERROR, 'Library [%s] with constructors has a cycle' % str(Item),\r
1546 ExtraData=ErrorMessage, File=self.MetaFile)\r
1547 if Item not in SortedLibraryList:\r
1548 SortedLibraryList.append(Item)\r
1549\r
1550 #\r
1551 # Build the list of constructor and destructir names\r
1552 # The DAG Topo sort produces the destructor order, so the list of constructors must generated in the reverse order\r
1553 #\r
1554 SortedLibraryList.reverse()\r
1555 return SortedLibraryList\r
1556\r
1557\r
1558 ## Override PCD setting (type, value, ...)\r
1559 #\r
1560 # @param ToPcd The PCD to be overrided\r
1561 # @param FromPcd The PCD overrideing from\r
1562 #\r
1563 def _OverridePcd(self, ToPcd, FromPcd, Module=""):\r
1564 #\r
1565 # in case there's PCDs coming from FDF file, which have no type given.\r
1566 # at this point, ToPcd.Type has the type found from dependent\r
1567 # package\r
1568 #\r
1569 if FromPcd != None:\r
1570 if ToPcd.Pending and FromPcd.Type not in [None, '']:\r
1571 ToPcd.Type = FromPcd.Type\r
e56468c0 1572 elif (ToPcd.Type not in [None, '']) and (FromPcd.Type not in [None, ''])\\r
1573 and (ToPcd.Type != FromPcd.Type) and (ToPcd.Type in FromPcd.Type):\r
1574 if ToPcd.Type.strip() == "DynamicEx":\r
1575 ToPcd.Type = FromPcd.Type \r
52302d4d
LG
1576 elif ToPcd.Type not in [None, ''] and FromPcd.Type not in [None, ''] \\r
1577 and ToPcd.Type != FromPcd.Type:\r
1578 EdkLogger.error("build", OPTION_CONFLICT, "Mismatched PCD type",\r
1579 ExtraData="%s.%s is defined as [%s] in module %s, but as [%s] in platform."\\r
1580 % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName,\r
1581 ToPcd.Type, Module, FromPcd.Type),\r
1582 File=self.MetaFile)\r
1583\r
1584 if FromPcd.MaxDatumSize not in [None, '']:\r
1585 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
1586 if FromPcd.DefaultValue not in [None, '']:\r
1587 ToPcd.DefaultValue = FromPcd.DefaultValue\r
1588 if FromPcd.TokenValue not in [None, '']:\r
1589 ToPcd.TokenValue = FromPcd.TokenValue\r
1590 if FromPcd.MaxDatumSize not in [None, '']:\r
1591 ToPcd.MaxDatumSize = FromPcd.MaxDatumSize\r
1592 if FromPcd.DatumType not in [None, '']:\r
1593 ToPcd.DatumType = FromPcd.DatumType\r
1594 if FromPcd.SkuInfoList not in [None, '', []]:\r
1595 ToPcd.SkuInfoList = FromPcd.SkuInfoList\r
1596\r
1597 # check the validation of datum\r
1598 IsValid, Cause = CheckPcdDatum(ToPcd.DatumType, ToPcd.DefaultValue)\r
1599 if not IsValid:\r
1600 EdkLogger.error('build', FORMAT_INVALID, Cause, File=self.MetaFile,\r
1601 ExtraData="%s.%s" % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName))\r
1602\r
1603 if ToPcd.DatumType == "VOID*" and ToPcd.MaxDatumSize in ['', None]:\r
1604 EdkLogger.debug(EdkLogger.DEBUG_9, "No MaxDatumSize specified for PCD %s.%s" \\r
1605 % (ToPcd.TokenSpaceGuidCName, ToPcd.TokenCName))\r
1606 Value = ToPcd.DefaultValue\r
1607 if Value in [None, '']:\r
1608 ToPcd.MaxDatumSize = 1\r
1609 elif Value[0] == 'L':\r
1610 ToPcd.MaxDatumSize = str(len(Value) * 2)\r
1611 elif Value[0] == '{':\r
1612 ToPcd.MaxDatumSize = str(len(Value.split(',')))\r
1613 else:\r
1614 ToPcd.MaxDatumSize = str(len(Value))\r
1615\r
1616 # apply default SKU for dynamic PCDS if specified one is not available\r
1617 if (ToPcd.Type in PCD_DYNAMIC_TYPE_LIST or ToPcd.Type in PCD_DYNAMIC_EX_TYPE_LIST) \\r
1618 and ToPcd.SkuInfoList in [None, {}, '']:\r
1619 if self.Platform.SkuName in self.Platform.SkuIds:\r
1620 SkuName = self.Platform.SkuName\r
1621 else:\r
1622 SkuName = 'DEFAULT'\r
1623 ToPcd.SkuInfoList = {\r
1624 SkuName : SkuInfoClass(SkuName, self.Platform.SkuIds[SkuName], '', '', '', '', '', ToPcd.DefaultValue)\r
1625 }\r
1626\r
1627 ## Apply PCD setting defined platform to a module\r
1628 #\r
1629 # @param Module The module from which the PCD setting will be overrided\r
1630 #\r
1631 # @retval PCD_list The list PCDs with settings from platform\r
1632 #\r
1633 def ApplyPcdSetting(self, Module, Pcds):\r
1634 # for each PCD in module\r
1635 for Name,Guid in Pcds:\r
1636 PcdInModule = Pcds[Name,Guid]\r
1637 # find out the PCD setting in platform\r
1638 if (Name,Guid) in self.Platform.Pcds:\r
1639 PcdInPlatform = self.Platform.Pcds[Name,Guid]\r
1640 else:\r
1641 PcdInPlatform = None\r
1642 # then override the settings if any\r
1643 self._OverridePcd(PcdInModule, PcdInPlatform, Module)\r
1644 # resolve the VariableGuid value\r
1645 for SkuId in PcdInModule.SkuInfoList:\r
1646 Sku = PcdInModule.SkuInfoList[SkuId]\r
1647 if Sku.VariableGuid == '': continue\r
1648 Sku.VariableGuidValue = GuidValue(Sku.VariableGuid, self.PackageList)\r
1649 if Sku.VariableGuidValue == None:\r
1650 PackageList = "\n\t".join([str(P) for P in self.PackageList])\r
1651 EdkLogger.error(\r
1652 'build',\r
1653 RESOURCE_NOT_AVAILABLE,\r
1654 "Value of GUID [%s] is not found in" % Sku.VariableGuid,\r
1655 ExtraData=PackageList + "\n\t(used with %s.%s from module %s)" \\r
1656 % (Guid, Name, str(Module)),\r
1657 File=self.MetaFile\r
1658 )\r
1659\r
1660 # override PCD settings with module specific setting\r
1661 if Module in self.Platform.Modules:\r
1662 PlatformModule = self.Platform.Modules[str(Module)]\r
1663 for Key in PlatformModule.Pcds:\r
1664 if Key in Pcds:\r
1665 self._OverridePcd(Pcds[Key], PlatformModule.Pcds[Key], Module)\r
1666 return Pcds.values()\r
1667\r
1668 ## Resolve library names to library modules\r
1669 #\r
b36d134f 1670 # (for Edk.x modules)\r
52302d4d
LG
1671 #\r
1672 # @param Module The module from which the library names will be resolved\r
1673 #\r
1674 # @retval library_list The list of library modules\r
1675 #\r
1676 def ResolveLibraryReference(self, Module):\r
1677 EdkLogger.verbose("")\r
1678 EdkLogger.verbose("Library instances of module [%s] [%s]:" % (str(Module), self.Arch))\r
1679 LibraryConsumerList = [Module]\r
1680\r
b36d134f 1681 # "CompilerStub" is a must for Edk modules\r
52302d4d
LG
1682 if Module.Libraries:\r
1683 Module.Libraries.append("CompilerStub")\r
1684 LibraryList = []\r
1685 while len(LibraryConsumerList) > 0:\r
1686 M = LibraryConsumerList.pop()\r
1687 for LibraryName in M.Libraries:\r
1688 Library = self.Platform.LibraryClasses[LibraryName, ':dummy:']\r
1689 if Library == None:\r
1690 for Key in self.Platform.LibraryClasses.data.keys():\r
1691 if LibraryName.upper() == Key.upper():\r
1692 Library = self.Platform.LibraryClasses[Key, ':dummy:']\r
1693 break\r
1694 if Library == None:\r
1695 EdkLogger.warn("build", "Library [%s] is not found" % LibraryName, File=str(M),\r
1696 ExtraData="\t%s [%s]" % (str(Module), self.Arch))\r
1697 continue\r
1698\r
1699 if Library not in LibraryList:\r
1700 LibraryList.append(Library)\r
1701 LibraryConsumerList.append(Library)\r
1702 EdkLogger.verbose("\t" + LibraryName + " : " + str(Library) + ' ' + str(type(Library)))\r
1703 return LibraryList\r
1704\r
6780eef1
LG
1705 ## Calculate the priority value of the build option\r
1706 #\r
1707 # @param Key Build option definition contain: TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
1708 #\r
1709 # @retval Value Priority value based on the priority list.\r
1710 #\r
1711 def CalculatePriorityValue(self, Key):\r
1712 Target, ToolChain, Arch, CommandType, Attr = Key.split('_') \r
1713 PriorityValue = 0x11111 \r
1714 if Target == "*":\r
1715 PriorityValue &= 0x01111\r
1716 if ToolChain == "*":\r
1717 PriorityValue &= 0x10111\r
1718 if Arch == "*":\r
1719 PriorityValue &= 0x11011\r
1720 if CommandType == "*":\r
1721 PriorityValue &= 0x11101\r
1722 if Attr == "*":\r
1723 PriorityValue &= 0x11110\r
1724 \r
1725 return self.PrioList["0x%0.5x"%PriorityValue]\r
1726 \r
1727\r
52302d4d
LG
1728 ## Expand * in build option key\r
1729 #\r
1730 # @param Options Options to be expanded\r
1731 #\r
1732 # @retval options Options expanded\r
6780eef1 1733 # \r
52302d4d
LG
1734 def _ExpandBuildOption(self, Options, ModuleStyle=None):\r
1735 BuildOptions = {}\r
1736 FamilyMatch = False\r
1737 FamilyIsNull = True\r
6780eef1
LG
1738 \r
1739 OverrideList = {}\r
1740 #\r
1741 # Construct a list contain the build options which need override.\r
1742 #\r
1743 for Key in Options:\r
1744 #\r
1745 # Key[0] -- tool family\r
1746 # Key[1] -- TARGET_TOOLCHAIN_ARCH_COMMANDTYPE_ATTRIBUTE\r
1747 #\r
1748 if Key[0] == self.BuildRuleFamily :\r
1749 Target, ToolChain, Arch, CommandType, Attr = Key[1].split('_')\r
1750 if Target == self.BuildTarget or Target == "*":\r
1751 if ToolChain == self.ToolChain or ToolChain == "*":\r
1752 if Arch == self.Arch or Arch == "*":\r
1753 if Options[Key].startswith("="):\r
1754 if OverrideList.get(Key[1]) != None: \r
1755 OverrideList.pop(Key[1])\r
1756 OverrideList[Key[1]] = Options[Key]\r
1757 \r
1758 #\r
1759 # Use the highest priority value. \r
1760 #\r
1761 if (len(OverrideList) >= 2):\r
1762 KeyList = OverrideList.keys()\r
1763 for Index in range(len(KeyList)):\r
1764 NowKey = KeyList[Index]\r
1765 Target1, ToolChain1, Arch1, CommandType1, Attr1 = NowKey.split("_")\r
1766 for Index1 in range(len(KeyList) - Index - 1):\r
1767 NextKey = KeyList[Index1 + Index + 1]\r
1768 #\r
1769 # Compare two Key, if one is included by another, choose the higher priority one\r
1770 # \r
1771 Target2, ToolChain2, Arch2, CommandType2, Attr2 = NextKey.split("_")\r
1772 if Target1 == Target2 or Target1 == "*" or Target2 == "*":\r
1773 if ToolChain1 == ToolChain2 or ToolChain1 == "*" or ToolChain2 == "*":\r
1774 if Arch1 == Arch2 or Arch1 == "*" or Arch2 == "*":\r
1775 if CommandType1 == CommandType2 or CommandType1 == "*" or CommandType2 == "*":\r
1776 if Attr1 == Attr2 or Attr1 == "*" or Attr2 == "*":\r
1777 if self.CalculatePriorityValue(NowKey) > self.CalculatePriorityValue(NextKey):\r
1778 if Options.get((self.BuildRuleFamily, NextKey)) != None: \r
1779 Options.pop((self.BuildRuleFamily, NextKey))\r
1780 else:\r
1781 if Options.get((self.BuildRuleFamily, NowKey)) != None: \r
1782 Options.pop((self.BuildRuleFamily, NowKey))\r
1783 \r
1784 \r
52302d4d
LG
1785 for Key in Options:\r
1786 if ModuleStyle != None and len (Key) > 2:\r
1787 # Check Module style is EDK or EDKII.\r
1788 # Only append build option for the matched style module.\r
1789 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
1790 continue\r
1791 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
1792 continue\r
1793 Family = Key[0]\r
1794 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
1795 # if tool chain family doesn't match, skip it\r
1796 if Tool in self.ToolDefinition and Family != "":\r
1797 FamilyIsNull = False\r
1798 if self.ToolDefinition[Tool].get(TAB_TOD_DEFINES_BUILDRULEFAMILY, "") != "":\r
1799 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_BUILDRULEFAMILY]:\r
1800 continue\r
1801 elif Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
1802 continue\r
1803 FamilyMatch = True\r
1804 # expand any wildcard\r
1805 if Target == "*" or Target == self.BuildTarget:\r
1806 if Tag == "*" or Tag == self.ToolChain:\r
1807 if Arch == "*" or Arch == self.Arch:\r
1808 if Tool not in BuildOptions:\r
1809 BuildOptions[Tool] = {}\r
1810 if Attr != "FLAGS" or Attr not in BuildOptions[Tool]:\r
1811 BuildOptions[Tool][Attr] = Options[Key]\r
1812 else:\r
1813 # append options for the same tool\r
1814 BuildOptions[Tool][Attr] += " " + Options[Key]\r
1815 # Build Option Family has been checked, which need't to be checked again for family.\r
1816 if FamilyMatch or FamilyIsNull:\r
1817 return BuildOptions\r
1818 \r
1819 for Key in Options:\r
1820 if ModuleStyle != None and len (Key) > 2:\r
1821 # Check Module style is EDK or EDKII.\r
1822 # Only append build option for the matched style module.\r
1823 if ModuleStyle == EDK_NAME and Key[2] != EDK_NAME:\r
1824 continue\r
1825 elif ModuleStyle == EDKII_NAME and Key[2] != EDKII_NAME:\r
1826 continue\r
1827 Family = Key[0]\r
1828 Target, Tag, Arch, Tool, Attr = Key[1].split("_")\r
1829 # if tool chain family doesn't match, skip it\r
1830 if Tool not in self.ToolDefinition or Family =="":\r
1831 continue\r
1832 # option has been added before\r
1833 if Family != self.ToolDefinition[Tool][TAB_TOD_DEFINES_FAMILY]:\r
1834 continue\r
1835\r
1836 # expand any wildcard\r
1837 if Target == "*" or Target == self.BuildTarget:\r
1838 if Tag == "*" or Tag == self.ToolChain:\r
1839 if Arch == "*" or Arch == self.Arch:\r
1840 if Tool not in BuildOptions:\r
1841 BuildOptions[Tool] = {}\r
1842 if Attr != "FLAGS" or Attr not in BuildOptions[Tool]:\r
1843 BuildOptions[Tool][Attr] = Options[Key]\r
1844 else:\r
1845 # append options for the same tool\r
1846 BuildOptions[Tool][Attr] += " " + Options[Key]\r
1847 return BuildOptions\r
1848\r
1849 ## Append build options in platform to a module\r
1850 #\r
1851 # @param Module The module to which the build options will be appened\r
1852 #\r
1853 # @retval options The options appended with build options in platform\r
1854 #\r
1855 def ApplyBuildOption(self, Module):\r
1856 # Get the different options for the different style module\r
1857 if Module.AutoGenVersion < 0x00010005:\r
1858 PlatformOptions = self.EdkBuildOption\r
1859 else:\r
1860 PlatformOptions = self.EdkIIBuildOption\r
1861 ModuleOptions = self._ExpandBuildOption(Module.BuildOptions)\r
1862 if Module in self.Platform.Modules:\r
1863 PlatformModule = self.Platform.Modules[str(Module)]\r
1864 PlatformModuleOptions = self._ExpandBuildOption(PlatformModule.BuildOptions)\r
1865 else:\r
1866 PlatformModuleOptions = {}\r
1867\r
1868 AllTools = set(ModuleOptions.keys() + PlatformOptions.keys() + PlatformModuleOptions.keys() + self.ToolDefinition.keys())\r
1869 BuildOptions = {}\r
1870 for Tool in AllTools:\r
1871 if Tool not in BuildOptions:\r
1872 BuildOptions[Tool] = {}\r
1873\r
1874 for Options in [self.ToolDefinition, ModuleOptions, PlatformOptions, PlatformModuleOptions]:\r
1875 if Tool not in Options:\r
1876 continue\r
1877 for Attr in Options[Tool]:\r
1878 Value = Options[Tool][Attr]\r
1879 if Attr not in BuildOptions[Tool]:\r
1880 BuildOptions[Tool][Attr] = ""\r
1881 # check if override is indicated\r
1882 if Value.startswith('='):\r
1883 BuildOptions[Tool][Attr] = Value[1:]\r
1884 else:\r
1885 BuildOptions[Tool][Attr] += " " + Value\r
f3decdc3
LG
1886 if Module.AutoGenVersion < 0x00010005 and self.Workspace.UniFlag != None:\r
1887 #\r
1888 # Override UNI flag only for EDK module.\r
1889 #\r
1890 if 'BUILD' not in BuildOptions:\r
1891 BuildOptions['BUILD'] = {}\r
1892 BuildOptions['BUILD']['FLAGS'] = self.Workspace.UniFlag\r
52302d4d
LG
1893 return BuildOptions\r
1894\r
1895 Platform = property(_GetPlatform)\r
1896 Name = property(_GetName)\r
1897 Guid = property(_GetGuid)\r
1898 Version = property(_GetVersion)\r
1899\r
1900 OutputDir = property(_GetOutputDir)\r
1901 BuildDir = property(_GetBuildDir)\r
1902 MakeFileDir = property(_GetMakeFileDir)\r
1903 FdfFile = property(_GetFdfFile)\r
1904\r
1905 PcdTokenNumber = property(_GetPcdTokenNumbers) # (TokenCName, TokenSpaceGuidCName) : GeneratedTokenNumber\r
1906 DynamicPcdList = property(_GetDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
1907 NonDynamicPcdList = property(_GetNonDynamicPcdList) # [(TokenCName1, TokenSpaceGuidCName1), (TokenCName2, TokenSpaceGuidCName2), ...]\r
1908 PackageList = property(_GetPackageList)\r
1909\r
1910 ToolDefinition = property(_GetToolDefinition) # toolcode : tool path\r
1911 ToolDefinitionFile = property(_GetToolDefFile) # toolcode : lib path\r
1912 ToolChainFamily = property(_GetToolChainFamily)\r
1913 BuildRuleFamily = property(_GetBuildRuleFamily)\r
1914 BuildOption = property(_GetBuildOptions) # toolcode : option\r
1915 EdkBuildOption = property(_GetEdkBuildOptions) # edktoolcode : option\r
1916 EdkIIBuildOption = property(_GetEdkIIBuildOptions) # edkiitoolcode : option\r
1917\r
1918 BuildCommand = property(_GetBuildCommand)\r
1919 BuildRule = property(_GetBuildRule)\r
1920 ModuleAutoGenList = property(_GetModuleAutoGenList)\r
1921 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
1922\r
1923## ModuleAutoGen class\r
1924#\r
1925# This class encapsules the AutoGen behaviors for the build tools. In addition to\r
1926# the generation of AutoGen.h and AutoGen.c, it will generate *.depex file according\r
1927# to the [depex] section in module's inf file.\r
1928#\r
1929class ModuleAutoGen(AutoGen):\r
1930 ## The real constructor of ModuleAutoGen\r
1931 #\r
1932 # This method is not supposed to be called by users of ModuleAutoGen. It's\r
1933 # only used by factory method __new__() to do real initialization work for an\r
1934 # object of ModuleAutoGen\r
1935 #\r
1936 # @param Workspace EdkIIWorkspaceBuild object\r
1937 # @param ModuleFile The path of module file\r
1938 # @param Target Build target (DEBUG, RELEASE)\r
1939 # @param Toolchain Name of tool chain\r
1940 # @param Arch The arch the module supports\r
1941 # @param PlatformFile Platform meta-file\r
1942 #\r
1943 def _Init(self, Workspace, ModuleFile, Target, Toolchain, Arch, PlatformFile):\r
1944 EdkLogger.debug(EdkLogger.DEBUG_9, "AutoGen module [%s] [%s]" % (ModuleFile, Arch))\r
1945 GlobalData.gProcessingFile = "%s [%s, %s, %s]" % (ModuleFile, Arch, Toolchain, Target)\r
1946\r
1947 self.Workspace = Workspace\r
1948 self.WorkspaceDir = Workspace.WorkspaceDir\r
1949\r
1950 self.MetaFile = ModuleFile\r
1951 self.PlatformInfo = PlatformAutoGen(Workspace, PlatformFile, Target, Toolchain, Arch)\r
1952 # check if this module is employed by active platform\r
1953 if not self.PlatformInfo.ValidModule(self.MetaFile):\r
1954 EdkLogger.verbose("Module [%s] for [%s] is not employed by active platform\n" \\r
1955 % (self.MetaFile, Arch))\r
1956 return False\r
1957\r
1958 self.SourceDir = self.MetaFile.SubDir\r
1959 self.SourceOverrideDir = None\r
1960 # use overrided path defined in DSC file\r
1961 if self.MetaFile.Key in GlobalData.gOverrideDir:\r
1962 self.SourceOverrideDir = GlobalData.gOverrideDir[self.MetaFile.Key]\r
1963\r
1964 self.ToolChain = Toolchain\r
1965 self.BuildTarget = Target\r
1966 self.Arch = Arch\r
1967 self.ToolChainFamily = self.PlatformInfo.ToolChainFamily\r
1968 self.BuildRuleFamily = self.PlatformInfo.BuildRuleFamily\r
1969\r
1970 self.IsMakeFileCreated = False\r
1971 self.IsCodeFileCreated = False\r
da92f276
LG
1972 self.IsAsBuiltInfCreated = False\r
1973 self.DepexGenerated = False\r
52302d4d
LG
1974\r
1975 self.BuildDatabase = self.Workspace.BuildDatabase\r
1976\r
1977 self._Module = None\r
1978 self._Name = None\r
1979 self._Guid = None\r
1980 self._Version = None\r
1981 self._ModuleType = None\r
1982 self._ComponentType = None\r
1983 self._PcdIsDriver = None\r
1984 self._AutoGenVersion = None\r
1985 self._LibraryFlag = None\r
1986 self._CustomMakefile = None\r
1987 self._Macro = None\r
1988\r
1989 self._BuildDir = None\r
1990 self._OutputDir = None\r
1991 self._DebugDir = None\r
1992 self._MakeFileDir = None\r
1993\r
1994 self._IncludePathList = None\r
1995 self._AutoGenFileList = None\r
1996 self._UnicodeFileList = None\r
1997 self._SourceFileList = None\r
1998 self._ObjectFileList = None\r
1999 self._BinaryFileList = None\r
2000\r
2001 self._DependentPackageList = None\r
2002 self._DependentLibraryList = None\r
2003 self._LibraryAutoGenList = None\r
2004 self._DerivedPackageList = None\r
2005 self._ModulePcdList = None\r
2006 self._LibraryPcdList = None\r
2007 self._GuidList = None\r
2008 self._ProtocolList = None\r
2009 self._PpiList = None\r
2010 self._DepexList = None\r
2011 self._DepexExpressionList = None\r
2012 self._BuildOption = None\r
79b74a03 2013 self._BuildOptionIncPathList = None\r
52302d4d
LG
2014 self._BuildTargets = None\r
2015 self._IntroBuildTargetList = None\r
2016 self._FinalBuildTargetList = None\r
2017 self._FileTypes = None\r
2018 self._BuildRules = None\r
2019\r
2020 return True\r
2021\r
2022 def __repr__(self):\r
2023 return "%s [%s]" % (self.MetaFile, self.Arch)\r
2024\r
2025 # Macros could be used in build_rule.txt (also Makefile)\r
2026 def _GetMacros(self):\r
2027 if self._Macro == None:\r
2028 self._Macro = sdict()\r
2029 self._Macro["WORKSPACE" ] = self.WorkspaceDir\r
2030 self._Macro["MODULE_NAME" ] = self.Name\r
2031 self._Macro["MODULE_GUID" ] = self.Guid\r
2032 self._Macro["MODULE_VERSION" ] = self.Version\r
2033 self._Macro["MODULE_TYPE" ] = self.ModuleType\r
2034 self._Macro["MODULE_FILE" ] = str(self.MetaFile)\r
2035 self._Macro["MODULE_FILE_BASE_NAME" ] = self.MetaFile.BaseName\r
2036 self._Macro["MODULE_RELATIVE_DIR" ] = self.SourceDir\r
2037 self._Macro["MODULE_DIR" ] = self.SourceDir\r
2038\r
2039 self._Macro["BASE_NAME" ] = self.Name\r
2040\r
2041 self._Macro["ARCH" ] = self.Arch\r
2042 self._Macro["TOOLCHAIN" ] = self.ToolChain\r
2043 self._Macro["TOOLCHAIN_TAG" ] = self.ToolChain\r
0d2711a6 2044 self._Macro["TOOL_CHAIN_TAG" ] = self.ToolChain\r
52302d4d
LG
2045 self._Macro["TARGET" ] = self.BuildTarget\r
2046\r
2047 self._Macro["BUILD_DIR" ] = self.PlatformInfo.BuildDir\r
2048 self._Macro["BIN_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2049 self._Macro["LIB_DIR" ] = os.path.join(self.PlatformInfo.BuildDir, self.Arch)\r
2050 self._Macro["MODULE_BUILD_DIR" ] = self.BuildDir\r
2051 self._Macro["OUTPUT_DIR" ] = self.OutputDir\r
2052 self._Macro["DEBUG_DIR" ] = self.DebugDir\r
2053 return self._Macro\r
2054\r
2055 ## Return the module build data object\r
2056 def _GetModule(self):\r
2057 if self._Module == None:\r
0d2711a6 2058 self._Module = self.Workspace.BuildDatabase[self.MetaFile, self.Arch, self.BuildTarget, self.ToolChain]\r
52302d4d
LG
2059 return self._Module\r
2060\r
2061 ## Return the module name\r
2062 def _GetBaseName(self):\r
2063 return self.Module.BaseName\r
2064\r
b36d134f
LG
2065 ## Return the module DxsFile if exist\r
2066 def _GetDxsFile(self):\r
2067 return self.Module.DxsFile\r
2068\r
52302d4d
LG
2069 ## Return the module SourceOverridePath\r
2070 def _GetSourceOverridePath(self):\r
2071 return self.Module.SourceOverridePath\r
2072\r
2073 ## Return the module meta-file GUID\r
2074 def _GetGuid(self):\r
2075 return self.Module.Guid\r
2076\r
2077 ## Return the module version\r
2078 def _GetVersion(self):\r
2079 return self.Module.Version\r
2080\r
2081 ## Return the module type\r
2082 def _GetModuleType(self):\r
2083 return self.Module.ModuleType\r
2084\r
b36d134f 2085 ## Return the component type (for Edk.x style of module)\r
52302d4d
LG
2086 def _GetComponentType(self):\r
2087 return self.Module.ComponentType\r
2088\r
2089 ## Return the build type\r
2090 def _GetBuildType(self):\r
2091 return self.Module.BuildType\r
2092\r
2093 ## Return the PCD_IS_DRIVER setting\r
2094 def _GetPcdIsDriver(self):\r
2095 return self.Module.PcdIsDriver\r
2096\r
2097 ## Return the autogen version, i.e. module meta-file version\r
2098 def _GetAutoGenVersion(self):\r
2099 return self.Module.AutoGenVersion\r
2100\r
2101 ## Check if the module is library or not\r
2102 def _IsLibrary(self):\r
2103 if self._LibraryFlag == None:\r
2104 if self.Module.LibraryClass != None and self.Module.LibraryClass != []:\r
2105 self._LibraryFlag = True\r
2106 else:\r
2107 self._LibraryFlag = False\r
2108 return self._LibraryFlag\r
2109\r
2110 ## Return the directory to store intermediate files of the module\r
2111 def _GetBuildDir(self):\r
2112 if self._BuildDir == None:\r
2113 self._BuildDir = path.join(\r
2114 self.PlatformInfo.BuildDir,\r
2115 self.Arch,\r
2116 self.SourceDir,\r
2117 self.MetaFile.BaseName\r
2118 )\r
2119 CreateDirectory(self._BuildDir)\r
2120 return self._BuildDir\r
2121\r
2122 ## Return the directory to store the intermediate object files of the mdoule\r
2123 def _GetOutputDir(self):\r
2124 if self._OutputDir == None:\r
2125 self._OutputDir = path.join(self.BuildDir, "OUTPUT")\r
2126 CreateDirectory(self._OutputDir)\r
2127 return self._OutputDir\r
2128\r
2129 ## Return the directory to store auto-gened source files of the mdoule\r
2130 def _GetDebugDir(self):\r
2131 if self._DebugDir == None:\r
2132 self._DebugDir = path.join(self.BuildDir, "DEBUG")\r
2133 CreateDirectory(self._DebugDir)\r
2134 return self._DebugDir\r
2135\r
2136 ## Return the path of custom file\r
2137 def _GetCustomMakefile(self):\r
2138 if self._CustomMakefile == None:\r
2139 self._CustomMakefile = {}\r
2140 for Type in self.Module.CustomMakefile:\r
2141 if Type in gMakeTypeMap:\r
2142 MakeType = gMakeTypeMap[Type]\r
2143 else:\r
2144 MakeType = 'nmake'\r
2145 if self.SourceOverrideDir != None:\r
2146 File = os.path.join(self.SourceOverrideDir, self.Module.CustomMakefile[Type])\r
2147 if not os.path.exists(File):\r
2148 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
2149 else:\r
2150 File = os.path.join(self.SourceDir, self.Module.CustomMakefile[Type])\r
2151 self._CustomMakefile[MakeType] = File\r
2152 return self._CustomMakefile\r
2153\r
2154 ## Return the directory of the makefile\r
2155 #\r
2156 # @retval string The directory string of module's makefile\r
2157 #\r
2158 def _GetMakeFileDir(self):\r
2159 return self.BuildDir\r
2160\r
2161 ## Return build command string\r
2162 #\r
2163 # @retval string Build command string\r
2164 #\r
2165 def _GetBuildCommand(self):\r
2166 return self.PlatformInfo.BuildCommand\r
2167\r
2168 ## Get object list of all packages the module and its dependent libraries belong to\r
2169 #\r
2170 # @retval list The list of package object\r
2171 #\r
2172 def _GetDerivedPackageList(self):\r
2173 PackageList = []\r
2174 for M in [self.Module] + self.DependentLibraryList:\r
2175 for Package in M.Packages:\r
2176 if Package in PackageList:\r
2177 continue\r
2178 PackageList.append(Package)\r
2179 return PackageList\r
2180\r
2181 ## Merge dependency expression\r
2182 #\r
2183 # @retval list The token list of the dependency expression after parsed\r
2184 #\r
2185 def _GetDepexTokenList(self):\r
2186 if self._DepexList == None:\r
2187 self._DepexList = {}\r
b36d134f 2188 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
2189 return self._DepexList\r
2190\r
2191 self._DepexList[self.ModuleType] = []\r
2192\r
2193 for ModuleType in self._DepexList:\r
2194 DepexList = self._DepexList[ModuleType]\r
2195 #\r
2196 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2197 #\r
2198 for M in [self.Module] + self.DependentLibraryList:\r
2199 Inherited = False\r
2200 for D in M.Depex[self.Arch, ModuleType]:\r
2201 if DepexList != []:\r
2202 DepexList.append('AND')\r
2203 DepexList.append('(')\r
2204 DepexList.extend(D)\r
2205 if DepexList[-1] == 'END': # no need of a END at this time\r
2206 DepexList.pop()\r
2207 DepexList.append(')')\r
2208 Inherited = True\r
2209 if Inherited:\r
2210 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexList))\r
2211 if 'BEFORE' in DepexList or 'AFTER' in DepexList:\r
2212 break\r
2213 if len(DepexList) > 0:\r
2214 EdkLogger.verbose('')\r
2215 return self._DepexList\r
2216\r
2217 ## Merge dependency expression\r
2218 #\r
2219 # @retval list The token list of the dependency expression after parsed\r
2220 #\r
2221 def _GetDepexExpressionTokenList(self):\r
2222 if self._DepexExpressionList == None:\r
2223 self._DepexExpressionList = {}\r
b36d134f 2224 if self.DxsFile or self.IsLibrary or TAB_DEPENDENCY_EXPRESSION_FILE in self.FileTypes:\r
52302d4d
LG
2225 return self._DepexExpressionList\r
2226\r
2227 self._DepexExpressionList[self.ModuleType] = ''\r
2228\r
2229 for ModuleType in self._DepexExpressionList:\r
2230 DepexExpressionList = self._DepexExpressionList[ModuleType]\r
2231 #\r
2232 # Append depex from dependent libraries, if not "BEFORE", "AFTER" expresion\r
2233 #\r
2234 for M in [self.Module] + self.DependentLibraryList:\r
2235 Inherited = False\r
2236 for D in M.DepexExpression[self.Arch, ModuleType]:\r
2237 if DepexExpressionList != '':\r
2238 DepexExpressionList += ' AND '\r
2239 DepexExpressionList += '('\r
2240 DepexExpressionList += D\r
2241 DepexExpressionList = DepexExpressionList.rstrip('END').strip()\r
2242 DepexExpressionList += ')'\r
2243 Inherited = True\r
2244 if Inherited:\r
2245 EdkLogger.verbose("DEPEX[%s] (+%s) = %s" % (self.Name, M.BaseName, DepexExpressionList))\r
2246 if 'BEFORE' in DepexExpressionList or 'AFTER' in DepexExpressionList:\r
2247 break\r
2248 if len(DepexExpressionList) > 0:\r
2249 EdkLogger.verbose('')\r
2250 self._DepexExpressionList[ModuleType] = DepexExpressionList\r
2251 return self._DepexExpressionList\r
2252\r
2253 ## Return the list of specification version required for the module\r
2254 #\r
2255 # @retval list The list of specification defined in module file\r
2256 #\r
2257 def _GetSpecification(self):\r
2258 return self.Module.Specification\r
2259\r
2260 ## Tool option for the module build\r
2261 #\r
2262 # @param PlatformInfo The object of PlatformBuildInfo\r
2263 # @retval dict The dict containing valid options\r
2264 #\r
2265 def _GetModuleBuildOption(self):\r
2266 if self._BuildOption == None:\r
2267 self._BuildOption = self.PlatformInfo.ApplyBuildOption(self.Module)\r
2268 return self._BuildOption\r
2269\r
79b74a03
LG
2270 ## Get include path list from tool option for the module build\r
2271 #\r
2272 # @retval list The include path list\r
2273 #\r
2274 def _GetBuildOptionIncPathList(self):\r
2275 if self._BuildOptionIncPathList == None:\r
2276 #\r
d40b2ee6 2277 # Regular expression for finding Include Directories, the difference between MSFT and INTEL/GCC/RVCT\r
79b74a03
LG
2278 # is the former use /I , the Latter used -I to specify include directories\r
2279 #\r
2280 if self.PlatformInfo.ToolChainFamily in ('MSFT'):\r
2281 gBuildOptIncludePattern = re.compile(r"(?:.*?)/I[ \t]*([^ ]*)", re.MULTILINE|re.DOTALL)\r
d40b2ee6 2282 elif self.PlatformInfo.ToolChainFamily in ('INTEL', 'GCC', 'RVCT'):\r
79b74a03 2283 gBuildOptIncludePattern = re.compile(r"(?:.*?)-I[ \t]*([^ ]*)", re.MULTILINE|re.DOTALL)\r
d40b2ee6
LG
2284 else:\r
2285 #\r
2286 # New ToolChainFamily, don't known whether there is option to specify include directories\r
2287 #\r
2288 self._BuildOptionIncPathList = []\r
2289 return self._BuildOptionIncPathList\r
79b74a03
LG
2290 \r
2291 BuildOptionIncPathList = []\r
2292 for Tool in ('CC', 'PP', 'VFRPP', 'ASLPP', 'ASLCC', 'APP', 'ASM'):\r
2293 Attr = 'FLAGS'\r
2294 try:\r
2295 FlagOption = self.BuildOption[Tool][Attr]\r
2296 except KeyError:\r
2297 FlagOption = ''\r
2298 \r
d40b2ee6
LG
2299 if self.PlatformInfo.ToolChainFamily != 'RVCT':\r
2300 IncPathList = [NormPath(Path, self.Macros) for Path in gBuildOptIncludePattern.findall(FlagOption)]\r
2301 else:\r
2302 #\r
2303 # RVCT may specify a list of directory seperated by commas\r
2304 #\r
2305 IncPathList = []\r
2306 for Path in gBuildOptIncludePattern.findall(FlagOption):\r
2307 PathList = GetSplitList(Path, TAB_COMMA_SPLIT)\r
2308 IncPathList += [NormPath(PathEntry, self.Macros) for PathEntry in PathList]\r
2309\r
79b74a03
LG
2310 #\r
2311 # EDK II modules must not reference header files outside of the packages they depend on or \r
2312 # within the module's directory tree. Report error if violation.\r
2313 #\r
2314 if self.AutoGenVersion >= 0x00010005 and len(IncPathList) > 0:\r
2315 for Path in IncPathList:\r
2316 if (Path not in self.IncludePathList) and (CommonPath([Path, self.MetaFile.Dir]) != self.MetaFile.Dir):\r
2317 ErrMsg = "The include directory for the EDK II module in this line is invalid %s specified in %s FLAGS '%s'" % (Path, Tool, FlagOption) \r
2318 EdkLogger.error("build", \r
2319 PARAMETER_INVALID,\r
2320 ExtraData = ErrMsg, \r
2321 File = str(self.MetaFile))\r
2322\r
2323 \r
2324 BuildOptionIncPathList += IncPathList\r
2325 \r
2326 self._BuildOptionIncPathList = BuildOptionIncPathList\r
2327 \r
2328 return self._BuildOptionIncPathList\r
2329 \r
52302d4d
LG
2330 ## Return a list of files which can be built from source\r
2331 #\r
2332 # What kind of files can be built is determined by build rules in\r
2333 # $(WORKSPACE)/Conf/build_rule.txt and toolchain family.\r
2334 #\r
2335 def _GetSourceFileList(self):\r
2336 if self._SourceFileList == None:\r
2337 self._SourceFileList = []\r
2338 for F in self.Module.Sources:\r
2339 # match tool chain\r
08dd311f 2340 if F.TagName not in ("", "*", self.ToolChain):\r
52302d4d
LG
2341 EdkLogger.debug(EdkLogger.DEBUG_9, "The toolchain [%s] for processing file [%s] is found, "\r
2342 "but [%s] is needed" % (F.TagName, str(F), self.ToolChain))\r
2343 continue\r
2344 # match tool chain family\r
08dd311f 2345 if F.ToolChainFamily not in ("", "*", self.ToolChainFamily):\r
52302d4d
LG
2346 EdkLogger.debug(\r
2347 EdkLogger.DEBUG_0,\r
2348 "The file [%s] must be built by tools of [%s], " \\r
2349 "but current toolchain family is [%s]" \\r
2350 % (str(F), F.ToolChainFamily, self.ToolChainFamily))\r
2351 continue\r
2352\r
2353 # add the file path into search path list for file including\r
2354 if F.Dir not in self.IncludePathList and self.AutoGenVersion >= 0x00010005:\r
2355 self.IncludePathList.insert(0, F.Dir)\r
2356 self._SourceFileList.append(F)\r
2357 self._ApplyBuildRule(F, TAB_UNKNOWN_FILE)\r
2358 return self._SourceFileList\r
2359\r
2360 ## Return the list of unicode files\r
2361 def _GetUnicodeFileList(self):\r
2362 if self._UnicodeFileList == None:\r
2363 if TAB_UNICODE_FILE in self.FileTypes:\r
2364 self._UnicodeFileList = self.FileTypes[TAB_UNICODE_FILE]\r
2365 else:\r
2366 self._UnicodeFileList = []\r
2367 return self._UnicodeFileList\r
2368\r
2369 ## Return a list of files which can be built from binary\r
2370 #\r
2371 # "Build" binary files are just to copy them to build directory.\r
2372 #\r
2373 # @retval list The list of files which can be built later\r
2374 #\r
2375 def _GetBinaryFiles(self):\r
2376 if self._BinaryFileList == None:\r
2377 self._BinaryFileList = []\r
2378 for F in self.Module.Binaries:\r
2379 if F.Target not in ['COMMON', '*'] and F.Target != self.BuildTarget:\r
2380 continue\r
2381 self._BinaryFileList.append(F)\r
2382 self._ApplyBuildRule(F, F.Type)\r
2383 return self._BinaryFileList\r
2384\r
2385 def _GetBuildRules(self):\r
2386 if self._BuildRules == None:\r
2387 BuildRules = {}\r
2388 BuildRuleDatabase = self.PlatformInfo.BuildRule\r
2389 for Type in BuildRuleDatabase.FileTypeList:\r
2390 #first try getting build rule by BuildRuleFamily\r
2391 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.BuildRuleFamily]\r
2392 if not RuleObject:\r
2393 # build type is always module type, but ...\r
2394 if self.ModuleType != self.BuildType:\r
2395 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.BuildRuleFamily]\r
2396 #second try getting build rule by ToolChainFamily\r
2397 if not RuleObject:\r
2398 RuleObject = BuildRuleDatabase[Type, self.BuildType, self.Arch, self.ToolChainFamily]\r
2399 if not RuleObject:\r
2400 # build type is always module type, but ...\r
2401 if self.ModuleType != self.BuildType:\r
2402 RuleObject = BuildRuleDatabase[Type, self.ModuleType, self.Arch, self.ToolChainFamily]\r
2403 if not RuleObject:\r
2404 continue\r
2405 RuleObject = RuleObject.Instantiate(self.Macros)\r
2406 BuildRules[Type] = RuleObject\r
2407 for Ext in RuleObject.SourceFileExtList:\r
2408 BuildRules[Ext] = RuleObject\r
2409 self._BuildRules = BuildRules\r
2410 return self._BuildRules\r
2411\r
2412 def _ApplyBuildRule(self, File, FileType):\r
2413 if self._BuildTargets == None:\r
2414 self._IntroBuildTargetList = set()\r
2415 self._FinalBuildTargetList = set()\r
2416 self._BuildTargets = {}\r
2417 self._FileTypes = {}\r
2418\r
2419 LastTarget = None\r
2420 RuleChain = []\r
2421 SourceList = [File]\r
2422 Index = 0\r
2423 while Index < len(SourceList):\r
2424 Source = SourceList[Index]\r
2425 Index = Index + 1\r
2426\r
2427 if Source != File:\r
2428 CreateDirectory(Source.Dir)\r
2429\r
2430 if File.IsBinary and File == Source and self._BinaryFileList != None and File in self._BinaryFileList:\r
da92f276
LG
2431 # Skip all files that are not binary libraries\r
2432 if not self.IsLibrary:\r
0d2711a6 2433 continue \r
52302d4d
LG
2434 RuleObject = self.BuildRules[TAB_DEFAULT_BINARY_FILE]\r
2435 elif FileType in self.BuildRules:\r
2436 RuleObject = self.BuildRules[FileType]\r
2437 elif Source.Ext in self.BuildRules:\r
2438 RuleObject = self.BuildRules[Source.Ext]\r
2439 else:\r
2440 # stop at no more rules\r
2441 if LastTarget:\r
2442 self._FinalBuildTargetList.add(LastTarget)\r
2443 break\r
2444\r
2445 FileType = RuleObject.SourceFileType\r
2446 if FileType not in self._FileTypes:\r
2447 self._FileTypes[FileType] = set()\r
2448 self._FileTypes[FileType].add(Source)\r
2449\r
2450 # stop at STATIC_LIBRARY for library\r
2451 if self.IsLibrary and FileType == TAB_STATIC_LIBRARY:\r
2452 if LastTarget:\r
2453 self._FinalBuildTargetList.add(LastTarget)\r
2454 break\r
2455\r
2456 Target = RuleObject.Apply(Source)\r
2457 if not Target:\r
2458 if LastTarget:\r
2459 self._FinalBuildTargetList.add(LastTarget)\r
2460 break\r
2461 elif not Target.Outputs:\r
2462 # Only do build for target with outputs\r
2463 self._FinalBuildTargetList.add(Target)\r
2464\r
2465 if FileType not in self._BuildTargets:\r
2466 self._BuildTargets[FileType] = set()\r
2467 self._BuildTargets[FileType].add(Target)\r
2468\r
2469 if not Source.IsBinary and Source == File:\r
2470 self._IntroBuildTargetList.add(Target)\r
2471\r
2472 # to avoid cyclic rule\r
2473 if FileType in RuleChain:\r
2474 break\r
2475\r
2476 RuleChain.append(FileType)\r
2477 SourceList.extend(Target.Outputs)\r
2478 LastTarget = Target\r
2479 FileType = TAB_UNKNOWN_FILE\r
2480\r
2481 def _GetTargets(self):\r
2482 if self._BuildTargets == None:\r
2483 self._IntroBuildTargetList = set()\r
2484 self._FinalBuildTargetList = set()\r
2485 self._BuildTargets = {}\r
2486 self._FileTypes = {}\r
2487\r
b36d134f 2488 #TRICK: call _GetSourceFileList to apply build rule for source files\r
52302d4d
LG
2489 if self.SourceFileList:\r
2490 pass\r
2491\r
2492 #TRICK: call _GetBinaryFileList to apply build rule for binary files\r
2493 if self.BinaryFileList:\r
2494 pass\r
2495\r
2496 return self._BuildTargets\r
2497\r
2498 def _GetIntroTargetList(self):\r
2499 self._GetTargets()\r
2500 return self._IntroBuildTargetList\r
2501\r
2502 def _GetFinalTargetList(self):\r
2503 self._GetTargets()\r
2504 return self._FinalBuildTargetList\r
2505\r
2506 def _GetFileTypes(self):\r
2507 self._GetTargets()\r
2508 return self._FileTypes\r
2509\r
2510 ## Get the list of package object the module depends on\r
2511 #\r
2512 # @retval list The package object list\r
2513 #\r
2514 def _GetDependentPackageList(self):\r
2515 return self.Module.Packages\r
2516\r
2517 ## Return the list of auto-generated code file\r
2518 #\r
2519 # @retval list The list of auto-generated file\r
2520 #\r
2521 def _GetAutoGenFileList(self):\r
2522 UniStringAutoGenC = True\r
4234283c 2523 UniStringBinBuffer = StringIO()\r
52302d4d 2524 if self.BuildType == 'UEFI_HII':\r
52302d4d
LG
2525 UniStringAutoGenC = False\r
2526 if self._AutoGenFileList == None:\r
2527 self._AutoGenFileList = {}\r
2528 AutoGenC = TemplateString()\r
2529 AutoGenH = TemplateString()\r
2530 StringH = TemplateString()\r
2531 GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer)\r
2532 if str(AutoGenC) != "" and TAB_C_CODE_FILE in self.FileTypes:\r
2533 AutoFile = PathClass(gAutoGenCodeFileName, self.DebugDir)\r
2534 self._AutoGenFileList[AutoFile] = str(AutoGenC)\r
2535 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
2536 if str(AutoGenH) != "":\r
2537 AutoFile = PathClass(gAutoGenHeaderFileName, self.DebugDir)\r
2538 self._AutoGenFileList[AutoFile] = str(AutoGenH)\r
2539 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
2540 if str(StringH) != "":\r
2541 AutoFile = PathClass(gAutoGenStringFileName % {"module_name":self.Name}, self.DebugDir)\r
2542 self._AutoGenFileList[AutoFile] = str(StringH)\r
2543 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
2544 if UniStringBinBuffer != None and UniStringBinBuffer.getvalue() != "":\r
2545 AutoFile = PathClass(gAutoGenStringFormFileName % {"module_name":self.Name}, self.OutputDir)\r
2546 self._AutoGenFileList[AutoFile] = UniStringBinBuffer.getvalue()\r
2547 AutoFile.IsBinary = True\r
2548 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
2549 if UniStringBinBuffer != None:\r
2550 UniStringBinBuffer.close()\r
2551 return self._AutoGenFileList\r
2552\r
2553 ## Return the list of library modules explicitly or implicityly used by this module\r
2554 def _GetLibraryList(self):\r
2555 if self._DependentLibraryList == None:\r
2556 # only merge library classes and PCD for non-library module\r
2557 if self.IsLibrary:\r
2558 self._DependentLibraryList = []\r
2559 else:\r
2560 if self.AutoGenVersion < 0x00010005:\r
2561 self._DependentLibraryList = self.PlatformInfo.ResolveLibraryReference(self.Module)\r
2562 else:\r
2563 self._DependentLibraryList = self.PlatformInfo.ApplyLibraryInstance(self.Module)\r
2564 return self._DependentLibraryList\r
2565\r
2566 ## Get the list of PCDs from current module\r
2567 #\r
2568 # @retval list The list of PCD\r
2569 #\r
2570 def _GetModulePcdList(self):\r
2571 if self._ModulePcdList == None:\r
2572 # apply PCD settings from platform\r
2573 self._ModulePcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, self.Module.Pcds)\r
2574 return self._ModulePcdList\r
2575\r
2576 ## Get the list of PCDs from dependent libraries\r
2577 #\r
2578 # @retval list The list of PCD\r
2579 #\r
2580 def _GetLibraryPcdList(self):\r
2581 if self._LibraryPcdList == None:\r
79b74a03 2582 Pcds = sdict()\r
52302d4d
LG
2583 if not self.IsLibrary:\r
2584 # get PCDs from dependent libraries\r
2585 for Library in self.DependentLibraryList:\r
2586 for Key in Library.Pcds:\r
2587 # skip duplicated PCDs\r
2588 if Key in self.Module.Pcds or Key in Pcds:\r
2589 continue\r
2590 Pcds[Key] = copy.copy(Library.Pcds[Key])\r
2591 # apply PCD settings from platform\r
2592 self._LibraryPcdList = self.PlatformInfo.ApplyPcdSetting(self.Module, Pcds)\r
2593 else:\r
2594 self._LibraryPcdList = []\r
2595 return self._LibraryPcdList\r
2596\r
2597 ## Get the GUID value mapping\r
2598 #\r
2599 # @retval dict The mapping between GUID cname and its value\r
2600 #\r
2601 def _GetGuidList(self):\r
2602 if self._GuidList == None:\r
2603 self._GuidList = self.Module.Guids\r
2604 for Library in self.DependentLibraryList:\r
2605 self._GuidList.update(Library.Guids)\r
2606 return self._GuidList\r
2607\r
2608 ## Get the protocol value mapping\r
2609 #\r
2610 # @retval dict The mapping between protocol cname and its value\r
2611 #\r
2612 def _GetProtocolList(self):\r
2613 if self._ProtocolList == None:\r
2614 self._ProtocolList = self.Module.Protocols\r
2615 for Library in self.DependentLibraryList:\r
2616 self._ProtocolList.update(Library.Protocols)\r
2617 return self._ProtocolList\r
2618\r
2619 ## Get the PPI value mapping\r
2620 #\r
2621 # @retval dict The mapping between PPI cname and its value\r
2622 #\r
2623 def _GetPpiList(self):\r
2624 if self._PpiList == None:\r
2625 self._PpiList = self.Module.Ppis\r
2626 for Library in self.DependentLibraryList:\r
2627 self._PpiList.update(Library.Ppis)\r
2628 return self._PpiList\r
2629\r
2630 ## Get the list of include search path\r
2631 #\r
2632 # @retval list The list path\r
2633 #\r
2634 def _GetIncludePathList(self):\r
2635 if self._IncludePathList == None:\r
2636 self._IncludePathList = []\r
2637 if self.AutoGenVersion < 0x00010005:\r
2638 for Inc in self.Module.Includes:\r
2639 if Inc not in self._IncludePathList:\r
2640 self._IncludePathList.append(Inc)\r
b36d134f 2641 # for Edk modules\r
52302d4d
LG
2642 Inc = path.join(Inc, self.Arch.capitalize())\r
2643 if os.path.exists(Inc) and Inc not in self._IncludePathList:\r
2644 self._IncludePathList.append(Inc)\r
b36d134f 2645 # Edk module needs to put DEBUG_DIR at the end of search path and not to use SOURCE_DIR all the time\r
52302d4d
LG
2646 self._IncludePathList.append(self.DebugDir)\r
2647 else:\r
2648 self._IncludePathList.append(self.MetaFile.Dir)\r
2649 self._IncludePathList.append(self.DebugDir)\r
2650\r
2651 for Package in self.Module.Packages:\r
2652 PackageDir = path.join(self.WorkspaceDir, Package.MetaFile.Dir)\r
2653 if PackageDir not in self._IncludePathList:\r
2654 self._IncludePathList.append(PackageDir)\r
2655 for Inc in Package.Includes:\r
2656 if Inc not in self._IncludePathList:\r
2657 self._IncludePathList.append(str(Inc))\r
2658 return self._IncludePathList\r
2659\r
da92f276
LG
2660 ## Create AsBuilt INF file the module\r
2661 #\r
2662 def CreateAsBuiltInf(self):\r
2663 if self.IsAsBuiltInfCreated:\r
2664 return\r
2665 \r
2666 # Skip the following code for EDK I inf\r
2667 if self.AutoGenVersion < 0x00010005:\r
2668 return\r
2669 \r
2670 # Skip the following code for libraries\r
2671 if self.IsLibrary:\r
2672 return\r
2673 \r
2674 # Skip the following code for modules with no source files\r
2675 if self.SourceFileList == None or self.SourceFileList == []:\r
2676 return\r
2677\r
2678 # Skip the following code for modules without any binary files\r
2679 if self.BinaryFileList <> None and self.BinaryFileList <> []:\r
2680 return\r
2681 \r
2682 ### TODO: How to handles mixed source and binary modules\r
2683\r
2684 # Find all DynamicEx PCDs used by this module and dependent libraries\r
2685 # Also find all packages that the DynamicEx PCDs depend on\r
2686 Pcds = []\r
2687 Packages = [] \r
2688 for Pcd in self.ModulePcdList + self.LibraryPcdList:\r
2689 if Pcd.Type in GenC.gDynamicExPcd:\r
2690 if Pcd not in Pcds:\r
2691 Pcds += [Pcd]\r
2692 for Package in self.DerivedPackageList:\r
2693 if Package not in Packages:\r
2694 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'DynamicEx') in Package.Pcds:\r
2695 Packages += [Package]\r
2696 elif (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, 'Dynamic') in Package.Pcds:\r
2697 Packages += [Package]\r
2698\r
2699 ModuleType = self.ModuleType\r
2700 if ModuleType == 'UEFI_DRIVER' and self.DepexGenerated:\r
2701 ModuleType = 'DXE_DRIVER'\r
2702\r
2703 AsBuiltInfDict = {\r
2704 'module_name' : self.Name,\r
2705 'module_guid' : self.Guid,\r
2706 'module_module_type' : ModuleType,\r
2707 'module_version_string' : self.Version,\r
2708 'module_uefi_specification_version' : [],\r
2709 'module_pi_specification_version' : [],\r
2710 'module_arch' : self.Arch,\r
2711 'package_item' : ['%s' % (Package.MetaFile.File.replace('\\','/')) for Package in Packages],\r
2712 'binary_item' : [],\r
2713 'pcd_item' : [],\r
2714 'flags_item' : []\r
2715 }\r
2716\r
2717 if 'UEFI_SPECIFICATION_VERSION' in self.Specification:\r
2718 AsBuiltInfDict['module_uefi_specification_version'] += [self.Specification['UEFI_SPECIFICATION_VERSION']]\r
2719 if 'PI_SPECIFICATION_VERSION' in self.Specification:\r
2720 AsBuiltInfDict['module_pi_specification_version'] += [self.Specification['PI_SPECIFICATION_VERSION']]\r
2721\r
2722 OutputDir = self.OutputDir.replace('\\','/').strip('/')\r
2723 if self.ModuleType in ['BASE', 'USER_DEFINED']:\r
2724 for Item in self.CodaTargetList:\r
2725 File = Item.Target.Path.replace('\\','/').strip('/').replace(OutputDir,'').strip('/')\r
2726 if Item.Target.Ext.lower() == '.aml': \r
2727 AsBuiltInfDict['binary_item'] += ['ASL|' + File]\r
2728 elif Item.Target.Ext.lower() == '.acpi': \r
2729 AsBuiltInfDict['binary_item'] += ['ACPI|' + File]\r
2730 else:\r
2731 AsBuiltInfDict['binary_item'] += ['BIN|' + File]\r
2732 else:\r
2733 for Item in self.CodaTargetList:\r
2734 File = Item.Target.Path.replace('\\','/').strip('/').replace(OutputDir,'').strip('/')\r
2735 if Item.Target.Ext.lower() == '.efi': \r
2736 AsBuiltInfDict['binary_item'] += ['PE32|' + self.Name + '.efi']\r
2737 else:\r
2738 AsBuiltInfDict['binary_item'] += ['BIN|' + File]\r
2739 if self.DepexGenerated:\r
2740 if self.ModuleType in ['PEIM']:\r
2741 AsBuiltInfDict['binary_item'] += ['PEI_DEPEX|' + self.Name + '.depex']\r
2742 if self.ModuleType in ['DXE_DRIVER','DXE_RUNTIME_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:\r
2743 AsBuiltInfDict['binary_item'] += ['DXE_DEPEX|' + self.Name + '.depex']\r
2744 if self.ModuleType in ['DXE_SMM_DRIVER']:\r
2745 AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']\r
2746\r
2747 for Pcd in Pcds:\r
2748 AsBuiltInfDict['pcd_item'] += [Pcd.TokenSpaceGuidCName + '.' + Pcd.TokenCName]\r
2749 \r
2750 for Item in self.BuildOption:\r
2751 if 'FLAGS' in self.BuildOption[Item]:\r
2752 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
2753 \r
2754 AsBuiltInf = TemplateString()\r
2755 AsBuiltInf.Append(gAsBuiltInfHeaderString.Replace(AsBuiltInfDict))\r
2756 \r
2757 SaveFileOnChange(os.path.join(self.OutputDir, self.Name + '.inf'), str(AsBuiltInf), False)\r
2758 \r
2759 self.IsAsBuiltInfCreated = True\r
2760 \r
52302d4d
LG
2761 ## Create makefile for the module and its dependent libraries\r
2762 #\r
2763 # @param CreateLibraryMakeFile Flag indicating if or not the makefiles of\r
2764 # dependent libraries will be created\r
2765 #\r
2766 def CreateMakeFile(self, CreateLibraryMakeFile=True):\r
2767 if self.IsMakeFileCreated:\r
2768 return\r
2769\r
2770 if not self.IsLibrary and CreateLibraryMakeFile:\r
2771 for LibraryAutoGen in self.LibraryAutoGenList:\r
2772 LibraryAutoGen.CreateMakeFile()\r
2773\r
2774 if len(self.CustomMakefile) == 0:\r
2775 Makefile = GenMake.ModuleMakefile(self)\r
2776 else:\r
2777 Makefile = GenMake.CustomMakefile(self)\r
2778 if Makefile.Generate():\r
2779 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated makefile for module %s [%s]" %\r
2780 (self.Name, self.Arch))\r
2781 else:\r
2782 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of makefile for module %s [%s]" %\r
2783 (self.Name, self.Arch))\r
2784\r
2785 self.IsMakeFileCreated = True\r
2786\r
2787 ## Create autogen code for the module and its dependent libraries\r
2788 #\r
2789 # @param CreateLibraryCodeFile Flag indicating if or not the code of\r
2790 # dependent libraries will be created\r
2791 #\r
2792 def CreateCodeFile(self, CreateLibraryCodeFile=True):\r
2793 if self.IsCodeFileCreated:\r
2794 return\r
2795\r
2796 if not self.IsLibrary and CreateLibraryCodeFile:\r
2797 for LibraryAutoGen in self.LibraryAutoGenList:\r
2798 LibraryAutoGen.CreateCodeFile()\r
2799\r
2800 AutoGenList = []\r
2801 IgoredAutoGenList = []\r
2802\r
2803 for File in self.AutoGenFileList:\r
2804 if GenC.Generate(File.Path, self.AutoGenFileList[File], File.IsBinary):\r
b36d134f 2805 #Ignore Edk AutoGen.c\r
52302d4d
LG
2806 if self.AutoGenVersion < 0x00010005 and File.Name == 'AutoGen.c':\r
2807 continue\r
2808\r
2809 AutoGenList.append(str(File))\r
2810 else:\r
2811 IgoredAutoGenList.append(str(File))\r
2812\r
2813 # Skip the following code for EDK I inf\r
2814 if self.AutoGenVersion < 0x00010005:\r
2815 return\r
2816\r
2817 for ModuleType in self.DepexList:\r
40d841f6
LG
2818 # Ignore empty [depex] section or [depex] section for "USER_DEFINED" module\r
2819 if len(self.DepexList[ModuleType]) == 0 or ModuleType == "USER_DEFINED":\r
52302d4d 2820 continue\r
40d841f6 2821\r
52302d4d
LG
2822 Dpx = GenDepex.DependencyExpression(self.DepexList[ModuleType], ModuleType, True)\r
2823 DpxFile = gAutoGenDepexFileName % {"module_name" : self.Name}\r
2824\r
da92f276 2825 if len(Dpx.PostfixNotation) <> 0:\r
0d2711a6 2826 self.DepexGenerated = True\r
da92f276 2827\r
52302d4d
LG
2828 if Dpx.Generate(path.join(self.OutputDir, DpxFile)):\r
2829 AutoGenList.append(str(DpxFile))\r
2830 else:\r
2831 IgoredAutoGenList.append(str(DpxFile))\r
2832\r
2833 if IgoredAutoGenList == []:\r
2834 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] files for module %s [%s]" %\r
2835 (" ".join(AutoGenList), self.Name, self.Arch))\r
2836 elif AutoGenList == []:\r
2837 EdkLogger.debug(EdkLogger.DEBUG_9, "Skipped the generation of [%s] files for module %s [%s]" %\r
2838 (" ".join(IgoredAutoGenList), self.Name, self.Arch))\r
2839 else:\r
2840 EdkLogger.debug(EdkLogger.DEBUG_9, "Generated [%s] (skipped %s) files for module %s [%s]" %\r
2841 (" ".join(AutoGenList), " ".join(IgoredAutoGenList), self.Name, self.Arch))\r
2842\r
2843 self.IsCodeFileCreated = True\r
2844 return AutoGenList\r
2845\r
2846 ## Summarize the ModuleAutoGen objects of all libraries used by this module\r
2847 def _GetLibraryAutoGenList(self):\r
2848 if self._LibraryAutoGenList == None:\r
2849 self._LibraryAutoGenList = []\r
2850 for Library in self.DependentLibraryList:\r
2851 La = ModuleAutoGen(\r
2852 self.Workspace,\r
2853 Library.MetaFile,\r
2854 self.BuildTarget,\r
2855 self.ToolChain,\r
2856 self.Arch,\r
2857 self.PlatformInfo.MetaFile\r
2858 )\r
2859 if La not in self._LibraryAutoGenList:\r
2860 self._LibraryAutoGenList.append(La)\r
2861 for Lib in La.CodaTargetList:\r
2862 self._ApplyBuildRule(Lib.Target, TAB_UNKNOWN_FILE)\r
2863 return self._LibraryAutoGenList\r
2864\r
52302d4d
LG
2865 Module = property(_GetModule)\r
2866 Name = property(_GetBaseName)\r
2867 Guid = property(_GetGuid)\r
2868 Version = property(_GetVersion)\r
2869 ModuleType = property(_GetModuleType)\r
2870 ComponentType = property(_GetComponentType)\r
2871 BuildType = property(_GetBuildType)\r
2872 PcdIsDriver = property(_GetPcdIsDriver)\r
2873 AutoGenVersion = property(_GetAutoGenVersion)\r
2874 Macros = property(_GetMacros)\r
2875 Specification = property(_GetSpecification)\r
2876\r
2877 IsLibrary = property(_IsLibrary)\r
2878\r
2879 BuildDir = property(_GetBuildDir)\r
2880 OutputDir = property(_GetOutputDir)\r
2881 DebugDir = property(_GetDebugDir)\r
2882 MakeFileDir = property(_GetMakeFileDir)\r
2883 CustomMakefile = property(_GetCustomMakefile)\r
2884\r
2885 IncludePathList = property(_GetIncludePathList)\r
2886 AutoGenFileList = property(_GetAutoGenFileList)\r
2887 UnicodeFileList = property(_GetUnicodeFileList)\r
2888 SourceFileList = property(_GetSourceFileList)\r
2889 BinaryFileList = property(_GetBinaryFiles) # FileType : [File List]\r
2890 Targets = property(_GetTargets)\r
2891 IntroTargetList = property(_GetIntroTargetList)\r
2892 CodaTargetList = property(_GetFinalTargetList)\r
2893 FileTypes = property(_GetFileTypes)\r
2894 BuildRules = property(_GetBuildRules)\r
2895\r
2896 DependentPackageList = property(_GetDependentPackageList)\r
2897 DependentLibraryList = property(_GetLibraryList)\r
2898 LibraryAutoGenList = property(_GetLibraryAutoGenList)\r
2899 DerivedPackageList = property(_GetDerivedPackageList)\r
2900\r
2901 ModulePcdList = property(_GetModulePcdList)\r
2902 LibraryPcdList = property(_GetLibraryPcdList)\r
2903 GuidList = property(_GetGuidList)\r
2904 ProtocolList = property(_GetProtocolList)\r
2905 PpiList = property(_GetPpiList)\r
2906 DepexList = property(_GetDepexTokenList)\r
b36d134f 2907 DxsFile = property(_GetDxsFile)\r
52302d4d
LG
2908 DepexExpressionList = property(_GetDepexExpressionTokenList)\r
2909 BuildOption = property(_GetModuleBuildOption)\r
79b74a03 2910 BuildOptionIncPathList = property(_GetBuildOptionIncPathList)\r
52302d4d
LG
2911 BuildCommand = property(_GetBuildCommand)\r
2912\r
2913# This acts like the main() function for the script, unless it is 'import'ed into another script.\r
2914if __name__ == '__main__':\r
2915 pass\r
2916\r