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