]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/WorkspaceDatabase.py
BaseTools: Enhance BaseTools supports FixedAtBuild usage in VFR file
[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
f0dc69e6 4# Copyright (c) 2008 - 2016, Intel Corporation. All rights reserved.<BR>\r
77177984 5# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
40d841f6 6# This program and the accompanying materials\r
52302d4d
LG
7# are licensed and made available under the terms and conditions of the BSD License\r
8# which accompanies this distribution. The full text of the license may be found at\r
9# http://opensource.org/licenses/bsd-license.php\r
10#\r
11# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13#\r
14\r
15##\r
16# Import Modules\r
17#\r
18import sqlite3\r
1be2ed90 19import Common.LongFilePathOs as os\r
52302d4d 20import pickle\r
e56468c0 21import uuid\r
52302d4d
LG
22\r
23import Common.EdkLogger as EdkLogger\r
24import Common.GlobalData as GlobalData\r
05cc51ad 25from Common.MultipleWorkspace import MultipleWorkspace as mws\r
52302d4d
LG
26\r
27from Common.String import *\r
28from Common.DataType import *\r
29from Common.Misc import *\r
30from types import *\r
31\r
32from CommonDataClass.CommonClass import SkuInfoClass\r
33\r
34from MetaDataTable import *\r
35from MetaFileTable import *\r
36from MetaFileParser import *\r
37from BuildClassObject import *\r
4afd3d04
LG
38from WorkspaceCommon import GetDeclaredPcd\r
39from Common.Misc import AnalyzeDscPcd\r
97fa0ee9 40from Common.Misc import ProcessDuplicatedInf\r
2bc3256c 41import re\r
e4ac870f 42from Common.Parsing import IsValidWord\r
82a6a960 43from Common.VariableAttributes import VariableAttributes\r
97fa0ee9
YL
44import Common.GlobalData as GlobalData\r
45\r
52302d4d
LG
46## Platform build information from DSC file\r
47#\r
48# This class is used to retrieve information stored in database and convert them\r
49# into PlatformBuildClassObject form for easier use for AutoGen.\r
50#\r
51class DscBuildData(PlatformBuildClassObject):\r
52 # dict used to convert PCD type in database to string used by build tool\r
53 _PCD_TYPE_STRING_ = {\r
54 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
55 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
56 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
57 MODEL_PCD_DYNAMIC : "Dynamic",\r
58 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
59 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
60 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
61 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
62 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
63 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
64 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
65 }\r
66\r
67 # dict used to convert part of [Defines] to members of DscBuildData directly\r
68 _PROPERTY_ = {\r
69 #\r
70 # Required Fields\r
71 #\r
72 TAB_DSC_DEFINES_PLATFORM_NAME : "_PlatformName",\r
73 TAB_DSC_DEFINES_PLATFORM_GUID : "_Guid",\r
74 TAB_DSC_DEFINES_PLATFORM_VERSION : "_Version",\r
75 TAB_DSC_DEFINES_DSC_SPECIFICATION : "_DscSpecification",\r
76 #TAB_DSC_DEFINES_OUTPUT_DIRECTORY : "_OutputDirectory",\r
77 #TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES : "_SupArchList",\r
78 #TAB_DSC_DEFINES_BUILD_TARGETS : "_BuildTargets",\r
e8a47801 79 TAB_DSC_DEFINES_SKUID_IDENTIFIER : "_SkuName",\r
52302d4d
LG
80 #TAB_DSC_DEFINES_FLASH_DEFINITION : "_FlashDefinition",\r
81 TAB_DSC_DEFINES_BUILD_NUMBER : "_BuildNumber",\r
82 TAB_DSC_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
83 TAB_DSC_DEFINES_BS_BASE_ADDRESS : "_BsBaseAddress",\r
84 TAB_DSC_DEFINES_RT_BASE_ADDRESS : "_RtBaseAddress",\r
6780eef1
LG
85 #TAB_DSC_DEFINES_RFC_LANGUAGES : "_RFCLanguages",\r
86 #TAB_DSC_DEFINES_ISO_LANGUAGES : "_ISOLanguages",\r
52302d4d
LG
87 }\r
88\r
89 # used to compose dummy library class name for those forced library instances\r
90 _NullLibraryNumber = 0\r
91\r
92 ## Constructor of DscBuildData\r
93 #\r
94 # Initialize object of DscBuildData\r
95 #\r
96 # @param FilePath The path of platform description file\r
97 # @param RawData The raw data of DSC file\r
98 # @param BuildDataBase Database used to retrieve module/package information\r
99 # @param Arch The target architecture\r
100 # @param Platform (not used for DscBuildData)\r
101 # @param Macros Macros used for replacement in DSC file\r
102 #\r
0d2711a6 103 def __init__(self, FilePath, RawData, BuildDataBase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
104 self.MetaFile = FilePath\r
105 self._RawData = RawData\r
106 self._Bdb = BuildDataBase\r
107 self._Arch = Arch\r
0d2711a6
LG
108 self._Target = Target\r
109 self._Toolchain = Toolchain\r
52302d4d 110 self._Clear()\r
97fa0ee9 111 self._HandleOverridePath()\r
52302d4d
LG
112\r
113 ## XXX[key] = value\r
114 def __setitem__(self, key, value):\r
115 self.__dict__[self._PROPERTY_[key]] = value\r
116\r
117 ## value = XXX[key]\r
118 def __getitem__(self, key):\r
119 return self.__dict__[self._PROPERTY_[key]]\r
120\r
121 ## "in" test support\r
122 def __contains__(self, key):\r
123 return key in self._PROPERTY_\r
124\r
125 ## Set all internal used members of DscBuildData to None\r
126 def _Clear(self):\r
127 self._Header = None\r
128 self._PlatformName = None\r
129 self._Guid = None\r
130 self._Version = None\r
131 self._DscSpecification = None\r
132 self._OutputDirectory = None\r
133 self._SupArchList = None\r
134 self._BuildTargets = None\r
135 self._SkuName = None\r
e8a47801 136 self._SkuIdentifier = None\r
1ae469b9 137 self._AvilableSkuIds = None\r
e8a47801 138 self._PcdInfoFlag = None\r
82a6a960 139 self._VarCheckFlag = None\r
52302d4d 140 self._FlashDefinition = None\r
f0dc69e6
YZ
141 self._Prebuild = None\r
142 self._Postbuild = None\r
52302d4d
LG
143 self._BuildNumber = None\r
144 self._MakefileName = None\r
145 self._BsBaseAddress = None\r
146 self._RtBaseAddress = None\r
147 self._SkuIds = None\r
148 self._Modules = None\r
149 self._LibraryInstances = None\r
150 self._LibraryClasses = None\r
151 self._Pcds = None\r
4afd3d04 152 self._DecPcds = None\r
52302d4d 153 self._BuildOptions = None\r
35f69db9 154 self._ModuleTypeOptions = None\r
52302d4d 155 self._LoadFixAddress = None\r
6780eef1
LG
156 self._RFCLanguages = None\r
157 self._ISOLanguages = None\r
e56468c0 158 self._VpdToolGuid = None\r
0d2711a6
LG
159 self.__Macros = None\r
160\r
97fa0ee9
YL
161\r
162 ## handle Override Path of Module\r
163 def _HandleOverridePath(self):\r
164 RecordList = self._RawData[MODEL_META_DATA_COMPONENT, self._Arch]\r
165 Macros = self._Macros\r
166 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
167 for Record in RecordList:\r
168 ModuleId = Record[5]\r
169 LineNo = Record[6]\r
170 ModuleFile = PathClass(NormPath(Record[0]), GlobalData.gWorkspace, Arch=self._Arch)\r
171 RecordList = self._RawData[MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH, self._Arch, None, ModuleId]\r
172 if RecordList != []:\r
05cc51ad 173 SourceOverridePath = mws.join(GlobalData.gWorkspace, NormPath(RecordList[0][0]))\r
97fa0ee9
YL
174\r
175 # Check if the source override path exists\r
176 if not os.path.isdir(SourceOverridePath):\r
177 EdkLogger.error('build', FILE_NOT_FOUND, Message='Source override path does not exist:', File=self.MetaFile, ExtraData=SourceOverridePath, Line=LineNo)\r
178\r
179 #Add to GlobalData Variables\r
180 GlobalData.gOverrideDir[ModuleFile.Key] = SourceOverridePath\r
181\r
0d2711a6
LG
182 ## Get current effective macros\r
183 def _GetMacros(self):\r
184 if self.__Macros == None:\r
185 self.__Macros = {}\r
186 self.__Macros.update(GlobalData.gPlatformDefines)\r
187 self.__Macros.update(GlobalData.gGlobalDefines)\r
188 self.__Macros.update(GlobalData.gCommandLineDefines)\r
189 return self.__Macros\r
52302d4d
LG
190\r
191 ## Get architecture\r
192 def _GetArch(self):\r
193 return self._Arch\r
194\r
195 ## Set architecture\r
196 #\r
197 # Changing the default ARCH to another may affect all other information\r
198 # because all information in a platform may be ARCH-related. That's\r
199 # why we need to clear all internal used members, in order to cause all\r
200 # information to be re-retrieved.\r
201 #\r
202 # @param Value The value of ARCH\r
203 #\r
204 def _SetArch(self, Value):\r
205 if self._Arch == Value:\r
206 return\r
207 self._Arch = Value\r
208 self._Clear()\r
209\r
210 ## Retrieve all information in [Defines] section\r
211 #\r
212 # (Retriving all [Defines] information in one-shot is just to save time.)\r
213 #\r
214 def _GetHeaderInfo(self):\r
215 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
216 for Record in RecordList:\r
0d2711a6 217 Name = Record[1]\r
52302d4d 218 # items defined _PROPERTY_ don't need additional processing\r
e8a47801 219 \r
52302d4d 220 # some special items in [Defines] section need special treatment\r
e8a47801 221 if Name == TAB_DSC_DEFINES_OUTPUT_DIRECTORY:\r
0d2711a6 222 self._OutputDirectory = NormPath(Record[2], self._Macros)\r
52302d4d
LG
223 if ' ' in self._OutputDirectory:\r
224 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "No space is allowed in OUTPUT_DIRECTORY",\r
225 File=self.MetaFile, Line=Record[-1],\r
226 ExtraData=self._OutputDirectory)\r
227 elif Name == TAB_DSC_DEFINES_FLASH_DEFINITION:\r
0d2711a6 228 self._FlashDefinition = PathClass(NormPath(Record[2], self._Macros), GlobalData.gWorkspace)\r
52302d4d
LG
229 ErrorCode, ErrorInfo = self._FlashDefinition.Validate('.fdf')\r
230 if ErrorCode != 0:\r
231 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=Record[-1],\r
232 ExtraData=ErrorInfo)\r
f0dc69e6 233 elif Name == TAB_DSC_PREBUILD:\r
c62f1874
YZ
234 PrebuildValue = Record[2]\r
235 if Record[2][0] == '"':\r
236 if Record[2][-1] != '"':\r
237 EdkLogger.error('build', FORMAT_INVALID, 'Missing double quotes in the end of %s statement.' % TAB_DSC_PREBUILD,\r
238 File=self.MetaFile, Line=Record[-1])\r
239 PrebuildValue = Record[2][1:-1]\r
240 self._Prebuild = PathClass(NormPath(PrebuildValue, self._Macros), GlobalData.gWorkspace)\r
f0dc69e6 241 elif Name == TAB_DSC_POSTBUILD:\r
c62f1874
YZ
242 PostbuildValue = Record[2]\r
243 if Record[2][0] == '"':\r
244 if Record[2][-1] != '"':\r
245 EdkLogger.error('build', FORMAT_INVALID, 'Missing double quotes in the end of %s statement.' % TAB_DSC_POSTBUILD,\r
246 File=self.MetaFile, Line=Record[-1])\r
247 PostbuildValue = Record[2][1:-1]\r
248 self._Postbuild = PathClass(NormPath(PostbuildValue, self._Macros), GlobalData.gWorkspace)\r
52302d4d 249 elif Name == TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES:\r
0d2711a6 250 self._SupArchList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
52302d4d 251 elif Name == TAB_DSC_DEFINES_BUILD_TARGETS:\r
0d2711a6 252 self._BuildTargets = GetSplitValueList(Record[2])\r
52302d4d
LG
253 elif Name == TAB_DSC_DEFINES_SKUID_IDENTIFIER:\r
254 if self._SkuName == None:\r
0d2711a6 255 self._SkuName = Record[2]\r
e8a47801 256 self._SkuIdentifier = Record[2]\r
1ae469b9 257 self._AvilableSkuIds = Record[2]\r
e8a47801
LG
258 elif Name == TAB_DSC_DEFINES_PCD_INFO_GENERATION:\r
259 self._PcdInfoFlag = Record[2]\r
82a6a960
BF
260 elif Name == TAB_DSC_DEFINES_PCD_VAR_CHECK_GENERATION:\r
261 self._VarCheckFlag = Record[2]\r
52302d4d 262 elif Name == TAB_FIX_LOAD_TOP_MEMORY_ADDRESS:\r
0d2711a6
LG
263 try:\r
264 self._LoadFixAddress = int (Record[2], 0)\r
265 except:\r
266 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (Record[2]))\r
6780eef1 267 elif Name == TAB_DSC_DEFINES_RFC_LANGUAGES:\r
0d2711a6 268 if not Record[2] or Record[2][0] != '"' or Record[2][-1] != '"' or len(Record[2]) == 1:\r
6780eef1
LG
269 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
270 File=self.MetaFile, Line=Record[-1])\r
0d2711a6 271 LanguageCodes = Record[2][1:-1]\r
6780eef1
LG
272 if not LanguageCodes:\r
273 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more RFC4646 format language code must be provided for RFC_LANGUAGES statement',\r
274 File=self.MetaFile, Line=Record[-1]) \r
275 LanguageList = GetSplitValueList(LanguageCodes, TAB_SEMI_COLON_SPLIT)\r
276 # check whether there is empty entries in the list\r
277 if None in LanguageList:\r
278 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more empty language code is in RFC_LANGUAGES statement',\r
279 File=self.MetaFile, Line=Record[-1]) \r
280 self._RFCLanguages = LanguageList\r
281 elif Name == TAB_DSC_DEFINES_ISO_LANGUAGES:\r
0d2711a6 282 if not Record[2] or Record[2][0] != '"' or Record[2][-1] != '"' or len(Record[2]) == 1:\r
6780eef1
LG
283 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'language code for ISO_LANGUAGES must have double quotes around it, for example: ISO_LANGUAGES = "engchn"',\r
284 File=self.MetaFile, Line=Record[-1])\r
0d2711a6 285 LanguageCodes = Record[2][1:-1]\r
6780eef1
LG
286 if not LanguageCodes:\r
287 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'one or more ISO639-2 format language code must be provided for ISO_LANGUAGES statement',\r
288 File=self.MetaFile, Line=Record[-1]) \r
289 if len(LanguageCodes)%3:\r
290 EdkLogger.error('build', FORMAT_NOT_SUPPORTED, 'bad ISO639-2 format for ISO_LANGUAGES',\r
291 File=self.MetaFile, Line=Record[-1])\r
292 LanguageList = []\r
293 for i in range(0, len(LanguageCodes), 3):\r
294 LanguageList.append(LanguageCodes[i:i+3])\r
295 self._ISOLanguages = LanguageList \r
e56468c0 296 elif Name == TAB_DSC_DEFINES_VPD_TOOL_GUID:\r
297 #\r
298 # try to convert GUID to a real UUID value to see whether the GUID is format \r
299 # for VPD_TOOL_GUID is correct.\r
300 #\r
301 try:\r
0d2711a6 302 uuid.UUID(Record[2])\r
e56468c0 303 except:\r
304 EdkLogger.error("build", FORMAT_INVALID, "Invalid GUID format for VPD_TOOL_GUID", File=self.MetaFile)\r
0d2711a6 305 self._VpdToolGuid = Record[2] \r
e8a47801
LG
306 elif Name in self:\r
307 self[Name] = Record[2] \r
52302d4d
LG
308 # set _Header to non-None in order to avoid database re-querying\r
309 self._Header = 'DUMMY'\r
310\r
311 ## Retrieve platform name\r
312 def _GetPlatformName(self):\r
313 if self._PlatformName == None:\r
314 if self._Header == None:\r
315 self._GetHeaderInfo()\r
316 if self._PlatformName == None:\r
317 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No PLATFORM_NAME", File=self.MetaFile)\r
318 return self._PlatformName\r
319\r
320 ## Retrieve file guid\r
321 def _GetFileGuid(self):\r
322 if self._Guid == None:\r
323 if self._Header == None:\r
324 self._GetHeaderInfo()\r
325 if self._Guid == None:\r
64b2609f 326 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No PLATFORM_GUID", File=self.MetaFile)\r
52302d4d
LG
327 return self._Guid\r
328\r
329 ## Retrieve platform version\r
330 def _GetVersion(self):\r
331 if self._Version == None:\r
332 if self._Header == None:\r
333 self._GetHeaderInfo()\r
334 if self._Version == None:\r
64b2609f 335 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No PLATFORM_VERSION", File=self.MetaFile)\r
52302d4d
LG
336 return self._Version\r
337\r
338 ## Retrieve platform description file version\r
339 def _GetDscSpec(self):\r
340 if self._DscSpecification == None:\r
341 if self._Header == None:\r
342 self._GetHeaderInfo()\r
343 if self._DscSpecification == None:\r
64b2609f 344 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No DSC_SPECIFICATION", File=self.MetaFile) \r
52302d4d
LG
345 return self._DscSpecification\r
346\r
347 ## Retrieve OUTPUT_DIRECTORY\r
348 def _GetOutpuDir(self):\r
349 if self._OutputDirectory == None:\r
350 if self._Header == None:\r
351 self._GetHeaderInfo()\r
352 if self._OutputDirectory == None:\r
353 self._OutputDirectory = os.path.join("Build", self._PlatformName)\r
354 return self._OutputDirectory\r
355\r
356 ## Retrieve SUPPORTED_ARCHITECTURES\r
357 def _GetSupArch(self):\r
358 if self._SupArchList == None:\r
359 if self._Header == None:\r
360 self._GetHeaderInfo()\r
361 if self._SupArchList == None:\r
64b2609f 362 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No SUPPORTED_ARCHITECTURES", File=self.MetaFile)\r
52302d4d
LG
363 return self._SupArchList\r
364\r
365 ## Retrieve BUILD_TARGETS\r
366 def _GetBuildTarget(self):\r
367 if self._BuildTargets == None:\r
368 if self._Header == None:\r
369 self._GetHeaderInfo()\r
370 if self._BuildTargets == None:\r
64b2609f 371 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No BUILD_TARGETS", File=self.MetaFile)\r
52302d4d 372 return self._BuildTargets\r
e8a47801
LG
373 \r
374 def _GetPcdInfoFlag(self):\r
375 if self._PcdInfoFlag == None or self._PcdInfoFlag.upper() == 'FALSE':\r
376 return False\r
377 elif self._PcdInfoFlag.upper() == 'TRUE':\r
378 return True\r
379 else:\r
380 return False\r
82a6a960
BF
381 def _GetVarCheckFlag(self): \r
382 if self._VarCheckFlag == None or self._VarCheckFlag.upper() == 'FALSE':\r
383 return False\r
384 elif self._VarCheckFlag.upper() == 'TRUE':\r
385 return True\r
386 else:\r
387 return False\r
1ae469b9
BF
388 def _GetAviableSkuIds(self):\r
389 if self._AvilableSkuIds:\r
390 return self._AvilableSkuIds\r
391 return self.SkuIdentifier\r
e8a47801 392 def _GetSkuIdentifier(self):\r
2bc3256c
LG
393 if self._SkuName:\r
394 return self._SkuName\r
e8a47801
LG
395 if self._SkuIdentifier == None:\r
396 if self._Header == None:\r
397 self._GetHeaderInfo()\r
398 return self._SkuIdentifier\r
52302d4d
LG
399 ## Retrieve SKUID_IDENTIFIER\r
400 def _GetSkuName(self):\r
401 if self._SkuName == None:\r
402 if self._Header == None:\r
403 self._GetHeaderInfo()\r
2bc3256c 404 if (self._SkuName == None or self._SkuName not in self.SkuIds):\r
52302d4d
LG
405 self._SkuName = 'DEFAULT'\r
406 return self._SkuName\r
407\r
408 ## Override SKUID_IDENTIFIER\r
409 def _SetSkuName(self, Value):\r
2bc3256c
LG
410 self._SkuName = Value\r
411 self._Pcds = None\r
52302d4d
LG
412\r
413 def _GetFdfFile(self):\r
414 if self._FlashDefinition == None:\r
415 if self._Header == None:\r
416 self._GetHeaderInfo()\r
417 if self._FlashDefinition == None:\r
418 self._FlashDefinition = ''\r
419 return self._FlashDefinition\r
420\r
f0dc69e6
YZ
421 def _GetPrebuild(self):\r
422 if self._Prebuild == None:\r
423 if self._Header == None:\r
424 self._GetHeaderInfo()\r
425 if self._Prebuild == None:\r
426 self._Prebuild = ''\r
427 return self._Prebuild\r
428\r
429 def _GetPostbuild(self):\r
430 if self._Postbuild == None:\r
431 if self._Header == None:\r
432 self._GetHeaderInfo()\r
433 if self._Postbuild == None:\r
434 self._Postbuild = ''\r
435 return self._Postbuild\r
436\r
52302d4d
LG
437 ## Retrieve FLASH_DEFINITION\r
438 def _GetBuildNumber(self):\r
439 if self._BuildNumber == None:\r
440 if self._Header == None:\r
441 self._GetHeaderInfo()\r
442 if self._BuildNumber == None:\r
443 self._BuildNumber = ''\r
444 return self._BuildNumber\r
445\r
446 ## Retrieve MAKEFILE_NAME\r
447 def _GetMakefileName(self):\r
448 if self._MakefileName == None:\r
449 if self._Header == None:\r
450 self._GetHeaderInfo()\r
451 if self._MakefileName == None:\r
452 self._MakefileName = ''\r
453 return self._MakefileName\r
454\r
455 ## Retrieve BsBaseAddress\r
456 def _GetBsBaseAddress(self):\r
457 if self._BsBaseAddress == None:\r
458 if self._Header == None:\r
459 self._GetHeaderInfo()\r
460 if self._BsBaseAddress == None:\r
461 self._BsBaseAddress = ''\r
462 return self._BsBaseAddress\r
463\r
464 ## Retrieve RtBaseAddress\r
465 def _GetRtBaseAddress(self):\r
466 if self._RtBaseAddress == None:\r
467 if self._Header == None:\r
468 self._GetHeaderInfo()\r
469 if self._RtBaseAddress == None:\r
470 self._RtBaseAddress = ''\r
471 return self._RtBaseAddress\r
472\r
473 ## Retrieve the top address for the load fix address\r
474 def _GetLoadFixAddress(self):\r
475 if self._LoadFixAddress == None:\r
476 if self._Header == None:\r
477 self._GetHeaderInfo()\r
0d2711a6 478\r
52302d4d 479 if self._LoadFixAddress == None:\r
0d2711a6
LG
480 self._LoadFixAddress = self._Macros.get(TAB_FIX_LOAD_TOP_MEMORY_ADDRESS, '0')\r
481\r
482 try:\r
483 self._LoadFixAddress = int (self._LoadFixAddress, 0)\r
484 except:\r
485 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (self._LoadFixAddress))\r
9508d0fa
LG
486 \r
487 #\r
488 # If command line defined, should override the value in DSC file.\r
489 #\r
490 if 'FIX_LOAD_TOP_MEMORY_ADDRESS' in GlobalData.gCommandLineDefines.keys():\r
491 try:\r
492 self._LoadFixAddress = int(GlobalData.gCommandLineDefines['FIX_LOAD_TOP_MEMORY_ADDRESS'], 0)\r
493 except:\r
494 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS %s is not valid dec or hex string" % (GlobalData.gCommandLineDefines['FIX_LOAD_TOP_MEMORY_ADDRESS']))\r
495 \r
496 if self._LoadFixAddress < 0:\r
497 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid negative value 0x%x" % (self._LoadFixAddress))\r
498 if self._LoadFixAddress != 0xFFFFFFFFFFFFFFFF and self._LoadFixAddress % 0x1000 != 0:\r
499 EdkLogger.error("build", PARAMETER_INVALID, "FIX_LOAD_TOP_MEMORY_ADDRESS is set to the invalid unaligned 4K value 0x%x" % (self._LoadFixAddress))\r
500 \r
52302d4d
LG
501 return self._LoadFixAddress\r
502\r
6780eef1
LG
503 ## Retrieve RFCLanguage filter\r
504 def _GetRFCLanguages(self):\r
505 if self._RFCLanguages == None:\r
506 if self._Header == None:\r
507 self._GetHeaderInfo()\r
508 if self._RFCLanguages == None:\r
509 self._RFCLanguages = []\r
510 return self._RFCLanguages\r
511\r
512 ## Retrieve ISOLanguage filter\r
513 def _GetISOLanguages(self):\r
514 if self._ISOLanguages == None:\r
515 if self._Header == None:\r
516 self._GetHeaderInfo()\r
517 if self._ISOLanguages == None:\r
518 self._ISOLanguages = []\r
519 return self._ISOLanguages\r
e56468c0 520 ## Retrieve the GUID string for VPD tool\r
521 def _GetVpdToolGuid(self):\r
522 if self._VpdToolGuid == None:\r
523 if self._Header == None:\r
524 self._GetHeaderInfo()\r
525 if self._VpdToolGuid == None:\r
526 self._VpdToolGuid = ''\r
527 return self._VpdToolGuid\r
08dd311f 528 \r
52302d4d
LG
529 ## Retrieve [SkuIds] section information\r
530 def _GetSkuIds(self):\r
531 if self._SkuIds == None:\r
0d2711a6
LG
532 self._SkuIds = sdict()\r
533 RecordList = self._RawData[MODEL_EFI_SKU_ID, self._Arch]\r
52302d4d
LG
534 for Record in RecordList:\r
535 if Record[0] in [None, '']:\r
536 EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID number',\r
537 File=self.MetaFile, Line=Record[-1])\r
538 if Record[1] in [None, '']:\r
539 EdkLogger.error('build', FORMAT_INVALID, 'No Sku ID name',\r
540 File=self.MetaFile, Line=Record[-1])\r
2bc3256c 541 self._SkuIds[Record[1]] = Record[0]\r
52302d4d 542 if 'DEFAULT' not in self._SkuIds:\r
d0acc87a 543 self._SkuIds['DEFAULT'] = '0'\r
e8a47801
LG
544 if 'COMMON' not in self._SkuIds:\r
545 self._SkuIds['COMMON'] = '0'\r
52302d4d
LG
546 return self._SkuIds\r
547\r
548 ## Retrieve [Components] section information\r
549 def _GetModules(self):\r
550 if self._Modules != None:\r
551 return self._Modules\r
552\r
553 self._Modules = sdict()\r
554 RecordList = self._RawData[MODEL_META_DATA_COMPONENT, self._Arch]\r
0d2711a6
LG
555 Macros = self._Macros\r
556 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d 557 for Record in RecordList:\r
97fa0ee9 558 DuplicatedFile = False\r
77177984 559\r
52302d4d
LG
560 ModuleFile = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
561 ModuleId = Record[5]\r
562 LineNo = Record[6]\r
563\r
564 # check the file validation\r
565 ErrorCode, ErrorInfo = ModuleFile.Validate('.inf')\r
566 if ErrorCode != 0:\r
567 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
568 ExtraData=ErrorInfo)\r
569 # Check duplication\r
64b2609f
LG
570 # If arch is COMMON, no duplicate module is checked since all modules in all component sections are selected\r
571 if self._Arch != 'COMMON' and ModuleFile in self._Modules:\r
97fa0ee9 572 DuplicatedFile = True\r
52302d4d
LG
573\r
574 Module = ModuleBuildClassObject()\r
575 Module.MetaFile = ModuleFile\r
576\r
52302d4d
LG
577 # get module private library instance\r
578 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, ModuleId]\r
579 for Record in RecordList:\r
580 LibraryClass = Record[0]\r
581 LibraryPath = PathClass(NormPath(Record[1], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
582 LineNo = Record[-1]\r
583\r
584 # check the file validation\r
585 ErrorCode, ErrorInfo = LibraryPath.Validate('.inf')\r
586 if ErrorCode != 0:\r
587 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
588 ExtraData=ErrorInfo)\r
589\r
590 if LibraryClass == '' or LibraryClass == 'NULL':\r
591 self._NullLibraryNumber += 1\r
592 LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
593 EdkLogger.verbose("Found forced library for %s\n\t%s [%s]" % (ModuleFile, LibraryPath, LibraryClass))\r
594 Module.LibraryClasses[LibraryClass] = LibraryPath\r
595 if LibraryPath not in self.LibraryInstances:\r
596 self.LibraryInstances.append(LibraryPath)\r
597\r
598 # get module private PCD setting\r
599 for Type in [MODEL_PCD_FIXED_AT_BUILD, MODEL_PCD_PATCHABLE_IN_MODULE, \\r
600 MODEL_PCD_FEATURE_FLAG, MODEL_PCD_DYNAMIC, MODEL_PCD_DYNAMIC_EX]:\r
601 RecordList = self._RawData[Type, self._Arch, None, ModuleId]\r
602 for TokenSpaceGuid, PcdCName, Setting, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
603 TokenList = GetSplitValueList(Setting)\r
604 DefaultValue = TokenList[0]\r
605 if len(TokenList) > 1:\r
606 MaxDatumSize = TokenList[1]\r
607 else:\r
608 MaxDatumSize = ''\r
609 TypeString = self._PCD_TYPE_STRING_[Type]\r
610 Pcd = PcdClassObject(\r
611 PcdCName,\r
612 TokenSpaceGuid,\r
613 TypeString,\r
614 '',\r
615 DefaultValue,\r
616 '',\r
617 MaxDatumSize,\r
618 {},\r
e56468c0 619 False,\r
52302d4d
LG
620 None\r
621 )\r
622 Module.Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
623\r
624 # get module private build options\r
625 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, None, ModuleId]\r
626 for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
627 if (ToolChainFamily, ToolChain) not in Module.BuildOptions:\r
628 Module.BuildOptions[ToolChainFamily, ToolChain] = Option\r
629 else:\r
630 OptionString = Module.BuildOptions[ToolChainFamily, ToolChain]\r
631 Module.BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
632\r
97fa0ee9
YL
633 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, None, ModuleId]\r
634 if DuplicatedFile and not RecordList:\r
635 EdkLogger.error('build', FILE_DUPLICATED, File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)\r
636 if RecordList:\r
637 if len(RecordList) != 1:\r
638 EdkLogger.error('build', OPTION_UNKNOWN, 'Only FILE_GUID can be listed in <Defines> section.',\r
639 File=self.MetaFile, ExtraData=str(ModuleFile), Line=LineNo)\r
640 ModuleFile = ProcessDuplicatedInf(ModuleFile, RecordList[0][2], GlobalData.gWorkspace)\r
641 ModuleFile.Arch = self._Arch\r
642\r
52302d4d
LG
643 self._Modules[ModuleFile] = Module\r
644 return self._Modules\r
645\r
646 ## Retrieve all possible library instances used in this platform\r
647 def _GetLibraryInstances(self):\r
648 if self._LibraryInstances == None:\r
649 self._GetLibraryClasses()\r
650 return self._LibraryInstances\r
651\r
652 ## Retrieve [LibraryClasses] information\r
653 def _GetLibraryClasses(self):\r
654 if self._LibraryClasses == None:\r
655 self._LibraryInstances = []\r
656 #\r
657 # tdict is a special dict kind of type, used for selecting correct\r
658 # library instance for given library class and module type\r
659 #\r
660 LibraryClassDict = tdict(True, 3)\r
661 # track all library class names\r
662 LibraryClassSet = set()\r
0d2711a6
LG
663 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, None, -1]\r
664 Macros = self._Macros\r
52302d4d
LG
665 for Record in RecordList:\r
666 LibraryClass, LibraryInstance, Dummy, Arch, ModuleType, Dummy, LineNo = Record\r
667 if LibraryClass == '' or LibraryClass == 'NULL':\r
668 self._NullLibraryNumber += 1\r
669 LibraryClass = 'NULL%d' % self._NullLibraryNumber\r
670 EdkLogger.verbose("Found forced library for arch=%s\n\t%s [%s]" % (Arch, LibraryInstance, LibraryClass))\r
671 LibraryClassSet.add(LibraryClass)\r
672 LibraryInstance = PathClass(NormPath(LibraryInstance, Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
673 # check the file validation\r
674 ErrorCode, ErrorInfo = LibraryInstance.Validate('.inf')\r
675 if ErrorCode != 0:\r
676 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
677 ExtraData=ErrorInfo)\r
678\r
679 if ModuleType != 'COMMON' and ModuleType not in SUP_MODULE_LIST:\r
680 EdkLogger.error('build', OPTION_UNKNOWN, "Unknown module type [%s]" % ModuleType,\r
681 File=self.MetaFile, ExtraData=LibraryInstance, Line=LineNo)\r
682 LibraryClassDict[Arch, ModuleType, LibraryClass] = LibraryInstance\r
683 if LibraryInstance not in self._LibraryInstances:\r
684 self._LibraryInstances.append(LibraryInstance)\r
685\r
686 # resolve the specific library instance for each class and each module type\r
687 self._LibraryClasses = tdict(True)\r
688 for LibraryClass in LibraryClassSet:\r
689 # try all possible module types\r
690 for ModuleType in SUP_MODULE_LIST:\r
691 LibraryInstance = LibraryClassDict[self._Arch, ModuleType, LibraryClass]\r
692 if LibraryInstance == None:\r
693 continue\r
694 self._LibraryClasses[LibraryClass, ModuleType] = LibraryInstance\r
695\r
0d2711a6
LG
696 # for Edk style library instances, which are listed in different section\r
697 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d
LG
698 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch]\r
699 for Record in RecordList:\r
700 File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
701 LineNo = Record[-1]\r
702 # check the file validation\r
703 ErrorCode, ErrorInfo = File.Validate('.inf')\r
704 if ErrorCode != 0:\r
705 EdkLogger.error('build', ErrorCode, File=self.MetaFile, Line=LineNo,\r
706 ExtraData=ErrorInfo)\r
707 if File not in self._LibraryInstances:\r
708 self._LibraryInstances.append(File)\r
709 #\r
710 # we need the module name as the library class name, so we have\r
711 # to parse it here. (self._Bdb[] will trigger a file parse if it\r
712 # hasn't been parsed)\r
713 #\r
0d2711a6 714 Library = self._Bdb[File, self._Arch, self._Target, self._Toolchain]\r
52302d4d
LG
715 self._LibraryClasses[Library.BaseName, ':dummy:'] = Library\r
716 return self._LibraryClasses\r
717\r
4afd3d04
LG
718 def _ValidatePcd(self, PcdCName, TokenSpaceGuid, Setting, PcdType, LineNo):\r
719 if self._DecPcds == None:\r
720 self._DecPcds = GetDeclaredPcd(self, self._Bdb, self._Arch, self._Target, self._Toolchain)\r
97fa0ee9
YL
721 FdfInfList = []\r
722 if GlobalData.gFdfParser:\r
723 FdfInfList = GlobalData.gFdfParser.Profile.InfList\r
724\r
725 PkgSet = set()\r
726 for Inf in FdfInfList:\r
727 ModuleFile = PathClass(NormPath(Inf), GlobalData.gWorkspace, Arch=self._Arch)\r
728 if ModuleFile in self._Modules:\r
729 continue\r
730 ModuleData = self._Bdb[ModuleFile, self._Arch, self._Target, self._Toolchain]\r
731 PkgSet.update(ModuleData.Packages)\r
732 DecPcds = {}\r
733 for Pkg in PkgSet:\r
734 for Pcd in Pkg.Pcds:\r
735 DecPcds[Pcd[0], Pcd[1]] = Pkg.Pcds[Pcd]\r
736 self._DecPcds.update(DecPcds)\r
737\r
4afd3d04
LG
738 if (PcdCName, TokenSpaceGuid) not in self._DecPcds:\r
739 EdkLogger.error('build', PARSER_ERROR,\r
97fa0ee9 740 "Pcd (%s.%s) defined in DSC is not declared in DEC files. Arch: ['%s']" % (TokenSpaceGuid, PcdCName, self._Arch),\r
4afd3d04
LG
741 File=self.MetaFile, Line=LineNo)\r
742 ValueList, IsValid, Index = AnalyzeDscPcd(Setting, PcdType, self._DecPcds[PcdCName, TokenSpaceGuid].DatumType)\r
743 if not IsValid and PcdType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:\r
744 EdkLogger.error('build', FORMAT_INVALID, "Pcd format incorrect.", File=self.MetaFile, Line=LineNo,\r
745 ExtraData="%s.%s|%s" % (TokenSpaceGuid, PcdCName, Setting))\r
746 if ValueList[Index] and PcdType not in [MODEL_PCD_FEATURE_FLAG, MODEL_PCD_FIXED_AT_BUILD]:\r
747 try:\r
748 ValueList[Index] = ValueExpression(ValueList[Index], GlobalData.gPlatformPcds)(True)\r
749 except WrnExpression, Value:\r
750 ValueList[Index] = Value.result\r
751 except EvaluationException, Excpt:\r
752 if hasattr(Excpt, 'Pcd'):\r
753 if Excpt.Pcd in GlobalData.gPlatformOtherPcds:\r
754 EdkLogger.error('Parser', FORMAT_INVALID, "Cannot use this PCD (%s) in an expression as"\r
755 " it must be defined in a [PcdsFixedAtBuild] or [PcdsFeatureFlag] section"\r
756 " of the DSC file" % Excpt.Pcd,\r
757 File=self.MetaFile, Line=LineNo)\r
758 else:\r
759 EdkLogger.error('Parser', FORMAT_INVALID, "PCD (%s) is not defined in DSC file" % Excpt.Pcd,\r
760 File=self.MetaFile, Line=LineNo)\r
761 else:\r
762 EdkLogger.error('Parser', FORMAT_INVALID, "Invalid expression: %s" % str(Excpt),\r
763 File=self.MetaFile, Line=LineNo)\r
764 if ValueList[Index] == 'True':\r
765 ValueList[Index] = '1'\r
766 elif ValueList[Index] == 'False':\r
767 ValueList[Index] = '0'\r
768 if ValueList[Index]:\r
769 Valid, ErrStr = CheckPcdDatum(self._DecPcds[PcdCName, TokenSpaceGuid].DatumType, ValueList[Index])\r
770 if not Valid:\r
771 EdkLogger.error('build', FORMAT_INVALID, ErrStr, File=self.MetaFile, Line=LineNo,\r
772 ExtraData="%s.%s" % (TokenSpaceGuid, PcdCName))\r
773 return ValueList\r
774\r
52302d4d
LG
775 ## Retrieve all PCD settings in platform\r
776 def _GetPcds(self):\r
777 if self._Pcds == None:\r
0d2711a6 778 self._Pcds = sdict()\r
52302d4d
LG
779 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
780 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
781 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
782 self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_DEFAULT))\r
783 self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_HII))\r
784 self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_VPD))\r
785 self._Pcds.update(self._GetDynamicPcd(MODEL_PCD_DYNAMIC_EX_DEFAULT))\r
786 self._Pcds.update(self._GetDynamicHiiPcd(MODEL_PCD_DYNAMIC_EX_HII))\r
787 self._Pcds.update(self._GetDynamicVpdPcd(MODEL_PCD_DYNAMIC_EX_VPD))\r
788 return self._Pcds\r
789\r
790 ## Retrieve [BuildOptions]\r
791 def _GetBuildOptions(self):\r
792 if self._BuildOptions == None:\r
0d2711a6 793 self._BuildOptions = sdict()\r
52302d4d 794 #\r
1ba5124e 795 # Retrieve build option for EDKII and EDK style module\r
52302d4d 796 #\r
1ba5124e
YL
797 for CodeBase in (EDKII_NAME, EDK_NAME):\r
798 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, CodeBase]\r
799 for ToolChainFamily, ToolChain, Option, Dummy1, Dummy2, Dummy3, Dummy4 in RecordList:\r
800 CurKey = (ToolChainFamily, ToolChain, CodeBase)\r
1ba5124e
YL
801 #\r
802 # Only flags can be appended\r
803 #\r
5015bee2 804 if CurKey not in self._BuildOptions or not ToolChain.endswith('_FLAGS') or Option.startswith('='):\r
1ba5124e
YL
805 self._BuildOptions[CurKey] = Option\r
806 else:\r
807 self._BuildOptions[CurKey] += ' ' + Option\r
52302d4d
LG
808 return self._BuildOptions\r
809\r
35f69db9
YL
810 def GetBuildOptionsByModuleType(self, Edk, ModuleType):\r
811 if self._ModuleTypeOptions == None:\r
812 self._ModuleTypeOptions = sdict()\r
813 if (Edk, ModuleType) not in self._ModuleTypeOptions:\r
814 options = sdict()\r
815 self._ModuleTypeOptions[Edk, ModuleType] = options\r
816 DriverType = '%s.%s' % (Edk, ModuleType)\r
35dc964b 817 CommonDriverType = '%s.%s' % ('COMMON', ModuleType)\r
35f69db9
YL
818 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, DriverType]\r
819 for ToolChainFamily, ToolChain, Option, Arch, Type, Dummy3, Dummy4 in RecordList:\r
35dc964b 820 if Type == DriverType or Type == CommonDriverType:\r
1ba5124e 821 Key = (ToolChainFamily, ToolChain, Edk)\r
5015bee2 822 if Key not in options or not ToolChain.endswith('_FLAGS') or Option.startswith('='):\r
1ba5124e
YL
823 options[Key] = Option\r
824 else:\r
825 options[Key] += ' ' + Option\r
35f69db9
YL
826 return self._ModuleTypeOptions[Edk, ModuleType]\r
827\r
52302d4d
LG
828 ## Retrieve non-dynamic PCD settings\r
829 #\r
830 # @param Type PCD type\r
831 #\r
832 # @retval a dict object contains settings of given PCD type\r
833 #\r
834 def _GetPcd(self, Type):\r
0d2711a6 835 Pcds = sdict()\r
52302d4d
LG
836 #\r
837 # tdict is a special dict kind of type, used for selecting correct\r
838 # PCD settings for certain ARCH\r
839 #\r
e8a47801
LG
840 \r
841 SkuObj = SkuClass(self.SkuIdentifier,self.SkuIds)\r
842 \r
52302d4d
LG
843 PcdDict = tdict(True, 3)\r
844 PcdSet = set()\r
845 # Find out all possible PCD candidates for self._Arch\r
846 RecordList = self._RawData[Type, self._Arch]\r
e8a47801 847 PcdValueDict = sdict()\r
52302d4d 848 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
e8a47801
LG
849 if SkuName in (SkuObj.SystemSkuId,'DEFAULT','COMMON'):\r
850 PcdSet.add((PcdCName, TokenSpaceGuid, SkuName,Dummy4))\r
851 PcdDict[Arch, PcdCName, TokenSpaceGuid,SkuName] = Setting\r
852 \r
853 #handle pcd value override \r
854 for PcdCName, TokenSpaceGuid, SkuName,Dummy4 in PcdSet:\r
855 Setting = PcdDict[self._Arch, PcdCName, TokenSpaceGuid,SkuName]\r
52302d4d
LG
856 if Setting == None:\r
857 continue\r
4afd3d04 858 PcdValue, DatumType, MaxDatumSize = self._ValidatePcd(PcdCName, TokenSpaceGuid, Setting, Type, Dummy4)\r
e8a47801
LG
859 if (PcdCName, TokenSpaceGuid) in PcdValueDict:\r
860 PcdValueDict[PcdCName, TokenSpaceGuid][SkuName] = (PcdValue,DatumType,MaxDatumSize) \r
861 else:\r
862 PcdValueDict[PcdCName, TokenSpaceGuid] = {SkuName:(PcdValue,DatumType,MaxDatumSize)} \r
863 \r
864 PcdsKeys = PcdValueDict.keys()\r
865 for PcdCName,TokenSpaceGuid in PcdsKeys:\r
866 \r
867 PcdSetting = PcdValueDict[PcdCName, TokenSpaceGuid]\r
868 PcdValue = None\r
869 DatumType = None\r
870 MaxDatumSize = None\r
871 if 'COMMON' in PcdSetting:\r
872 PcdValue,DatumType,MaxDatumSize = PcdSetting['COMMON']\r
873 if 'DEFAULT' in PcdSetting:\r
874 PcdValue,DatumType,MaxDatumSize = PcdSetting['DEFAULT']\r
875 if SkuObj.SystemSkuId in PcdSetting:\r
876 PcdValue,DatumType,MaxDatumSize = PcdSetting[SkuObj.SystemSkuId]\r
877 \r
52302d4d
LG
878 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
879 PcdCName,\r
880 TokenSpaceGuid,\r
881 self._PCD_TYPE_STRING_[Type],\r
882 DatumType,\r
883 PcdValue,\r
884 '',\r
885 MaxDatumSize,\r
886 {},\r
e56468c0 887 False,\r
52302d4d
LG
888 None\r
889 )\r
890 return Pcds\r
891\r
892 ## Retrieve dynamic PCD settings\r
893 #\r
894 # @param Type PCD type\r
895 #\r
896 # @retval a dict object contains settings of given PCD type\r
897 #\r
898 def _GetDynamicPcd(self, Type):\r
e8a47801
LG
899 \r
900 SkuObj = SkuClass(self.SkuIdentifier,self.SkuIds)\r
901 \r
0d2711a6 902 Pcds = sdict()\r
52302d4d
LG
903 #\r
904 # tdict is a special dict kind of type, used for selecting correct\r
905 # PCD settings for certain ARCH and SKU\r
906 #\r
907 PcdDict = tdict(True, 4)\r
6780eef1 908 PcdList = []\r
52302d4d
LG
909 # Find out all possible PCD candidates for self._Arch\r
910 RecordList = self._RawData[Type, self._Arch]\r
e8a47801
LG
911 AvailableSkuIdSet = SkuObj.AvailableSkuIdSet.copy()\r
912 \r
913 AvailableSkuIdSet.update({'DEFAULT':0,'COMMON':0})\r
52302d4d 914 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
e8a47801
LG
915 if SkuName not in AvailableSkuIdSet:\r
916 continue\r
917 \r
918 PcdList.append((PcdCName, TokenSpaceGuid, SkuName,Dummy4))\r
52302d4d
LG
919 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
920 # Remove redundant PCD candidates, per the ARCH and SKU\r
e8a47801
LG
921 for PcdCName, TokenSpaceGuid, SkuName, Dummy4 in PcdList:\r
922 \r
923 Setting = PcdDict[self._Arch, SkuName, PcdCName, TokenSpaceGuid]\r
52302d4d
LG
924 if Setting == None:\r
925 continue\r
6780eef1 926 \r
4afd3d04 927 PcdValue, DatumType, MaxDatumSize = self._ValidatePcd(PcdCName, TokenSpaceGuid, Setting, Type, Dummy4)\r
e8a47801
LG
928 SkuInfo = SkuInfoClass(SkuName, self.SkuIds[SkuName], '', '', '', '', '', PcdValue)\r
929 if (PcdCName,TokenSpaceGuid) in Pcds.keys(): \r
930 pcdObject = Pcds[PcdCName,TokenSpaceGuid]\r
931 pcdObject.SkuInfoList[SkuName] = SkuInfo\r
2bc3256c
LG
932 if MaxDatumSize.strip():\r
933 CurrentMaxSize = int(MaxDatumSize.strip(),0)\r
934 else:\r
935 CurrentMaxSize = 0\r
936 if pcdObject.MaxDatumSize:\r
937 PcdMaxSize = int(pcdObject.MaxDatumSize,0)\r
938 else:\r
939 PcdMaxSize = 0\r
940 if CurrentMaxSize > PcdMaxSize:\r
941 pcdObject.MaxDatumSize = str(CurrentMaxSize)\r
e8a47801
LG
942 else: \r
943 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
944 PcdCName,\r
945 TokenSpaceGuid,\r
946 self._PCD_TYPE_STRING_[Type],\r
947 DatumType,\r
948 PcdValue,\r
949 '',\r
950 MaxDatumSize,\r
951 {SkuName : SkuInfo},\r
952 False,\r
953 None\r
954 )\r
955 \r
956 for pcd in Pcds.values():\r
2bc3256c
LG
957 pcdDecObject = self._DecPcds[pcd.TokenCName,pcd.TokenSpaceGuidCName]\r
958 if 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' not in pcd.SkuInfoList.keys(): \r
e8a47801
LG
959 valuefromDec = pcdDecObject.DefaultValue\r
960 SkuInfo = SkuInfoClass('DEFAULT', '0', '', '', '', '', '', valuefromDec)\r
961 pcd.SkuInfoList['DEFAULT'] = SkuInfo\r
962 elif 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
963 pcd.SkuInfoList['DEFAULT'] = pcd.SkuInfoList['COMMON']\r
964 del(pcd.SkuInfoList['COMMON'])\r
965 elif 'DEFAULT' in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
966 del(pcd.SkuInfoList['COMMON'])\r
967 if SkuObj.SkuUsageType == SkuObj.SINGLE:\r
968 if 'DEFAULT' in pcd.SkuInfoList.keys() and SkuObj.SystemSkuId not in pcd.SkuInfoList.keys():\r
969 pcd.SkuInfoList[SkuObj.SystemSkuId] = pcd.SkuInfoList['DEFAULT']\r
970 del(pcd.SkuInfoList['DEFAULT'])\r
2bc3256c 971 \r
52302d4d
LG
972 return Pcds\r
973\r
82a6a960
BF
974 def CompareVarAttr(self, Attr1, Attr2):\r
975 if not Attr1 or not Attr2: # for empty string\r
976 return True\r
977 Attr1s = [attr.strip() for attr in Attr1.split(",")]\r
978 Attr1Set = set(Attr1s)\r
979 Attr2s = [attr.strip() for attr in Attr2.split(",")]\r
980 Attr2Set = set(Attr2s)\r
981 if Attr2Set == Attr1Set:\r
982 return True\r
983 else:\r
984 return False\r
52302d4d
LG
985 ## Retrieve dynamic HII PCD settings\r
986 #\r
987 # @param Type PCD type\r
988 #\r
989 # @retval a dict object contains settings of given PCD type\r
990 #\r
991 def _GetDynamicHiiPcd(self, Type):\r
e8a47801
LG
992 \r
993 SkuObj = SkuClass(self.SkuIdentifier,self.SkuIds)\r
82a6a960 994 VariableAttrs = {}\r
e8a47801 995 \r
0d2711a6 996 Pcds = sdict()\r
52302d4d
LG
997 #\r
998 # tdict is a special dict kind of type, used for selecting correct\r
999 # PCD settings for certain ARCH and SKU\r
1000 #\r
1001 PcdDict = tdict(True, 4)\r
1002 PcdSet = set()\r
1003 RecordList = self._RawData[Type, self._Arch]\r
1004 # Find out all possible PCD candidates for self._Arch\r
e8a47801
LG
1005 AvailableSkuIdSet = SkuObj.AvailableSkuIdSet.copy()\r
1006 \r
1007 AvailableSkuIdSet.update({'DEFAULT':0,'COMMON':0})\r
52302d4d 1008 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
e8a47801
LG
1009 if SkuName not in AvailableSkuIdSet:\r
1010 continue\r
1011 PcdSet.add((PcdCName, TokenSpaceGuid, SkuName,Dummy4))\r
52302d4d
LG
1012 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
1013 # Remove redundant PCD candidates, per the ARCH and SKU\r
e8a47801
LG
1014 for PcdCName, TokenSpaceGuid,SkuName, Dummy4 in PcdSet:\r
1015 \r
1016 Setting = PcdDict[self._Arch, SkuName, PcdCName, TokenSpaceGuid]\r
52302d4d
LG
1017 if Setting == None:\r
1018 continue\r
82a6a960 1019 VariableName, VariableGuid, VariableOffset, DefaultValue, VarAttribute = self._ValidatePcd(PcdCName, TokenSpaceGuid, Setting, Type, Dummy4)\r
2bc3256c 1020 \r
82a6a960
BF
1021 rt, Msg = VariableAttributes.ValidateVarAttributes(VarAttribute)\r
1022 if not rt:\r
1023 EdkLogger.error("build", PCD_VARIABLE_ATTRIBUTES_ERROR, "Variable attributes settings for %s is incorrect.\n %s" % (".".join((TokenSpaceGuid, PcdCName)), Msg),\r
1024 ExtraData = "[%s]" % VarAttribute)\r
2bc3256c 1025 ExceedMax = False\r
e4ac870f 1026 FormatCorrect = True\r
2bc3256c
LG
1027 if VariableOffset.isdigit():\r
1028 if int(VariableOffset,10) > 0xFFFF:\r
1029 ExceedMax = True\r
1030 elif re.match(r'[\t\s]*0[xX][a-fA-F0-9]+$',VariableOffset):\r
1031 if int(VariableOffset,16) > 0xFFFF:\r
1032 ExceedMax = True\r
e4ac870f
LG
1033 # For Offset written in "A.B"\r
1034 elif VariableOffset.find('.') > -1:\r
1035 VariableOffsetList = VariableOffset.split(".")\r
1036 if not (len(VariableOffsetList) == 2\r
1037 and IsValidWord(VariableOffsetList[0])\r
1038 and IsValidWord(VariableOffsetList[1])):\r
1039 FormatCorrect = False\r
2bc3256c 1040 else:\r
e4ac870f
LG
1041 FormatCorrect = False\r
1042 if not FormatCorrect:\r
2bc3256c
LG
1043 EdkLogger.error('Build', FORMAT_INVALID, "Invalid syntax or format of the variable offset value is incorrect for %s." % ".".join((TokenSpaceGuid,PcdCName)))\r
1044 \r
1045 if ExceedMax:\r
1046 EdkLogger.error('Build', OPTION_VALUE_INVALID, "The variable offset value must not exceed the maximum value of 0xFFFF (UINT16) for %s." % ".".join((TokenSpaceGuid,PcdCName)))\r
82a6a960
BF
1047 if (VariableName, VariableGuid) not in VariableAttrs:\r
1048 VariableAttrs[(VariableName, VariableGuid)] = VarAttribute\r
1049 else:\r
1050 if not self.CompareVarAttr(VariableAttrs[(VariableName, VariableGuid)], VarAttribute):\r
1051 EdkLogger.error('Build', PCD_VARIABLE_ATTRIBUTES_CONFLICT_ERROR, "The variable %s.%s for DynamicHii PCDs has conflicting attributes [%s] and [%s] " % (VariableGuid, VariableName, VarAttribute, VariableAttrs[(VariableName, VariableGuid)]))\r
2bc3256c 1052 \r
82a6a960
BF
1053 SkuInfo = SkuInfoClass(SkuName, self.SkuIds[SkuName], VariableName, VariableGuid, VariableOffset, DefaultValue, VariableAttribute = VarAttribute)\r
1054 pcdDecObject = self._DecPcds[PcdCName, TokenSpaceGuid]\r
e8a47801
LG
1055 if (PcdCName,TokenSpaceGuid) in Pcds.keys(): \r
1056 pcdObject = Pcds[PcdCName,TokenSpaceGuid]\r
1057 pcdObject.SkuInfoList[SkuName] = SkuInfo\r
1058 else:\r
1059 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
52302d4d
LG
1060 PcdCName,\r
1061 TokenSpaceGuid,\r
1062 self._PCD_TYPE_STRING_[Type],\r
1063 '',\r
1064 DefaultValue,\r
1065 '',\r
1066 '',\r
e8a47801 1067 {SkuName : SkuInfo},\r
e56468c0 1068 False,\r
82a6a960
BF
1069 None,\r
1070 pcdDecObject.validateranges,\r
1071 pcdDecObject.validlists,\r
1072 pcdDecObject.expressions\r
52302d4d 1073 )\r
e8a47801
LG
1074 \r
1075\r
1076 for pcd in Pcds.values():\r
1077 SkuInfoObj = pcd.SkuInfoList.values()[0]\r
2bc3256c
LG
1078 pcdDecObject = self._DecPcds[pcd.TokenCName,pcd.TokenSpaceGuidCName]\r
1079 # Only fix the value while no value provided in DSC file.\r
1080 for sku in pcd.SkuInfoList.values():\r
1081 if (sku.HiiDefaultValue == "" or sku.HiiDefaultValue==None):\r
1082 sku.HiiDefaultValue = pcdDecObject.DefaultValue\r
1083 if 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' not in pcd.SkuInfoList.keys(): \r
e8a47801
LG
1084 valuefromDec = pcdDecObject.DefaultValue\r
1085 SkuInfo = SkuInfoClass('DEFAULT', '0', SkuInfoObj.VariableName, SkuInfoObj.VariableGuid, SkuInfoObj.VariableOffset, valuefromDec)\r
1086 pcd.SkuInfoList['DEFAULT'] = SkuInfo\r
1087 elif 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
1088 pcd.SkuInfoList['DEFAULT'] = pcd.SkuInfoList['COMMON']\r
1089 del(pcd.SkuInfoList['COMMON'])\r
1090 elif 'DEFAULT' in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
1091 del(pcd.SkuInfoList['COMMON'])\r
1092 \r
1093 if SkuObj.SkuUsageType == SkuObj.SINGLE:\r
1094 if 'DEFAULT' in pcd.SkuInfoList.keys() and SkuObj.SystemSkuId not in pcd.SkuInfoList.keys():\r
1095 pcd.SkuInfoList[SkuObj.SystemSkuId] = pcd.SkuInfoList['DEFAULT']\r
1096 del(pcd.SkuInfoList['DEFAULT'])\r
2bc3256c
LG
1097 \r
1098 \r
1099 if pcd.MaxDatumSize.strip(): \r
1100 MaxSize = int(pcd.MaxDatumSize,0)\r
1101 else:\r
1102 MaxSize = 0\r
1103 if pcdDecObject.DatumType == 'VOID*':\r
1104 for (skuname,skuobj) in pcd.SkuInfoList.items():\r
1105 datalen = 0\r
1106 if skuobj.HiiDefaultValue.startswith("L"):\r
1107 datalen = (len(skuobj.HiiDefaultValue)- 3 + 1) * 2\r
1108 elif skuobj.HiiDefaultValue.startswith("{"):\r
1109 datalen = len(skuobj.HiiDefaultValue.split(","))\r
1110 else:\r
1111 datalen = len(skuobj.HiiDefaultValue) -2 + 1 \r
1112 if datalen>MaxSize:\r
1113 MaxSize = datalen\r
1114 pcd.MaxDatumSize = str(MaxSize)\r
52302d4d
LG
1115 return Pcds\r
1116\r
1117 ## Retrieve dynamic VPD PCD settings\r
1118 #\r
1119 # @param Type PCD type\r
1120 #\r
1121 # @retval a dict object contains settings of given PCD type\r
1122 #\r
1123 def _GetDynamicVpdPcd(self, Type):\r
e8a47801
LG
1124 \r
1125 SkuObj = SkuClass(self.SkuIdentifier,self.SkuIds)\r
1126 \r
0d2711a6 1127 Pcds = sdict()\r
52302d4d
LG
1128 #\r
1129 # tdict is a special dict kind of type, used for selecting correct\r
1130 # PCD settings for certain ARCH and SKU\r
1131 #\r
1132 PcdDict = tdict(True, 4)\r
6780eef1 1133 PcdList = []\r
52302d4d
LG
1134 # Find out all possible PCD candidates for self._Arch\r
1135 RecordList = self._RawData[Type, self._Arch]\r
e8a47801
LG
1136 AvailableSkuIdSet = SkuObj.AvailableSkuIdSet.copy()\r
1137 \r
1138 AvailableSkuIdSet.update({'DEFAULT':0,'COMMON':0})\r
52302d4d 1139 for TokenSpaceGuid, PcdCName, Setting, Arch, SkuName, Dummy3, Dummy4 in RecordList:\r
e8a47801
LG
1140 if SkuName not in AvailableSkuIdSet:\r
1141 continue\r
1142\r
1143 PcdList.append((PcdCName, TokenSpaceGuid,SkuName, Dummy4))\r
52302d4d
LG
1144 PcdDict[Arch, SkuName, PcdCName, TokenSpaceGuid] = Setting\r
1145 # Remove redundant PCD candidates, per the ARCH and SKU\r
e8a47801
LG
1146 for PcdCName, TokenSpaceGuid, SkuName,Dummy4 in PcdList:\r
1147 Setting = PcdDict[self._Arch, SkuName, PcdCName, TokenSpaceGuid]\r
52302d4d
LG
1148 if Setting == None:\r
1149 continue\r
e56468c0 1150 #\r
1151 # For the VOID* type, it can have optional data of MaxDatumSize and InitialValue\r
1152 # For the Integer & Boolean type, the optional data can only be InitialValue.\r
1153 # At this point, we put all the data into the PcdClssObject for we don't know the PCD's datumtype\r
1154 # until the DEC parser has been called.\r
1155 # \r
4afd3d04 1156 VpdOffset, MaxDatumSize, InitialValue = self._ValidatePcd(PcdCName, TokenSpaceGuid, Setting, Type, Dummy4)\r
e8a47801
LG
1157 SkuInfo = SkuInfoClass(SkuName, self.SkuIds[SkuName], '', '', '', '', VpdOffset, InitialValue)\r
1158 if (PcdCName,TokenSpaceGuid) in Pcds.keys(): \r
1159 pcdObject = Pcds[PcdCName,TokenSpaceGuid]\r
1160 pcdObject.SkuInfoList[SkuName] = SkuInfo\r
2bc3256c
LG
1161 if MaxDatumSize.strip():\r
1162 CurrentMaxSize = int(MaxDatumSize.strip(),0)\r
1163 else:\r
1164 CurrentMaxSize = 0\r
1165 if pcdObject.MaxDatumSize:\r
1166 PcdMaxSize = int(pcdObject.MaxDatumSize,0)\r
1167 else:\r
1168 PcdMaxSize = 0\r
1169 if CurrentMaxSize > PcdMaxSize:\r
1170 pcdObject.MaxDatumSize = str(CurrentMaxSize)\r
e8a47801
LG
1171 else:\r
1172 Pcds[PcdCName, TokenSpaceGuid] = PcdClassObject(\r
52302d4d
LG
1173 PcdCName,\r
1174 TokenSpaceGuid,\r
1175 self._PCD_TYPE_STRING_[Type],\r
1176 '',\r
37fe82ee 1177 InitialValue,\r
52302d4d
LG
1178 '',\r
1179 MaxDatumSize,\r
e8a47801 1180 {SkuName : SkuInfo},\r
e56468c0 1181 False,\r
52302d4d
LG
1182 None\r
1183 )\r
e8a47801
LG
1184 for pcd in Pcds.values():\r
1185 SkuInfoObj = pcd.SkuInfoList.values()[0]\r
2bc3256c 1186 pcdDecObject = self._DecPcds[pcd.TokenCName,pcd.TokenSpaceGuidCName]\r
e8a47801 1187 if 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' not in pcd.SkuInfoList.keys():\r
e8a47801
LG
1188 valuefromDec = pcdDecObject.DefaultValue\r
1189 SkuInfo = SkuInfoClass('DEFAULT', '0', '', '', '','',SkuInfoObj.VpdOffset, valuefromDec)\r
1190 pcd.SkuInfoList['DEFAULT'] = SkuInfo\r
1191 elif 'DEFAULT' not in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
1192 pcd.SkuInfoList['DEFAULT'] = pcd.SkuInfoList['COMMON']\r
1193 del(pcd.SkuInfoList['COMMON'])\r
1194 elif 'DEFAULT' in pcd.SkuInfoList.keys() and 'COMMON' in pcd.SkuInfoList.keys():\r
1195 del(pcd.SkuInfoList['COMMON'])\r
1196 if SkuObj.SkuUsageType == SkuObj.SINGLE:\r
1197 if 'DEFAULT' in pcd.SkuInfoList.keys() and SkuObj.SystemSkuId not in pcd.SkuInfoList.keys():\r
1198 pcd.SkuInfoList[SkuObj.SystemSkuId] = pcd.SkuInfoList['DEFAULT']\r
1199 del(pcd.SkuInfoList['DEFAULT'])\r
1200 \r
52302d4d
LG
1201 return Pcds\r
1202\r
1203 ## Add external modules\r
1204 #\r
1205 # The external modules are mostly those listed in FDF file, which don't\r
1206 # need "build".\r
1207 #\r
1208 # @param FilePath The path of module description file\r
1209 #\r
1210 def AddModule(self, FilePath):\r
1211 FilePath = NormPath(FilePath)\r
1212 if FilePath not in self.Modules:\r
1213 Module = ModuleBuildClassObject()\r
1214 Module.MetaFile = FilePath\r
1215 self.Modules.append(Module)\r
1216\r
1217 ## Add external PCDs\r
1218 #\r
1219 # The external PCDs are mostly those listed in FDF file to specify address\r
1220 # or offset information.\r
1221 #\r
1222 # @param Name Name of the PCD\r
1223 # @param Guid Token space guid of the PCD\r
1224 # @param Value Value of the PCD\r
1225 #\r
1226 def AddPcd(self, Name, Guid, Value):\r
1227 if (Name, Guid) not in self.Pcds:\r
e56468c0 1228 self.Pcds[Name, Guid] = PcdClassObject(Name, Guid, '', '', '', '', '', {}, False, None)\r
52302d4d
LG
1229 self.Pcds[Name, Guid].DefaultValue = Value\r
1230\r
0d2711a6 1231 _Macros = property(_GetMacros)\r
52302d4d
LG
1232 Arch = property(_GetArch, _SetArch)\r
1233 Platform = property(_GetPlatformName)\r
1234 PlatformName = property(_GetPlatformName)\r
1235 Guid = property(_GetFileGuid)\r
1236 Version = property(_GetVersion)\r
1237 DscSpecification = property(_GetDscSpec)\r
1238 OutputDirectory = property(_GetOutpuDir)\r
1239 SupArchList = property(_GetSupArch)\r
1240 BuildTargets = property(_GetBuildTarget)\r
1241 SkuName = property(_GetSkuName, _SetSkuName)\r
e8a47801 1242 SkuIdentifier = property(_GetSkuIdentifier)\r
1ae469b9 1243 AvilableSkuIds = property(_GetAviableSkuIds)\r
e8a47801 1244 PcdInfoFlag = property(_GetPcdInfoFlag)\r
82a6a960 1245 VarCheckFlag = property(_GetVarCheckFlag)\r
52302d4d 1246 FlashDefinition = property(_GetFdfFile)\r
f0dc69e6
YZ
1247 Prebuild = property(_GetPrebuild)\r
1248 Postbuild = property(_GetPostbuild)\r
52302d4d
LG
1249 BuildNumber = property(_GetBuildNumber)\r
1250 MakefileName = property(_GetMakefileName)\r
1251 BsBaseAddress = property(_GetBsBaseAddress)\r
1252 RtBaseAddress = property(_GetRtBaseAddress)\r
1253 LoadFixAddress = property(_GetLoadFixAddress)\r
6780eef1
LG
1254 RFCLanguages = property(_GetRFCLanguages)\r
1255 ISOLanguages = property(_GetISOLanguages)\r
08dd311f 1256 VpdToolGuid = property(_GetVpdToolGuid) \r
52302d4d
LG
1257 SkuIds = property(_GetSkuIds)\r
1258 Modules = property(_GetModules)\r
1259 LibraryInstances = property(_GetLibraryInstances)\r
1260 LibraryClasses = property(_GetLibraryClasses)\r
1261 Pcds = property(_GetPcds)\r
1262 BuildOptions = property(_GetBuildOptions)\r
1263\r
e56468c0 1264## Platform build information from DEC file\r
52302d4d
LG
1265#\r
1266# This class is used to retrieve information stored in database and convert them\r
1267# into PackageBuildClassObject form for easier use for AutoGen.\r
1268#\r
1269class DecBuildData(PackageBuildClassObject):\r
1270 # dict used to convert PCD type in database to string used by build tool\r
1271 _PCD_TYPE_STRING_ = {\r
1272 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
1273 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
1274 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
1275 MODEL_PCD_DYNAMIC : "Dynamic",\r
1276 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
1277 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
1278 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
1279 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
1280 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
1281 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
1282 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
1283 }\r
1284\r
1285 # dict used to convert part of [Defines] to members of DecBuildData directly\r
1286 _PROPERTY_ = {\r
1287 #\r
1288 # Required Fields\r
1289 #\r
1290 TAB_DEC_DEFINES_PACKAGE_NAME : "_PackageName",\r
1291 TAB_DEC_DEFINES_PACKAGE_GUID : "_Guid",\r
1292 TAB_DEC_DEFINES_PACKAGE_VERSION : "_Version",\r
e56468c0 1293 TAB_DEC_DEFINES_PKG_UNI_FILE : "_PkgUniFile",\r
52302d4d
LG
1294 }\r
1295\r
1296\r
1297 ## Constructor of DecBuildData\r
1298 #\r
1299 # Initialize object of DecBuildData\r
1300 #\r
1301 # @param FilePath The path of package description file\r
1302 # @param RawData The raw data of DEC file\r
1303 # @param BuildDataBase Database used to retrieve module information\r
1304 # @param Arch The target architecture\r
1305 # @param Platform (not used for DecBuildData)\r
1306 # @param Macros Macros used for replacement in DSC file\r
1307 #\r
0d2711a6 1308 def __init__(self, File, RawData, BuildDataBase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
1309 self.MetaFile = File\r
1310 self._PackageDir = File.Dir\r
1311 self._RawData = RawData\r
1312 self._Bdb = BuildDataBase\r
1313 self._Arch = Arch\r
0d2711a6
LG
1314 self._Target = Target\r
1315 self._Toolchain = Toolchain\r
52302d4d
LG
1316 self._Clear()\r
1317\r
1318 ## XXX[key] = value\r
1319 def __setitem__(self, key, value):\r
1320 self.__dict__[self._PROPERTY_[key]] = value\r
1321\r
1322 ## value = XXX[key]\r
1323 def __getitem__(self, key):\r
1324 return self.__dict__[self._PROPERTY_[key]]\r
1325\r
1326 ## "in" test support\r
1327 def __contains__(self, key):\r
1328 return key in self._PROPERTY_\r
1329\r
1330 ## Set all internal used members of DecBuildData to None\r
1331 def _Clear(self):\r
1332 self._Header = None\r
1333 self._PackageName = None\r
1334 self._Guid = None\r
1335 self._Version = None\r
e56468c0 1336 self._PkgUniFile = None\r
52302d4d
LG
1337 self._Protocols = None\r
1338 self._Ppis = None\r
1339 self._Guids = None\r
1340 self._Includes = None\r
1341 self._LibraryClasses = None\r
1342 self._Pcds = None\r
0d2711a6 1343 self.__Macros = None\r
c28d2e10
YZ
1344 self._PrivateProtocols = None\r
1345 self._PrivatePpis = None\r
1346 self._PrivateGuids = None\r
1347 self._PrivateIncludes = None\r
0d2711a6
LG
1348\r
1349 ## Get current effective macros\r
1350 def _GetMacros(self):\r
1351 if self.__Macros == None:\r
1352 self.__Macros = {}\r
1353 self.__Macros.update(GlobalData.gGlobalDefines)\r
1354 return self.__Macros\r
52302d4d
LG
1355\r
1356 ## Get architecture\r
1357 def _GetArch(self):\r
1358 return self._Arch\r
1359\r
1360 ## Set architecture\r
1361 #\r
1362 # Changing the default ARCH to another may affect all other information\r
1363 # because all information in a platform may be ARCH-related. That's\r
1364 # why we need to clear all internal used members, in order to cause all\r
1365 # information to be re-retrieved.\r
1366 #\r
1367 # @param Value The value of ARCH\r
1368 #\r
1369 def _SetArch(self, Value):\r
1370 if self._Arch == Value:\r
1371 return\r
1372 self._Arch = Value\r
1373 self._Clear()\r
1374\r
1375 ## Retrieve all information in [Defines] section\r
1376 #\r
1377 # (Retriving all [Defines] information in one-shot is just to save time.)\r
1378 #\r
1379 def _GetHeaderInfo(self):\r
0d2711a6 1380 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch]\r
52302d4d 1381 for Record in RecordList:\r
0d2711a6 1382 Name = Record[1]\r
52302d4d 1383 if Name in self:\r
0d2711a6 1384 self[Name] = Record[2]\r
52302d4d
LG
1385 self._Header = 'DUMMY'\r
1386\r
1387 ## Retrieve package name\r
1388 def _GetPackageName(self):\r
1389 if self._PackageName == None:\r
1390 if self._Header == None:\r
1391 self._GetHeaderInfo()\r
1392 if self._PackageName == None:\r
1393 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_NAME", File=self.MetaFile)\r
1394 return self._PackageName\r
1395\r
1396 ## Retrieve file guid\r
1397 def _GetFileGuid(self):\r
1398 if self._Guid == None:\r
1399 if self._Header == None:\r
1400 self._GetHeaderInfo()\r
1401 if self._Guid == None:\r
1402 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE, "No PACKAGE_GUID", File=self.MetaFile)\r
1403 return self._Guid\r
1404\r
1405 ## Retrieve package version\r
1406 def _GetVersion(self):\r
1407 if self._Version == None:\r
1408 if self._Header == None:\r
1409 self._GetHeaderInfo()\r
1410 if self._Version == None:\r
1411 self._Version = ''\r
1412 return self._Version\r
1413\r
1414 ## Retrieve protocol definitions (name/value pairs)\r
1415 def _GetProtocol(self):\r
1416 if self._Protocols == None:\r
1417 #\r
1418 # tdict is a special kind of dict, used for selecting correct\r
1419 # protocol defition for given ARCH\r
1420 #\r
1421 ProtocolDict = tdict(True)\r
c28d2e10 1422 PrivateProtocolDict = tdict(True)\r
52302d4d 1423 NameList = []\r
c28d2e10 1424 PrivateNameList = []\r
24e7435a 1425 PublicNameList = []\r
52302d4d
LG
1426 # find out all protocol definitions for specific and 'common' arch\r
1427 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch]\r
c28d2e10
YZ
1428 for Name, Guid, Dummy, Arch, PrivateFlag, ID, LineNo in RecordList:\r
1429 if PrivateFlag == 'PRIVATE':\r
1430 if Name not in PrivateNameList:\r
1431 PrivateNameList.append(Name)\r
1432 PrivateProtocolDict[Arch, Name] = Guid\r
24e7435a
YZ
1433 if Name in PublicNameList:\r
1434 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
1435 else:\r
1436 if Name not in PublicNameList:\r
1437 PublicNameList.append(Name)\r
1438 if Name in PrivateNameList:\r
1439 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
52302d4d
LG
1440 if Name not in NameList:\r
1441 NameList.append(Name)\r
1442 ProtocolDict[Arch, Name] = Guid\r
1443 # use sdict to keep the order\r
1444 self._Protocols = sdict()\r
c28d2e10 1445 self._PrivateProtocols = sdict()\r
52302d4d
LG
1446 for Name in NameList:\r
1447 #\r
1448 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1449 # will automatically turn to 'common' ARCH for trying\r
1450 #\r
1451 self._Protocols[Name] = ProtocolDict[self._Arch, Name]\r
c28d2e10
YZ
1452 for Name in PrivateNameList:\r
1453 self._PrivateProtocols[Name] = PrivateProtocolDict[self._Arch, Name]\r
52302d4d
LG
1454 return self._Protocols\r
1455\r
1456 ## Retrieve PPI definitions (name/value pairs)\r
1457 def _GetPpi(self):\r
1458 if self._Ppis == None:\r
1459 #\r
1460 # tdict is a special kind of dict, used for selecting correct\r
1461 # PPI defition for given ARCH\r
1462 #\r
1463 PpiDict = tdict(True)\r
c28d2e10 1464 PrivatePpiDict = tdict(True)\r
52302d4d 1465 NameList = []\r
c28d2e10 1466 PrivateNameList = []\r
24e7435a 1467 PublicNameList = []\r
52302d4d
LG
1468 # find out all PPI definitions for specific arch and 'common' arch\r
1469 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch]\r
c28d2e10
YZ
1470 for Name, Guid, Dummy, Arch, PrivateFlag, ID, LineNo in RecordList:\r
1471 if PrivateFlag == 'PRIVATE':\r
1472 if Name not in PrivateNameList:\r
1473 PrivateNameList.append(Name)\r
1474 PrivatePpiDict[Arch, Name] = Guid\r
24e7435a
YZ
1475 if Name in PublicNameList:\r
1476 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
1477 else:\r
1478 if Name not in PublicNameList:\r
1479 PublicNameList.append(Name)\r
1480 if Name in PrivateNameList:\r
1481 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
52302d4d
LG
1482 if Name not in NameList:\r
1483 NameList.append(Name)\r
1484 PpiDict[Arch, Name] = Guid\r
1485 # use sdict to keep the order\r
1486 self._Ppis = sdict()\r
c28d2e10 1487 self._PrivatePpis = sdict()\r
52302d4d
LG
1488 for Name in NameList:\r
1489 #\r
1490 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1491 # will automatically turn to 'common' ARCH for trying\r
1492 #\r
1493 self._Ppis[Name] = PpiDict[self._Arch, Name]\r
c28d2e10
YZ
1494 for Name in PrivateNameList:\r
1495 self._PrivatePpis[Name] = PrivatePpiDict[self._Arch, Name]\r
52302d4d
LG
1496 return self._Ppis\r
1497\r
1498 ## Retrieve GUID definitions (name/value pairs)\r
1499 def _GetGuid(self):\r
1500 if self._Guids == None:\r
1501 #\r
1502 # tdict is a special kind of dict, used for selecting correct\r
1503 # GUID defition for given ARCH\r
1504 #\r
1505 GuidDict = tdict(True)\r
c28d2e10 1506 PrivateGuidDict = tdict(True)\r
52302d4d 1507 NameList = []\r
c28d2e10 1508 PrivateNameList = []\r
24e7435a 1509 PublicNameList = []\r
52302d4d
LG
1510 # find out all protocol definitions for specific and 'common' arch\r
1511 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch]\r
c28d2e10
YZ
1512 for Name, Guid, Dummy, Arch, PrivateFlag, ID, LineNo in RecordList:\r
1513 if PrivateFlag == 'PRIVATE':\r
1514 if Name not in PrivateNameList:\r
1515 PrivateNameList.append(Name)\r
1516 PrivateGuidDict[Arch, Name] = Guid\r
24e7435a
YZ
1517 if Name in PublicNameList:\r
1518 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
1519 else:\r
1520 if Name not in PublicNameList:\r
1521 PublicNameList.append(Name)\r
1522 if Name in PrivateNameList:\r
1523 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % Name, File=self.MetaFile, Line=LineNo)\r
52302d4d
LG
1524 if Name not in NameList:\r
1525 NameList.append(Name)\r
1526 GuidDict[Arch, Name] = Guid\r
1527 # use sdict to keep the order\r
1528 self._Guids = sdict()\r
c28d2e10 1529 self._PrivateGuids = sdict()\r
52302d4d
LG
1530 for Name in NameList:\r
1531 #\r
1532 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1533 # will automatically turn to 'common' ARCH for trying\r
1534 #\r
1535 self._Guids[Name] = GuidDict[self._Arch, Name]\r
c28d2e10
YZ
1536 for Name in PrivateNameList:\r
1537 self._PrivateGuids[Name] = PrivateGuidDict[self._Arch, Name]\r
52302d4d
LG
1538 return self._Guids\r
1539\r
1540 ## Retrieve public include paths declared in this package\r
1541 def _GetInclude(self):\r
1542 if self._Includes == None:\r
1543 self._Includes = []\r
c28d2e10 1544 self._PrivateIncludes = []\r
24e7435a 1545 PublicInclues = []\r
52302d4d 1546 RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch]\r
0d2711a6
LG
1547 Macros = self._Macros\r
1548 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
52302d4d
LG
1549 for Record in RecordList:\r
1550 File = PathClass(NormPath(Record[0], Macros), self._PackageDir, Arch=self._Arch)\r
1551 LineNo = Record[-1]\r
1552 # validate the path\r
1553 ErrorCode, ErrorInfo = File.Validate()\r
1554 if ErrorCode != 0:\r
1555 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1556\r
1557 # avoid duplicate include path\r
1558 if File not in self._Includes:\r
1559 self._Includes.append(File)\r
c28d2e10
YZ
1560 if Record[4] == 'PRIVATE':\r
1561 if File not in self._PrivateIncludes:\r
1562 self._PrivateIncludes.append(File)\r
24e7435a
YZ
1563 if File in PublicInclues:\r
1564 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % File, File=self.MetaFile, Line=LineNo)\r
1565 else:\r
1566 if File not in PublicInclues:\r
1567 PublicInclues.append(File)\r
1568 if File in self._PrivateIncludes:\r
1569 EdkLogger.error('build', OPTION_CONFLICT, "Can't determine %s's attribute, it is both defined as Private and non-Private attribute in DEC file." % File, File=self.MetaFile, Line=LineNo)\r
1570\r
52302d4d
LG
1571 return self._Includes\r
1572\r
1573 ## Retrieve library class declarations (not used in build at present)\r
1574 def _GetLibraryClass(self):\r
1575 if self._LibraryClasses == None:\r
1576 #\r
1577 # tdict is a special kind of dict, used for selecting correct\r
1578 # library class declaration for given ARCH\r
1579 #\r
1580 LibraryClassDict = tdict(True)\r
1581 LibraryClassSet = set()\r
1582 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch]\r
0d2711a6 1583 Macros = self._Macros\r
c28d2e10 1584 for LibraryClass, File, Dummy, Arch, PrivateFlag, ID, LineNo in RecordList:\r
52302d4d
LG
1585 File = PathClass(NormPath(File, Macros), self._PackageDir, Arch=self._Arch)\r
1586 # check the file validation\r
1587 ErrorCode, ErrorInfo = File.Validate()\r
1588 if ErrorCode != 0:\r
1589 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
1590 LibraryClassSet.add(LibraryClass)\r
1591 LibraryClassDict[Arch, LibraryClass] = File\r
1592 self._LibraryClasses = sdict()\r
1593 for LibraryClass in LibraryClassSet:\r
1594 self._LibraryClasses[LibraryClass] = LibraryClassDict[self._Arch, LibraryClass]\r
1595 return self._LibraryClasses\r
1596\r
1597 ## Retrieve PCD declarations\r
1598 def _GetPcds(self):\r
1599 if self._Pcds == None:\r
0d2711a6 1600 self._Pcds = sdict()\r
52302d4d
LG
1601 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
1602 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
1603 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
1604 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
1605 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
1606 return self._Pcds\r
1607\r
1608 ## Retrieve PCD declarations for given type\r
1609 def _GetPcd(self, Type):\r
0d2711a6 1610 Pcds = sdict()\r
52302d4d
LG
1611 #\r
1612 # tdict is a special kind of dict, used for selecting correct\r
1613 # PCD declaration for given ARCH\r
1614 #\r
1615 PcdDict = tdict(True, 3)\r
1616 # for summarizing PCD\r
1617 PcdSet = set()\r
1618 # find out all PCDs of the 'type'\r
1619 RecordList = self._RawData[Type, self._Arch]\r
c28d2e10 1620 for TokenSpaceGuid, PcdCName, Setting, Arch, PrivateFlag, Dummy1, Dummy2 in RecordList:\r
52302d4d
LG
1621 PcdDict[Arch, PcdCName, TokenSpaceGuid] = Setting\r
1622 PcdSet.add((PcdCName, TokenSpaceGuid))\r
1623\r
1624 for PcdCName, TokenSpaceGuid in PcdSet:\r
52302d4d
LG
1625 #\r
1626 # limit the ARCH to self._Arch, if no self._Arch found, tdict\r
1627 # will automatically turn to 'common' ARCH and try again\r
1628 #\r
1629 Setting = PcdDict[self._Arch, PcdCName, TokenSpaceGuid]\r
1630 if Setting == None:\r
1631 continue\r
6780eef1
LG
1632\r
1633 DefaultValue, DatumType, TokenNumber = AnalyzePcdData(Setting)\r
1634 \r
82a6a960 1635 validateranges, validlists, expressions = self._RawData.GetValidExpression(TokenSpaceGuid, PcdCName) \r
52302d4d
LG
1636 Pcds[PcdCName, TokenSpaceGuid, self._PCD_TYPE_STRING_[Type]] = PcdClassObject(\r
1637 PcdCName,\r
1638 TokenSpaceGuid,\r
1639 self._PCD_TYPE_STRING_[Type],\r
1640 DatumType,\r
1641 DefaultValue,\r
1642 TokenNumber,\r
1643 '',\r
1644 {},\r
e56468c0 1645 False,\r
82a6a960
BF
1646 None,\r
1647 list(validateranges),\r
1648 list(validlists),\r
1649 list(expressions)\r
52302d4d
LG
1650 )\r
1651 return Pcds\r
1652\r
1653\r
0d2711a6 1654 _Macros = property(_GetMacros)\r
52302d4d
LG
1655 Arch = property(_GetArch, _SetArch)\r
1656 PackageName = property(_GetPackageName)\r
1657 Guid = property(_GetFileGuid)\r
1658 Version = property(_GetVersion)\r
1659\r
1660 Protocols = property(_GetProtocol)\r
1661 Ppis = property(_GetPpi)\r
1662 Guids = property(_GetGuid)\r
1663 Includes = property(_GetInclude)\r
1664 LibraryClasses = property(_GetLibraryClass)\r
1665 Pcds = property(_GetPcds)\r
1666\r
1667## Module build information from INF file\r
1668#\r
1669# This class is used to retrieve information stored in database and convert them\r
1670# into ModuleBuildClassObject form for easier use for AutoGen.\r
1671#\r
1672class InfBuildData(ModuleBuildClassObject):\r
1673 # dict used to convert PCD type in database to string used by build tool\r
1674 _PCD_TYPE_STRING_ = {\r
1675 MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
1676 MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
1677 MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
1678 MODEL_PCD_DYNAMIC : "Dynamic",\r
1679 MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
1680 MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
1681 MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
1682 MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
1683 MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
1684 MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
1685 MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
1686 }\r
1687\r
1688 # dict used to convert part of [Defines] to members of InfBuildData directly\r
1689 _PROPERTY_ = {\r
1690 #\r
1691 # Required Fields\r
1692 #\r
1693 TAB_INF_DEFINES_BASE_NAME : "_BaseName",\r
1694 TAB_INF_DEFINES_FILE_GUID : "_Guid",\r
1695 TAB_INF_DEFINES_MODULE_TYPE : "_ModuleType",\r
1696 #\r
1697 # Optional Fields\r
1698 #\r
0d2711a6 1699 #TAB_INF_DEFINES_INF_VERSION : "_AutoGenVersion",\r
52302d4d
LG
1700 TAB_INF_DEFINES_COMPONENT_TYPE : "_ComponentType",\r
1701 TAB_INF_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
1702 #TAB_INF_DEFINES_CUSTOM_MAKEFILE : "_CustomMakefile",\r
b36d134f 1703 TAB_INF_DEFINES_DPX_SOURCE :"_DxsFile",\r
52302d4d
LG
1704 TAB_INF_DEFINES_VERSION_NUMBER : "_Version",\r
1705 TAB_INF_DEFINES_VERSION_STRING : "_Version",\r
1706 TAB_INF_DEFINES_VERSION : "_Version",\r
1707 TAB_INF_DEFINES_PCD_IS_DRIVER : "_PcdIsDriver",\r
1708 TAB_INF_DEFINES_SHADOW : "_Shadow",\r
1709\r
1710 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH : "_SourceOverridePath",\r
1711 }\r
1712\r
1713 # dict used to convert Component type to Module type\r
1714 _MODULE_TYPE_ = {\r
1715 "LIBRARY" : "BASE",\r
1716 "SECURITY_CORE" : "SEC",\r
1717 "PEI_CORE" : "PEI_CORE",\r
1718 "COMBINED_PEIM_DRIVER" : "PEIM",\r
1719 "PIC_PEIM" : "PEIM",\r
1720 "RELOCATABLE_PEIM" : "PEIM",\r
1721 "PE32_PEIM" : "PEIM",\r
1722 "BS_DRIVER" : "DXE_DRIVER",\r
1723 "RT_DRIVER" : "DXE_RUNTIME_DRIVER",\r
1724 "SAL_RT_DRIVER" : "DXE_SAL_DRIVER",\r
1725 "DXE_SMM_DRIVER" : "DXE_SMM_DRIVER",\r
1726 # "SMM_DRIVER" : "DXE_SMM_DRIVER",\r
1727 # "BS_DRIVER" : "DXE_SMM_DRIVER",\r
1728 # "BS_DRIVER" : "UEFI_DRIVER",\r
1729 "APPLICATION" : "UEFI_APPLICATION",\r
1730 "LOGO" : "BASE",\r
1731 }\r
1732\r
1733 # regular expression for converting XXX_FLAGS in [nmake] section to new type\r
1734 _NMAKE_FLAG_PATTERN_ = re.compile("(?:EBC_)?([A-Z]+)_(?:STD_|PROJ_|ARCH_)?FLAGS(?:_DLL|_ASL|_EXE)?", re.UNICODE)\r
1735 # dict used to convert old tool name used in [nmake] section to new ones\r
1736 _TOOL_CODE_ = {\r
1737 "C" : "CC",\r
1738 "LIB" : "SLINK",\r
1739 "LINK" : "DLINK",\r
1740 }\r
1741\r
1742\r
1743 ## Constructor of DscBuildData\r
1744 #\r
1745 # Initialize object of DscBuildData\r
1746 #\r
1747 # @param FilePath The path of platform description file\r
1748 # @param RawData The raw data of DSC file\r
1749 # @param BuildDataBase Database used to retrieve module/package information\r
1750 # @param Arch The target architecture\r
1751 # @param Platform The name of platform employing this module\r
1752 # @param Macros Macros used for replacement in DSC file\r
1753 #\r
0d2711a6 1754 def __init__(self, FilePath, RawData, BuildDatabase, Arch='COMMON', Target=None, Toolchain=None):\r
52302d4d
LG
1755 self.MetaFile = FilePath\r
1756 self._ModuleDir = FilePath.Dir\r
1757 self._RawData = RawData\r
1758 self._Bdb = BuildDatabase\r
1759 self._Arch = Arch\r
0d2711a6
LG
1760 self._Target = Target\r
1761 self._Toolchain = Toolchain\r
52302d4d 1762 self._Platform = 'COMMON'\r
52302d4d
LG
1763 self._SourceOverridePath = None\r
1764 if FilePath.Key in GlobalData.gOverrideDir:\r
1765 self._SourceOverridePath = GlobalData.gOverrideDir[FilePath.Key]\r
1766 self._Clear()\r
1767\r
1768 ## XXX[key] = value\r
1769 def __setitem__(self, key, value):\r
1770 self.__dict__[self._PROPERTY_[key]] = value\r
1771\r
1772 ## value = XXX[key]\r
1773 def __getitem__(self, key):\r
1774 return self.__dict__[self._PROPERTY_[key]]\r
1775\r
1776 ## "in" test support\r
1777 def __contains__(self, key):\r
1778 return key in self._PROPERTY_\r
1779\r
1780 ## Set all internal used members of InfBuildData to None\r
1781 def _Clear(self):\r
e8a47801 1782 self._HeaderComments = None\r
2bc3256c 1783 self._TailComments = None\r
52302d4d
LG
1784 self._Header_ = None\r
1785 self._AutoGenVersion = None\r
1786 self._BaseName = None\r
b36d134f 1787 self._DxsFile = None\r
52302d4d
LG
1788 self._ModuleType = None\r
1789 self._ComponentType = None\r
1790 self._BuildType = None\r
1791 self._Guid = None\r
1792 self._Version = None\r
1793 self._PcdIsDriver = None\r
1794 self._BinaryModule = None\r
1795 self._Shadow = None\r
1796 self._MakefileName = None\r
1797 self._CustomMakefile = None\r
1798 self._Specification = None\r
1799 self._LibraryClass = None\r
1800 self._ModuleEntryPointList = None\r
1801 self._ModuleUnloadImageList = None\r
1802 self._ConstructorList = None\r
1803 self._DestructorList = None\r
1804 self._Defs = None\r
1805 self._Binaries = None\r
1806 self._Sources = None\r
1807 self._LibraryClasses = None\r
1808 self._Libraries = None\r
1809 self._Protocols = None\r
e8a47801 1810 self._ProtocolComments = None\r
52302d4d 1811 self._Ppis = None\r
e8a47801 1812 self._PpiComments = None\r
52302d4d 1813 self._Guids = None\r
e8a47801
LG
1814 self._GuidsUsedByPcd = sdict()\r
1815 self._GuidComments = None\r
52302d4d
LG
1816 self._Includes = None\r
1817 self._Packages = None\r
1818 self._Pcds = None\r
e8a47801 1819 self._PcdComments = None\r
52302d4d
LG
1820 self._BuildOptions = None\r
1821 self._Depex = None\r
1822 self._DepexExpression = None\r
0d2711a6
LG
1823 self.__Macros = None\r
1824\r
1825 ## Get current effective macros\r
1826 def _GetMacros(self):\r
1827 if self.__Macros == None:\r
1828 self.__Macros = {}\r
d0acc87a 1829 # EDK_GLOBAL defined macros can be applied to EDK module\r
0d2711a6
LG
1830 if self.AutoGenVersion < 0x00010005:\r
1831 self.__Macros.update(GlobalData.gEdkGlobal)\r
d0acc87a 1832 self.__Macros.update(GlobalData.gGlobalDefines)\r
0d2711a6 1833 return self.__Macros\r
52302d4d
LG
1834\r
1835 ## Get architecture\r
1836 def _GetArch(self):\r
1837 return self._Arch\r
1838\r
1839 ## Set architecture\r
1840 #\r
1841 # Changing the default ARCH to another may affect all other information\r
1842 # because all information in a platform may be ARCH-related. That's\r
1843 # why we need to clear all internal used members, in order to cause all\r
1844 # information to be re-retrieved.\r
1845 #\r
1846 # @param Value The value of ARCH\r
1847 #\r
1848 def _SetArch(self, Value):\r
1849 if self._Arch == Value:\r
1850 return\r
1851 self._Arch = Value\r
1852 self._Clear()\r
1853\r
1854 ## Return the name of platform employing this module\r
1855 def _GetPlatform(self):\r
1856 return self._Platform\r
1857\r
1858 ## Change the name of platform employing this module\r
1859 #\r
1860 # Changing the default name of platform to another may affect some information\r
1861 # because they may be PLATFORM-related. That's why we need to clear all internal\r
1862 # used members, in order to cause all information to be re-retrieved.\r
1863 #\r
1864 def _SetPlatform(self, Value):\r
1865 if self._Platform == Value:\r
1866 return\r
1867 self._Platform = Value\r
1868 self._Clear()\r
e8a47801
LG
1869 def _GetHeaderComments(self):\r
1870 if not self._HeaderComments:\r
1871 self._HeaderComments = []\r
1872 RecordList = self._RawData[MODEL_META_DATA_HEADER_COMMENT]\r
1873 for Record in RecordList:\r
1874 self._HeaderComments.append(Record[0])\r
1875 return self._HeaderComments\r
2bc3256c
LG
1876 def _GetTailComments(self):\r
1877 if not self._TailComments:\r
1878 self._TailComments = []\r
1879 RecordList = self._RawData[MODEL_META_DATA_TAIL_COMMENT]\r
1880 for Record in RecordList:\r
1881 self._TailComments.append(Record[0])\r
1882 return self._TailComments\r
52302d4d
LG
1883 ## Retrieve all information in [Defines] section\r
1884 #\r
1885 # (Retriving all [Defines] information in one-shot is just to save time.)\r
1886 #\r
1887 def _GetHeaderInfo(self):\r
1888 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
1889 for Record in RecordList:\r
0d2711a6 1890 Name, Value = Record[1], ReplaceMacro(Record[2], self._Macros, False)\r
52302d4d
LG
1891 # items defined _PROPERTY_ don't need additional processing\r
1892 if Name in self:\r
0d2711a6 1893 self[Name] = Value\r
97fa0ee9
YL
1894 if self._Defs == None:\r
1895 self._Defs = sdict()\r
1896 self._Defs[Name] = Value\r
52302d4d 1897 # some special items in [Defines] section need special treatment\r
08dd311f
LG
1898 elif Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION', 'EDK_RELEASE_VERSION', 'PI_SPECIFICATION_VERSION'):\r
1899 if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):\r
1900 Name = 'UEFI_SPECIFICATION_VERSION'\r
52302d4d
LG
1901 if self._Specification == None:\r
1902 self._Specification = sdict()\r
0d2711a6 1903 self._Specification[Name] = GetHexVerValue(Value)\r
08dd311f
LG
1904 if self._Specification[Name] == None:\r
1905 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
0d2711a6 1906 "'%s' format is not supported for %s" % (Value, Name),\r
08dd311f 1907 File=self.MetaFile, Line=Record[-1])\r
52302d4d
LG
1908 elif Name == 'LIBRARY_CLASS':\r
1909 if self._LibraryClass == None:\r
1910 self._LibraryClass = []\r
0d2711a6 1911 ValueList = GetSplitValueList(Value)\r
52302d4d
LG
1912 LibraryClass = ValueList[0]\r
1913 if len(ValueList) > 1:\r
1914 SupModuleList = GetSplitValueList(ValueList[1], ' ')\r
1915 else:\r
1916 SupModuleList = SUP_MODULE_LIST\r
1917 self._LibraryClass.append(LibraryClassObject(LibraryClass, SupModuleList))\r
1918 elif Name == 'ENTRY_POINT':\r
1919 if self._ModuleEntryPointList == None:\r
1920 self._ModuleEntryPointList = []\r
0d2711a6 1921 self._ModuleEntryPointList.append(Value)\r
52302d4d
LG
1922 elif Name == 'UNLOAD_IMAGE':\r
1923 if self._ModuleUnloadImageList == None:\r
1924 self._ModuleUnloadImageList = []\r
0d2711a6 1925 if not Value:\r
52302d4d 1926 continue\r
0d2711a6 1927 self._ModuleUnloadImageList.append(Value)\r
52302d4d
LG
1928 elif Name == 'CONSTRUCTOR':\r
1929 if self._ConstructorList == None:\r
1930 self._ConstructorList = []\r
0d2711a6 1931 if not Value:\r
52302d4d 1932 continue\r
0d2711a6 1933 self._ConstructorList.append(Value)\r
52302d4d
LG
1934 elif Name == 'DESTRUCTOR':\r
1935 if self._DestructorList == None:\r
1936 self._DestructorList = []\r
0d2711a6 1937 if not Value:\r
52302d4d 1938 continue\r
0d2711a6 1939 self._DestructorList.append(Value)\r
52302d4d 1940 elif Name == TAB_INF_DEFINES_CUSTOM_MAKEFILE:\r
0d2711a6 1941 TokenList = GetSplitValueList(Value)\r
52302d4d
LG
1942 if self._CustomMakefile == None:\r
1943 self._CustomMakefile = {}\r
1944 if len(TokenList) < 2:\r
1945 self._CustomMakefile['MSFT'] = TokenList[0]\r
1946 self._CustomMakefile['GCC'] = TokenList[0]\r
1947 else:\r
1948 if TokenList[0] not in ['MSFT', 'GCC']:\r
1949 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
1950 "No supported family [%s]" % TokenList[0],\r
1951 File=self.MetaFile, Line=Record[-1])\r
1952 self._CustomMakefile[TokenList[0]] = TokenList[1]\r
1953 else:\r
1954 if self._Defs == None:\r
1955 self._Defs = sdict()\r
0d2711a6 1956 self._Defs[Name] = Value\r
52302d4d
LG
1957\r
1958 #\r
0d2711a6 1959 # Retrieve information in sections specific to Edk.x modules\r
52302d4d 1960 #\r
0d2711a6 1961 if self.AutoGenVersion >= 0x00010005:\r
52302d4d
LG
1962 if not self._ModuleType:\r
1963 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
1964 "MODULE_TYPE is not given", File=self.MetaFile)\r
da92f276
LG
1965 if self._ModuleType not in SUP_MODULE_LIST:\r
1966 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
1967 for Record in RecordList:\r
0d2711a6 1968 Name = Record[1]\r
da92f276
LG
1969 if Name == "MODULE_TYPE":\r
1970 LineNo = Record[6]\r
1971 break\r
1972 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
47fea6af 1973 "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 1974 File=self.MetaFile, Line=LineNo)\r
da92f276 1975 if (self._Specification == None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x0001000A):\r
52302d4d 1976 if self._ModuleType == SUP_MODULE_SMM_CORE:\r
47fea6af 1977 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
52302d4d 1978 if self._Defs and 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
9ccb26bc 1979 and 'PCI_CLASS_CODE' in self._Defs and 'PCI_REVISION' in self._Defs:\r
52302d4d 1980 self._BuildType = 'UEFI_OPTIONROM'\r
9ccb26bc
YZ
1981 if 'PCI_COMPRESS' in self._Defs:\r
1982 if self._Defs['PCI_COMPRESS'] not in ('TRUE', 'FALSE'):\r
1983 EdkLogger.error("build", FORMAT_INVALID, "Expected TRUE/FALSE for PCI_COMPRESS: %s" %self.MetaFile)\r
1984\r
52302d4d
LG
1985 elif self._Defs and 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
1986 and self._Defs['UEFI_HII_RESOURCE_SECTION'] == 'TRUE':\r
1987 self._BuildType = 'UEFI_HII'\r
1988 else:\r
1989 self._BuildType = self._ModuleType.upper()\r
47fea6af 1990\r
b36d134f
LG
1991 if self._DxsFile:\r
1992 File = PathClass(NormPath(self._DxsFile), self._ModuleDir, Arch=self._Arch)\r
1993 # check the file validation\r
1994 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
1995 if ErrorCode != 0:\r
1996 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
1997 File=self.MetaFile, Line=LineNo)\r
1998 if self.Sources == None:\r
1999 self._Sources = []\r
2000 self._Sources.append(File)\r
0d2711a6 2001 else: \r
52302d4d
LG
2002 if not self._ComponentType:\r
2003 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
2004 "COMPONENT_TYPE is not given", File=self.MetaFile)\r
47fea6af 2005 self._BuildType = self._ComponentType.upper()\r
52302d4d
LG
2006 if self._ComponentType in self._MODULE_TYPE_:\r
2007 self._ModuleType = self._MODULE_TYPE_[self._ComponentType]\r
2008 if self._ComponentType == 'LIBRARY':\r
2009 self._LibraryClass = [LibraryClassObject(self._BaseName, SUP_MODULE_LIST)]\r
2010 # make use some [nmake] section macros\r
0d2711a6
LG
2011 Macros = self._Macros\r
2012 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
2013 Macros['PROCESSOR'] = self._Arch\r
52302d4d 2014 RecordList = self._RawData[MODEL_META_DATA_NMAKE, self._Arch, self._Platform]\r
47fea6af 2015 for Name, Value, Dummy, Arch, Platform, ID, LineNo in RecordList:\r
0d2711a6 2016 Value = ReplaceMacro(Value, Macros, True)\r
52302d4d
LG
2017 if Name == "IMAGE_ENTRY_POINT":\r
2018 if self._ModuleEntryPointList == None:\r
2019 self._ModuleEntryPointList = []\r
2020 self._ModuleEntryPointList.append(Value)\r
2021 elif Name == "DPX_SOURCE":\r
0d2711a6 2022 File = PathClass(NormPath(Value), self._ModuleDir, Arch=self._Arch)\r
52302d4d
LG
2023 # check the file validation\r
2024 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
2025 if ErrorCode != 0:\r
2026 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
2027 File=self.MetaFile, Line=LineNo)\r
2028 if self.Sources == None:\r
2029 self._Sources = []\r
2030 self._Sources.append(File)\r
2031 else:\r
2032 ToolList = self._NMAKE_FLAG_PATTERN_.findall(Name)\r
2033 if len(ToolList) == 0 or len(ToolList) != 1:\r
2034 pass\r
2035# EdkLogger.warn("build", "Don't know how to do with macro [%s]" % Name,\r
2036# File=self.MetaFile, Line=LineNo)\r
2037 else:\r
2038 if self._BuildOptions == None:\r
2039 self._BuildOptions = sdict()\r
2040\r
2041 if ToolList[0] in self._TOOL_CODE_:\r
2042 Tool = self._TOOL_CODE_[ToolList[0]]\r
2043 else:\r
2044 Tool = ToolList[0]\r
2045 ToolChain = "*_*_*_%s_FLAGS" % Tool\r
f51461c8 2046 ToolChainFamily = 'MSFT' # Edk.x only support MSFT tool chain\r
52302d4d 2047 #ignore not replaced macros in value\r
0d2711a6 2048 ValueList = GetSplitList(' ' + Value, '/D')\r
52302d4d
LG
2049 Dummy = ValueList[0]\r
2050 for Index in range(1, len(ValueList)):\r
2051 if ValueList[Index][-1] == '=' or ValueList[Index] == '':\r
2052 continue\r
2053 Dummy = Dummy + ' /D ' + ValueList[Index]\r
2054 Value = Dummy.strip()\r
2055 if (ToolChainFamily, ToolChain) not in self._BuildOptions:\r
2056 self._BuildOptions[ToolChainFamily, ToolChain] = Value\r
2057 else:\r
2058 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
2059 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Value\r
2060 # set _Header to non-None in order to avoid database re-querying\r
2061 self._Header_ = 'DUMMY'\r
2062\r
2063 ## Retrieve file version\r
2064 def _GetInfVersion(self):\r
2065 if self._AutoGenVersion == None:\r
0d2711a6
LG
2066 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
2067 for Record in RecordList:\r
2068 if Record[1] == TAB_INF_DEFINES_INF_VERSION:\r
3ab1434a
YZ
2069 if '.' in Record[2]:\r
2070 ValueList = Record[2].split('.')\r
2071 Major = '%04o' % int(ValueList[0], 0)\r
2072 Minor = '%04o' % int(ValueList[1], 0)\r
2073 self._AutoGenVersion = int('0x' + Major + Minor, 0)\r
2074 else:\r
2075 self._AutoGenVersion = int(Record[2], 0)\r
0d2711a6 2076 break\r
52302d4d
LG
2077 if self._AutoGenVersion == None:\r
2078 self._AutoGenVersion = 0x00010000\r
2079 return self._AutoGenVersion\r
2080\r
2081 ## Retrieve BASE_NAME\r
2082 def _GetBaseName(self):\r
2083 if self._BaseName == None:\r
2084 if self._Header_ == None:\r
2085 self._GetHeaderInfo()\r
2086 if self._BaseName == None:\r
2087 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No BASE_NAME name", File=self.MetaFile)\r
2088 return self._BaseName\r
2089\r
b36d134f
LG
2090 ## Retrieve DxsFile\r
2091 def _GetDxsFile(self):\r
2092 if self._DxsFile == None:\r
2093 if self._Header_ == None:\r
2094 self._GetHeaderInfo()\r
2095 if self._DxsFile == None:\r
2096 self._DxsFile = ''\r
2097 return self._DxsFile\r
2098\r
52302d4d
LG
2099 ## Retrieve MODULE_TYPE\r
2100 def _GetModuleType(self):\r
2101 if self._ModuleType == None:\r
2102 if self._Header_ == None:\r
2103 self._GetHeaderInfo()\r
2104 if self._ModuleType == None:\r
2105 self._ModuleType = 'BASE'\r
2106 if self._ModuleType not in SUP_MODULE_LIST:\r
2107 self._ModuleType = "USER_DEFINED"\r
2108 return self._ModuleType\r
2109\r
2110 ## Retrieve COMPONENT_TYPE\r
2111 def _GetComponentType(self):\r
2112 if self._ComponentType == None:\r
2113 if self._Header_ == None:\r
2114 self._GetHeaderInfo()\r
2115 if self._ComponentType == None:\r
2116 self._ComponentType = 'USER_DEFINED'\r
2117 return self._ComponentType\r
2118\r
2119 ## Retrieve "BUILD_TYPE"\r
2120 def _GetBuildType(self):\r
2121 if self._BuildType == None:\r
2122 if self._Header_ == None:\r
2123 self._GetHeaderInfo()\r
2124 if not self._BuildType:\r
2125 self._BuildType = "BASE"\r
2126 return self._BuildType\r
2127\r
2128 ## Retrieve file guid\r
2129 def _GetFileGuid(self):\r
2130 if self._Guid == None:\r
2131 if self._Header_ == None:\r
2132 self._GetHeaderInfo()\r
2133 if self._Guid == None:\r
1ba5124e 2134 self._Guid = '00000000-0000-0000-0000-000000000000'\r
52302d4d
LG
2135 return self._Guid\r
2136\r
2137 ## Retrieve module version\r
2138 def _GetVersion(self):\r
2139 if self._Version == None:\r
2140 if self._Header_ == None:\r
2141 self._GetHeaderInfo()\r
2142 if self._Version == None:\r
2143 self._Version = '0.0'\r
2144 return self._Version\r
2145\r
2146 ## Retrieve PCD_IS_DRIVER\r
2147 def _GetPcdIsDriver(self):\r
2148 if self._PcdIsDriver == None:\r
2149 if self._Header_ == None:\r
2150 self._GetHeaderInfo()\r
2151 if self._PcdIsDriver == None:\r
2152 self._PcdIsDriver = ''\r
2153 return self._PcdIsDriver\r
2154\r
2155 ## Retrieve SHADOW\r
2156 def _GetShadow(self):\r
2157 if self._Shadow == None:\r
2158 if self._Header_ == None:\r
2159 self._GetHeaderInfo()\r
2160 if self._Shadow != None and self._Shadow.upper() == 'TRUE':\r
2161 self._Shadow = True\r
2162 else:\r
2163 self._Shadow = False\r
2164 return self._Shadow\r
2165\r
2166 ## Retrieve CUSTOM_MAKEFILE\r
2167 def _GetMakefile(self):\r
2168 if self._CustomMakefile == None:\r
2169 if self._Header_ == None:\r
2170 self._GetHeaderInfo()\r
2171 if self._CustomMakefile == None:\r
2172 self._CustomMakefile = {}\r
2173 return self._CustomMakefile\r
2174\r
2175 ## Retrieve EFI_SPECIFICATION_VERSION\r
2176 def _GetSpec(self):\r
2177 if self._Specification == None:\r
2178 if self._Header_ == None:\r
2179 self._GetHeaderInfo()\r
2180 if self._Specification == None:\r
2181 self._Specification = {}\r
2182 return self._Specification\r
2183\r
2184 ## Retrieve LIBRARY_CLASS\r
2185 def _GetLibraryClass(self):\r
2186 if self._LibraryClass == None:\r
2187 if self._Header_ == None:\r
2188 self._GetHeaderInfo()\r
2189 if self._LibraryClass == None:\r
2190 self._LibraryClass = []\r
2191 return self._LibraryClass\r
2192\r
2193 ## Retrieve ENTRY_POINT\r
2194 def _GetEntryPoint(self):\r
2195 if self._ModuleEntryPointList == None:\r
2196 if self._Header_ == None:\r
2197 self._GetHeaderInfo()\r
2198 if self._ModuleEntryPointList == None:\r
2199 self._ModuleEntryPointList = []\r
2200 return self._ModuleEntryPointList\r
2201\r
2202 ## Retrieve UNLOAD_IMAGE\r
2203 def _GetUnloadImage(self):\r
2204 if self._ModuleUnloadImageList == None:\r
2205 if self._Header_ == None:\r
2206 self._GetHeaderInfo()\r
2207 if self._ModuleUnloadImageList == None:\r
2208 self._ModuleUnloadImageList = []\r
2209 return self._ModuleUnloadImageList\r
2210\r
2211 ## Retrieve CONSTRUCTOR\r
2212 def _GetConstructor(self):\r
2213 if self._ConstructorList == None:\r
2214 if self._Header_ == None:\r
2215 self._GetHeaderInfo()\r
2216 if self._ConstructorList == None:\r
2217 self._ConstructorList = []\r
2218 return self._ConstructorList\r
2219\r
2220 ## Retrieve DESTRUCTOR\r
2221 def _GetDestructor(self):\r
2222 if self._DestructorList == None:\r
2223 if self._Header_ == None:\r
2224 self._GetHeaderInfo()\r
2225 if self._DestructorList == None:\r
2226 self._DestructorList = []\r
2227 return self._DestructorList\r
2228\r
2229 ## Retrieve definies other than above ones\r
2230 def _GetDefines(self):\r
2231 if self._Defs == None:\r
2232 if self._Header_ == None:\r
2233 self._GetHeaderInfo()\r
2234 if self._Defs == None:\r
2235 self._Defs = sdict()\r
2236 return self._Defs\r
2237\r
2238 ## Retrieve binary files\r
a0a2cd1e 2239 def _GetBinaries(self):\r
52302d4d
LG
2240 if self._Binaries == None:\r
2241 self._Binaries = []\r
2242 RecordList = self._RawData[MODEL_EFI_BINARY_FILE, self._Arch, self._Platform]\r
0d2711a6
LG
2243 Macros = self._Macros\r
2244 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
2245 Macros['PROCESSOR'] = self._Arch\r
52302d4d 2246 for Record in RecordList:\r
52302d4d
LG
2247 FileType = Record[0]\r
2248 LineNo = Record[-1]\r
2249 Target = 'COMMON'\r
2250 FeatureFlag = []\r
2251 if Record[2]:\r
2252 TokenList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
2253 if TokenList:\r
2254 Target = TokenList[0]\r
2255 if len(TokenList) > 1:\r
2256 FeatureFlag = Record[1:]\r
2257\r
2258 File = PathClass(NormPath(Record[1], Macros), self._ModuleDir, '', FileType, True, self._Arch, '', Target)\r
2259 # check the file validation\r
2260 ErrorCode, ErrorInfo = File.Validate()\r
2261 if ErrorCode != 0:\r
2262 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
2263 self._Binaries.append(File)\r
2264 return self._Binaries\r
2265\r
a0a2cd1e
FB
2266 ## Retrieve binary files with error check.\r
2267 def _GetBinaryFiles(self):\r
2268 Binaries = self._GetBinaries()\r
2269 if GlobalData.gIgnoreSource and Binaries == []:\r
2270 ErrorInfo = "The INF file does not contain any Binaries to use in creating the image\n"\r
2271 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, ExtraData=ErrorInfo, File=self.MetaFile)\r
2272\r
2273 return Binaries\r
2274 ## Check whether it exists the binaries with current ARCH in AsBuild INF\r
2275 def _IsSupportedArch(self):\r
2276 if self._GetBinaries() and not self._GetSourceFiles():\r
2277 return True\r
2278 else:\r
2279 return False\r
52302d4d
LG
2280 ## Retrieve source files\r
2281 def _GetSourceFiles(self):\r
fae62ff2
HC
2282 #Ignore all source files in a binary build mode\r
2283 if GlobalData.gIgnoreSource:\r
2284 self._Sources = []\r
2285 return self._Sources\r
2286\r
52302d4d
LG
2287 if self._Sources == None:\r
2288 self._Sources = []\r
2289 RecordList = self._RawData[MODEL_EFI_SOURCE_FILE, self._Arch, self._Platform]\r
0d2711a6 2290 Macros = self._Macros\r
52302d4d 2291 for Record in RecordList:\r
52302d4d
LG
2292 LineNo = Record[-1]\r
2293 ToolChainFamily = Record[1]\r
2294 TagName = Record[2]\r
2295 ToolCode = Record[3]\r
2296 FeatureFlag = Record[4]\r
0d2711a6 2297 if self.AutoGenVersion < 0x00010005:\r
d0acc87a
LG
2298 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
2299 Macros['PROCESSOR'] = self._Arch\r
05cc51ad
LY
2300 SourceFile = NormPath(Record[0], Macros)\r
2301 if SourceFile[0] == os.path.sep:\r
2302 SourceFile = mws.join(GlobalData.gWorkspace, SourceFile[1:])\r
0d2711a6 2303 # old module source files (Edk)\r
05cc51ad 2304 File = PathClass(SourceFile, self._ModuleDir, self._SourceOverridePath,\r
52302d4d
LG
2305 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
2306 # check the file validation\r
2307 ErrorCode, ErrorInfo = File.Validate(CaseSensitive=False)\r
2308 if ErrorCode != 0:\r
2309 if File.Ext.lower() == '.h':\r
2310 EdkLogger.warn('build', 'Include file not found', ExtraData=ErrorInfo,\r
2311 File=self.MetaFile, Line=LineNo)\r
2312 continue\r
2313 else:\r
2314 EdkLogger.error('build', ErrorCode, ExtraData=File, File=self.MetaFile, Line=LineNo)\r
2315 else:\r
2316 File = PathClass(NormPath(Record[0], Macros), self._ModuleDir, '',\r
2317 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
2318 # check the file validation\r
2319 ErrorCode, ErrorInfo = File.Validate()\r
2320 if ErrorCode != 0:\r
2321 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
2322\r
2323 self._Sources.append(File)\r
2324 return self._Sources\r
2325\r
2326 ## Retrieve library classes employed by this module\r
2327 def _GetLibraryClassUses(self):\r
2328 if self._LibraryClasses == None:\r
2329 self._LibraryClasses = sdict()\r
2330 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, self._Platform]\r
2331 for Record in RecordList:\r
52302d4d
LG
2332 Lib = Record[0]\r
2333 Instance = Record[1]\r
0d2711a6 2334 if Instance:\r
52302d4d
LG
2335 Instance = NormPath(Instance, self._Macros)\r
2336 self._LibraryClasses[Lib] = Instance\r
2337 return self._LibraryClasses\r
2338\r
0d2711a6 2339 ## Retrieve library names (for Edk.x style of modules)\r
52302d4d
LG
2340 def _GetLibraryNames(self):\r
2341 if self._Libraries == None:\r
2342 self._Libraries = []\r
2343 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch, self._Platform]\r
2344 for Record in RecordList:\r
0d2711a6
LG
2345 LibraryName = ReplaceMacro(Record[0], self._Macros, False)\r
2346 # in case of name with '.lib' extension, which is unusual in Edk.x inf\r
2347 LibraryName = os.path.splitext(LibraryName)[0]\r
52302d4d
LG
2348 if LibraryName not in self._Libraries:\r
2349 self._Libraries.append(LibraryName)\r
2350 return self._Libraries\r
2351\r
e8a47801
LG
2352 def _GetProtocolComments(self):\r
2353 self._GetProtocols()\r
2354 return self._ProtocolComments\r
52302d4d
LG
2355 ## Retrieve protocols consumed/produced by this module\r
2356 def _GetProtocols(self):\r
2357 if self._Protocols == None:\r
2358 self._Protocols = sdict()\r
e8a47801 2359 self._ProtocolComments = sdict()\r
52302d4d
LG
2360 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]\r
2361 for Record in RecordList:\r
2362 CName = Record[0]\r
c28d2e10 2363 Value = ProtocolValue(CName, self.Packages, self.MetaFile.Path)\r
52302d4d
LG
2364 if Value == None:\r
2365 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2366 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2367 "Value of Protocol [%s] is not found under [Protocols] section in" % CName,\r
2368 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
2369 self._Protocols[CName] = Value\r
e8a47801
LG
2370 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
2371 Comments = []\r
2372 for CmtRec in CommentRecords:\r
2373 Comments.append(CmtRec[0])\r
2374 self._ProtocolComments[CName] = Comments\r
52302d4d
LG
2375 return self._Protocols\r
2376\r
e8a47801
LG
2377 def _GetPpiComments(self):\r
2378 self._GetPpis()\r
2379 return self._PpiComments\r
52302d4d
LG
2380 ## Retrieve PPIs consumed/produced by this module\r
2381 def _GetPpis(self):\r
2382 if self._Ppis == None:\r
2383 self._Ppis = sdict()\r
e8a47801 2384 self._PpiComments = sdict()\r
52302d4d
LG
2385 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]\r
2386 for Record in RecordList:\r
2387 CName = Record[0]\r
c28d2e10 2388 Value = PpiValue(CName, self.Packages, self.MetaFile.Path)\r
52302d4d
LG
2389 if Value == None:\r
2390 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2391 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2392 "Value of PPI [%s] is not found under [Ppis] section in " % CName,\r
2393 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
2394 self._Ppis[CName] = Value\r
e8a47801
LG
2395 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
2396 Comments = []\r
2397 for CmtRec in CommentRecords:\r
2398 Comments.append(CmtRec[0])\r
2399 self._PpiComments[CName] = Comments\r
52302d4d
LG
2400 return self._Ppis\r
2401\r
e8a47801
LG
2402 def _GetGuidComments(self):\r
2403 self._GetGuids()\r
2404 return self._GuidComments\r
52302d4d
LG
2405 ## Retrieve GUIDs consumed/produced by this module\r
2406 def _GetGuids(self):\r
2407 if self._Guids == None:\r
2408 self._Guids = sdict()\r
e8a47801 2409 self._GuidComments = sdict()\r
52302d4d
LG
2410 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]\r
2411 for Record in RecordList:\r
2412 CName = Record[0]\r
c28d2e10 2413 Value = GuidValue(CName, self.Packages, self.MetaFile.Path)\r
52302d4d
LG
2414 if Value == None:\r
2415 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2416 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2417 "Value of Guid [%s] is not found under [Guids] section in" % CName,\r
2418 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
2419 self._Guids[CName] = Value\r
e8a47801
LG
2420 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
2421 Comments = []\r
2422 for CmtRec in CommentRecords:\r
2423 Comments.append(CmtRec[0])\r
2424 self._GuidComments[CName] = Comments\r
52302d4d
LG
2425 return self._Guids\r
2426\r
0d2711a6 2427 ## Retrieve include paths necessary for this module (for Edk.x style of modules)\r
52302d4d
LG
2428 def _GetIncludes(self):\r
2429 if self._Includes == None:\r
2430 self._Includes = []\r
2431 if self._SourceOverridePath:\r
2432 self._Includes.append(self._SourceOverridePath)\r
0d2711a6
LG
2433\r
2434 Macros = self._Macros\r
2435 if 'PROCESSOR' in GlobalData.gEdkGlobal.keys():\r
2436 Macros['PROCESSOR'] = GlobalData.gEdkGlobal['PROCESSOR']\r
2437 else:\r
2438 Macros['PROCESSOR'] = self._Arch\r
52302d4d 2439 RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch, self._Platform]\r
52302d4d 2440 for Record in RecordList:\r
52302d4d 2441 if Record[0].find('EDK_SOURCE') > -1:\r
0d2711a6
LG
2442 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
2443 File = NormPath(Record[0], self._Macros)\r
52302d4d
LG
2444 if File[0] == '.':\r
2445 File = os.path.join(self._ModuleDir, File)\r
2446 else:\r
2447 File = os.path.join(GlobalData.gWorkspace, File)\r
2448 File = RealPath(os.path.normpath(File))\r
2449 if File:\r
2450 self._Includes.append(File)\r
2451\r
2452 #TRICK: let compiler to choose correct header file\r
0d2711a6
LG
2453 Macros['EDK_SOURCE'] = GlobalData.gEdkSource\r
2454 File = NormPath(Record[0], self._Macros)\r
52302d4d
LG
2455 if File[0] == '.':\r
2456 File = os.path.join(self._ModuleDir, File)\r
2457 else:\r
2458 File = os.path.join(GlobalData.gWorkspace, File)\r
2459 File = RealPath(os.path.normpath(File))\r
2460 if File:\r
2461 self._Includes.append(File)\r
2462 else:\r
0d2711a6 2463 File = NormPath(Record[0], Macros)\r
52302d4d
LG
2464 if File[0] == '.':\r
2465 File = os.path.join(self._ModuleDir, File)\r
2466 else:\r
05cc51ad 2467 File = mws.join(GlobalData.gWorkspace, File)\r
52302d4d
LG
2468 File = RealPath(os.path.normpath(File))\r
2469 if File:\r
2470 self._Includes.append(File)\r
05cc51ad
LY
2471 if not File and Record[0].find('EFI_SOURCE') > -1:\r
2472 # tricky to regard WorkSpace as EFI_SOURCE\r
2473 Macros['EFI_SOURCE'] = GlobalData.gWorkspace\r
2474 File = NormPath(Record[0], Macros)\r
2475 if File[0] == '.':\r
2476 File = os.path.join(self._ModuleDir, File)\r
2477 else:\r
2478 File = os.path.join(GlobalData.gWorkspace, File)\r
2479 File = RealPath(os.path.normpath(File))\r
2480 if File:\r
2481 self._Includes.append(File)\r
52302d4d
LG
2482 return self._Includes\r
2483\r
2484 ## Retrieve packages this module depends on\r
2485 def _GetPackages(self):\r
2486 if self._Packages == None:\r
2487 self._Packages = []\r
2488 RecordList = self._RawData[MODEL_META_DATA_PACKAGE, self._Arch, self._Platform]\r
0d2711a6
LG
2489 Macros = self._Macros\r
2490 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
52302d4d
LG
2491 for Record in RecordList:\r
2492 File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
2493 LineNo = Record[-1]\r
2494 # check the file validation\r
2495 ErrorCode, ErrorInfo = File.Validate('.dec')\r
2496 if ErrorCode != 0:\r
2497 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
2498 # parse this package now. we need it to get protocol/ppi/guid value\r
0d2711a6 2499 Package = self._Bdb[File, self._Arch, self._Target, self._Toolchain]\r
52302d4d
LG
2500 self._Packages.append(Package)\r
2501 return self._Packages\r
2502\r
e8a47801
LG
2503 ## Retrieve PCD comments\r
2504 def _GetPcdComments(self):\r
2505 self._GetPcds()\r
2506 return self._PcdComments\r
52302d4d
LG
2507 ## Retrieve PCDs used in this module\r
2508 def _GetPcds(self):\r
2509 if self._Pcds == None:\r
79b74a03 2510 self._Pcds = sdict()\r
e8a47801 2511 self._PcdComments = sdict()\r
52302d4d
LG
2512 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
2513 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
2514 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
2515 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
2516 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
2517 return self._Pcds\r
2518\r
2519 ## Retrieve build options specific to this module\r
2520 def _GetBuildOptions(self):\r
2521 if self._BuildOptions == None:\r
2522 self._BuildOptions = sdict()\r
2523 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, self._Platform]\r
2524 for Record in RecordList:\r
2525 ToolChainFamily = Record[0]\r
2526 ToolChain = Record[1]\r
2527 Option = Record[2]\r
5015bee2 2528 if (ToolChainFamily, ToolChain) not in self._BuildOptions or Option.startswith('='):\r
52302d4d
LG
2529 self._BuildOptions[ToolChainFamily, ToolChain] = Option\r
2530 else:\r
2531 # concatenate the option string if they're for the same tool\r
2532 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
2533 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
2534 return self._BuildOptions\r
2535\r
0d2711a6 2536 ## Retrieve dependency expression\r
52302d4d
LG
2537 def _GetDepex(self):\r
2538 if self._Depex == None:\r
2539 self._Depex = tdict(False, 2)\r
2540 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
da92f276
LG
2541 \r
2542 # If the module has only Binaries and no Sources, then ignore [Depex] \r
2543 if self.Sources == None or self.Sources == []:\r
0d2711a6
LG
2544 if self.Binaries != None and self.Binaries != []:\r
2545 return self._Depex\r
da92f276 2546 \r
52302d4d
LG
2547 # PEIM and DXE drivers must have a valid [Depex] section\r
2548 if len(self.LibraryClass) == 0 and len(RecordList) == 0:\r
2549 if self.ModuleType == 'DXE_DRIVER' or self.ModuleType == 'PEIM' or self.ModuleType == 'DXE_SMM_DRIVER' or \\r
2550 self.ModuleType == 'DXE_SAL_DRIVER' or self.ModuleType == 'DXE_RUNTIME_DRIVER':\r
2551 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No [Depex] section or no valid expression in [Depex] section for [%s] module" \\r
2552 % self.ModuleType, File=self.MetaFile)\r
2553\r
97fa0ee9
YL
2554 if len(RecordList) != 0 and self.ModuleType == 'USER_DEFINED':\r
2555 for Record in RecordList:\r
2556 if Record[4] not in ['PEIM', 'DXE_DRIVER', 'DXE_SMM_DRIVER']:\r
2557 EdkLogger.error('build', FORMAT_INVALID,\r
2558 "'%s' module must specify the type of [Depex] section" % self.ModuleType,\r
2559 File=self.MetaFile)\r
2560\r
0d2711a6 2561 Depex = sdict()\r
52302d4d 2562 for Record in RecordList:\r
0d2711a6 2563 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
52302d4d
LG
2564 Arch = Record[3]\r
2565 ModuleType = Record[4]\r
0d2711a6 2566 TokenList = DepexStr.split()\r
52302d4d
LG
2567 if (Arch, ModuleType) not in Depex:\r
2568 Depex[Arch, ModuleType] = []\r
2569 DepexList = Depex[Arch, ModuleType]\r
2570 for Token in TokenList:\r
2571 if Token in DEPEX_SUPPORTED_OPCODE:\r
2572 DepexList.append(Token)\r
2573 elif Token.endswith(".inf"): # module file name\r
2574 ModuleFile = os.path.normpath(Token)\r
2575 Module = self.BuildDatabase[ModuleFile]\r
2576 if Module == None:\r
2577 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "Module is not found in active platform",\r
2578 ExtraData=Token, File=self.MetaFile, Line=Record[-1])\r
2579 DepexList.append(Module.Guid)\r
2580 else:\r
2581 # get the GUID value now\r
c28d2e10 2582 Value = ProtocolValue(Token, self.Packages, self.MetaFile.Path)\r
52302d4d 2583 if Value == None:\r
c28d2e10 2584 Value = PpiValue(Token, self.Packages, self.MetaFile.Path)\r
52302d4d 2585 if Value == None:\r
c28d2e10 2586 Value = GuidValue(Token, self.Packages, self.MetaFile.Path)\r
52302d4d
LG
2587 if Value == None:\r
2588 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2589 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2590 "Value of [%s] is not found in" % Token,\r
2591 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
2592 DepexList.append(Value)\r
2593 for Arch, ModuleType in Depex:\r
2594 self._Depex[Arch, ModuleType] = Depex[Arch, ModuleType]\r
2595 return self._Depex\r
2596\r
2597 ## Retrieve depedency expression\r
2598 def _GetDepexExpression(self):\r
2599 if self._DepexExpression == None:\r
2600 self._DepexExpression = tdict(False, 2)\r
2601 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
0d2711a6 2602 DepexExpression = sdict()\r
52302d4d 2603 for Record in RecordList:\r
0d2711a6 2604 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
52302d4d
LG
2605 Arch = Record[3]\r
2606 ModuleType = Record[4]\r
0d2711a6 2607 TokenList = DepexStr.split()\r
52302d4d
LG
2608 if (Arch, ModuleType) not in DepexExpression:\r
2609 DepexExpression[Arch, ModuleType] = ''\r
2610 for Token in TokenList:\r
2611 DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType] + Token.strip() + ' '\r
2612 for Arch, ModuleType in DepexExpression:\r
2613 self._DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType]\r
2614 return self._DepexExpression\r
2615\r
e8a47801
LG
2616 def GetGuidsUsedByPcd(self):\r
2617 return self._GuidsUsedByPcd\r
52302d4d
LG
2618 ## Retrieve PCD for given type\r
2619 def _GetPcd(self, Type):\r
79b74a03 2620 Pcds = sdict()\r
52302d4d 2621 PcdDict = tdict(True, 4)\r
6780eef1 2622 PcdList = []\r
52302d4d 2623 RecordList = self._RawData[Type, self._Arch, self._Platform]\r
e8a47801 2624 for TokenSpaceGuid, PcdCName, Setting, Arch, Platform, Id, LineNo in RecordList:\r
52302d4d 2625 PcdDict[Arch, Platform, PcdCName, TokenSpaceGuid] = (Setting, LineNo)\r
6780eef1 2626 PcdList.append((PcdCName, TokenSpaceGuid))\r
52302d4d
LG
2627 # get the guid value\r
2628 if TokenSpaceGuid not in self.Guids:\r
c28d2e10 2629 Value = GuidValue(TokenSpaceGuid, self.Packages, self.MetaFile.Path)\r
52302d4d
LG
2630 if Value == None:\r
2631 PackageList = "\n\t".join([str(P) for P in self.Packages])\r
2632 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
2633 "Value of Guid [%s] is not found under [Guids] section in" % TokenSpaceGuid,\r
2634 ExtraData=PackageList, File=self.MetaFile, Line=LineNo)\r
2635 self.Guids[TokenSpaceGuid] = Value\r
e8a47801
LG
2636 self._GuidsUsedByPcd[TokenSpaceGuid] = Value\r
2637 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Id]\r
2638 Comments = []\r
2639 for CmtRec in CommentRecords:\r
2640 Comments.append(CmtRec[0])\r
2641 self._PcdComments[TokenSpaceGuid, PcdCName] = Comments\r
52302d4d
LG
2642\r
2643 # resolve PCD type, value, datum info, etc. by getting its definition from package\r
6780eef1 2644 for PcdCName, TokenSpaceGuid in PcdList:\r
2a29017e 2645 PcdRealName = PcdCName\r
52302d4d
LG
2646 Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]\r
2647 if Setting == None:\r
2648 continue\r
6780eef1 2649 ValueList = AnalyzePcdData(Setting)\r
52302d4d
LG
2650 DefaultValue = ValueList[0]\r
2651 Pcd = PcdClassObject(\r
2652 PcdCName,\r
2653 TokenSpaceGuid,\r
2654 '',\r
2655 '',\r
2656 DefaultValue,\r
2657 '',\r
2658 '',\r
2659 {},\r
e56468c0 2660 False,\r
52302d4d
LG
2661 self.Guids[TokenSpaceGuid]\r
2662 )\r
e8a47801
LG
2663 if Type == MODEL_PCD_PATCHABLE_IN_MODULE and ValueList[1]:\r
2664 # Patch PCD: TokenSpace.PcdCName|Value|Offset\r
2665 Pcd.Offset = ValueList[1]\r
52302d4d 2666\r
2a29017e
YZ
2667 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
2668 for Package in self.Packages:\r
2669 for key in Package.Pcds:\r
2670 if (Package.Pcds[key].TokenCName, Package.Pcds[key].TokenSpaceGuidCName) == (PcdRealName, TokenSpaceGuid):\r
2671 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
2672 Pcd_Type = item[0].split('_')[-1]\r
2673 if Pcd_Type == Package.Pcds[key].Type:\r
2674 Value = Package.Pcds[key]\r
2675 Value.TokenCName = Package.Pcds[key].TokenCName + '_' + Pcd_Type\r
2676 if len(key) == 2:\r
2677 newkey = (Value.TokenCName, key[1])\r
2678 elif len(key) == 3:\r
2679 newkey = (Value.TokenCName, key[1], key[2])\r
2680 del Package.Pcds[key]\r
2681 Package.Pcds[newkey] = Value\r
2682 break\r
2683 else:\r
2684 pass\r
2685 else:\r
2686 pass\r
2687\r
52302d4d
LG
2688 # get necessary info from package declaring this PCD\r
2689 for Package in self.Packages:\r
2690 #\r
2691 # 'dynamic' in INF means its type is determined by platform;\r
2692 # if platform doesn't give its type, use 'lowest' one in the\r
2693 # following order, if any\r
2694 #\r
2695 # "FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"\r
2696 #\r
2697 PcdType = self._PCD_TYPE_STRING_[Type]\r
e56468c0 2698 if Type == MODEL_PCD_DYNAMIC:\r
52302d4d
LG
2699 Pcd.Pending = True\r
2700 for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:\r
2a29017e
YZ
2701 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
2702 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
2703 if str(item[0]).endswith(T) and (item[0], item[1], T) in Package.Pcds:\r
2704 PcdType = T\r
2705 PcdCName = item[0]\r
2706 break\r
2707 else:\r
2708 pass\r
52302d4d 2709 break\r
2a29017e
YZ
2710 else:\r
2711 if (PcdRealName, TokenSpaceGuid, T) in Package.Pcds:\r
2712 PcdType = T\r
2713 break\r
2714\r
52302d4d
LG
2715 else:\r
2716 Pcd.Pending = False\r
2a29017e
YZ
2717 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
2718 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
2719 Pcd_Type = item[0].split('_')[-1]\r
2720 if Pcd_Type == PcdType:\r
2721 PcdCName = item[0]\r
2722 break\r
2723 else:\r
2724 pass\r
2725 else:\r
2726 pass\r
52302d4d
LG
2727\r
2728 if (PcdCName, TokenSpaceGuid, PcdType) in Package.Pcds:\r
2729 PcdInPackage = Package.Pcds[PcdCName, TokenSpaceGuid, PcdType]\r
2730 Pcd.Type = PcdType\r
2731 Pcd.TokenValue = PcdInPackage.TokenValue\r
6780eef1
LG
2732 \r
2733 #\r
2734 # Check whether the token value exist or not.\r
2735 #\r
2736 if Pcd.TokenValue == None or Pcd.TokenValue == "":\r
2737 EdkLogger.error(\r
2738 'build',\r
2739 FORMAT_INVALID,\r
2a29017e 2740 "No TokenValue for PCD [%s.%s] in [%s]!" % (TokenSpaceGuid, PcdRealName, str(Package)),\r
47fea6af 2741 File=self.MetaFile, Line=LineNo,\r
6780eef1
LG
2742 ExtraData=None\r
2743 ) \r
2744 #\r
2745 # Check hexadecimal token value length and format.\r
2746 #\r
79b74a03 2747 ReIsValidPcdTokenValue = re.compile(r"^[0][x|X][0]*[0-9a-fA-F]{1,8}$", re.DOTALL)\r
6780eef1 2748 if Pcd.TokenValue.startswith("0x") or Pcd.TokenValue.startswith("0X"):\r
79b74a03 2749 if ReIsValidPcdTokenValue.match(Pcd.TokenValue) == None:\r
6780eef1
LG
2750 EdkLogger.error(\r
2751 'build',\r
2752 FORMAT_INVALID,\r
2a29017e 2753 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid:" % (Pcd.TokenValue, TokenSpaceGuid, PcdRealName, str(Package)),\r
47fea6af 2754 File=self.MetaFile, Line=LineNo,\r
6780eef1
LG
2755 ExtraData=None\r
2756 )\r
2757 \r
2758 #\r
2759 # Check decimal token value length and format.\r
2760 # \r
2761 else:\r
2762 try:\r
2763 TokenValueInt = int (Pcd.TokenValue, 10)\r
2764 if (TokenValueInt < 0 or TokenValueInt > 4294967295):\r
2765 EdkLogger.error(\r
2766 'build',\r
2767 FORMAT_INVALID,\r
2a29017e 2768 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid, as a decimal it should between: 0 - 4294967295!" % (Pcd.TokenValue, TokenSpaceGuid, PcdRealName, str(Package)),\r
47fea6af 2769 File=self.MetaFile, Line=LineNo,\r
6780eef1 2770 ExtraData=None\r
47fea6af 2771 )\r
6780eef1
LG
2772 except:\r
2773 EdkLogger.error(\r
2774 'build',\r
2775 FORMAT_INVALID,\r
2a29017e 2776 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid, it should be hexadecimal or decimal!" % (Pcd.TokenValue, TokenSpaceGuid, PcdRealName, str(Package)),\r
47fea6af 2777 File=self.MetaFile, Line=LineNo,\r
6780eef1
LG
2778 ExtraData=None\r
2779 )\r
47fea6af 2780\r
52302d4d
LG
2781 Pcd.DatumType = PcdInPackage.DatumType\r
2782 Pcd.MaxDatumSize = PcdInPackage.MaxDatumSize\r
2783 Pcd.InfDefaultValue = Pcd.DefaultValue\r
2784 if Pcd.DefaultValue in [None, '']:\r
2785 Pcd.DefaultValue = PcdInPackage.DefaultValue\r
2786 break\r
2787 else:\r
2788 EdkLogger.error(\r
2789 'build',\r
6780eef1 2790 FORMAT_INVALID,\r
2a29017e 2791 "PCD [%s.%s] in [%s] is not found in dependent packages:" % (TokenSpaceGuid, PcdRealName, self.MetaFile),\r
47fea6af 2792 File=self.MetaFile, Line=LineNo,\r
52302d4d
LG
2793 ExtraData="\t%s" % '\n\t'.join([str(P) for P in self.Packages])\r
2794 )\r
2795 Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
6780eef1 2796\r
52302d4d
LG
2797 return Pcds\r
2798\r
e8a47801
LG
2799 ## check whether current module is binary module\r
2800 def _IsBinaryModule(self):\r
2801 if self.Binaries and not self.Sources:\r
2802 return True\r
2803 elif GlobalData.gIgnoreSource:\r
2804 return True\r
2805 else:\r
2806 return False\r
2807\r
2808 _Macros = property(_GetMacros)\r
2809 Arch = property(_GetArch, _SetArch)\r
2810 Platform = property(_GetPlatform, _SetPlatform)\r
52302d4d 2811\r
e8a47801 2812 HeaderComments = property(_GetHeaderComments)\r
2bc3256c 2813 TailComments = property(_GetTailComments)\r
52302d4d
LG
2814 AutoGenVersion = property(_GetInfVersion)\r
2815 BaseName = property(_GetBaseName)\r
2816 ModuleType = property(_GetModuleType)\r
2817 ComponentType = property(_GetComponentType)\r
2818 BuildType = property(_GetBuildType)\r
2819 Guid = property(_GetFileGuid)\r
2820 Version = property(_GetVersion)\r
2821 PcdIsDriver = property(_GetPcdIsDriver)\r
2822 Shadow = property(_GetShadow)\r
2823 CustomMakefile = property(_GetMakefile)\r
2824 Specification = property(_GetSpec)\r
2825 LibraryClass = property(_GetLibraryClass)\r
2826 ModuleEntryPointList = property(_GetEntryPoint)\r
2827 ModuleUnloadImageList = property(_GetUnloadImage)\r
2828 ConstructorList = property(_GetConstructor)\r
2829 DestructorList = property(_GetDestructor)\r
2830 Defines = property(_GetDefines)\r
b36d134f
LG
2831 DxsFile = property(_GetDxsFile)\r
2832 \r
52302d4d
LG
2833 Binaries = property(_GetBinaryFiles)\r
2834 Sources = property(_GetSourceFiles)\r
2835 LibraryClasses = property(_GetLibraryClassUses)\r
2836 Libraries = property(_GetLibraryNames)\r
2837 Protocols = property(_GetProtocols)\r
e8a47801 2838 ProtocolComments = property(_GetProtocolComments)\r
52302d4d 2839 Ppis = property(_GetPpis)\r
e8a47801 2840 PpiComments = property(_GetPpiComments)\r
52302d4d 2841 Guids = property(_GetGuids)\r
e8a47801 2842 GuidComments = property(_GetGuidComments)\r
52302d4d
LG
2843 Includes = property(_GetIncludes)\r
2844 Packages = property(_GetPackages)\r
2845 Pcds = property(_GetPcds)\r
e8a47801 2846 PcdComments = property(_GetPcdComments)\r
52302d4d
LG
2847 BuildOptions = property(_GetBuildOptions)\r
2848 Depex = property(_GetDepex)\r
2849 DepexExpression = property(_GetDepexExpression)\r
e8a47801 2850 IsBinaryModule = property(_IsBinaryModule)\r
a0a2cd1e 2851 IsSupportedArch = property(_IsSupportedArch)\r
52302d4d
LG
2852\r
2853## Database\r
2854#\r
e56468c0 2855# This class defined the build database for all modules, packages and platform.\r
52302d4d
LG
2856# It will call corresponding parser for the given file if it cannot find it in\r
2857# the database.\r
2858#\r
2859# @param DbPath Path of database file\r
2860# @param GlobalMacros Global macros used for replacement during file parsing\r
2861# @prarm RenewDb=False Create new database file if it's already there\r
2862#\r
2863class WorkspaceDatabase(object):\r
52302d4d 2864\r
52302d4d
LG
2865\r
2866 #\r
2867 # internal class used for call corresponding file parser and caching the result\r
2868 # to avoid unnecessary re-parsing\r
2869 #\r
2870 class BuildObjectFactory(object):\r
0d2711a6 2871\r
52302d4d
LG
2872 _FILE_TYPE_ = {\r
2873 ".inf" : MODEL_FILE_INF,\r
2874 ".dec" : MODEL_FILE_DEC,\r
2875 ".dsc" : MODEL_FILE_DSC,\r
0d2711a6
LG
2876 }\r
2877\r
2878 # file parser\r
2879 _FILE_PARSER_ = {\r
2880 MODEL_FILE_INF : InfParser,\r
2881 MODEL_FILE_DEC : DecParser,\r
2882 MODEL_FILE_DSC : DscParser,\r
52302d4d
LG
2883 }\r
2884\r
2885 # convert to xxxBuildData object\r
2886 _GENERATOR_ = {\r
2887 MODEL_FILE_INF : InfBuildData,\r
2888 MODEL_FILE_DEC : DecBuildData,\r
2889 MODEL_FILE_DSC : DscBuildData,\r
52302d4d
LG
2890 }\r
2891\r
2892 _CACHE_ = {} # (FilePath, Arch) : <object>\r
2893\r
2894 # constructor\r
2895 def __init__(self, WorkspaceDb):\r
2896 self.WorkspaceDb = WorkspaceDb\r
2897\r
0d2711a6 2898 # key = (FilePath, Arch=None)\r
52302d4d
LG
2899 def __contains__(self, Key):\r
2900 FilePath = Key[0]\r
52302d4d
LG
2901 if len(Key) > 1:\r
2902 Arch = Key[1]\r
0d2711a6
LG
2903 else:\r
2904 Arch = None\r
52302d4d
LG
2905 return (FilePath, Arch) in self._CACHE_\r
2906\r
0d2711a6 2907 # key = (FilePath, Arch=None, Target=None, Toochain=None)\r
52302d4d
LG
2908 def __getitem__(self, Key):\r
2909 FilePath = Key[0]\r
0d2711a6
LG
2910 KeyLength = len(Key)\r
2911 if KeyLength > 1:\r
52302d4d 2912 Arch = Key[1]\r
0d2711a6
LG
2913 else:\r
2914 Arch = None\r
2915 if KeyLength > 2:\r
2916 Target = Key[2]\r
2917 else:\r
2918 Target = None\r
2919 if KeyLength > 3:\r
2920 Toolchain = Key[3]\r
2921 else:\r
2922 Toolchain = None\r
52302d4d
LG
2923\r
2924 # if it's generated before, just return the cached one\r
0d2711a6 2925 Key = (FilePath, Arch, Target, Toolchain)\r
52302d4d
LG
2926 if Key in self._CACHE_:\r
2927 return self._CACHE_[Key]\r
2928\r
2929 # check file type\r
0d2711a6 2930 Ext = FilePath.Type\r
52302d4d
LG
2931 if Ext not in self._FILE_TYPE_:\r
2932 return None\r
2933 FileType = self._FILE_TYPE_[Ext]\r
2934 if FileType not in self._GENERATOR_:\r
2935 return None\r
2936\r
0d2711a6
LG
2937 # get the parser ready for this file\r
2938 MetaFile = self._FILE_PARSER_[FileType](\r
2939 FilePath, \r
2940 FileType, \r
cdd1b5e5 2941 Arch,\r
0d2711a6
LG
2942 MetaFileStorage(self.WorkspaceDb.Cur, FilePath, FileType)\r
2943 )\r
2944 # alwasy do post-process, in case of macros change\r
2945 MetaFile.DoPostProcess()\r
2946 # object the build is based on\r
52302d4d
LG
2947 BuildObject = self._GENERATOR_[FileType](\r
2948 FilePath,\r
2949 MetaFile,\r
2950 self,\r
2951 Arch,\r
0d2711a6
LG
2952 Target,\r
2953 Toolchain\r
52302d4d
LG
2954 )\r
2955 self._CACHE_[Key] = BuildObject\r
2956 return BuildObject\r
2957\r
2958 # placeholder for file format conversion\r
2959 class TransformObjectFactory:\r
2960 def __init__(self, WorkspaceDb):\r
2961 self.WorkspaceDb = WorkspaceDb\r
2962\r
2963 # key = FilePath, Arch\r
2964 def __getitem__(self, Key):\r
2965 pass\r
2966\r
2967 ## Constructor of WorkspaceDatabase\r
2968 #\r
2969 # @param DbPath Path of database file\r
2970 # @param GlobalMacros Global macros used for replacement during file parsing\r
2971 # @prarm RenewDb=False Create new database file if it's already there\r
2972 #\r
0d2711a6 2973 def __init__(self, DbPath, RenewDb=False):\r
4234283c 2974 self._DbClosedFlag = False\r
0d2711a6 2975 if not DbPath:\r
05cc51ad 2976 DbPath = os.path.normpath(mws.join(GlobalData.gWorkspace, 'Conf', GlobalData.gDatabasePath))\r
52302d4d
LG
2977\r
2978 # don't create necessary path for db in memory\r
2979 if DbPath != ':memory:':\r
2980 DbDir = os.path.split(DbPath)[0]\r
2981 if not os.path.exists(DbDir):\r
2982 os.makedirs(DbDir)\r
2983\r
2984 # remove db file in case inconsistency between db and file in file system\r
2985 if self._CheckWhetherDbNeedRenew(RenewDb, DbPath):\r
2986 os.remove(DbPath)\r
2987 \r
2988 # create db with optimized parameters\r
2989 self.Conn = sqlite3.connect(DbPath, isolation_level='DEFERRED')\r
2990 self.Conn.execute("PRAGMA synchronous=OFF")\r
2991 self.Conn.execute("PRAGMA temp_store=MEMORY")\r
2992 self.Conn.execute("PRAGMA count_changes=OFF")\r
2993 self.Conn.execute("PRAGMA cache_size=8192")\r
2994 #self.Conn.execute("PRAGMA page_size=8192")\r
2995\r
2996 # to avoid non-ascii character conversion issue\r
2997 self.Conn.text_factory = str\r
2998 self.Cur = self.Conn.cursor()\r
2999\r
3000 # create table for internal uses\r
3001 self.TblDataModel = TableDataModel(self.Cur)\r
3002 self.TblFile = TableFile(self.Cur)\r
0d2711a6 3003 self.Platform = None\r
52302d4d
LG
3004\r
3005 # conversion object for build or file format conversion purpose\r
3006 self.BuildObject = WorkspaceDatabase.BuildObjectFactory(self)\r
3007 self.TransformObject = WorkspaceDatabase.TransformObjectFactory(self)\r
3008\r
3009 ## Check whether workspace database need to be renew.\r
3010 # The renew reason maybe:\r
3011 # 1) If user force to renew;\r
3012 # 2) If user do not force renew, and\r
3013 # a) If the time of last modified python source is newer than database file;\r
3014 # b) If the time of last modified frozen executable file is newer than database file;\r
3015 #\r
3016 # @param force User force renew database\r
3017 # @param DbPath The absolute path of workspace database file\r
3018 #\r
3019 # @return Bool value for whether need renew workspace databse\r
3020 #\r
3021 def _CheckWhetherDbNeedRenew (self, force, DbPath):\r
52302d4d
LG
3022 # if database does not exist, we need do nothing\r
3023 if not os.path.exists(DbPath): return False\r
3024 \r
3025 # if user force to renew database, then not check whether database is out of date\r
3026 if force: return True\r
3027 \r
3028 # \r
3029 # Check the time of last modified source file or build.exe\r
3030 # if is newer than time of database, then database need to be re-created.\r
3031 #\r
3032 timeOfToolModified = 0\r
3033 if hasattr(sys, "frozen"):\r
3034 exePath = os.path.abspath(sys.executable)\r
3035 timeOfToolModified = os.stat(exePath).st_mtime\r
3036 else:\r
3037 curPath = os.path.dirname(__file__) # curPath is the path of WorkspaceDatabase.py\r
3038 rootPath = os.path.split(curPath)[0] # rootPath is root path of python source, such as /BaseTools/Source/Python\r
3039 if rootPath == "" or rootPath == None:\r
3040 EdkLogger.verbose("\nFail to find the root path of build.exe or python sources, so can not \\r
3041determine whether database file is out of date!\n")\r
3042 \r
3043 # walk the root path of source or build's binary to get the time last modified.\r
3044 \r
3045 for root, dirs, files in os.walk (rootPath):\r
3046 for dir in dirs:\r
3047 # bypass source control folder \r
3048 if dir.lower() in [".svn", "_svn", "cvs"]:\r
3049 dirs.remove(dir)\r
3050 \r
3051 for file in files:\r
3052 ext = os.path.splitext(file)[1]\r
3053 if ext.lower() == ".py": # only check .py files\r
3054 fd = os.stat(os.path.join(root, file))\r
3055 if timeOfToolModified < fd.st_mtime:\r
3056 timeOfToolModified = fd.st_mtime\r
3057 if timeOfToolModified > os.stat(DbPath).st_mtime:\r
3058 EdkLogger.verbose("\nWorkspace database is out of data!")\r
3059 return True\r
3060 \r
3061 return False\r
3062 \r
3063 ## Initialize build database\r
3064 def InitDatabase(self):\r
3065 EdkLogger.verbose("\nInitialize build database started ...")\r
3066\r
3067 #\r
3068 # Create new tables\r
3069 #\r
3070 self.TblDataModel.Create(False)\r
3071 self.TblFile.Create(False)\r
3072\r
3073 #\r
3074 # Initialize table DataModel\r
3075 #\r
3076 self.TblDataModel.InitTable()\r
3077 EdkLogger.verbose("Initialize build database ... DONE!")\r
3078\r
3079 ## Query a table\r
3080 #\r
3081 # @param Table: The instance of the table to be queried\r
3082 #\r
3083 def QueryTable(self, Table):\r
3084 Table.Query()\r
3085\r
0d2711a6
LG
3086 def __del__(self):\r
3087 self.Close()\r
3088\r
52302d4d
LG
3089 ## Close entire database\r
3090 #\r
3091 # Commit all first\r
3092 # Close the connection and cursor\r
3093 #\r
3094 def Close(self):\r
4234283c
LG
3095 if not self._DbClosedFlag:\r
3096 self.Conn.commit()\r
3097 self.Cur.close()\r
3098 self.Conn.close()\r
3099 self._DbClosedFlag = True\r
52302d4d 3100\r
52302d4d 3101 ## Summarize all packages in the database\r
0d2711a6
LG
3102 def GetPackageList(self, Platform, Arch, TargetName, ToolChainTag):\r
3103 self.Platform = Platform\r
47fea6af 3104 PackageList = []\r
0d2711a6
LG
3105 Pa = self.BuildObject[self.Platform, 'COMMON']\r
3106 #\r
3107 # Get Package related to Modules\r
3108 #\r
3109 for Module in Pa.Modules:\r
3110 ModuleObj = self.BuildObject[Module, Arch, TargetName, ToolChainTag]\r
3111 for Package in ModuleObj.Packages:\r
52302d4d
LG
3112 if Package not in PackageList:\r
3113 PackageList.append(Package)\r
0d2711a6
LG
3114 #\r
3115 # Get Packages related to Libraries\r
3116 #\r
3117 for Lib in Pa.LibraryInstances:\r
3118 LibObj = self.BuildObject[Lib, Arch, TargetName, ToolChainTag]\r
3119 for Package in LibObj.Packages:\r
3120 if Package not in PackageList:\r
47fea6af
YZ
3121 PackageList.append(Package)\r
3122\r
52302d4d
LG
3123 return PackageList\r
3124\r
3125 ## Summarize all platforms in the database\r
3126 def _GetPlatformList(self):\r
3127 PlatformList = []\r
3128 for PlatformFile in self.TblFile.GetFileList(MODEL_FILE_DSC):\r
3129 try:\r
3130 Platform = self.BuildObject[PathClass(PlatformFile), 'COMMON']\r
3131 except:\r
3132 Platform = None\r
3133 if Platform != None:\r
3134 PlatformList.append(Platform)\r
3135 return PlatformList\r
3136\r
f0dc69e6 3137 def _MapPlatform(self, Dscfile):\r
d429fcd0
YZ
3138 Platform = self.BuildObject[PathClass(Dscfile), 'COMMON']\r
3139 if Platform == None:\r
3140 EdkLogger.error('build', PARSER_ERROR, "Failed to parser DSC file: %s" % Dscfile)\r
f0dc69e6
YZ
3141 return Platform\r
3142\r
52302d4d 3143 PlatformList = property(_GetPlatformList)\r
52302d4d
LG
3144\r
3145##\r
3146#\r
3147# This acts like the main() function for the script, unless it is 'import'ed into another\r
3148# script.\r
3149#\r
3150if __name__ == '__main__':\r
3151 pass\r
3152\r