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