]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/WorkspaceDatabase.py
Sync BaseTools Trunk (version r2387) to EDKII main trunk.
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / WorkspaceDatabase.py
CommitLineData
52302d4d
LG
1## @file\r
2# This file is used to create a database used by build tool\r
3#\r
da92f276 4# Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>\r
40d841f6 5# This program and the accompanying materials\r
52302d4d
LG
6# are licensed and made available under the terms and conditions of the BSD License\r
7# which accompanies this distribution. The full text of the license may be found at\r
8# http://opensource.org/licenses/bsd-license.php\r
9#\r
10# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12#\r
13\r
14##\r
15# Import Modules\r
16#\r
17import sqlite3\r
18import os\r
19import os.path\r
20import pickle\r
e56468c0 21import uuid\r
52302d4d
LG
22\r
23import Common.EdkLogger as EdkLogger\r
24import Common.GlobalData as GlobalData\r
25\r
26from Common.String import *\r
27from Common.DataType import *\r
28from Common.Misc import *\r
29from types import *\r
30\r
31from CommonDataClass.CommonClass import SkuInfoClass\r
32\r
33from MetaDataTable import *\r
34from MetaFileTable import *\r
35from MetaFileParser import *\r
36from BuildClassObject import *\r
37\r
38## Platform build information from DSC file\r
39#\r
40# This class is used to retrieve information stored in database and convert them\r
41# into PlatformBuildClassObject form for easier use for AutoGen.\r
42#\r
43class DscBuildData(PlatformBuildClassObject):\r
44 # dict used to convert PCD type in database to string used by build tool\r
45 _PCD_TYPE_STRING_ = {\r
46 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
47 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
48 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
49 MODEL_PCD_DYNAMIC : "Dynamic",\r
50 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
51 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
52 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
53 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
54 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
55 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
56 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
57 }\r
58\r
59 # dict used to convert part of [Defines] to members of DscBuildData directly\r
60 _PROPERTY_ = {\r
61 #\r
62 # Required Fields\r
63 #\r
64 TAB_DSC_DEFINES_PLATFORM_NAME : "_PlatformName",\r
65 TAB_DSC_DEFINES_PLATFORM_GUID : "_Guid",\r
66 TAB_DSC_DEFINES_PLATFORM_VERSION : "_Version",\r
67 TAB_DSC_DEFINES_DSC_SPECIFICATION : "_DscSpecification",\r
68 #TAB_DSC_DEFINES_OUTPUT_DIRECTORY : "_OutputDirectory",\r
69 #TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES : "_SupArchList",\r
70 #TAB_DSC_DEFINES_BUILD_TARGETS : "_BuildTargets",\r
71 #TAB_DSC_DEFINES_SKUID_IDENTIFIER : "_SkuName",\r
72 #TAB_DSC_DEFINES_FLASH_DEFINITION : "_FlashDefinition",\r
73 TAB_DSC_DEFINES_BUILD_NUMBER : "_BuildNumber",\r
74 TAB_DSC_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
75 TAB_DSC_DEFINES_BS_BASE_ADDRESS : "_BsBaseAddress",\r
76 TAB_DSC_DEFINES_RT_BASE_ADDRESS : "_RtBaseAddress",\r
6780eef1
LG
77 #TAB_DSC_DEFINES_RFC_LANGUAGES : "_RFCLanguages",\r
78 #TAB_DSC_DEFINES_ISO_LANGUAGES : "_ISOLanguages",\r
52302d4d
LG
79 }\r
80\r
81 # used to compose dummy library class name for those forced library instances\r
82 _NullLibraryNumber = 0\r
83\r
84 ## Constructor of DscBuildData\r
85 #\r
86 # Initialize object of DscBuildData\r
87 #\r
88 # @param FilePath The path of platform description file\r
89 # @param RawData The raw data of DSC file\r
90 # @param BuildDataBase Database used to retrieve module/package information\r
91 # @param Arch The target architecture\r
92 # @param Platform (not used for DscBuildData)\r
93 # @param Macros Macros used for replacement in DSC file\r
94 #\r
0d2711a6 95 def __init__(self, FilePath, RawData, BuildDataBase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
96 self.MetaFile = FilePath\r
97 self._RawData = RawData\r
98 self._Bdb = BuildDataBase\r
99 self._Arch = Arch\r
0d2711a6
LG
100 self._Target = Target\r
101 self._Toolchain = Toolchain\r
52302d4d 102 self._Clear()\r
52302d4d
LG
103\r
104 ## XXX[key] = value\r
105 def __setitem__(self, key, value):\r
106 self.__dict__[self._PROPERTY_[key]] = value\r
107\r
108 ## value = XXX[key]\r
109 def __getitem__(self, key):\r
110 return self.__dict__[self._PROPERTY_[key]]\r
111\r
112 ## "in" test support\r
113 def __contains__(self, key):\r
114 return key in self._PROPERTY_\r
115\r
116 ## Set all internal used members of DscBuildData to None\r
117 def _Clear(self):\r
118 self._Header = None\r
119 self._PlatformName = None\r
120 self._Guid = None\r
121 self._Version = None\r
122 self._DscSpecification = None\r
123 self._OutputDirectory = None\r
124 self._SupArchList = None\r
125 self._BuildTargets = None\r
126 self._SkuName = None\r
127 self._FlashDefinition = None\r
128 self._BuildNumber = None\r
129 self._MakefileName = None\r
130 self._BsBaseAddress = None\r
131 self._RtBaseAddress = None\r
132 self._SkuIds = None\r
133 self._Modules = None\r
134 self._LibraryInstances = None\r
135 self._LibraryClasses = None\r
136 self._Pcds = None\r
137 self._BuildOptions = None\r
138 self._LoadFixAddress = None\r
6780eef1
LG
139 self._RFCLanguages = None\r
140 self._ISOLanguages = None\r
e56468c0 141 self._VpdToolGuid = None\r
0d2711a6
LG
142 self.__Macros = None\r
143\r
144 ## Get current effective macros\r
145 def _GetMacros(self):\r
146 if self.__Macros == None:\r
147 self.__Macros = {}\r
148 self.__Macros.update(GlobalData.gPlatformDefines)\r
149 self.__Macros.update(GlobalData.gGlobalDefines)\r
150 self.__Macros.update(GlobalData.gCommandLineDefines)\r
151 return self.__Macros\r
52302d4d
LG
152\r
153 ## Get architecture\r
154 def _GetArch(self):\r
155 return self._Arch\r
156\r
157 ## Set architecture\r
158 #\r
159 # Changing the default ARCH to another may affect all other information\r
160 # because all information in a platform may be ARCH-related. That's\r
161 # why we need to clear all internal used members, in order to cause all\r
162 # information to be re-retrieved.\r
163 #\r
164 # @param Value The value of ARCH\r
165 #\r
166 def _SetArch(self, Value):\r
167 if self._Arch == Value:\r
168 return\r
169 self._Arch = Value\r
170 self._Clear()\r
171\r
172 ## Retrieve all information in [Defines] section\r
173 #\r
174 # (Retriving all [Defines] information in one-shot is just to save time.)\r
175 #\r
176 def _GetHeaderInfo(self):\r
177 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
178 for Record in RecordList:\r
0d2711a6 179 Name = Record[1]\r
52302d4d
LG
180 # items defined _PROPERTY_ don't need additional processing\r
181 if Name in self:\r
0d2711a6 182 self[Name] = Record[2]\r
52302d4d
LG
183 # some special items in [Defines] section need special treatment\r
184 elif Name == TAB_DSC_DEFINES_OUTPUT_DIRECTORY:\r
0d2711a6 185 self._OutputDirectory = NormPath(Record[2], self._Macros)\r
52302d4d
LG
186 if ' ' in self._OutputDirectory:\r
187 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "No space is allowed in OUTPUT_DIRECTORY",\r
188 File=self.MetaFile, Line=Record[-1],\r
189 ExtraData=self._OutputDirectory)\r
190 elif Name == TAB_DSC_DEFINES_FLASH_DEFINITION:\r
0d2711a6 191 self._FlashDefinition = PathClass(NormPath(Record[2], self._Macros), GlobalData.gWorkspace)\r
52302d4d
LG
192 ErrorCode, ErrorInfo = self._FlashDefinition.Validate('.fdf')\r
193 if ErrorCode != 0:\r
194 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=Record[-1],\r
195 ExtraData=ErrorInfo)\r
196 elif Name == TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES:\r
0d2711a6 197 self._SupArchList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
52302d4d 198 elif Name == TAB_DSC_DEFINES_BUILD_TARGETS:\r
0d2711a6 199 self._BuildTargets = GetSplitValueList(Record[2])\r
52302d4d
LG
200 elif Name == TAB_DSC_DEFINES_SKUID_IDENTIFIER:\r
201 if self._SkuName == None:\r
0d2711a6 202 self._SkuName = Record[2]\r
52302d4d 203 elif Name == TAB_FIX_LOAD_TOP_MEMORY_ADDRESS:\r
0d2711a6
LG
204 try:\r
205 self._LoadFixAddress = int (Record[2], 0)\r
206 except:\r
207 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (Record[2]))\r
6780eef1 208 elif Name == TAB_DSC_DEFINES_RFC_LANGUAGES:\r
0d2711a6 209 if not Record[2] or Record[2][0] != '"' or Record[2][-1] != '"' or len(Record[2]) == 1:\r
6780eef1
LG
210 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'language code for RFC_LANGUAGES must have double quotes around it, for example: RFC_LANGUAGES = "en-us;zh-hans"',\r
211 File=self.MetaFile, Line=Record[-1])\r
0d2711a6 212 LanguageCodes = Record[2][1:-1]\r
6780eef1
LG
213 if not LanguageCodes:\r
214 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more RFC4646 format language code must be provided for RFC_LANGUAGES statement',\r
215 File=self.MetaFile, Line=Record[-1]) \r
216 LanguageList = GetSplitValueList(LanguageCodes, TAB_SEMI_COLON_SPLIT)\r
217 # check whether there is empty entries in the list\r
218 if None in LanguageList:\r
219 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more empty language code is in RFC_LANGUAGES statement',\r
220 File=self.MetaFile, Line=Record[-1]) \r
221 self._RFCLanguages = LanguageList\r
222 elif Name == TAB_DSC_DEFINES_ISO_LANGUAGES:\r
0d2711a6 223 if not Record[2] or Record[2][0] != '"' or Record[2][-1] != '"' or len(Record[2]) == 1:\r
6780eef1
LG
224 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'language code for ISO_LANGUAGES must have double quotes around it, for example: ISO_LANGUAGES = "engchn"',\r
225 File=self.MetaFile, Line=Record[-1])\r
0d2711a6 226 LanguageCodes = Record[2][1:-1]\r
6780eef1
LG
227 if not LanguageCodes:\r
228 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more ISO639-2 format language code must be provided for ISO_LANGUAGES statement',\r
229 File=self.MetaFile, Line=Record[-1]) \r
230 if len(LanguageCodes)%3:\r
231 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'bad ISO639-2 format for ISO_LANGUAGES',\r
232 File=self.MetaFile, Line=Record[-1])\r
233 LanguageList = []\r
234 for i in range(0, len(LanguageCodes), 3):\r
235 LanguageList.append(LanguageCodes[i:i+3])\r
236 self._ISOLanguages = LanguageList \r
e56468c0 237 elif Name == TAB_DSC_DEFINES_VPD_TOOL_GUID:\r
238 #\r
239 # try to convert GUID to a real UUID value to see whether the GUID is format \r
240 # for VPD_TOOL_GUID is correct.\r
241 #\r
242 try:\r
0d2711a6 243 uuid.UUID(Record[2])\r
e56468c0 244 except:\r
245 EdkLogger.error("build", FORMAT_INVALID, "Invalid GUID format for VPD_TOOL_GUID", File=self.MetaFile)\r
0d2711a6 246 self._VpdToolGuid = Record[2] \r
52302d4d
LG
247 # set _Header to non-None in order to avoid database re-querying\r
248 self._Header = 'DUMMY'\r
249\r
250 ## Retrieve platform name\r
251 def _GetPlatformName(self):\r
252 if self._PlatformName == None:\r
253 if self._Header == None:\r
254 self._GetHeaderInfo()\r
255 if self._PlatformName == None:\r
256 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No PLATFORM_NAME", File=self.MetaFile)\r
257 return self._PlatformName\r
258\r
259 ## Retrieve file guid\r
260 def _GetFileGuid(self):\r
261 if self._Guid == None:\r
262 if self._Header == None:\r
263 self._GetHeaderInfo()\r
264 if self._Guid == None:\r
265 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No FILE_GUID", File=self.MetaFile)\r
266 return self._Guid\r
267\r
268 ## Retrieve platform version\r
269 def _GetVersion(self):\r
270 if self._Version == None:\r
271 if self._Header == None:\r
272 self._GetHeaderInfo()\r
273 if self._Version == None:\r
274 self._Version = ''\r
275 return self._Version\r
276\r
277 ## Retrieve platform description file version\r
278 def _GetDscSpec(self):\r
279 if self._DscSpecification == None:\r
280 if self._Header == None:\r
281 self._GetHeaderInfo()\r
282 if self._DscSpecification == None:\r
283 self._DscSpecification = ''\r
284 return self._DscSpecification\r
285\r
286 ## Retrieve OUTPUT_DIRECTORY\r
287 def _GetOutpuDir(self):\r
288 if self._OutputDirectory == None:\r
289 if self._Header == None:\r
290 self._GetHeaderInfo()\r
291 if self._OutputDirectory == None:\r
292 self._OutputDirectory = os.path.join("Build", self._PlatformName)\r
293 return self._OutputDirectory\r
294\r
295 ## Retrieve SUPPORTED_ARCHITECTURES\r
296 def _GetSupArch(self):\r
297 if self._SupArchList == None:\r
298 if self._Header == None:\r
299 self._GetHeaderInfo()\r
300 if self._SupArchList == None:\r
301 self._SupArchList = ARCH_LIST\r
302 return self._SupArchList\r
303\r
304 ## Retrieve BUILD_TARGETS\r
305 def _GetBuildTarget(self):\r
306 if self._BuildTargets == None:\r
307 if self._Header == None:\r
308 self._GetHeaderInfo()\r
309 if self._BuildTargets == None:\r
b36d134f 310 self._BuildTargets = ['DEBUG', 'RELEASE', 'NOOPT']\r
52302d4d
LG
311 return self._BuildTargets\r
312\r
313 ## Retrieve SKUID_IDENTIFIER\r
314 def _GetSkuName(self):\r
315 if self._SkuName == None:\r
316 if self._Header == None:\r
317 self._GetHeaderInfo()\r
318 if self._SkuName == None or self._SkuName not in self.SkuIds:\r
319 self._SkuName = 'DEFAULT'\r
320 return self._SkuName\r
321\r
322 ## Override SKUID_IDENTIFIER\r
323 def _SetSkuName(self, Value):\r
324 if Value in self.SkuIds:\r
325 self._SkuName = Value\r
e56468c0 326 # Needs to re-retrieve the PCD information\r
327 self._Pcds = None\r
52302d4d
LG
328\r
329 def _GetFdfFile(self):\r
330 if self._FlashDefinition == None:\r
331 if self._Header == None:\r
332 self._GetHeaderInfo()\r
333 if self._FlashDefinition == None:\r
334 self._FlashDefinition = ''\r
335 return self._FlashDefinition\r
336\r
337 ## Retrieve FLASH_DEFINITION\r
338 def _GetBuildNumber(self):\r
339 if self._BuildNumber == None:\r
340 if self._Header == None:\r
341 self._GetHeaderInfo()\r
342 if self._BuildNumber == None:\r
343 self._BuildNumber = ''\r
344 return self._BuildNumber\r
345\r
346 ## Retrieve MAKEFILE_NAME\r
347 def _GetMakefileName(self):\r
348 if self._MakefileName == None:\r
349 if self._Header == None:\r
350 self._GetHeaderInfo()\r
351 if self._MakefileName == None:\r
352 self._MakefileName = ''\r
353 return self._MakefileName\r
354\r
355 ## Retrieve BsBaseAddress\r
356 def _GetBsBaseAddress(self):\r
357 if self._BsBaseAddress == None:\r
358 if self._Header == None:\r
359 self._GetHeaderInfo()\r
360 if self._BsBaseAddress == None:\r
361 self._BsBaseAddress = ''\r
362 return self._BsBaseAddress\r
363\r
364 ## Retrieve RtBaseAddress\r
365 def _GetRtBaseAddress(self):\r
366 if self._RtBaseAddress == None:\r
367 if self._Header == None:\r
368 self._GetHeaderInfo()\r
369 if self._RtBaseAddress == None:\r
370 self._RtBaseAddress = ''\r
371 return self._RtBaseAddress\r
372\r
373 ## Retrieve the top address for the load fix address\r
374 def _GetLoadFixAddress(self):\r
375 if self._LoadFixAddress == None:\r
376 if self._Header == None:\r
377 self._GetHeaderInfo()\r
0d2711a6 378\r
52302d4d 379 if self._LoadFixAddress == None:\r
0d2711a6
LG
380 self._LoadFixAddress = self._Macros.get(TAB_FIX_LOAD_TOP_MEMORY_ADDRESS, '0')\r
381\r
382 try:\r
383 self._LoadFixAddress = int (self._LoadFixAddress, 0)\r
384 except:\r
385 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (self._LoadFixAddress))\r
386 if self._LoadFixAddress < 0:\r
387 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid negative value %s" % (self._LoadFixAddress))\r
388 if self._LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self._LoadFixAddress % 0x1000 != 0:\r
389 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid unaligned 4K value %s" % (self._LoadFixAddress))\r
52302d4d
LG
390 return self._LoadFixAddress\r
391\r
6780eef1
LG
392 ## Retrieve RFCLanguage filter\r
393 def _GetRFCLanguages(self):\r
394 if self._RFCLanguages == None:\r
395 if self._Header == None:\r
396 self._GetHeaderInfo()\r
397 if self._RFCLanguages == None:\r
398 self._RFCLanguages = []\r
399 return self._RFCLanguages\r
400\r
401 ## Retrieve ISOLanguage filter\r
402 def _GetISOLanguages(self):\r
403 if self._ISOLanguages == None:\r
404 if self._Header == None:\r
405 self._GetHeaderInfo()\r
406 if self._ISOLanguages == None:\r
407 self._ISOLanguages = []\r
408 return self._ISOLanguages\r
e56468c0 409 ## Retrieve the GUID string for VPD tool\r
410 def _GetVpdToolGuid(self):\r
411 if self._VpdToolGuid == None:\r
412 if self._Header == None:\r
413 self._GetHeaderInfo()\r
414 if self._VpdToolGuid == None:\r
415 self._VpdToolGuid = ''\r
416 return self._VpdToolGuid\r
08dd311f 417 \r
52302d4d
LG
418 ## Retrieve [SkuIds] section information\r
419 def _GetSkuIds(self):\r
420 if self._SkuIds == None:\r
0d2711a6
LG
421 self._SkuIds = sdict()\r
422 RecordList = self._RawData[MODEL_EFI_SKU_ID, self._Arch]\r
52302d4d
LG
423 for Record in RecordList:\r
424 if Record[0] in [None, '']:\r
425 EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID number',\r
426 File=self.MetaFile, Line=Record[-1])\r
427 if Record[1] in [None, '']:\r
428 EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID name',\r
429 File=self.MetaFile, Line=Record[-1])\r
430 self._SkuIds[Record[1]] = Record[0]\r
431 if 'DEFAULT' not in self._SkuIds:\r
432 self._SkuIds['DEFAULT'] = 0\r
433 return self._SkuIds\r
434\r
435 ## Retrieve [Components] section information\r
436 def _GetModules(self):\r
437 if self._Modules != None:\r
438 return self._Modules\r
439\r
440 self._Modules = sdict()\r
441 RecordList = self._RawData[MODEL_META_DATA_COMPONENT, self._Arch]\r
0d2711a6
LG
442 Macros = self._Macros\r
443 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d
LG
444 for Record in RecordList:\r
445 ModuleFile = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
446 ModuleId = Record[5]\r
447 LineNo = Record[6]\r
448\r
449 # check the file validation\r
450 ErrorCode, ErrorInfo = ModuleFile.Validate('.inf')\r
451 if ErrorCode != 0:\r
452 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
453 ExtraData=ErrorInfo)\r
454 # Check duplication\r
455 if ModuleFile in self._Modules:\r
456 EdkLogger.error('build', FILE_DUPLICATED, File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)\r
457\r
458 Module = ModuleBuildClassObject()\r
459 Module.MetaFile = ModuleFile\r
460\r
461 # get module override path\r
462 RecordList = self._RawData[MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH, self._Arch, None, ModuleId]\r
463 if RecordList != []:\r
464 Module.SourceOverridePath = os.path.join(GlobalData.gWorkspace, NormPath(RecordList[0][0], Macros))\r
465\r
466 # Check if the source override path exists\r
467 if not os.path.isdir(Module.SourceOverridePath):\r
468 EdkLogger.error('build', FILE_NOT_FOUND, Message = 'Source override path does not exist:', File=self.MetaFile, ExtraData=Module.SourceOverridePath, Line=LineNo)\r
469 \r
470 #Add to GlobalData Variables\r
471 GlobalData.gOverrideDir[ModuleFile.Key] = Module.SourceOverridePath\r
472\r
473 # get module private library instance\r
474 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, ModuleId]\r
475 for Record in RecordList:\r
476 LibraryClass = Record[0]\r
477 LibraryPath = PathClass(NormPath(Record[1], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
478 LineNo = Record[-1]\r
479\r
480 # check the file validation\r
481 ErrorCode, ErrorInfo = LibraryPath.Validate('.inf')\r
482 if ErrorCode != 0:\r
483 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
484 ExtraData=ErrorInfo)\r
485\r
486 if LibraryClass == '' or LibraryClass == 'NULL':\r
487 self._NullLibraryNumber += 1\r
488 LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
489 EdkLogger.verbose("Found forced library for %s\n\t%s [%s]" % (ModuleFile, LibraryPath, LibraryClass))\r
490 Module.LibraryClasses[LibraryClass] = LibraryPath\r
491 if LibraryPath not in self.LibraryInstances:\r
492 self.LibraryInstances.append(LibraryPath)\r
493\r
494 # get module private PCD setting\r
495 for Type in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, \\r
496 MODEL_PCD_FEATURE_FLAG, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX]:\r
497 RecordList = self._RawData[Type, self._Arch, None, ModuleId]\r
498 for TokenSpaceGuid, PcdCName, Setting, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
499 TokenList = GetSplitValueList(Setting)\r
500 DefaultValue = TokenList[0]\r
501 if len(TokenList) > 1:\r
502 MaxDatumSize = TokenList[1]\r
503 else:\r
504 MaxDatumSize = ''\r
505 TypeString = self._PCD_TYPE_STRING_[Type]\r
506 Pcd = PcdClassObject(\r
507 PcdCName,\r
508 TokenSpaceGuid,\r
509 TypeString,\r
510 '',\r
511 DefaultValue,\r
512 '',\r
513 MaxDatumSize,\r
514 {},\r
e56468c0 515 False,\r
52302d4d
LG
516 None\r
517 )\r
518 Module.Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
519\r
520 # get module private build options\r
521 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, None, ModuleId]\r
522 for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
523 if (ToolChainFamily, ToolChain) not in Module.BuildOptions:\r
524 Module.BuildOptions[ToolChainFamily, ToolChain] = Option\r
525 else:\r
526 OptionString = Module.BuildOptions[ToolChainFamily, ToolChain]\r
527 Module.BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
528\r
529 self._Modules[ModuleFile] = Module\r
530 return self._Modules\r
531\r
532 ## Retrieve all possible library instances used in this platform\r
533 def _GetLibraryInstances(self):\r
534 if self._LibraryInstances == None:\r
535 self._GetLibraryClasses()\r
536 return self._LibraryInstances\r
537\r
538 ## Retrieve [LibraryClasses] information\r
539 def _GetLibraryClasses(self):\r
540 if self._LibraryClasses == None:\r
541 self._LibraryInstances = []\r
542 #\r
543 # tdict is a special dict kind of type, used for selecting correct\r
544 # library instance for given library class and module type\r
545 #\r
546 LibraryClassDict = tdict(True, 3)\r
547 # track all library class names\r
548 LibraryClassSet = set()\r
0d2711a6
LG
549 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, -1]\r
550 Macros = self._Macros\r
52302d4d
LG
551 for Record in RecordList:\r
552 LibraryClass, LibraryInstance, Dummy, Arch, ModuleType, Dummy, LineNo = Record\r
553 if LibraryClass == '' or LibraryClass == 'NULL':\r
554 self._NullLibraryNumber += 1\r
555 LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
556 EdkLogger.verbose("Found forced library for arch=%s\n\t%s [%s]" % (Arch, LibraryInstance, LibraryClass))\r
557 LibraryClassSet.add(LibraryClass)\r
558 LibraryInstance = PathClass(NormPath(LibraryInstance, Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
559 # check the file validation\r
560 ErrorCode, ErrorInfo = LibraryInstance.Validate('.inf')\r
561 if ErrorCode != 0:\r
562 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
563 ExtraData=ErrorInfo)\r
564\r
565 if ModuleType != 'COMMON' and ModuleType not in SUP_MODULE_LIST:\r
566 EdkLogger.error('build', OPTION_UNKNOWN, "Unknown module type [%s]" % ModuleType,\r
567 File=self.MetaFile, ExtraData=LibraryInstance, Line=LineNo)\r
568 LibraryClassDict[Arch, ModuleType, LibraryClass] = LibraryInstance\r
569 if LibraryInstance not in self._LibraryInstances:\r
570 self._LibraryInstances.append(LibraryInstance)\r
571\r
572 # resolve the specific library instance for each class and each module type\r
573 self._LibraryClasses = tdict(True)\r
574 for LibraryClass in LibraryClassSet:\r
575 # try all possible module types\r
576 for ModuleType in SUP_MODULE_LIST:\r
577 LibraryInstance = LibraryClassDict[self._Arch, ModuleType, LibraryClass]\r
578 if LibraryInstance == None:\r
579 continue\r
580 self._LibraryClasses[LibraryClass, ModuleType] = LibraryInstance\r
581\r
0d2711a6
LG
582 # for Edk style library instances, which are listed in different section\r
583 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d
LG
584 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch]\r
585 for Record in RecordList:\r
586 File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
587 LineNo = Record[-1]\r
588 # check the file validation\r
589 ErrorCode, ErrorInfo = File.Validate('.inf')\r
590 if ErrorCode != 0:\r
591 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
592 ExtraData=ErrorInfo)\r
593 if File not in self._LibraryInstances:\r
594 self._LibraryInstances.append(File)\r
595 #\r
596 # we need the module name as the library class name, so we have\r
597 # to parse it here. (self._Bdb[] will trigger a file parse if it\r
598 # hasn't been parsed)\r
599 #\r
0d2711a6 600 Library = self._Bdb[File, self._Arch, self._Target, self._Toolchain]\r
52302d4d
LG
601 self._LibraryClasses[Library.BaseName, ':dummy:'] = Library\r
602 return self._LibraryClasses\r
603\r
604 ## Retrieve all PCD settings in platform\r
605 def _GetPcds(self):\r
606 if self._Pcds == None:\r
0d2711a6 607 self._Pcds = sdict()\r
52302d4d
LG
608 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
609 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
610 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
611 self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_DEFAULT))\r
612 self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_HII))\r
613 self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_VPD))\r
614 self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_EX_DEFAULT))\r
615 self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_EX_HII))\r
616 self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_EX_VPD))\r
617 return self._Pcds\r
618\r
619 ## Retrieve [BuildOptions]\r
620 def _GetBuildOptions(self):\r
621 if self._BuildOptions == None:\r
0d2711a6 622 self._BuildOptions = sdict()\r
52302d4d
LG
623 #\r
624 # Retrieve build option for EDKII style module\r
625 #\r
0d2711a6 626 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, EDKII_NAME]\r
52302d4d
LG
627 for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
628 self._BuildOptions[ToolChainFamily, ToolChain, EDKII_NAME] = Option\r
629 #\r
630 # Retrieve build option for EDK style module\r
631 #\r
0d2711a6 632 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, EDK_NAME] \r
52302d4d
LG
633 for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
634 self._BuildOptions[ToolChainFamily, ToolChain, EDK_NAME] = Option\r
635 return self._BuildOptions\r
636\r
637 ## Retrieve non-dynamic PCD settings\r
638 #\r
639 # @param Type PCD type\r
640 #\r
641 # @retval a dict object contains settings of given PCD type\r
642 #\r
643 def _GetPcd(self, Type):\r
0d2711a6 644 Pcds = sdict()\r
52302d4d
LG
645 #\r
646 # tdict is a special dict kind of type, used for selecting correct\r
647 # PCD settings for certain ARCH\r
648 #\r
649 PcdDict = tdict(True, 3)\r
650 PcdSet = set()\r
651 # Find out all possible PCD candidates for self._Arch\r
652 RecordList = self._RawData[Type, self._Arch]\r
653 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
654 PcdSet.add((PcdCName, TokenSpaceGuid))\r
655 PcdDict[Arch, PcdCName, TokenSpaceGuid] = Setting\r
656 # Remove redundant PCD candidates\r
657 for PcdCName, TokenSpaceGuid in PcdSet:\r
52302d4d
LG
658 Setting = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
659 if Setting == None:\r
660 continue\r
6780eef1 661 PcdValue, DatumType, MaxDatumSize = AnalyzePcdData(Setting)\r
52302d4d
LG
662 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
663 PcdCName,\r
664 TokenSpaceGuid,\r
665 self._PCD_TYPE_STRING_[Type],\r
666 DatumType,\r
667 PcdValue,\r
668 '',\r
669 MaxDatumSize,\r
670 {},\r
e56468c0 671 False,\r
52302d4d
LG
672 None\r
673 )\r
674 return Pcds\r
675\r
676 ## Retrieve dynamic PCD settings\r
677 #\r
678 # @param Type PCD type\r
679 #\r
680 # @retval a dict object contains settings of given PCD type\r
681 #\r
682 def _GetDynamicPcd(self, Type):\r
0d2711a6 683 Pcds = sdict()\r
52302d4d
LG
684 #\r
685 # tdict is a special dict kind of type, used for selecting correct\r
686 # PCD settings for certain ARCH and SKU\r
687 #\r
688 PcdDict = tdict(True, 4)\r
6780eef1 689 PcdList = []\r
52302d4d
LG
690 # Find out all possible PCD candidates for self._Arch\r
691 RecordList = self._RawData[Type, self._Arch]\r
692 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
6780eef1 693 PcdList.append((PcdCName, TokenSpaceGuid))\r
52302d4d
LG
694 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
695 # Remove redundant PCD candidates, per the ARCH and SKU\r
6780eef1 696 for PcdCName, TokenSpaceGuid in PcdList:\r
52302d4d
LG
697 Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
698 if Setting == None:\r
699 continue\r
6780eef1
LG
700 \r
701 PcdValue, DatumType, MaxDatumSize = AnalyzePcdData(Setting)\r
702 \r
52302d4d
LG
703 SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], '', '', '', '', '', PcdValue)\r
704 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
705 PcdCName,\r
706 TokenSpaceGuid,\r
707 self._PCD_TYPE_STRING_[Type],\r
708 DatumType,\r
709 PcdValue,\r
710 '',\r
711 MaxDatumSize,\r
712 {self.SkuName : SkuInfo},\r
e56468c0 713 False,\r
52302d4d
LG
714 None\r
715 )\r
716 return Pcds\r
717\r
718 ## Retrieve dynamic HII PCD settings\r
719 #\r
720 # @param Type PCD type\r
721 #\r
722 # @retval a dict object contains settings of given PCD type\r
723 #\r
724 def _GetDynamicHiiPcd(self, Type):\r
0d2711a6 725 Pcds = sdict()\r
52302d4d
LG
726 #\r
727 # tdict is a special dict kind of type, used for selecting correct\r
728 # PCD settings for certain ARCH and SKU\r
729 #\r
730 PcdDict = tdict(True, 4)\r
731 PcdSet = set()\r
732 RecordList = self._RawData[Type, self._Arch]\r
733 # Find out all possible PCD candidates for self._Arch\r
734 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
735 PcdSet.add((PcdCName, TokenSpaceGuid))\r
736 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
737 # Remove redundant PCD candidates, per the ARCH and SKU\r
738 for PcdCName, TokenSpaceGuid in PcdSet:\r
52302d4d
LG
739 Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
740 if Setting == None:\r
741 continue\r
6780eef1 742 VariableName, VariableGuid, VariableOffset, DefaultValue = AnalyzeHiiPcdData(Setting)\r
52302d4d
LG
743 SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], VariableName, VariableGuid, VariableOffset, DefaultValue)\r
744 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
745 PcdCName,\r
746 TokenSpaceGuid,\r
747 self._PCD_TYPE_STRING_[Type],\r
748 '',\r
749 DefaultValue,\r
750 '',\r
751 '',\r
752 {self.SkuName : SkuInfo},\r
e56468c0 753 False,\r
52302d4d
LG
754 None\r
755 )\r
756 return Pcds\r
757\r
758 ## Retrieve dynamic VPD PCD settings\r
759 #\r
760 # @param Type PCD type\r
761 #\r
762 # @retval a dict object contains settings of given PCD type\r
763 #\r
764 def _GetDynamicVpdPcd(self, Type):\r
0d2711a6 765 Pcds = sdict()\r
52302d4d
LG
766 #\r
767 # tdict is a special dict kind of type, used for selecting correct\r
768 # PCD settings for certain ARCH and SKU\r
769 #\r
770 PcdDict = tdict(True, 4)\r
6780eef1 771 PcdList = []\r
52302d4d
LG
772 # Find out all possible PCD candidates for self._Arch\r
773 RecordList = self._RawData[Type, self._Arch]\r
774 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
6780eef1 775 PcdList.append((PcdCName, TokenSpaceGuid))\r
52302d4d
LG
776 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
777 # Remove redundant PCD candidates, per the ARCH and SKU\r
6780eef1 778 for PcdCName, TokenSpaceGuid in PcdList:\r
52302d4d
LG
779 Setting = PcdDict[self._Arch, self.SkuName, PcdCName, TokenSpaceGuid]\r
780 if Setting == None:\r
781 continue\r
e56468c0 782 #\r
783 # For the VOID* type, it can have optional data of MaxDatumSize and InitialValue\r
784 # For the Integer & Boolean type, the optional data can only be InitialValue.\r
785 # At this point, we put all the data into the PcdClssObject for we don't know the PCD's datumtype\r
786 # until the DEC parser has been called.\r
787 # \r
6780eef1 788 VpdOffset, MaxDatumSize, InitialValue = AnalyzeVpdPcdData(Setting)\r
e56468c0 789\r
790 SkuInfo = SkuInfoClass(self.SkuName, self.SkuIds[self.SkuName], '', '', '', '', VpdOffset, InitialValue)\r
52302d4d
LG
791 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
792 PcdCName,\r
793 TokenSpaceGuid,\r
794 self._PCD_TYPE_STRING_[Type],\r
795 '',\r
796 '',\r
797 '',\r
798 MaxDatumSize,\r
799 {self.SkuName : SkuInfo},\r
e56468c0 800 False,\r
52302d4d
LG
801 None\r
802 )\r
803 return Pcds\r
804\r
805 ## Add external modules\r
806 #\r
807 # The external modules are mostly those listed in FDF file, which don't\r
808 # need "build".\r
809 #\r
810 # @param FilePath The path of module description file\r
811 #\r
812 def AddModule(self, FilePath):\r
813 FilePath = NormPath(FilePath)\r
814 if FilePath not in self.Modules:\r
815 Module = ModuleBuildClassObject()\r
816 Module.MetaFile = FilePath\r
817 self.Modules.append(Module)\r
818\r
819 ## Add external PCDs\r
820 #\r
821 # The external PCDs are mostly those listed in FDF file to specify address\r
822 # or offset information.\r
823 #\r
824 # @param Name Name of the PCD\r
825 # @param Guid Token space guid of the PCD\r
826 # @param Value Value of the PCD\r
827 #\r
828 def AddPcd(self, Name, Guid, Value):\r
829 if (Name, Guid) not in self.Pcds:\r
e56468c0 830 self.Pcds[Name, Guid] = PcdClassObject(Name, Guid, '', '', '', '', '', {}, False, None)\r
52302d4d
LG
831 self.Pcds[Name, Guid].DefaultValue = Value\r
832\r
0d2711a6 833 _Macros = property(_GetMacros)\r
52302d4d
LG
834 Arch = property(_GetArch, _SetArch)\r
835 Platform = property(_GetPlatformName)\r
836 PlatformName = property(_GetPlatformName)\r
837 Guid = property(_GetFileGuid)\r
838 Version = property(_GetVersion)\r
839 DscSpecification = property(_GetDscSpec)\r
840 OutputDirectory = property(_GetOutpuDir)\r
841 SupArchList = property(_GetSupArch)\r
842 BuildTargets = property(_GetBuildTarget)\r
843 SkuName = property(_GetSkuName, _SetSkuName)\r
844 FlashDefinition = property(_GetFdfFile)\r
845 BuildNumber = property(_GetBuildNumber)\r
846 MakefileName = property(_GetMakefileName)\r
847 BsBaseAddress = property(_GetBsBaseAddress)\r
848 RtBaseAddress = property(_GetRtBaseAddress)\r
849 LoadFixAddress = property(_GetLoadFixAddress)\r
6780eef1
LG
850 RFCLanguages = property(_GetRFCLanguages)\r
851 ISOLanguages = property(_GetISOLanguages)\r
08dd311f 852 VpdToolGuid = property(_GetVpdToolGuid) \r
52302d4d
LG
853 SkuIds = property(_GetSkuIds)\r
854 Modules = property(_GetModules)\r
855 LibraryInstances = property(_GetLibraryInstances)\r
856 LibraryClasses = property(_GetLibraryClasses)\r
857 Pcds = property(_GetPcds)\r
858 BuildOptions = property(_GetBuildOptions)\r
859\r
e56468c0 860## Platform build information from DEC file\r
52302d4d
LG
861#\r
862# This class is used to retrieve information stored in database and convert them\r
863# into PackageBuildClassObject form for easier use for AutoGen.\r
864#\r
865class DecBuildData(PackageBuildClassObject):\r
866 # dict used to convert PCD type in database to string used by build tool\r
867 _PCD_TYPE_STRING_ = {\r
868 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
869 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
870 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
871 MODEL_PCD_DYNAMIC : "Dynamic",\r
872 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
873 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
874 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
875 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
876 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
877 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
878 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
879 }\r
880\r
881 # dict used to convert part of [Defines] to members of DecBuildData directly\r
882 _PROPERTY_ = {\r
883 #\r
884 # Required Fields\r
885 #\r
886 TAB_DEC_DEFINES_PACKAGE_NAME : "_PackageName",\r
887 TAB_DEC_DEFINES_PACKAGE_GUID : "_Guid",\r
888 TAB_DEC_DEFINES_PACKAGE_VERSION : "_Version",\r
e56468c0 889 TAB_DEC_DEFINES_PKG_UNI_FILE : "_PkgUniFile",\r
52302d4d
LG
890 }\r
891\r
892\r
893 ## Constructor of DecBuildData\r
894 #\r
895 # Initialize object of DecBuildData\r
896 #\r
897 # @param FilePath The path of package description file\r
898 # @param RawData The raw data of DEC file\r
899 # @param BuildDataBase Database used to retrieve module information\r
900 # @param Arch The target architecture\r
901 # @param Platform (not used for DecBuildData)\r
902 # @param Macros Macros used for replacement in DSC file\r
903 #\r
0d2711a6 904 def __init__(self, File, RawData, BuildDataBase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
905 self.MetaFile = File\r
906 self._PackageDir = File.Dir\r
907 self._RawData = RawData\r
908 self._Bdb = BuildDataBase\r
909 self._Arch = Arch\r
0d2711a6
LG
910 self._Target = Target\r
911 self._Toolchain = Toolchain\r
52302d4d
LG
912 self._Clear()\r
913\r
914 ## XXX[key] = value\r
915 def __setitem__(self, key, value):\r
916 self.__dict__[self._PROPERTY_[key]] = value\r
917\r
918 ## value = XXX[key]\r
919 def __getitem__(self, key):\r
920 return self.__dict__[self._PROPERTY_[key]]\r
921\r
922 ## "in" test support\r
923 def __contains__(self, key):\r
924 return key in self._PROPERTY_\r
925\r
926 ## Set all internal used members of DecBuildData to None\r
927 def _Clear(self):\r
928 self._Header = None\r
929 self._PackageName = None\r
930 self._Guid = None\r
931 self._Version = None\r
e56468c0 932 self._PkgUniFile = None\r
52302d4d
LG
933 self._Protocols = None\r
934 self._Ppis = None\r
935 self._Guids = None\r
936 self._Includes = None\r
937 self._LibraryClasses = None\r
938 self._Pcds = None\r
0d2711a6
LG
939 self.__Macros = None\r
940\r
941 ## Get current effective macros\r
942 def _GetMacros(self):\r
943 if self.__Macros == None:\r
944 self.__Macros = {}\r
945 self.__Macros.update(GlobalData.gGlobalDefines)\r
946 return self.__Macros\r
52302d4d
LG
947\r
948 ## Get architecture\r
949 def _GetArch(self):\r
950 return self._Arch\r
951\r
952 ## Set architecture\r
953 #\r
954 # Changing the default ARCH to another may affect all other information\r
955 # because all information in a platform may be ARCH-related. That's\r
956 # why we need to clear all internal used members, in order to cause all\r
957 # information to be re-retrieved.\r
958 #\r
959 # @param Value The value of ARCH\r
960 #\r
961 def _SetArch(self, Value):\r
962 if self._Arch == Value:\r
963 return\r
964 self._Arch = Value\r
965 self._Clear()\r
966\r
967 ## Retrieve all information in [Defines] section\r
968 #\r
969 # (Retriving all [Defines] information in one-shot is just to save time.)\r
970 #\r
971 def _GetHeaderInfo(self):\r
0d2711a6 972 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
52302d4d 973 for Record in RecordList:\r
0d2711a6 974 Name = Record[1]\r
52302d4d 975 if Name in self:\r
0d2711a6 976 self[Name] = Record[2]\r
52302d4d
LG
977 self._Header = 'DUMMY'\r
978\r
979 ## Retrieve package name\r
980 def _GetPackageName(self):\r
981 if self._PackageName == None:\r
982 if self._Header == None:\r
983 self._GetHeaderInfo()\r
984 if self._PackageName == None:\r
985 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_NAME", File=self.MetaFile)\r
986 return self._PackageName\r
987\r
988 ## Retrieve file guid\r
989 def _GetFileGuid(self):\r
990 if self._Guid == None:\r
991 if self._Header == None:\r
992 self._GetHeaderInfo()\r
993 if self._Guid == None:\r
994 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_GUID", File=self.MetaFile)\r
995 return self._Guid\r
996\r
997 ## Retrieve package version\r
998 def _GetVersion(self):\r
999 if self._Version == None:\r
1000 if self._Header == None:\r
1001 self._GetHeaderInfo()\r
1002 if self._Version == None:\r
1003 self._Version = ''\r
1004 return self._Version\r
1005\r
1006 ## Retrieve protocol definitions (name/value pairs)\r
1007 def _GetProtocol(self):\r
1008 if self._Protocols == None:\r
1009 #\r
1010 # tdict is a special kind of dict, used for selecting correct\r
1011 # protocol defition for given ARCH\r
1012 #\r
1013 ProtocolDict = tdict(True)\r
1014 NameList = []\r
1015 # find out all protocol definitions for specific and 'common' arch\r
1016 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch]\r
1017 for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
1018 if Name not in NameList:\r
1019 NameList.append(Name)\r
1020 ProtocolDict[Arch, Name] = Guid\r
1021 # use sdict to keep the order\r
1022 self._Protocols = sdict()\r
1023 for Name in NameList:\r
1024 #\r
1025 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1026 # will automatically turn to 'common' ARCH for trying\r
1027 #\r
1028 self._Protocols[Name] = ProtocolDict[self._Arch, Name]\r
1029 return self._Protocols\r
1030\r
1031 ## Retrieve PPI definitions (name/value pairs)\r
1032 def _GetPpi(self):\r
1033 if self._Ppis == None:\r
1034 #\r
1035 # tdict is a special kind of dict, used for selecting correct\r
1036 # PPI defition for given ARCH\r
1037 #\r
1038 PpiDict = tdict(True)\r
1039 NameList = []\r
1040 # find out all PPI definitions for specific arch and 'common' arch\r
1041 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch]\r
1042 for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
1043 if Name not in NameList:\r
1044 NameList.append(Name)\r
1045 PpiDict[Arch, Name] = Guid\r
1046 # use sdict to keep the order\r
1047 self._Ppis = sdict()\r
1048 for Name in NameList:\r
1049 #\r
1050 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1051 # will automatically turn to 'common' ARCH for trying\r
1052 #\r
1053 self._Ppis[Name] = PpiDict[self._Arch, Name]\r
1054 return self._Ppis\r
1055\r
1056 ## Retrieve GUID definitions (name/value pairs)\r
1057 def _GetGuid(self):\r
1058 if self._Guids == None:\r
1059 #\r
1060 # tdict is a special kind of dict, used for selecting correct\r
1061 # GUID defition for given ARCH\r
1062 #\r
1063 GuidDict = tdict(True)\r
1064 NameList = []\r
1065 # find out all protocol definitions for specific and 'common' arch\r
1066 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch]\r
1067 for Name, Guid, Dummy, Arch, ID, LineNo in RecordList:\r
1068 if Name not in NameList:\r
1069 NameList.append(Name)\r
1070 GuidDict[Arch, Name] = Guid\r
1071 # use sdict to keep the order\r
1072 self._Guids = sdict()\r
1073 for Name in NameList:\r
1074 #\r
1075 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1076 # will automatically turn to 'common' ARCH for trying\r
1077 #\r
1078 self._Guids[Name] = GuidDict[self._Arch, Name]\r
1079 return self._Guids\r
1080\r
1081 ## Retrieve public include paths declared in this package\r
1082 def _GetInclude(self):\r
1083 if self._Includes == None:\r
1084 self._Includes = []\r
1085 RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch]\r
0d2711a6
LG
1086 Macros = self._Macros\r
1087 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d
LG
1088 for Record in RecordList:\r
1089 File = PathClass(NormPath(Record[0], Macros), self._PackageDir, Arch=self._Arch)\r
1090 LineNo = Record[-1]\r
1091 # validate the path\r
1092 ErrorCode, ErrorInfo = File.Validate()\r
1093 if ErrorCode != 0:\r
1094 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1095\r
1096 # avoid duplicate include path\r
1097 if File not in self._Includes:\r
1098 self._Includes.append(File)\r
1099 return self._Includes\r
1100\r
1101 ## Retrieve library class declarations (not used in build at present)\r
1102 def _GetLibraryClass(self):\r
1103 if self._LibraryClasses == None:\r
1104 #\r
1105 # tdict is a special kind of dict, used for selecting correct\r
1106 # library class declaration for given ARCH\r
1107 #\r
1108 LibraryClassDict = tdict(True)\r
1109 LibraryClassSet = set()\r
1110 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch]\r
0d2711a6 1111 Macros = self._Macros\r
52302d4d
LG
1112 for LibraryClass, File, Dummy, Arch, ID, LineNo in RecordList:\r
1113 File = PathClass(NormPath(File, Macros), self._PackageDir, Arch=self._Arch)\r
1114 # check the file validation\r
1115 ErrorCode, ErrorInfo = File.Validate()\r
1116 if ErrorCode != 0:\r
1117 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1118 LibraryClassSet.add(LibraryClass)\r
1119 LibraryClassDict[Arch, LibraryClass] = File\r
1120 self._LibraryClasses = sdict()\r
1121 for LibraryClass in LibraryClassSet:\r
1122 self._LibraryClasses[LibraryClass] = LibraryClassDict[self._Arch, LibraryClass]\r
1123 return self._LibraryClasses\r
1124\r
1125 ## Retrieve PCD declarations\r
1126 def _GetPcds(self):\r
1127 if self._Pcds == None:\r
0d2711a6 1128 self._Pcds = sdict()\r
52302d4d
LG
1129 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
1130 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
1131 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
1132 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
1133 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
1134 return self._Pcds\r
1135\r
1136 ## Retrieve PCD declarations for given type\r
1137 def _GetPcd(self, Type):\r
0d2711a6 1138 Pcds = sdict()\r
52302d4d
LG
1139 #\r
1140 # tdict is a special kind of dict, used for selecting correct\r
1141 # PCD declaration for given ARCH\r
1142 #\r
1143 PcdDict = tdict(True, 3)\r
1144 # for summarizing PCD\r
1145 PcdSet = set()\r
1146 # find out all PCDs of the 'type'\r
1147 RecordList = self._RawData[Type, self._Arch]\r
1148 for TokenSpaceGuid, PcdCName, Setting, Arch, Dummy1, Dummy2 in RecordList:\r
1149 PcdDict[Arch, PcdCName, TokenSpaceGuid] = Setting\r
1150 PcdSet.add((PcdCName, TokenSpaceGuid))\r
1151\r
1152 for PcdCName, TokenSpaceGuid in PcdSet:\r
52302d4d
LG
1153 #\r
1154 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1155 # will automatically turn to 'common' ARCH and try again\r
1156 #\r
1157 Setting = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
1158 if Setting == None:\r
1159 continue\r
6780eef1
LG
1160\r
1161 DefaultValue, DatumType, TokenNumber = AnalyzePcdData(Setting)\r
1162 \r
52302d4d
LG
1163 Pcds[PcdCName, TokenSpaceGuid, self._PCD_TYPE_STRING_[Type]] = PcdClassObject(\r
1164 PcdCName,\r
1165 TokenSpaceGuid,\r
1166 self._PCD_TYPE_STRING_[Type],\r
1167 DatumType,\r
1168 DefaultValue,\r
1169 TokenNumber,\r
1170 '',\r
1171 {},\r
e56468c0 1172 False,\r
52302d4d
LG
1173 None\r
1174 )\r
1175 return Pcds\r
1176\r
1177\r
0d2711a6 1178 _Macros = property(_GetMacros)\r
52302d4d
LG
1179 Arch = property(_GetArch, _SetArch)\r
1180 PackageName = property(_GetPackageName)\r
1181 Guid = property(_GetFileGuid)\r
1182 Version = property(_GetVersion)\r
1183\r
1184 Protocols = property(_GetProtocol)\r
1185 Ppis = property(_GetPpi)\r
1186 Guids = property(_GetGuid)\r
1187 Includes = property(_GetInclude)\r
1188 LibraryClasses = property(_GetLibraryClass)\r
1189 Pcds = property(_GetPcds)\r
1190\r
1191## Module build information from INF file\r
1192#\r
1193# This class is used to retrieve information stored in database and convert them\r
1194# into ModuleBuildClassObject form for easier use for AutoGen.\r
1195#\r
1196class InfBuildData(ModuleBuildClassObject):\r
1197 # dict used to convert PCD type in database to string used by build tool\r
1198 _PCD_TYPE_STRING_ = {\r
1199 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
1200 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
1201 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
1202 MODEL_PCD_DYNAMIC : "Dynamic",\r
1203 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
1204 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
1205 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
1206 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
1207 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
1208 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
1209 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
1210 }\r
1211\r
1212 # dict used to convert part of [Defines] to members of InfBuildData directly\r
1213 _PROPERTY_ = {\r
1214 #\r
1215 # Required Fields\r
1216 #\r
1217 TAB_INF_DEFINES_BASE_NAME : "_BaseName",\r
1218 TAB_INF_DEFINES_FILE_GUID : "_Guid",\r
1219 TAB_INF_DEFINES_MODULE_TYPE : "_ModuleType",\r
1220 #\r
1221 # Optional Fields\r
1222 #\r
0d2711a6 1223 #TAB_INF_DEFINES_INF_VERSION : "_AutoGenVersion",\r
52302d4d
LG
1224 TAB_INF_DEFINES_COMPONENT_TYPE : "_ComponentType",\r
1225 TAB_INF_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
1226 #TAB_INF_DEFINES_CUSTOM_MAKEFILE : "_CustomMakefile",\r
b36d134f 1227 TAB_INF_DEFINES_DPX_SOURCE :"_DxsFile",\r
52302d4d
LG
1228 TAB_INF_DEFINES_VERSION_NUMBER : "_Version",\r
1229 TAB_INF_DEFINES_VERSION_STRING : "_Version",\r
1230 TAB_INF_DEFINES_VERSION : "_Version",\r
1231 TAB_INF_DEFINES_PCD_IS_DRIVER : "_PcdIsDriver",\r
1232 TAB_INF_DEFINES_SHADOW : "_Shadow",\r
1233\r
1234 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH : "_SourceOverridePath",\r
1235 }\r
1236\r
1237 # dict used to convert Component type to Module type\r
1238 _MODULE_TYPE_ = {\r
1239 "LIBRARY" : "BASE",\r
1240 "SECURITY_CORE" : "SEC",\r
1241 "PEI_CORE" : "PEI_CORE",\r
1242 "COMBINED_PEIM_DRIVER" : "PEIM",\r
1243 "PIC_PEIM" : "PEIM",\r
1244 "RELOCATABLE_PEIM" : "PEIM",\r
1245 "PE32_PEIM" : "PEIM",\r
1246 "BS_DRIVER" : "DXE_DRIVER",\r
1247 "RT_DRIVER" : "DXE_RUNTIME_DRIVER",\r
1248 "SAL_RT_DRIVER" : "DXE_SAL_DRIVER",\r
1249 "DXE_SMM_DRIVER" : "DXE_SMM_DRIVER",\r
1250 # "SMM_DRIVER" : "DXE_SMM_DRIVER",\r
1251 # "BS_DRIVER" : "DXE_SMM_DRIVER",\r
1252 # "BS_DRIVER" : "UEFI_DRIVER",\r
1253 "APPLICATION" : "UEFI_APPLICATION",\r
1254 "LOGO" : "BASE",\r
1255 }\r
1256\r
1257 # regular expression for converting XXX_FLAGS in [nmake] section to new type\r
1258 _NMAKE_FLAG_PATTERN_ = re.compile("(?:EBC_)?([A-Z]+)_(?:STD_|PROJ_|ARCH_)?FLAGS(?:_DLL|_ASL|_EXE)?", re.UNICODE)\r
1259 # dict used to convert old tool name used in [nmake] section to new ones\r
1260 _TOOL_CODE_ = {\r
1261 "C" : "CC",\r
1262 "LIB" : "SLINK",\r
1263 "LINK" : "DLINK",\r
1264 }\r
1265\r
1266\r
1267 ## Constructor of DscBuildData\r
1268 #\r
1269 # Initialize object of DscBuildData\r
1270 #\r
1271 # @param FilePath The path of platform description file\r
1272 # @param RawData The raw data of DSC file\r
1273 # @param BuildDataBase Database used to retrieve module/package information\r
1274 # @param Arch The target architecture\r
1275 # @param Platform The name of platform employing this module\r
1276 # @param Macros Macros used for replacement in DSC file\r
1277 #\r
0d2711a6 1278 def __init__(self, FilePath, RawData, BuildDatabase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
1279 self.MetaFile = FilePath\r
1280 self._ModuleDir = FilePath.Dir\r
1281 self._RawData = RawData\r
1282 self._Bdb = BuildDatabase\r
1283 self._Arch = Arch\r
0d2711a6
LG
1284 self._Target = Target\r
1285 self._Toolchain = Toolchain\r
52302d4d 1286 self._Platform = 'COMMON'\r
52302d4d
LG
1287 self._SourceOverridePath = None\r
1288 if FilePath.Key in GlobalData.gOverrideDir:\r
1289 self._SourceOverridePath = GlobalData.gOverrideDir[FilePath.Key]\r
1290 self._Clear()\r
1291\r
1292 ## XXX[key] = value\r
1293 def __setitem__(self, key, value):\r
1294 self.__dict__[self._PROPERTY_[key]] = value\r
1295\r
1296 ## value = XXX[key]\r
1297 def __getitem__(self, key):\r
1298 return self.__dict__[self._PROPERTY_[key]]\r
1299\r
1300 ## "in" test support\r
1301 def __contains__(self, key):\r
1302 return key in self._PROPERTY_\r
1303\r
1304 ## Set all internal used members of InfBuildData to None\r
1305 def _Clear(self):\r
1306 self._Header_ = None\r
1307 self._AutoGenVersion = None\r
1308 self._BaseName = None\r
b36d134f 1309 self._DxsFile = None\r
52302d4d
LG
1310 self._ModuleType = None\r
1311 self._ComponentType = None\r
1312 self._BuildType = None\r
1313 self._Guid = None\r
1314 self._Version = None\r
1315 self._PcdIsDriver = None\r
1316 self._BinaryModule = None\r
1317 self._Shadow = None\r
1318 self._MakefileName = None\r
1319 self._CustomMakefile = None\r
1320 self._Specification = None\r
1321 self._LibraryClass = None\r
1322 self._ModuleEntryPointList = None\r
1323 self._ModuleUnloadImageList = None\r
1324 self._ConstructorList = None\r
1325 self._DestructorList = None\r
1326 self._Defs = None\r
1327 self._Binaries = None\r
1328 self._Sources = None\r
1329 self._LibraryClasses = None\r
1330 self._Libraries = None\r
1331 self._Protocols = None\r
1332 self._Ppis = None\r
1333 self._Guids = None\r
1334 self._Includes = None\r
1335 self._Packages = None\r
1336 self._Pcds = None\r
1337 self._BuildOptions = None\r
1338 self._Depex = None\r
1339 self._DepexExpression = None\r
0d2711a6
LG
1340 self.__Macros = None\r
1341\r
1342 ## Get current effective macros\r
1343 def _GetMacros(self):\r
1344 if self.__Macros == None:\r
1345 self.__Macros = {}\r
1346 # EDK_GLOBAL defined macros can be applied to EDK modoule\r
1347 if self.AutoGenVersion < 0x00010005:\r
1348 self.__Macros.update(GlobalData.gEdkGlobal)\r
1349 self.__Macros.update(GlobalData.gGlobalDefines)\r
1350 return self.__Macros\r
52302d4d
LG
1351\r
1352 ## Get architecture\r
1353 def _GetArch(self):\r
1354 return self._Arch\r
1355\r
1356 ## Set architecture\r
1357 #\r
1358 # Changing the default ARCH to another may affect all other information\r
1359 # because all information in a platform may be ARCH-related. That's\r
1360 # why we need to clear all internal used members, in order to cause all\r
1361 # information to be re-retrieved.\r
1362 #\r
1363 # @param Value The value of ARCH\r
1364 #\r
1365 def _SetArch(self, Value):\r
1366 if self._Arch == Value:\r
1367 return\r
1368 self._Arch = Value\r
1369 self._Clear()\r
1370\r
1371 ## Return the name of platform employing this module\r
1372 def _GetPlatform(self):\r
1373 return self._Platform\r
1374\r
1375 ## Change the name of platform employing this module\r
1376 #\r
1377 # Changing the default name of platform to another may affect some information\r
1378 # because they may be PLATFORM-related. That's why we need to clear all internal\r
1379 # used members, in order to cause all information to be re-retrieved.\r
1380 #\r
1381 def _SetPlatform(self, Value):\r
1382 if self._Platform == Value:\r
1383 return\r
1384 self._Platform = Value\r
1385 self._Clear()\r
1386\r
1387 ## Retrieve all information in [Defines] section\r
1388 #\r
1389 # (Retriving all [Defines] information in one-shot is just to save time.)\r
1390 #\r
1391 def _GetHeaderInfo(self):\r
1392 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
1393 for Record in RecordList:\r
0d2711a6 1394 Name, Value = Record[1], ReplaceMacro(Record[2], self._Macros, False)\r
52302d4d
LG
1395 # items defined _PROPERTY_ don't need additional processing\r
1396 if Name in self:\r
0d2711a6 1397 self[Name] = Value\r
52302d4d 1398 # some special items in [Defines] section need special treatment\r
08dd311f
LG
1399 elif Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION', 'EDK_RELEASE_VERSION', 'PI_SPECIFICATION_VERSION'):\r
1400 if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):\r
1401 Name = 'UEFI_SPECIFICATION_VERSION'\r
52302d4d
LG
1402 if self._Specification == None:\r
1403 self._Specification = sdict()\r
0d2711a6 1404 self._Specification[Name] = GetHexVerValue(Value)\r
08dd311f
LG
1405 if self._Specification[Name] == None:\r
1406 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
0d2711a6 1407 "'%s' format is not supported for %s" % (Value, Name),\r
08dd311f 1408 File=self.MetaFile, Line=Record[-1])\r
52302d4d
LG
1409 elif Name == 'LIBRARY_CLASS':\r
1410 if self._LibraryClass == None:\r
1411 self._LibraryClass = []\r
0d2711a6 1412 ValueList = GetSplitValueList(Value)\r
52302d4d
LG
1413 LibraryClass = ValueList[0]\r
1414 if len(ValueList) > 1:\r
1415 SupModuleList = GetSplitValueList(ValueList[1], ' ')\r
1416 else:\r
1417 SupModuleList = SUP_MODULE_LIST\r
1418 self._LibraryClass.append(LibraryClassObject(LibraryClass, SupModuleList))\r
1419 elif Name == 'ENTRY_POINT':\r
1420 if self._ModuleEntryPointList == None:\r
1421 self._ModuleEntryPointList = []\r
0d2711a6 1422 self._ModuleEntryPointList.append(Value)\r
52302d4d
LG
1423 elif Name == 'UNLOAD_IMAGE':\r
1424 if self._ModuleUnloadImageList == None:\r
1425 self._ModuleUnloadImageList = []\r
0d2711a6 1426 if not Value:\r
52302d4d 1427 continue\r
0d2711a6 1428 self._ModuleUnloadImageList.append(Value)\r
52302d4d
LG
1429 elif Name == 'CONSTRUCTOR':\r
1430 if self._ConstructorList == None:\r
1431 self._ConstructorList = []\r
0d2711a6 1432 if not Value:\r
52302d4d 1433 continue\r
0d2711a6 1434 self._ConstructorList.append(Value)\r
52302d4d
LG
1435 elif Name == 'DESTRUCTOR':\r
1436 if self._DestructorList == None:\r
1437 self._DestructorList = []\r
0d2711a6 1438 if not Value:\r
52302d4d 1439 continue\r
0d2711a6 1440 self._DestructorList.append(Value)\r
52302d4d 1441 elif Name == TAB_INF_DEFINES_CUSTOM_MAKEFILE:\r
0d2711a6 1442 TokenList = GetSplitValueList(Value)\r
52302d4d
LG
1443 if self._CustomMakefile == None:\r
1444 self._CustomMakefile = {}\r
1445 if len(TokenList) < 2:\r
1446 self._CustomMakefile['MSFT'] = TokenList[0]\r
1447 self._CustomMakefile['GCC'] = TokenList[0]\r
1448 else:\r
1449 if TokenList[0] not in ['MSFT', 'GCC']:\r
1450 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
1451 "No supported family [%s]" % TokenList[0],\r
1452 File=self.MetaFile, Line=Record[-1])\r
1453 self._CustomMakefile[TokenList[0]] = TokenList[1]\r
1454 else:\r
1455 if self._Defs == None:\r
1456 self._Defs = sdict()\r
0d2711a6 1457 self._Defs[Name] = Value\r
52302d4d
LG
1458\r
1459 #\r
0d2711a6 1460 # Retrieve information in sections specific to Edk.x modules\r
52302d4d 1461 #\r
0d2711a6 1462 if self.AutoGenVersion >= 0x00010005:\r
52302d4d
LG
1463 if not self._ModuleType:\r
1464 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
1465 "MODULE_TYPE is not given", File=self.MetaFile)\r
da92f276
LG
1466 if self._ModuleType not in SUP_MODULE_LIST:\r
1467 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
1468 for Record in RecordList:\r
0d2711a6 1469 Name = Record[1]\r
da92f276
LG
1470 if Name == "MODULE_TYPE":\r
1471 LineNo = Record[6]\r
1472 break\r
1473 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
1474 "MODULE_TYPE %s is not supported for EDK II, valid values are:\n %s" % (self._ModuleType,' '.join(l for l in SUP_MODULE_LIST)), \r
0d2711a6 1475 File=self.MetaFile, Line=LineNo)\r
da92f276 1476 if (self._Specification == None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x0001000A):\r
52302d4d
LG
1477 if self._ModuleType == SUP_MODULE_SMM_CORE:\r
1478 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "SMM_CORE module type can't be used in the module with PI_SPECIFICATION_VERSION less than 0x0001000A", File=self.MetaFile) \r
1479 if self._Defs and 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
1480 and 'PCI_CLASS_CODE' in self._Defs:\r
1481 self._BuildType = 'UEFI_OPTIONROM'\r
1482 elif self._Defs and 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
1483 and self._Defs['UEFI_HII_RESOURCE_SECTION'] == 'TRUE':\r
1484 self._BuildType = 'UEFI_HII'\r
1485 else:\r
1486 self._BuildType = self._ModuleType.upper()\r
b36d134f
LG
1487 \r
1488 if self._DxsFile:\r
1489 File = PathClass(NormPath(self._DxsFile), self._ModuleDir, Arch=self._Arch)\r
1490 # check the file validation\r
1491 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
1492 if ErrorCode != 0:\r
1493 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
1494 File=self.MetaFile, Line=LineNo)\r
1495 if self.Sources == None:\r
1496 self._Sources = []\r
1497 self._Sources.append(File)\r
0d2711a6 1498 else: \r
52302d4d
LG
1499 if not self._ComponentType:\r
1500 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
1501 "COMPONENT_TYPE is not given", File=self.MetaFile)\r
0d2711a6 1502 self._BuildType = self._ComponentType.upper() \r
52302d4d
LG
1503 if self._ComponentType in self._MODULE_TYPE_:\r
1504 self._ModuleType = self._MODULE_TYPE_[self._ComponentType]\r
1505 if self._ComponentType == 'LIBRARY':\r
1506 self._LibraryClass = [LibraryClassObject(self._BaseName, SUP_MODULE_LIST)]\r
1507 # make use some [nmake] section macros\r
0d2711a6
LG
1508 Macros = self._Macros\r
1509 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
1510 Macros['PROCESSOR'] = self._Arch\r
52302d4d
LG
1511 RecordList = self._RawData[MODEL_META_DATA_NMAKE, self._Arch, self._Platform]\r
1512 for Name,Value,Dummy,Arch,Platform,ID,LineNo in RecordList:\r
0d2711a6 1513 Value = ReplaceMacro(Value, Macros, True)\r
52302d4d
LG
1514 if Name == "IMAGE_ENTRY_POINT":\r
1515 if self._ModuleEntryPointList == None:\r
1516 self._ModuleEntryPointList = []\r
1517 self._ModuleEntryPointList.append(Value)\r
1518 elif Name == "DPX_SOURCE":\r
0d2711a6 1519 File = PathClass(NormPath(Value), self._ModuleDir, Arch=self._Arch)\r
52302d4d
LG
1520 # check the file validation\r
1521 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
1522 if ErrorCode != 0:\r
1523 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
1524 File=self.MetaFile, Line=LineNo)\r
1525 if self.Sources == None:\r
1526 self._Sources = []\r
1527 self._Sources.append(File)\r
1528 else:\r
1529 ToolList = self._NMAKE_FLAG_PATTERN_.findall(Name)\r
1530 if len(ToolList) == 0 or len(ToolList) != 1:\r
1531 pass\r
1532# EdkLogger.warn("build", "Don't know how to do with macro [%s]" % Name,\r
1533# File=self.MetaFile, Line=LineNo)\r
1534 else:\r
1535 if self._BuildOptions == None:\r
1536 self._BuildOptions = sdict()\r
1537\r
1538 if ToolList[0] in self._TOOL_CODE_:\r
1539 Tool = self._TOOL_CODE_[ToolList[0]]\r
1540 else:\r
1541 Tool = ToolList[0]\r
1542 ToolChain = "*_*_*_%s_FLAGS" % Tool\r
0d2711a6 1543 ToolChainFamily = 'MSFT' # Edk.x only support MSFT tool chain\r
52302d4d 1544 #ignore not replaced macros in value\r
0d2711a6 1545 ValueList = GetSplitList(' ' + Value, '/D')\r
52302d4d
LG
1546 Dummy = ValueList[0]\r
1547 for Index in range(1, len(ValueList)):\r
1548 if ValueList[Index][-1] == '=' or ValueList[Index] == '':\r
1549 continue\r
1550 Dummy = Dummy + ' /D ' + ValueList[Index]\r
1551 Value = Dummy.strip()\r
1552 if (ToolChainFamily, ToolChain) not in self._BuildOptions:\r
1553 self._BuildOptions[ToolChainFamily, ToolChain] = Value\r
1554 else:\r
1555 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
1556 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Value\r
1557 # set _Header to non-None in order to avoid database re-querying\r
1558 self._Header_ = 'DUMMY'\r
1559\r
1560 ## Retrieve file version\r
1561 def _GetInfVersion(self):\r
1562 if self._AutoGenVersion == None:\r
0d2711a6
LG
1563 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
1564 for Record in RecordList:\r
1565 if Record[1] == TAB_INF_DEFINES_INF_VERSION:\r
1566 self._AutoGenVersion = int(Record[2], 0)\r
1567 break\r
52302d4d
LG
1568 if self._AutoGenVersion == None:\r
1569 self._AutoGenVersion = 0x00010000\r
1570 return self._AutoGenVersion\r
1571\r
1572 ## Retrieve BASE_NAME\r
1573 def _GetBaseName(self):\r
1574 if self._BaseName == None:\r
1575 if self._Header_ == None:\r
1576 self._GetHeaderInfo()\r
1577 if self._BaseName == None:\r
1578 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No BASE_NAME name", File=self.MetaFile)\r
1579 return self._BaseName\r
1580\r
b36d134f
LG
1581 ## Retrieve DxsFile\r
1582 def _GetDxsFile(self):\r
1583 if self._DxsFile == None:\r
1584 if self._Header_ == None:\r
1585 self._GetHeaderInfo()\r
1586 if self._DxsFile == None:\r
1587 self._DxsFile = ''\r
1588 return self._DxsFile\r
1589\r
52302d4d
LG
1590 ## Retrieve MODULE_TYPE\r
1591 def _GetModuleType(self):\r
1592 if self._ModuleType == None:\r
1593 if self._Header_ == None:\r
1594 self._GetHeaderInfo()\r
1595 if self._ModuleType == None:\r
1596 self._ModuleType = 'BASE'\r
1597 if self._ModuleType not in SUP_MODULE_LIST:\r
1598 self._ModuleType = "USER_DEFINED"\r
1599 return self._ModuleType\r
1600\r
1601 ## Retrieve COMPONENT_TYPE\r
1602 def _GetComponentType(self):\r
1603 if self._ComponentType == None:\r
1604 if self._Header_ == None:\r
1605 self._GetHeaderInfo()\r
1606 if self._ComponentType == None:\r
1607 self._ComponentType = 'USER_DEFINED'\r
1608 return self._ComponentType\r
1609\r
1610 ## Retrieve "BUILD_TYPE"\r
1611 def _GetBuildType(self):\r
1612 if self._BuildType == None:\r
1613 if self._Header_ == None:\r
1614 self._GetHeaderInfo()\r
1615 if not self._BuildType:\r
1616 self._BuildType = "BASE"\r
1617 return self._BuildType\r
1618\r
1619 ## Retrieve file guid\r
1620 def _GetFileGuid(self):\r
1621 if self._Guid == None:\r
1622 if self._Header_ == None:\r
1623 self._GetHeaderInfo()\r
1624 if self._Guid == None:\r
1625 self._Guid = '00000000-0000-0000-000000000000'\r
1626 return self._Guid\r
1627\r
1628 ## Retrieve module version\r
1629 def _GetVersion(self):\r
1630 if self._Version == None:\r
1631 if self._Header_ == None:\r
1632 self._GetHeaderInfo()\r
1633 if self._Version == None:\r
1634 self._Version = '0.0'\r
1635 return self._Version\r
1636\r
1637 ## Retrieve PCD_IS_DRIVER\r
1638 def _GetPcdIsDriver(self):\r
1639 if self._PcdIsDriver == None:\r
1640 if self._Header_ == None:\r
1641 self._GetHeaderInfo()\r
1642 if self._PcdIsDriver == None:\r
1643 self._PcdIsDriver = ''\r
1644 return self._PcdIsDriver\r
1645\r
1646 ## Retrieve SHADOW\r
1647 def _GetShadow(self):\r
1648 if self._Shadow == None:\r
1649 if self._Header_ == None:\r
1650 self._GetHeaderInfo()\r
1651 if self._Shadow != None and self._Shadow.upper() == 'TRUE':\r
1652 self._Shadow = True\r
1653 else:\r
1654 self._Shadow = False\r
1655 return self._Shadow\r
1656\r
1657 ## Retrieve CUSTOM_MAKEFILE\r
1658 def _GetMakefile(self):\r
1659 if self._CustomMakefile == None:\r
1660 if self._Header_ == None:\r
1661 self._GetHeaderInfo()\r
1662 if self._CustomMakefile == None:\r
1663 self._CustomMakefile = {}\r
1664 return self._CustomMakefile\r
1665\r
1666 ## Retrieve EFI_SPECIFICATION_VERSION\r
1667 def _GetSpec(self):\r
1668 if self._Specification == None:\r
1669 if self._Header_ == None:\r
1670 self._GetHeaderInfo()\r
1671 if self._Specification == None:\r
1672 self._Specification = {}\r
1673 return self._Specification\r
1674\r
1675 ## Retrieve LIBRARY_CLASS\r
1676 def _GetLibraryClass(self):\r
1677 if self._LibraryClass == None:\r
1678 if self._Header_ == None:\r
1679 self._GetHeaderInfo()\r
1680 if self._LibraryClass == None:\r
1681 self._LibraryClass = []\r
1682 return self._LibraryClass\r
1683\r
1684 ## Retrieve ENTRY_POINT\r
1685 def _GetEntryPoint(self):\r
1686 if self._ModuleEntryPointList == None:\r
1687 if self._Header_ == None:\r
1688 self._GetHeaderInfo()\r
1689 if self._ModuleEntryPointList == None:\r
1690 self._ModuleEntryPointList = []\r
1691 return self._ModuleEntryPointList\r
1692\r
1693 ## Retrieve UNLOAD_IMAGE\r
1694 def _GetUnloadImage(self):\r
1695 if self._ModuleUnloadImageList == None:\r
1696 if self._Header_ == None:\r
1697 self._GetHeaderInfo()\r
1698 if self._ModuleUnloadImageList == None:\r
1699 self._ModuleUnloadImageList = []\r
1700 return self._ModuleUnloadImageList\r
1701\r
1702 ## Retrieve CONSTRUCTOR\r
1703 def _GetConstructor(self):\r
1704 if self._ConstructorList == None:\r
1705 if self._Header_ == None:\r
1706 self._GetHeaderInfo()\r
1707 if self._ConstructorList == None:\r
1708 self._ConstructorList = []\r
1709 return self._ConstructorList\r
1710\r
1711 ## Retrieve DESTRUCTOR\r
1712 def _GetDestructor(self):\r
1713 if self._DestructorList == None:\r
1714 if self._Header_ == None:\r
1715 self._GetHeaderInfo()\r
1716 if self._DestructorList == None:\r
1717 self._DestructorList = []\r
1718 return self._DestructorList\r
1719\r
1720 ## Retrieve definies other than above ones\r
1721 def _GetDefines(self):\r
1722 if self._Defs == None:\r
1723 if self._Header_ == None:\r
1724 self._GetHeaderInfo()\r
1725 if self._Defs == None:\r
1726 self._Defs = sdict()\r
1727 return self._Defs\r
1728\r
1729 ## Retrieve binary files\r
1730 def _GetBinaryFiles(self):\r
1731 if self._Binaries == None:\r
1732 self._Binaries = []\r
1733 RecordList = self._RawData[MODEL_EFI_BINARY_FILE, self._Arch, self._Platform]\r
0d2711a6
LG
1734 Macros = self._Macros\r
1735 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
1736 Macros['PROCESSOR'] = self._Arch\r
52302d4d 1737 for Record in RecordList:\r
52302d4d
LG
1738 FileType = Record[0]\r
1739 LineNo = Record[-1]\r
1740 Target = 'COMMON'\r
1741 FeatureFlag = []\r
1742 if Record[2]:\r
1743 TokenList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
1744 if TokenList:\r
1745 Target = TokenList[0]\r
1746 if len(TokenList) > 1:\r
1747 FeatureFlag = Record[1:]\r
1748\r
1749 File = PathClass(NormPath(Record[1], Macros), self._ModuleDir, '', FileType, True, self._Arch, '', Target)\r
1750 # check the file validation\r
1751 ErrorCode, ErrorInfo = File.Validate()\r
1752 if ErrorCode != 0:\r
1753 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1754 self._Binaries.append(File)\r
1755 return self._Binaries\r
1756\r
1757 ## Retrieve source files\r
1758 def _GetSourceFiles(self):\r
1759 if self._Sources == None:\r
1760 self._Sources = []\r
1761 RecordList = self._RawData[MODEL_EFI_SOURCE_FILE, self._Arch, self._Platform]\r
0d2711a6
LG
1762 Macros = self._Macros\r
1763 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
1764 Macros['PROCESSOR'] = self._Arch\r
52302d4d 1765 for Record in RecordList:\r
52302d4d
LG
1766 LineNo = Record[-1]\r
1767 ToolChainFamily = Record[1]\r
1768 TagName = Record[2]\r
1769 ToolCode = Record[3]\r
1770 FeatureFlag = Record[4]\r
0d2711a6
LG
1771 if self.AutoGenVersion < 0x00010005:\r
1772 # old module source files (Edk)\r
52302d4d
LG
1773 File = PathClass(NormPath(Record[0], Macros), self._ModuleDir, self._SourceOverridePath,\r
1774 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
1775 # check the file validation\r
1776 ErrorCode, ErrorInfo = File.Validate(CaseSensitive=False)\r
1777 if ErrorCode != 0:\r
1778 if File.Ext.lower() == '.h':\r
1779 EdkLogger.warn('build', 'Include file not found', ExtraData=ErrorInfo,\r
1780 File=self.MetaFile, Line=LineNo)\r
1781 continue\r
1782 else:\r
1783 EdkLogger.error('build', ErrorCode, ExtraData=File, File=self.MetaFile, Line=LineNo)\r
1784 else:\r
1785 File = PathClass(NormPath(Record[0], Macros), self._ModuleDir, '',\r
1786 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
1787 # check the file validation\r
1788 ErrorCode, ErrorInfo = File.Validate()\r
1789 if ErrorCode != 0:\r
1790 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1791\r
1792 self._Sources.append(File)\r
1793 return self._Sources\r
1794\r
1795 ## Retrieve library classes employed by this module\r
1796 def _GetLibraryClassUses(self):\r
1797 if self._LibraryClasses == None:\r
1798 self._LibraryClasses = sdict()\r
1799 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, self._Platform]\r
1800 for Record in RecordList:\r
52302d4d
LG
1801 Lib = Record[0]\r
1802 Instance = Record[1]\r
0d2711a6 1803 if Instance:\r
52302d4d
LG
1804 Instance = NormPath(Instance, self._Macros)\r
1805 self._LibraryClasses[Lib] = Instance\r
1806 return self._LibraryClasses\r
1807\r
0d2711a6 1808 ## Retrieve library names (for Edk.x style of modules)\r
52302d4d
LG
1809 def _GetLibraryNames(self):\r
1810 if self._Libraries == None:\r
1811 self._Libraries = []\r
1812 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch, self._Platform]\r
1813 for Record in RecordList:\r
0d2711a6
LG
1814 LibraryName = ReplaceMacro(Record[0], self._Macros, False)\r
1815 # in case of name with '.lib' extension, which is unusual in Edk.x inf\r
1816 LibraryName = os.path.splitext(LibraryName)[0]\r
52302d4d
LG
1817 if LibraryName not in self._Libraries:\r
1818 self._Libraries.append(LibraryName)\r
1819 return self._Libraries\r
1820\r
1821 ## Retrieve protocols consumed/produced by this module\r
1822 def _GetProtocols(self):\r
1823 if self._Protocols == None:\r
1824 self._Protocols = sdict()\r
1825 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]\r
1826 for Record in RecordList:\r
1827 CName = Record[0]\r
1828 Value = ProtocolValue(CName, self.Packages)\r
1829 if Value == None:\r
1830 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
1831 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
1832 "Value of Protocol [%s] is not found under [Protocols] section in" % CName,\r
1833 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
1834 self._Protocols[CName] = Value\r
1835 return self._Protocols\r
1836\r
1837 ## Retrieve PPIs consumed/produced by this module\r
1838 def _GetPpis(self):\r
1839 if self._Ppis == None:\r
1840 self._Ppis = sdict()\r
1841 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]\r
1842 for Record in RecordList:\r
1843 CName = Record[0]\r
1844 Value = PpiValue(CName, self.Packages)\r
1845 if Value == None:\r
1846 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
1847 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
1848 "Value of PPI [%s] is not found under [Ppis] section in " % CName,\r
1849 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
1850 self._Ppis[CName] = Value\r
1851 return self._Ppis\r
1852\r
1853 ## Retrieve GUIDs consumed/produced by this module\r
1854 def _GetGuids(self):\r
1855 if self._Guids == None:\r
1856 self._Guids = sdict()\r
1857 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]\r
1858 for Record in RecordList:\r
1859 CName = Record[0]\r
1860 Value = GuidValue(CName, self.Packages)\r
1861 if Value == None:\r
1862 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
1863 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
1864 "Value of Guid [%s] is not found under [Guids] section in" % CName,\r
1865 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
1866 self._Guids[CName] = Value\r
1867 return self._Guids\r
1868\r
0d2711a6 1869 ## Retrieve include paths necessary for this module (for Edk.x style of modules)\r
52302d4d
LG
1870 def _GetIncludes(self):\r
1871 if self._Includes == None:\r
1872 self._Includes = []\r
1873 if self._SourceOverridePath:\r
1874 self._Includes.append(self._SourceOverridePath)\r
0d2711a6
LG
1875\r
1876 Macros = self._Macros\r
1877 if 'PROCESSOR' in GlobalData.gEdkGlobal.keys():\r
1878 Macros['PROCESSOR'] = GlobalData.gEdkGlobal['PROCESSOR']\r
1879 else:\r
1880 Macros['PROCESSOR'] = self._Arch\r
52302d4d 1881 RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch, self._Platform]\r
52302d4d 1882 for Record in RecordList:\r
52302d4d 1883 if Record[0].find('EDK_SOURCE') > -1:\r
0d2711a6
LG
1884 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
1885 File = NormPath(Record[0], self._Macros)\r
52302d4d
LG
1886 if File[0] == '.':\r
1887 File = os.path.join(self._ModuleDir, File)\r
1888 else:\r
1889 File = os.path.join(GlobalData.gWorkspace, File)\r
1890 File = RealPath(os.path.normpath(File))\r
1891 if File:\r
1892 self._Includes.append(File)\r
1893\r
1894 #TRICK: let compiler to choose correct header file\r
0d2711a6
LG
1895 Macros['EDK_SOURCE'] = GlobalData.gEdkSource\r
1896 File = NormPath(Record[0], self._Macros)\r
52302d4d
LG
1897 if File[0] == '.':\r
1898 File = os.path.join(self._ModuleDir, File)\r
1899 else:\r
1900 File = os.path.join(GlobalData.gWorkspace, File)\r
1901 File = RealPath(os.path.normpath(File))\r
1902 if File:\r
1903 self._Includes.append(File)\r
1904 else:\r
0d2711a6 1905 File = NormPath(Record[0], Macros)\r
52302d4d
LG
1906 if File[0] == '.':\r
1907 File = os.path.join(self._ModuleDir, File)\r
1908 else:\r
1909 File = os.path.join(GlobalData.gWorkspace, File)\r
1910 File = RealPath(os.path.normpath(File))\r
1911 if File:\r
1912 self._Includes.append(File)\r
1913 return self._Includes\r
1914\r
1915 ## Retrieve packages this module depends on\r
1916 def _GetPackages(self):\r
1917 if self._Packages == None:\r
1918 self._Packages = []\r
1919 RecordList = self._RawData[MODEL_META_DATA_PACKAGE, self._Arch, self._Platform]\r
0d2711a6
LG
1920 Macros = self._Macros\r
1921 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
52302d4d
LG
1922 for Record in RecordList:\r
1923 File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
1924 LineNo = Record[-1]\r
1925 # check the file validation\r
1926 ErrorCode, ErrorInfo = File.Validate('.dec')\r
1927 if ErrorCode != 0:\r
1928 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1929 # parse this package now. we need it to get protocol/ppi/guid value\r
0d2711a6 1930 Package = self._Bdb[File, self._Arch, self._Target, self._Toolchain]\r
52302d4d
LG
1931 self._Packages.append(Package)\r
1932 return self._Packages\r
1933\r
1934 ## Retrieve PCDs used in this module\r
1935 def _GetPcds(self):\r
1936 if self._Pcds == None:\r
79b74a03 1937 self._Pcds = sdict()\r
52302d4d
LG
1938 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
1939 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
1940 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
1941 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
1942 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
1943 return self._Pcds\r
1944\r
1945 ## Retrieve build options specific to this module\r
1946 def _GetBuildOptions(self):\r
1947 if self._BuildOptions == None:\r
1948 self._BuildOptions = sdict()\r
1949 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, self._Platform]\r
1950 for Record in RecordList:\r
1951 ToolChainFamily = Record[0]\r
1952 ToolChain = Record[1]\r
1953 Option = Record[2]\r
1954 if (ToolChainFamily, ToolChain) not in self._BuildOptions:\r
1955 self._BuildOptions[ToolChainFamily, ToolChain] = Option\r
1956 else:\r
1957 # concatenate the option string if they're for the same tool\r
1958 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
1959 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
1960 return self._BuildOptions\r
1961\r
0d2711a6 1962 ## Retrieve dependency expression\r
52302d4d
LG
1963 def _GetDepex(self):\r
1964 if self._Depex == None:\r
1965 self._Depex = tdict(False, 2)\r
1966 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
da92f276
LG
1967 \r
1968 # If the module has only Binaries and no Sources, then ignore [Depex] \r
1969 if self.Sources == None or self.Sources == []:\r
0d2711a6
LG
1970 if self.Binaries != None and self.Binaries != []:\r
1971 return self._Depex\r
da92f276 1972 \r
52302d4d
LG
1973 # PEIM and DXE drivers must have a valid [Depex] section\r
1974 if len(self.LibraryClass) == 0 and len(RecordList) == 0:\r
1975 if self.ModuleType == 'DXE_DRIVER' or self.ModuleType == 'PEIM' or self.ModuleType == 'DXE_SMM_DRIVER' or \\r
1976 self.ModuleType == 'DXE_SAL_DRIVER' or self.ModuleType == 'DXE_RUNTIME_DRIVER':\r
1977 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No [Depex] section or no valid expression in [Depex] section for [%s] module" \\r
1978 % self.ModuleType, File=self.MetaFile)\r
1979\r
0d2711a6 1980 Depex = sdict()\r
52302d4d 1981 for Record in RecordList:\r
0d2711a6 1982 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
52302d4d
LG
1983 Arch = Record[3]\r
1984 ModuleType = Record[4]\r
0d2711a6 1985 TokenList = DepexStr.split()\r
52302d4d
LG
1986 if (Arch, ModuleType) not in Depex:\r
1987 Depex[Arch, ModuleType] = []\r
1988 DepexList = Depex[Arch, ModuleType]\r
1989 for Token in TokenList:\r
1990 if Token in DEPEX_SUPPORTED_OPCODE:\r
1991 DepexList.append(Token)\r
1992 elif Token.endswith(".inf"): # module file name\r
1993 ModuleFile = os.path.normpath(Token)\r
1994 Module = self.BuildDatabase[ModuleFile]\r
1995 if Module == None:\r
1996 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "Module is not found in active platform",\r
1997 ExtraData=Token, File=self.MetaFile, Line=Record[-1])\r
1998 DepexList.append(Module.Guid)\r
1999 else:\r
2000 # get the GUID value now\r
2001 Value = ProtocolValue(Token, self.Packages)\r
2002 if Value == None:\r
2003 Value = PpiValue(Token, self.Packages)\r
2004 if Value == None:\r
2005 Value = GuidValue(Token, self.Packages)\r
2006 if Value == None:\r
2007 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2008 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2009 "Value of [%s] is not found in" % Token,\r
2010 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
2011 DepexList.append(Value)\r
2012 for Arch, ModuleType in Depex:\r
2013 self._Depex[Arch, ModuleType] = Depex[Arch, ModuleType]\r
2014 return self._Depex\r
2015\r
2016 ## Retrieve depedency expression\r
2017 def _GetDepexExpression(self):\r
2018 if self._DepexExpression == None:\r
2019 self._DepexExpression = tdict(False, 2)\r
2020 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
0d2711a6 2021 DepexExpression = sdict()\r
52302d4d 2022 for Record in RecordList:\r
0d2711a6 2023 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
52302d4d
LG
2024 Arch = Record[3]\r
2025 ModuleType = Record[4]\r
0d2711a6 2026 TokenList = DepexStr.split()\r
52302d4d
LG
2027 if (Arch, ModuleType) not in DepexExpression:\r
2028 DepexExpression[Arch, ModuleType] = ''\r
2029 for Token in TokenList:\r
2030 DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType] + Token.strip() + ' '\r
2031 for Arch, ModuleType in DepexExpression:\r
2032 self._DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType]\r
2033 return self._DepexExpression\r
2034\r
2035 ## Retrieve PCD for given type\r
2036 def _GetPcd(self, Type):\r
79b74a03 2037 Pcds = sdict()\r
52302d4d 2038 PcdDict = tdict(True, 4)\r
6780eef1 2039 PcdList = []\r
52302d4d
LG
2040 RecordList = self._RawData[Type, self._Arch, self._Platform]\r
2041 for TokenSpaceGuid, PcdCName, Setting, Arch, Platform, Dummy1, LineNo in RecordList:\r
2042 PcdDict[Arch, Platform, PcdCName, TokenSpaceGuid] = (Setting, LineNo)\r
6780eef1 2043 PcdList.append((PcdCName, TokenSpaceGuid))\r
52302d4d
LG
2044 # get the guid value\r
2045 if TokenSpaceGuid not in self.Guids:\r
2046 Value = GuidValue(TokenSpaceGuid, self.Packages)\r
2047 if Value == None:\r
2048 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2049 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2050 "Value of Guid [%s] is not found under [Guids] section in" % TokenSpaceGuid,\r
2051 ExtraData=PackageList, File=self.MetaFile, Line=LineNo)\r
2052 self.Guids[TokenSpaceGuid] = Value\r
2053\r
2054 # resolve PCD type, value, datum info, etc. by getting its definition from package\r
6780eef1 2055 for PcdCName, TokenSpaceGuid in PcdList:\r
52302d4d
LG
2056 Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]\r
2057 if Setting == None:\r
2058 continue\r
6780eef1 2059 ValueList = AnalyzePcdData(Setting)\r
52302d4d
LG
2060 DefaultValue = ValueList[0]\r
2061 Pcd = PcdClassObject(\r
2062 PcdCName,\r
2063 TokenSpaceGuid,\r
2064 '',\r
2065 '',\r
2066 DefaultValue,\r
2067 '',\r
2068 '',\r
2069 {},\r
e56468c0 2070 False,\r
52302d4d
LG
2071 self.Guids[TokenSpaceGuid]\r
2072 )\r
2073\r
2074 # get necessary info from package declaring this PCD\r
2075 for Package in self.Packages:\r
2076 #\r
2077 # 'dynamic' in INF means its type is determined by platform;\r
2078 # if platform doesn't give its type, use 'lowest' one in the\r
2079 # following order, if any\r
2080 #\r
2081 # "FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"\r
2082 #\r
2083 PcdType = self._PCD_TYPE_STRING_[Type]\r
e56468c0 2084 if Type == MODEL_PCD_DYNAMIC:\r
52302d4d
LG
2085 Pcd.Pending = True\r
2086 for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:\r
2087 if (PcdCName, TokenSpaceGuid, T) in Package.Pcds:\r
2088 PcdType = T\r
2089 break\r
2090 else:\r
2091 Pcd.Pending = False\r
2092\r
2093 if (PcdCName, TokenSpaceGuid, PcdType) in Package.Pcds:\r
2094 PcdInPackage = Package.Pcds[PcdCName, TokenSpaceGuid, PcdType]\r
2095 Pcd.Type = PcdType\r
2096 Pcd.TokenValue = PcdInPackage.TokenValue\r
6780eef1
LG
2097 \r
2098 #\r
2099 # Check whether the token value exist or not.\r
2100 #\r
2101 if Pcd.TokenValue == None or Pcd.TokenValue == "":\r
2102 EdkLogger.error(\r
2103 'build',\r
2104 FORMAT_INVALID,\r
2105 "No TokenValue for PCD [%s.%s] in [%s]!" % (TokenSpaceGuid, PcdCName, str(Package)),\r
2106 File =self.MetaFile, Line=LineNo,\r
2107 ExtraData=None\r
2108 ) \r
2109 #\r
2110 # Check hexadecimal token value length and format.\r
2111 #\r
79b74a03 2112 ReIsValidPcdTokenValue = re.compile(r"^[0][x|X][0]*[0-9a-fA-F]{1,8}$", re.DOTALL)\r
6780eef1 2113 if Pcd.TokenValue.startswith("0x") or Pcd.TokenValue.startswith("0X"):\r
79b74a03 2114 if ReIsValidPcdTokenValue.match(Pcd.TokenValue) == None:\r
6780eef1
LG
2115 EdkLogger.error(\r
2116 'build',\r
2117 FORMAT_INVALID,\r
2118 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid:" % (Pcd.TokenValue, TokenSpaceGuid, PcdCName, str(Package)),\r
2119 File =self.MetaFile, Line=LineNo,\r
2120 ExtraData=None\r
2121 )\r
2122 \r
2123 #\r
2124 # Check decimal token value length and format.\r
2125 # \r
2126 else:\r
2127 try:\r
2128 TokenValueInt = int (Pcd.TokenValue, 10)\r
2129 if (TokenValueInt < 0 or TokenValueInt > 4294967295):\r
2130 EdkLogger.error(\r
2131 'build',\r
2132 FORMAT_INVALID,\r
2133 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid, as a decimal it should between: 0 - 4294967295!"% (Pcd.TokenValue, TokenSpaceGuid, PcdCName, str(Package)),\r
2134 File =self.MetaFile, Line=LineNo,\r
2135 ExtraData=None\r
2136 ) \r
2137 except:\r
2138 EdkLogger.error(\r
2139 'build',\r
2140 FORMAT_INVALID,\r
2141 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid, it should be hexadecimal or decimal!"% (Pcd.TokenValue, TokenSpaceGuid, PcdCName, str(Package)),\r
2142 File =self.MetaFile, Line=LineNo,\r
2143 ExtraData=None\r
2144 )\r
2145 \r
52302d4d
LG
2146 Pcd.DatumType = PcdInPackage.DatumType\r
2147 Pcd.MaxDatumSize = PcdInPackage.MaxDatumSize\r
2148 Pcd.InfDefaultValue = Pcd.DefaultValue\r
2149 if Pcd.DefaultValue in [None, '']:\r
2150 Pcd.DefaultValue = PcdInPackage.DefaultValue\r
2151 break\r
2152 else:\r
2153 EdkLogger.error(\r
2154 'build',\r
6780eef1 2155 FORMAT_INVALID,\r
52302d4d
LG
2156 "PCD [%s.%s] in [%s] is not found in dependent packages:" % (TokenSpaceGuid, PcdCName, self.MetaFile),\r
2157 File =self.MetaFile, Line=LineNo,\r
2158 ExtraData="\t%s" % '\n\t'.join([str(P) for P in self.Packages])\r
2159 )\r
2160 Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
6780eef1 2161\r
52302d4d
LG
2162 return Pcds\r
2163\r
0d2711a6 2164 _Macros = property(_GetMacros)\r
52302d4d
LG
2165 Arch = property(_GetArch, _SetArch)\r
2166 Platform = property(_GetPlatform, _SetPlatform)\r
2167\r
2168 AutoGenVersion = property(_GetInfVersion)\r
2169 BaseName = property(_GetBaseName)\r
2170 ModuleType = property(_GetModuleType)\r
2171 ComponentType = property(_GetComponentType)\r
2172 BuildType = property(_GetBuildType)\r
2173 Guid = property(_GetFileGuid)\r
2174 Version = property(_GetVersion)\r
2175 PcdIsDriver = property(_GetPcdIsDriver)\r
2176 Shadow = property(_GetShadow)\r
2177 CustomMakefile = property(_GetMakefile)\r
2178 Specification = property(_GetSpec)\r
2179 LibraryClass = property(_GetLibraryClass)\r
2180 ModuleEntryPointList = property(_GetEntryPoint)\r
2181 ModuleUnloadImageList = property(_GetUnloadImage)\r
2182 ConstructorList = property(_GetConstructor)\r
2183 DestructorList = property(_GetDestructor)\r
2184 Defines = property(_GetDefines)\r
b36d134f
LG
2185 DxsFile = property(_GetDxsFile)\r
2186 \r
52302d4d
LG
2187 Binaries = property(_GetBinaryFiles)\r
2188 Sources = property(_GetSourceFiles)\r
2189 LibraryClasses = property(_GetLibraryClassUses)\r
2190 Libraries = property(_GetLibraryNames)\r
2191 Protocols = property(_GetProtocols)\r
2192 Ppis = property(_GetPpis)\r
2193 Guids = property(_GetGuids)\r
2194 Includes = property(_GetIncludes)\r
2195 Packages = property(_GetPackages)\r
2196 Pcds = property(_GetPcds)\r
2197 BuildOptions = property(_GetBuildOptions)\r
2198 Depex = property(_GetDepex)\r
2199 DepexExpression = property(_GetDepexExpression)\r
2200\r
2201## Database\r
2202#\r
e56468c0 2203# This class defined the build database for all modules, packages and platform.\r
52302d4d
LG
2204# It will call corresponding parser for the given file if it cannot find it in\r
2205# the database.\r
2206#\r
2207# @param DbPath Path of database file\r
2208# @param GlobalMacros Global macros used for replacement during file parsing\r
2209# @prarm RenewDb=False Create new database file if it's already there\r
2210#\r
2211class WorkspaceDatabase(object):\r
52302d4d
LG
2212\r
2213 # default database file path\r
2214 _DB_PATH_ = "Conf/.cache/build.db"\r
2215\r
2216 #\r
2217 # internal class used for call corresponding file parser and caching the result\r
2218 # to avoid unnecessary re-parsing\r
2219 #\r
2220 class BuildObjectFactory(object):\r
0d2711a6 2221\r
52302d4d
LG
2222 _FILE_TYPE_ = {\r
2223 ".inf" : MODEL_FILE_INF,\r
2224 ".dec" : MODEL_FILE_DEC,\r
2225 ".dsc" : MODEL_FILE_DSC,\r
0d2711a6
LG
2226 }\r
2227\r
2228 # file parser\r
2229 _FILE_PARSER_ = {\r
2230 MODEL_FILE_INF : InfParser,\r
2231 MODEL_FILE_DEC : DecParser,\r
2232 MODEL_FILE_DSC : DscParser,\r
52302d4d
LG
2233 }\r
2234\r
2235 # convert to xxxBuildData object\r
2236 _GENERATOR_ = {\r
2237 MODEL_FILE_INF : InfBuildData,\r
2238 MODEL_FILE_DEC : DecBuildData,\r
2239 MODEL_FILE_DSC : DscBuildData,\r
52302d4d
LG
2240 }\r
2241\r
2242 _CACHE_ = {} # (FilePath, Arch) : <object>\r
2243\r
2244 # constructor\r
2245 def __init__(self, WorkspaceDb):\r
2246 self.WorkspaceDb = WorkspaceDb\r
2247\r
0d2711a6 2248 # key = (FilePath, Arch=None)\r
52302d4d
LG
2249 def __contains__(self, Key):\r
2250 FilePath = Key[0]\r
52302d4d
LG
2251 if len(Key) > 1:\r
2252 Arch = Key[1]\r
0d2711a6
LG
2253 else:\r
2254 Arch = None\r
52302d4d
LG
2255 return (FilePath, Arch) in self._CACHE_\r
2256\r
0d2711a6 2257 # key = (FilePath, Arch=None, Target=None, Toochain=None)\r
52302d4d
LG
2258 def __getitem__(self, Key):\r
2259 FilePath = Key[0]\r
0d2711a6
LG
2260 KeyLength = len(Key)\r
2261 if KeyLength > 1:\r
52302d4d 2262 Arch = Key[1]\r
0d2711a6
LG
2263 else:\r
2264 Arch = None\r
2265 if KeyLength > 2:\r
2266 Target = Key[2]\r
2267 else:\r
2268 Target = None\r
2269 if KeyLength > 3:\r
2270 Toolchain = Key[3]\r
2271 else:\r
2272 Toolchain = None\r
52302d4d
LG
2273\r
2274 # if it's generated before, just return the cached one\r
0d2711a6 2275 Key = (FilePath, Arch, Target, Toolchain)\r
52302d4d
LG
2276 if Key in self._CACHE_:\r
2277 return self._CACHE_[Key]\r
2278\r
2279 # check file type\r
0d2711a6 2280 Ext = FilePath.Type\r
52302d4d
LG
2281 if Ext not in self._FILE_TYPE_:\r
2282 return None\r
2283 FileType = self._FILE_TYPE_[Ext]\r
2284 if FileType not in self._GENERATOR_:\r
2285 return None\r
2286\r
0d2711a6
LG
2287 # get the parser ready for this file\r
2288 MetaFile = self._FILE_PARSER_[FileType](\r
2289 FilePath, \r
2290 FileType, \r
2291 MetaFileStorage(self.WorkspaceDb.Cur, FilePath, FileType)\r
2292 )\r
2293 # alwasy do post-process, in case of macros change\r
2294 MetaFile.DoPostProcess()\r
2295 # object the build is based on\r
52302d4d
LG
2296 BuildObject = self._GENERATOR_[FileType](\r
2297 FilePath,\r
2298 MetaFile,\r
2299 self,\r
2300 Arch,\r
0d2711a6
LG
2301 Target,\r
2302 Toolchain\r
52302d4d
LG
2303 )\r
2304 self._CACHE_[Key] = BuildObject\r
2305 return BuildObject\r
2306\r
2307 # placeholder for file format conversion\r
2308 class TransformObjectFactory:\r
2309 def __init__(self, WorkspaceDb):\r
2310 self.WorkspaceDb = WorkspaceDb\r
2311\r
2312 # key = FilePath, Arch\r
2313 def __getitem__(self, Key):\r
2314 pass\r
2315\r
2316 ## Constructor of WorkspaceDatabase\r
2317 #\r
2318 # @param DbPath Path of database file\r
2319 # @param GlobalMacros Global macros used for replacement during file parsing\r
2320 # @prarm RenewDb=False Create new database file if it's already there\r
2321 #\r
0d2711a6 2322 def __init__(self, DbPath, RenewDb=False):\r
4234283c 2323 self._DbClosedFlag = False\r
0d2711a6 2324 if not DbPath:\r
52302d4d
LG
2325 DbPath = os.path.normpath(os.path.join(GlobalData.gWorkspace, self._DB_PATH_))\r
2326\r
2327 # don't create necessary path for db in memory\r
2328 if DbPath != ':memory:':\r
2329 DbDir = os.path.split(DbPath)[0]\r
2330 if not os.path.exists(DbDir):\r
2331 os.makedirs(DbDir)\r
2332\r
2333 # remove db file in case inconsistency between db and file in file system\r
2334 if self._CheckWhetherDbNeedRenew(RenewDb, DbPath):\r
2335 os.remove(DbPath)\r
2336 \r
2337 # create db with optimized parameters\r
2338 self.Conn = sqlite3.connect(DbPath, isolation_level='DEFERRED')\r
2339 self.Conn.execute("PRAGMA synchronous=OFF")\r
2340 self.Conn.execute("PRAGMA temp_store=MEMORY")\r
2341 self.Conn.execute("PRAGMA count_changes=OFF")\r
2342 self.Conn.execute("PRAGMA cache_size=8192")\r
2343 #self.Conn.execute("PRAGMA page_size=8192")\r
2344\r
2345 # to avoid non-ascii character conversion issue\r
2346 self.Conn.text_factory = str\r
2347 self.Cur = self.Conn.cursor()\r
2348\r
2349 # create table for internal uses\r
2350 self.TblDataModel = TableDataModel(self.Cur)\r
2351 self.TblFile = TableFile(self.Cur)\r
0d2711a6 2352 self.Platform = None\r
52302d4d
LG
2353\r
2354 # conversion object for build or file format conversion purpose\r
2355 self.BuildObject = WorkspaceDatabase.BuildObjectFactory(self)\r
2356 self.TransformObject = WorkspaceDatabase.TransformObjectFactory(self)\r
2357\r
2358 ## Check whether workspace database need to be renew.\r
2359 # The renew reason maybe:\r
2360 # 1) If user force to renew;\r
2361 # 2) If user do not force renew, and\r
2362 # a) If the time of last modified python source is newer than database file;\r
2363 # b) If the time of last modified frozen executable file is newer than database file;\r
2364 #\r
2365 # @param force User force renew database\r
2366 # @param DbPath The absolute path of workspace database file\r
2367 #\r
2368 # @return Bool value for whether need renew workspace databse\r
2369 #\r
2370 def _CheckWhetherDbNeedRenew (self, force, DbPath):\r
52302d4d
LG
2371 # if database does not exist, we need do nothing\r
2372 if not os.path.exists(DbPath): return False\r
2373 \r
2374 # if user force to renew database, then not check whether database is out of date\r
2375 if force: return True\r
2376 \r
2377 # \r
2378 # Check the time of last modified source file or build.exe\r
2379 # if is newer than time of database, then database need to be re-created.\r
2380 #\r
2381 timeOfToolModified = 0\r
2382 if hasattr(sys, "frozen"):\r
2383 exePath = os.path.abspath(sys.executable)\r
2384 timeOfToolModified = os.stat(exePath).st_mtime\r
2385 else:\r
2386 curPath = os.path.dirname(__file__) # curPath is the path of WorkspaceDatabase.py\r
2387 rootPath = os.path.split(curPath)[0] # rootPath is root path of python source, such as /BaseTools/Source/Python\r
2388 if rootPath == "" or rootPath == None:\r
2389 EdkLogger.verbose("\nFail to find the root path of build.exe or python sources, so can not \\r
2390determine whether database file is out of date!\n")\r
2391 \r
2392 # walk the root path of source or build's binary to get the time last modified.\r
2393 \r
2394 for root, dirs, files in os.walk (rootPath):\r
2395 for dir in dirs:\r
2396 # bypass source control folder \r
2397 if dir.lower() in [".svn", "_svn", "cvs"]:\r
2398 dirs.remove(dir)\r
2399 \r
2400 for file in files:\r
2401 ext = os.path.splitext(file)[1]\r
2402 if ext.lower() == ".py": # only check .py files\r
2403 fd = os.stat(os.path.join(root, file))\r
2404 if timeOfToolModified < fd.st_mtime:\r
2405 timeOfToolModified = fd.st_mtime\r
2406 if timeOfToolModified > os.stat(DbPath).st_mtime:\r
2407 EdkLogger.verbose("\nWorkspace database is out of data!")\r
2408 return True\r
2409 \r
2410 return False\r
2411 \r
2412 ## Initialize build database\r
2413 def InitDatabase(self):\r
2414 EdkLogger.verbose("\nInitialize build database started ...")\r
2415\r
2416 #\r
2417 # Create new tables\r
2418 #\r
2419 self.TblDataModel.Create(False)\r
2420 self.TblFile.Create(False)\r
2421\r
2422 #\r
2423 # Initialize table DataModel\r
2424 #\r
2425 self.TblDataModel.InitTable()\r
2426 EdkLogger.verbose("Initialize build database ... DONE!")\r
2427\r
2428 ## Query a table\r
2429 #\r
2430 # @param Table: The instance of the table to be queried\r
2431 #\r
2432 def QueryTable(self, Table):\r
2433 Table.Query()\r
2434\r
0d2711a6
LG
2435 def __del__(self):\r
2436 self.Close()\r
2437\r
52302d4d
LG
2438 ## Close entire database\r
2439 #\r
2440 # Commit all first\r
2441 # Close the connection and cursor\r
2442 #\r
2443 def Close(self):\r
4234283c
LG
2444 if not self._DbClosedFlag:\r
2445 self.Conn.commit()\r
2446 self.Cur.close()\r
2447 self.Conn.close()\r
2448 self._DbClosedFlag = True\r
52302d4d 2449\r
52302d4d 2450 ## Summarize all packages in the database\r
0d2711a6
LG
2451 def GetPackageList(self, Platform, Arch, TargetName, ToolChainTag):\r
2452 self.Platform = Platform\r
2453 PackageList =[]\r
2454 Pa = self.BuildObject[self.Platform, 'COMMON']\r
2455 #\r
2456 # Get Package related to Modules\r
2457 #\r
2458 for Module in Pa.Modules:\r
2459 ModuleObj = self.BuildObject[Module, Arch, TargetName, ToolChainTag]\r
2460 for Package in ModuleObj.Packages:\r
52302d4d
LG
2461 if Package not in PackageList:\r
2462 PackageList.append(Package)\r
0d2711a6
LG
2463 #\r
2464 # Get Packages related to Libraries\r
2465 #\r
2466 for Lib in Pa.LibraryInstances:\r
2467 LibObj = self.BuildObject[Lib, Arch, TargetName, ToolChainTag]\r
2468 for Package in LibObj.Packages:\r
2469 if Package not in PackageList:\r
2470 PackageList.append(Package) \r
2471 \r
52302d4d
LG
2472 return PackageList\r
2473\r
2474 ## Summarize all platforms in the database\r
2475 def _GetPlatformList(self):\r
2476 PlatformList = []\r
2477 for PlatformFile in self.TblFile.GetFileList(MODEL_FILE_DSC):\r
2478 try:\r
2479 Platform = self.BuildObject[PathClass(PlatformFile), 'COMMON']\r
2480 except:\r
2481 Platform = None\r
2482 if Platform != None:\r
2483 PlatformList.append(Platform)\r
2484 return PlatformList\r
2485\r
52302d4d 2486 PlatformList = property(_GetPlatformList)\r
52302d4d
LG
2487\r
2488##\r
2489#\r
2490# This acts like the main() function for the script, unless it is 'import'ed into another\r
2491# script.\r
2492#\r
2493if __name__ == '__main__':\r
2494 pass\r
2495\r