]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/InfBuildData.py
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
BaseTools: Refactor python except statements
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / InfBuildData.py
CommitLineData
ae7b6df8
LG		 1## @file\r
2# This file is used to create a database used by build tool\r
3#\r
a0767bae 4# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
ae7b6df8
LG		 5# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
6# This program and the accompanying materials\r
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
5a57246e 15from Common.StringUtils import *\r
ae7b6df8
LG		 16from Common.DataType import *\r
17from Common.Misc import *\r
18from types import *\r
726c501c 19from MetaFileParser import *\r
a0767bae 20from collections import OrderedDict\r
ae7b6df8
LG		 21\r
22from Workspace.BuildClassObject import ModuleBuildClassObject, LibraryClassObject, PcdClassObject\r
23## Module build information from INF file\r
24#\r
25# This class is used to retrieve information stored in database and convert them\r
26# into ModuleBuildClassObject form for easier use for AutoGen.\r
27#\r
28class InfBuildData(ModuleBuildClassObject):\r
29 # dict used to convert PCD type in database to string used by build tool\r
30 _PCD_TYPE_STRING_ = {\r
be409b67
CJ		 31 MODEL_PCD_FIXED_AT_BUILD : TAB_PCDS_FIXED_AT_BUILD,\r
32 MODEL_PCD_PATCHABLE_IN_MODULE : TAB_PCDS_PATCHABLE_IN_MODULE,\r
33 MODEL_PCD_FEATURE_FLAG : TAB_PCDS_FEATURE_FLAG,\r
34 MODEL_PCD_DYNAMIC : TAB_PCDS_DYNAMIC,\r
35 MODEL_PCD_DYNAMIC_DEFAULT : TAB_PCDS_DYNAMIC,\r
36 MODEL_PCD_DYNAMIC_HII : TAB_PCDS_DYNAMIC_HII,\r
37 MODEL_PCD_DYNAMIC_VPD : TAB_PCDS_DYNAMIC_VPD,\r
38 MODEL_PCD_DYNAMIC_EX : TAB_PCDS_DYNAMIC_EX,\r
39 MODEL_PCD_DYNAMIC_EX_DEFAULT : TAB_PCDS_DYNAMIC_EX,\r
40 MODEL_PCD_DYNAMIC_EX_HII : TAB_PCDS_DYNAMIC_EX_HII,\r
41 MODEL_PCD_DYNAMIC_EX_VPD : TAB_PCDS_DYNAMIC_EX_VPD,\r
ae7b6df8
LG		 42 }\r
43\r
44 # dict used to convert part of [Defines] to members of InfBuildData directly\r
45 _PROPERTY_ = {\r
46 #\r
47 # Required Fields\r
48 #\r
49 TAB_INF_DEFINES_BASE_NAME : "_BaseName",\r
50 TAB_INF_DEFINES_FILE_GUID : "_Guid",\r
51 TAB_INF_DEFINES_MODULE_TYPE : "_ModuleType",\r
52 #\r
53 # Optional Fields\r
54 #\r
55 # TAB_INF_DEFINES_INF_VERSION : "_AutoGenVersion",\r
56 TAB_INF_DEFINES_COMPONENT_TYPE : "_ComponentType",\r
57 TAB_INF_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
58 # TAB_INF_DEFINES_CUSTOM_MAKEFILE : "_CustomMakefile",\r
59 TAB_INF_DEFINES_DPX_SOURCE :"_DxsFile",\r
60 TAB_INF_DEFINES_VERSION_NUMBER : "_Version",\r
61 TAB_INF_DEFINES_VERSION_STRING : "_Version",\r
62 TAB_INF_DEFINES_VERSION : "_Version",\r
63 TAB_INF_DEFINES_PCD_IS_DRIVER : "_PcdIsDriver",\r
64 TAB_INF_DEFINES_SHADOW : "_Shadow",\r
65\r
66 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH : "_SourceOverridePath",\r
67 }\r
68\r
ae7b6df8
LG		 69 # regular expression for converting XXX_FLAGS in [nmake] section to new type\r
70 _NMAKE_FLAG_PATTERN_ = re.compile("(?:EBC_)?([A-Z]+)_(?:STD_|PROJ_|ARCH_)?FLAGS(?:_DLL|_ASL|_EXE)?", re.UNICODE)\r
71 # dict used to convert old tool name used in [nmake] section to new ones\r
72 _TOOL_CODE_ = {\r
73 "C" : "CC",\r
91fa33ee 74 BINARY_FILE_TYPE_LIB : "SLINK",\r
ae7b6df8
LG		 75 "LINK" : "DLINK",\r
76 }\r
77\r
78\r
79 ## Constructor of DscBuildData\r
80 #\r
81 # Initialize object of DscBuildData\r
82 #\r
83 # @param FilePath The path of platform description file\r
84 # @param RawData The raw data of DSC file\r
85 # @param BuildDataBase Database used to retrieve module/package information\r
86 # @param Arch The target architecture\r
87 # @param Platform The name of platform employing this module\r
88 # @param Macros Macros used for replacement in DSC file\r
89 #\r
55c84777 90 def __init__(self, FilePath, RawData, BuildDatabase, Arch=TAB_ARCH_COMMON, Target=None, Toolchain=None):\r
ae7b6df8
LG		 91 self.MetaFile = FilePath\r
92 self._ModuleDir = FilePath.Dir\r
93 self._RawData = RawData\r
94 self._Bdb = BuildDatabase\r
95 self._Arch = Arch\r
96 self._Target = Target\r
97 self._Toolchain = Toolchain\r
55c84777 98 self._Platform = TAB_COMMON\r
ae7b6df8
LG		 99 self._SourceOverridePath = None\r
100 if FilePath.Key in GlobalData.gOverrideDir:\r
101 self._SourceOverridePath = GlobalData.gOverrideDir[FilePath.Key]\r
102 self._Clear()\r
103\r
104 ## XXX[key] = value\r
105 def __setitem__(self, key, value):\r
106 self.__dict__[self._PROPERTY_[key]] = value\r
107\r
108 ## value = XXX[key]\r
109 def __getitem__(self, key):\r
110 return self.__dict__[self._PROPERTY_[key]]\r
111\r
112 ## "in" test support\r
113 def __contains__(self, key):\r
114 return key in self._PROPERTY_\r
115\r
116 ## Set all internal used members of InfBuildData to None\r
117 def _Clear(self):\r
118 self._HeaderComments = None\r
119 self._TailComments = None\r
120 self._Header_ = None\r
121 self._AutoGenVersion = None\r
122 self._BaseName = None\r
123 self._DxsFile = None\r
124 self._ModuleType = None\r
125 self._ComponentType = None\r
126 self._BuildType = None\r
127 self._Guid = None\r
128 self._Version = None\r
129 self._PcdIsDriver = None\r
130 self._BinaryModule = None\r
131 self._Shadow = None\r
132 self._MakefileName = None\r
133 self._CustomMakefile = None\r
134 self._Specification = None\r
135 self._LibraryClass = None\r
136 self._ModuleEntryPointList = None\r
137 self._ModuleUnloadImageList = None\r
138 self._ConstructorList = None\r
139 self._DestructorList = None\r
a0767bae 140 self._Defs = OrderedDict()\r
ae7b6df8
LG		 141 self._Binaries = None\r
142 self._Sources = None\r
143 self._LibraryClasses = None\r
144 self._Libraries = None\r
145 self._Protocols = None\r
146 self._ProtocolComments = None\r
147 self._Ppis = None\r
148 self._PpiComments = None\r
149 self._Guids = None\r
a0767bae 150 self._GuidsUsedByPcd = OrderedDict()\r
ae7b6df8
LG		 151 self._GuidComments = None\r
152 self._Includes = None\r
153 self._Packages = None\r
154 self._Pcds = None\r
155 self._PcdComments = None\r
156 self._BuildOptions = None\r
157 self._Depex = None\r
158 self._DepexExpression = None\r
159 self.__Macros = None\r
160\r
161 ## Get current effective macros\r
162 def _GetMacros(self):\r
4231a819 163 if self.__Macros is None:\r
ae7b6df8
LG		 164 self.__Macros = {}\r
165 # EDK_GLOBAL defined macros can be applied to EDK module\r
166 if self.AutoGenVersion < 0x00010005:\r
167 self.__Macros.update(GlobalData.gEdkGlobal)\r
168 self.__Macros.update(GlobalData.gGlobalDefines)\r
169 return self.__Macros\r
170\r
171 ## Get architecture\r
172 def _GetArch(self):\r
173 return self._Arch\r
174\r
175 ## Set architecture\r
176 #\r
177 # Changing the default ARCH to another may affect all other information\r
178 # because all information in a platform may be ARCH-related. That's\r
179 # why we need to clear all internal used members, in order to cause all\r
180 # information to be re-retrieved.\r
181 #\r
182 # @param Value The value of ARCH\r
183 #\r
184 def _SetArch(self, Value):\r
185 if self._Arch == Value:\r
186 return\r
187 self._Arch = Value\r
188 self._Clear()\r
189\r
190 ## Return the name of platform employing this module\r
191 def _GetPlatform(self):\r
192 return self._Platform\r
193\r
194 ## Change the name of platform employing this module\r
195 #\r
196 # Changing the default name of platform to another may affect some information\r
197 # because they may be PLATFORM-related. That's why we need to clear all internal\r
198 # used members, in order to cause all information to be re-retrieved.\r
199 #\r
200 def _SetPlatform(self, Value):\r
201 if self._Platform == Value:\r
202 return\r
203 self._Platform = Value\r
204 self._Clear()\r
205 def _GetHeaderComments(self):\r
206 if not self._HeaderComments:\r
207 self._HeaderComments = []\r
208 RecordList = self._RawData[MODEL_META_DATA_HEADER_COMMENT]\r
209 for Record in RecordList:\r
210 self._HeaderComments.append(Record[0])\r
211 return self._HeaderComments\r
212 def _GetTailComments(self):\r
213 if not self._TailComments:\r
214 self._TailComments = []\r
215 RecordList = self._RawData[MODEL_META_DATA_TAIL_COMMENT]\r
216 for Record in RecordList:\r
217 self._TailComments.append(Record[0])\r
218 return self._TailComments\r
219 ## Retrieve all information in [Defines] section\r
220 #\r
221 # (Retriving all [Defines] information in one-shot is just to save time.)\r
222 #\r
223 def _GetHeaderInfo(self):\r
224 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
225 for Record in RecordList:\r
226 Name, Value = Record[1], ReplaceMacro(Record[2], self._Macros, False)\r
227 # items defined _PROPERTY_ don't need additional processing\r
228 if Name in self:\r
229 self[Name] = Value\r
ae7b6df8
LG		 230 self._Defs[Name] = Value\r
231 self._Macros[Name] = Value\r
232 # some special items in [Defines] section need special treatment\r
233 elif Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION', 'EDK_RELEASE_VERSION', 'PI_SPECIFICATION_VERSION'):\r
234 if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):\r
235 Name = 'UEFI_SPECIFICATION_VERSION'\r
4231a819 236 if self._Specification is None:\r
a0767bae 237 self._Specification = OrderedDict()\r
ae7b6df8 238 self._Specification[Name] = GetHexVerValue(Value)\r
4231a819 239 if self._Specification[Name] is None:\r
ae7b6df8
LG		 240 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
241 "'%s' format is not supported for %s" % (Value, Name),\r
242 File=self.MetaFile, Line=Record[-1])\r
243 elif Name == 'LIBRARY_CLASS':\r
4231a819 244 if self._LibraryClass is None:\r
ae7b6df8
LG		 245 self._LibraryClass = []\r
246 ValueList = GetSplitValueList(Value)\r
247 LibraryClass = ValueList[0]\r
248 if len(ValueList) > 1:\r
249 SupModuleList = GetSplitValueList(ValueList[1], ' ')\r
250 else:\r
251 SupModuleList = SUP_MODULE_LIST\r
252 self._LibraryClass.append(LibraryClassObject(LibraryClass, SupModuleList))\r
253 elif Name == 'ENTRY_POINT':\r
4231a819 254 if self._ModuleEntryPointList is None:\r
ae7b6df8
LG		 255 self._ModuleEntryPointList = []\r
256 self._ModuleEntryPointList.append(Value)\r
257 elif Name == 'UNLOAD_IMAGE':\r
4231a819 258 if self._ModuleUnloadImageList is None:\r
ae7b6df8
LG		 259 self._ModuleUnloadImageList = []\r
260 if not Value:\r
261 continue\r
262 self._ModuleUnloadImageList.append(Value)\r
263 elif Name == 'CONSTRUCTOR':\r
4231a819 264 if self._ConstructorList is None:\r
ae7b6df8
LG		 265 self._ConstructorList = []\r
266 if not Value:\r
267 continue\r
268 self._ConstructorList.append(Value)\r
269 elif Name == 'DESTRUCTOR':\r
4231a819 270 if self._DestructorList is None:\r
ae7b6df8
LG		 271 self._DestructorList = []\r
272 if not Value:\r
273 continue\r
274 self._DestructorList.append(Value)\r
275 elif Name == TAB_INF_DEFINES_CUSTOM_MAKEFILE:\r
276 TokenList = GetSplitValueList(Value)\r
4231a819 277 if self._CustomMakefile is None:\r
ae7b6df8
LG		 278 self._CustomMakefile = {}\r
279 if len(TokenList) < 2:\r
280 self._CustomMakefile['MSFT'] = TokenList[0]\r
281 self._CustomMakefile['GCC'] = TokenList[0]\r
282 else:\r
283 if TokenList[0] not in ['MSFT', 'GCC']:\r
284 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
285 "No supported family [%s]" % TokenList[0],\r
286 File=self.MetaFile, Line=Record[-1])\r
287 self._CustomMakefile[TokenList[0]] = TokenList[1]\r
288 else:\r
ae7b6df8
LG		 289 self._Defs[Name] = Value\r
290 self._Macros[Name] = Value\r
291\r
292 #\r
293 # Retrieve information in sections specific to Edk.x modules\r
294 #\r
295 if self.AutoGenVersion >= 0x00010005:\r
296 if not self._ModuleType:\r
297 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
298 "MODULE_TYPE is not given", File=self.MetaFile)\r
299 if self._ModuleType not in SUP_MODULE_LIST:\r
300 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
301 for Record in RecordList:\r
302 Name = Record[1]\r
303 if Name == "MODULE_TYPE":\r
304 LineNo = Record[6]\r
305 break\r
306 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
307 "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
308 File=self.MetaFile, Line=LineNo)\r
4231a819 309 if (self._Specification is None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x0001000A):\r
ae7b6df8
LG		 310 if self._ModuleType == SUP_MODULE_SMM_CORE:\r
311 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
4231a819 312 if (self._Specification is None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x00010032):\r
ae7b6df8
LG		 313 if self._ModuleType == SUP_MODULE_MM_CORE_STANDALONE:\r
314 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "MM_CORE_STANDALONE module type can't be used in the module with PI_SPECIFICATION_VERSION less than 0x00010032", File=self.MetaFile)\r
315 if self._ModuleType == SUP_MODULE_MM_STANDALONE:\r
316 EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "MM_STANDALONE module type can't be used in the module with PI_SPECIFICATION_VERSION less than 0x00010032", File=self.MetaFile)\r
a0767bae 317 if 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
ae7b6df8
LG		 318 and 'PCI_CLASS_CODE' in self._Defs and 'PCI_REVISION' in self._Defs:\r
319 self._BuildType = 'UEFI_OPTIONROM'\r
320 if 'PCI_COMPRESS' in self._Defs:\r
321 if self._Defs['PCI_COMPRESS'] not in ('TRUE', 'FALSE'):\r
322 EdkLogger.error("build", FORMAT_INVALID, "Expected TRUE/FALSE for PCI_COMPRESS: %s" % self.MetaFile)\r
323\r
a0767bae 324 elif 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
ae7b6df8
LG		 325 and self._Defs['UEFI_HII_RESOURCE_SECTION'] == 'TRUE':\r
326 self._BuildType = 'UEFI_HII'\r
327 else:\r
328 self._BuildType = self._ModuleType.upper()\r
329\r
330 if self._DxsFile:\r
331 File = PathClass(NormPath(self._DxsFile), self._ModuleDir, Arch=self._Arch)\r
332 # check the file validation\r
333 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
334 if ErrorCode != 0:\r
335 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
336 File=self.MetaFile, Line=LineNo)\r
4231a819 337 if self.Sources is None:\r
ae7b6df8
LG		 338 self._Sources = []\r
339 self._Sources.append(File)\r
340 else:\r
341 if not self._ComponentType:\r
342 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
343 "COMPONENT_TYPE is not given", File=self.MetaFile)\r
344 self._BuildType = self._ComponentType.upper()\r
ee1ca53d
CJ		 345 if self._ComponentType in COMPONENT_TO_MODULE_MAP_DICT:\r
346 self._ModuleType = COMPONENT_TO_MODULE_MAP_DICT[self._ComponentType]\r
0c60e60b 347 if self._ComponentType == EDK_COMPONENT_TYPE_LIBRARY:\r
ae7b6df8
LG		 348 self._LibraryClass = [LibraryClassObject(self._BaseName, SUP_MODULE_LIST)]\r
349 # make use some [nmake] section macros\r
350 Macros = self._Macros\r
351 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
352 Macros['PROCESSOR'] = self._Arch\r
353 RecordList = self._RawData[MODEL_META_DATA_NMAKE, self._Arch, self._Platform]\r
354 for Name, Value, Dummy, Arch, Platform, ID, LineNo in RecordList:\r
355 Value = ReplaceMacro(Value, Macros, True)\r
356 if Name == "IMAGE_ENTRY_POINT":\r
4231a819 357 if self._ModuleEntryPointList is None:\r
ae7b6df8
LG		 358 self._ModuleEntryPointList = []\r
359 self._ModuleEntryPointList.append(Value)\r
360 elif Name == "DPX_SOURCE":\r
361 File = PathClass(NormPath(Value), self._ModuleDir, Arch=self._Arch)\r
362 # check the file validation\r
363 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
364 if ErrorCode != 0:\r
365 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
366 File=self.MetaFile, Line=LineNo)\r
4231a819 367 if self.Sources is None:\r
ae7b6df8
LG		 368 self._Sources = []\r
369 self._Sources.append(File)\r
370 else:\r
371 ToolList = self._NMAKE_FLAG_PATTERN_.findall(Name)\r
372 if len(ToolList) == 0 or len(ToolList) != 1:\r
373 pass\r
374# EdkLogger.warn("build", "Don't know how to do with macro [%s]" % Name,\r
375# File=self.MetaFile, Line=LineNo)\r
376 else:\r
4231a819 377 if self._BuildOptions is None:\r
a0767bae 378 self._BuildOptions = OrderedDict()\r
ae7b6df8
LG		 379\r
380 if ToolList[0] in self._TOOL_CODE_:\r
381 Tool = self._TOOL_CODE_[ToolList[0]]\r
382 else:\r
383 Tool = ToolList[0]\r
384 ToolChain = "*_*_*_%s_FLAGS" % Tool\r
385 ToolChainFamily = 'MSFT' # Edk.x only support MSFT tool chain\r
386 # ignore not replaced macros in value\r
387 ValueList = GetSplitList(' ' + Value, '/D')\r
388 Dummy = ValueList[0]\r
389 for Index in range(1, len(ValueList)):\r
390 if ValueList[Index][-1] == '=' or ValueList[Index] == '':\r
391 continue\r
392 Dummy = Dummy + ' /D ' + ValueList[Index]\r
393 Value = Dummy.strip()\r
394 if (ToolChainFamily, ToolChain) not in self._BuildOptions:\r
395 self._BuildOptions[ToolChainFamily, ToolChain] = Value\r
396 else:\r
397 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
398 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Value\r
399 # set _Header to non-None in order to avoid database re-querying\r
400 self._Header_ = 'DUMMY'\r
401\r
402 ## Retrieve file version\r
403 def _GetInfVersion(self):\r
4231a819 404 if self._AutoGenVersion is None:\r
ae7b6df8
LG		 405 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
406 for Record in RecordList:\r
407 if Record[1] == TAB_INF_DEFINES_INF_VERSION:\r
408 if '.' in Record[2]:\r
409 ValueList = Record[2].split('.')\r
410 Major = '%04o' % int(ValueList[0], 0)\r
411 Minor = '%04o' % int(ValueList[1], 0)\r
412 self._AutoGenVersion = int('0x' + Major + Minor, 0)\r
413 else:\r
414 self._AutoGenVersion = int(Record[2], 0)\r
415 break\r
4231a819 416 if self._AutoGenVersion is None:\r
ae7b6df8
LG		 417 self._AutoGenVersion = 0x00010000\r
418 return self._AutoGenVersion\r
419\r
420 ## Retrieve BASE_NAME\r
421 def _GetBaseName(self):\r
4231a819
CJ		 422 if self._BaseName is None:\r
423 if self._Header_ is None:\r
ae7b6df8 424 self._GetHeaderInfo()\r
4231a819 425 if self._BaseName is None:\r
ae7b6df8
LG		 426 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No BASE_NAME name", File=self.MetaFile)\r
427 return self._BaseName\r
428\r
429 ## Retrieve DxsFile\r
430 def _GetDxsFile(self):\r
4231a819
CJ		 431 if self._DxsFile is None:\r
432 if self._Header_ is None:\r
ae7b6df8 433 self._GetHeaderInfo()\r
4231a819 434 if self._DxsFile is None:\r
ae7b6df8
LG		 435 self._DxsFile = ''\r
436 return self._DxsFile\r
437\r
438 ## Retrieve MODULE_TYPE\r
439 def _GetModuleType(self):\r
4231a819
CJ		 440 if self._ModuleType is None:\r
441 if self._Header_ is None:\r
ae7b6df8 442 self._GetHeaderInfo()\r
4231a819 443 if self._ModuleType is None:\r
8bb63e37 444 self._ModuleType = SUP_MODULE_BASE\r
ae7b6df8 445 if self._ModuleType not in SUP_MODULE_LIST:\r
8bb63e37 446 self._ModuleType = SUP_MODULE_USER_DEFINED\r
ae7b6df8
LG		 447 return self._ModuleType\r
448\r
449 ## Retrieve COMPONENT_TYPE\r
450 def _GetComponentType(self):\r
4231a819
CJ		 451 if self._ComponentType is None:\r
452 if self._Header_ is None:\r
ae7b6df8 453 self._GetHeaderInfo()\r
4231a819 454 if self._ComponentType is None:\r
8bb63e37 455 self._ComponentType = SUP_MODULE_USER_DEFINED\r
ae7b6df8
LG		 456 return self._ComponentType\r
457\r
458 ## Retrieve "BUILD_TYPE"\r
459 def _GetBuildType(self):\r
4231a819
CJ		 460 if self._BuildType is None:\r
461 if self._Header_ is None:\r
ae7b6df8
LG		 462 self._GetHeaderInfo()\r
463 if not self._BuildType:\r
8bb63e37 464 self._BuildType = SUP_MODULE_BASE\r
ae7b6df8
LG		 465 return self._BuildType\r
466\r
467 ## Retrieve file guid\r
468 def _GetFileGuid(self):\r
4231a819
CJ		 469 if self._Guid is None:\r
470 if self._Header_ is None:\r
ae7b6df8 471 self._GetHeaderInfo()\r
4231a819 472 if self._Guid is None:\r
ae7b6df8
LG		 473 self._Guid = '00000000-0000-0000-0000-000000000000'\r
474 return self._Guid\r
475\r
476 ## Retrieve module version\r
477 def _GetVersion(self):\r
4231a819
CJ		 478 if self._Version is None:\r
479 if self._Header_ is None:\r
ae7b6df8 480 self._GetHeaderInfo()\r
4231a819 481 if self._Version is None:\r
ae7b6df8
LG		 482 self._Version = '0.0'\r
483 return self._Version\r
484\r
485 ## Retrieve PCD_IS_DRIVER\r
486 def _GetPcdIsDriver(self):\r
4231a819
CJ		 487 if self._PcdIsDriver is None:\r
488 if self._Header_ is None:\r
ae7b6df8 489 self._GetHeaderInfo()\r
4231a819 490 if self._PcdIsDriver is None:\r
ae7b6df8
LG		 491 self._PcdIsDriver = ''\r
492 return self._PcdIsDriver\r
493\r
494 ## Retrieve SHADOW\r
495 def _GetShadow(self):\r
4231a819
CJ		 496 if self._Shadow is None:\r
497 if self._Header_ is None:\r
ae7b6df8 498 self._GetHeaderInfo()\r
4231a819 499 if self._Shadow is not None and self._Shadow.upper() == 'TRUE':\r
ae7b6df8
LG		 500 self._Shadow = True\r
501 else:\r
502 self._Shadow = False\r
503 return self._Shadow\r
504\r
505 ## Retrieve CUSTOM_MAKEFILE\r
506 def _GetMakefile(self):\r
4231a819
CJ		 507 if self._CustomMakefile is None:\r
508 if self._Header_ is None:\r
ae7b6df8 509 self._GetHeaderInfo()\r
4231a819 510 if self._CustomMakefile is None:\r
ae7b6df8
LG		 511 self._CustomMakefile = {}\r
512 return self._CustomMakefile\r
513\r
514 ## Retrieve EFI_SPECIFICATION_VERSION\r
515 def _GetSpec(self):\r
4231a819
CJ		 516 if self._Specification is None:\r
517 if self._Header_ is None:\r
ae7b6df8 518 self._GetHeaderInfo()\r
4231a819 519 if self._Specification is None:\r
ae7b6df8
LG		 520 self._Specification = {}\r
521 return self._Specification\r
522\r
523 ## Retrieve LIBRARY_CLASS\r
524 def _GetLibraryClass(self):\r
4231a819
CJ		 525 if self._LibraryClass is None:\r
526 if self._Header_ is None:\r
ae7b6df8 527 self._GetHeaderInfo()\r
4231a819 528 if self._LibraryClass is None:\r
ae7b6df8
LG		 529 self._LibraryClass = []\r
530 return self._LibraryClass\r
531\r
532 ## Retrieve ENTRY_POINT\r
533 def _GetEntryPoint(self):\r
4231a819
CJ		 534 if self._ModuleEntryPointList is None:\r
535 if self._Header_ is None:\r
ae7b6df8 536 self._GetHeaderInfo()\r
4231a819 537 if self._ModuleEntryPointList is None:\r
ae7b6df8
LG		 538 self._ModuleEntryPointList = []\r
539 return self._ModuleEntryPointList\r
540\r
541 ## Retrieve UNLOAD_IMAGE\r
542 def _GetUnloadImage(self):\r
4231a819
CJ		 543 if self._ModuleUnloadImageList is None:\r
544 if self._Header_ is None:\r
ae7b6df8 545 self._GetHeaderInfo()\r
4231a819 546 if self._ModuleUnloadImageList is None:\r
ae7b6df8
LG		 547 self._ModuleUnloadImageList = []\r
548 return self._ModuleUnloadImageList\r
549\r
550 ## Retrieve CONSTRUCTOR\r
551 def _GetConstructor(self):\r
4231a819
CJ		 552 if self._ConstructorList is None:\r
553 if self._Header_ is None:\r
ae7b6df8 554 self._GetHeaderInfo()\r
4231a819 555 if self._ConstructorList is None:\r
ae7b6df8
LG		 556 self._ConstructorList = []\r
557 return self._ConstructorList\r
558\r
559 ## Retrieve DESTRUCTOR\r
560 def _GetDestructor(self):\r
4231a819
CJ		 561 if self._DestructorList is None:\r
562 if self._Header_ is None:\r
ae7b6df8 563 self._GetHeaderInfo()\r
4231a819 564 if self._DestructorList is None:\r
ae7b6df8
LG		 565 self._DestructorList = []\r
566 return self._DestructorList\r
567\r
568 ## Retrieve definies other than above ones\r
569 def _GetDefines(self):\r
a0767bae
CJ		 570 if len(self._Defs) == 0 and self._Header_ is None:\r
571 self._GetHeaderInfo()\r
ae7b6df8
LG		 572 return self._Defs\r
573\r
574 ## Retrieve binary files\r
575 def _GetBinaries(self):\r
4231a819 576 if self._Binaries is None:\r
ae7b6df8
LG		 577 self._Binaries = []\r
578 RecordList = self._RawData[MODEL_EFI_BINARY_FILE, self._Arch, self._Platform]\r
579 Macros = self._Macros\r
580 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
581 Macros['PROCESSOR'] = self._Arch\r
582 for Record in RecordList:\r
583 FileType = Record[0]\r
584 LineNo = Record[-1]\r
55c84777 585 Target = TAB_COMMON\r
ae7b6df8
LG		 586 FeatureFlag = []\r
587 if Record[2]:\r
588 TokenList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
589 if TokenList:\r
590 Target = TokenList[0]\r
591 if len(TokenList) > 1:\r
592 FeatureFlag = Record[1:]\r
593\r
594 File = PathClass(NormPath(Record[1], Macros), self._ModuleDir, '', FileType, True, self._Arch, '', Target)\r
595 # check the file validation\r
596 ErrorCode, ErrorInfo = File.Validate()\r
597 if ErrorCode != 0:\r
598 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
599 self._Binaries.append(File)\r
600 return self._Binaries\r
601\r
602 ## Retrieve binary files with error check.\r
603 def _GetBinaryFiles(self):\r
604 Binaries = self._GetBinaries()\r
605 if GlobalData.gIgnoreSource and Binaries == []:\r
606 ErrorInfo = "The INF file does not contain any Binaries to use in creating the image\n"\r
607 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, ExtraData=ErrorInfo, File=self.MetaFile)\r
608\r
609 return Binaries\r
610 ## Check whether it exists the binaries with current ARCH in AsBuild INF\r
611 def _IsSupportedArch(self):\r
612 if self._GetBinaries() and not self._GetSourceFiles():\r
613 return True\r
614 else:\r
615 return False\r
616 ## Retrieve source files\r
617 def _GetSourceFiles(self):\r
618 # Ignore all source files in a binary build mode\r
619 if GlobalData.gIgnoreSource:\r
620 self._Sources = []\r
621 return self._Sources\r
622\r
4231a819 623 if self._Sources is None:\r
ae7b6df8
LG		 624 self._Sources = []\r
625 RecordList = self._RawData[MODEL_EFI_SOURCE_FILE, self._Arch, self._Platform]\r
626 Macros = self._Macros\r
627 for Record in RecordList:\r
628 LineNo = Record[-1]\r
629 ToolChainFamily = Record[1]\r
630 TagName = Record[2]\r
631 ToolCode = Record[3]\r
632 FeatureFlag = Record[4]\r
633 if self.AutoGenVersion < 0x00010005:\r
634 Macros["EDK_SOURCE"] = GlobalData.gEcpSource\r
635 Macros['PROCESSOR'] = self._Arch\r
636 SourceFile = NormPath(Record[0], Macros)\r
637 if SourceFile[0] == os.path.sep:\r
638 SourceFile = mws.join(GlobalData.gWorkspace, SourceFile[1:])\r
639 # old module source files (Edk)\r
640 File = PathClass(SourceFile, self._ModuleDir, self._SourceOverridePath,\r
641 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
642 # check the file validation\r
643 ErrorCode, ErrorInfo = File.Validate(CaseSensitive=False)\r
644 if ErrorCode != 0:\r
645 if File.Ext.lower() == '.h':\r
646 EdkLogger.warn('build', 'Include file not found', ExtraData=ErrorInfo,\r
647 File=self.MetaFile, Line=LineNo)\r
648 continue\r
649 else:\r
650 EdkLogger.error('build', ErrorCode, ExtraData=File, File=self.MetaFile, Line=LineNo)\r
651 else:\r
652 File = PathClass(NormPath(Record[0], Macros), self._ModuleDir, '',\r
653 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
654 # check the file validation\r
655 ErrorCode, ErrorInfo = File.Validate()\r
656 if ErrorCode != 0:\r
657 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
658\r
659 self._Sources.append(File)\r
660 return self._Sources\r
661\r
662 ## Retrieve library classes employed by this module\r
663 def _GetLibraryClassUses(self):\r
4231a819 664 if self._LibraryClasses is None:\r
a0767bae 665 self._LibraryClasses = OrderedDict()\r
ae7b6df8
LG		 666 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, self._Platform]\r
667 for Record in RecordList:\r
668 Lib = Record[0]\r
669 Instance = Record[1]\r
670 if Instance:\r
671 Instance = NormPath(Instance, self._Macros)\r
672 self._LibraryClasses[Lib] = Instance\r
673 return self._LibraryClasses\r
674\r
675 ## Retrieve library names (for Edk.x style of modules)\r
676 def _GetLibraryNames(self):\r
4231a819 677 if self._Libraries is None:\r
ae7b6df8
LG		 678 self._Libraries = []\r
679 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch, self._Platform]\r
680 for Record in RecordList:\r
681 LibraryName = ReplaceMacro(Record[0], self._Macros, False)\r
682 # in case of name with '.lib' extension, which is unusual in Edk.x inf\r
683 LibraryName = os.path.splitext(LibraryName)[0]\r
684 if LibraryName not in self._Libraries:\r
685 self._Libraries.append(LibraryName)\r
686 return self._Libraries\r
687\r
688 def _GetProtocolComments(self):\r
689 self._GetProtocols()\r
690 return self._ProtocolComments\r
691 ## Retrieve protocols consumed/produced by this module\r
692 def _GetProtocols(self):\r
4231a819 693 if self._Protocols is None:\r
a0767bae
CJ		 694 self._Protocols = OrderedDict()\r
695 self._ProtocolComments = OrderedDict()\r
ae7b6df8
LG		 696 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]\r
697 for Record in RecordList:\r
698 CName = Record[0]\r
699 Value = ProtocolValue(CName, self.Packages, self.MetaFile.Path)\r
4231a819 700 if Value is None:\r
8252e6bf 701 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 702 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
703 "Value of Protocol [%s] is not found under [Protocols] section in" % CName,\r
704 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
705 self._Protocols[CName] = Value\r
706 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
707 Comments = []\r
708 for CmtRec in CommentRecords:\r
709 Comments.append(CmtRec[0])\r
710 self._ProtocolComments[CName] = Comments\r
711 return self._Protocols\r
712\r
713 def _GetPpiComments(self):\r
714 self._GetPpis()\r
715 return self._PpiComments\r
716 ## Retrieve PPIs consumed/produced by this module\r
717 def _GetPpis(self):\r
4231a819 718 if self._Ppis is None:\r
a0767bae
CJ		 719 self._Ppis = OrderedDict()\r
720 self._PpiComments = OrderedDict()\r
ae7b6df8
LG		 721 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]\r
722 for Record in RecordList:\r
723 CName = Record[0]\r
724 Value = PpiValue(CName, self.Packages, self.MetaFile.Path)\r
4231a819 725 if Value is None:\r
8252e6bf 726 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 727 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
728 "Value of PPI [%s] is not found under [Ppis] section in " % CName,\r
729 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
730 self._Ppis[CName] = Value\r
731 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
732 Comments = []\r
733 for CmtRec in CommentRecords:\r
734 Comments.append(CmtRec[0])\r
735 self._PpiComments[CName] = Comments\r
736 return self._Ppis\r
737\r
738 def _GetGuidComments(self):\r
739 self._GetGuids()\r
740 return self._GuidComments\r
741 ## Retrieve GUIDs consumed/produced by this module\r
742 def _GetGuids(self):\r
4231a819 743 if self._Guids is None:\r
a0767bae
CJ		 744 self._Guids = OrderedDict()\r
745 self._GuidComments = OrderedDict()\r
ae7b6df8
LG		 746 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]\r
747 for Record in RecordList:\r
748 CName = Record[0]\r
749 Value = GuidValue(CName, self.Packages, self.MetaFile.Path)\r
4231a819 750 if Value is None:\r
8252e6bf 751 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 752 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
753 "Value of Guid [%s] is not found under [Guids] section in" % CName,\r
754 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
755 self._Guids[CName] = Value\r
756 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
757 Comments = []\r
758 for CmtRec in CommentRecords:\r
759 Comments.append(CmtRec[0])\r
760 self._GuidComments[CName] = Comments\r
761 return self._Guids\r
762\r
763 ## Retrieve include paths necessary for this module (for Edk.x style of modules)\r
764 def _GetIncludes(self):\r
4231a819 765 if self._Includes is None:\r
ae7b6df8
LG		 766 self._Includes = []\r
767 if self._SourceOverridePath:\r
768 self._Includes.append(self._SourceOverridePath)\r
769\r
770 Macros = self._Macros\r
9eb87141 771 Macros['PROCESSOR'] = GlobalData.gEdkGlobal.get('PROCESSOR', self._Arch)\r
ae7b6df8
LG		 772 RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch, self._Platform]\r
773 for Record in RecordList:\r
774 if Record[0].find('EDK_SOURCE') > -1:\r
775 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
776 File = NormPath(Record[0], self._Macros)\r
777 if File[0] == '.':\r
778 File = os.path.join(self._ModuleDir, File)\r
779 else:\r
780 File = os.path.join(GlobalData.gWorkspace, File)\r
781 File = RealPath(os.path.normpath(File))\r
782 if File:\r
783 self._Includes.append(File)\r
784\r
785 # TRICK: let compiler to choose correct header file\r
786 Macros['EDK_SOURCE'] = GlobalData.gEdkSource\r
787 File = NormPath(Record[0], self._Macros)\r
788 if File[0] == '.':\r
789 File = os.path.join(self._ModuleDir, File)\r
790 else:\r
791 File = os.path.join(GlobalData.gWorkspace, File)\r
792 File = RealPath(os.path.normpath(File))\r
793 if File:\r
794 self._Includes.append(File)\r
795 else:\r
796 File = NormPath(Record[0], Macros)\r
797 if File[0] == '.':\r
798 File = os.path.join(self._ModuleDir, File)\r
799 else:\r
800 File = mws.join(GlobalData.gWorkspace, File)\r
801 File = RealPath(os.path.normpath(File))\r
802 if File:\r
803 self._Includes.append(File)\r
804 if not File and Record[0].find('EFI_SOURCE') > -1:\r
805 # tricky to regard WorkSpace as EFI_SOURCE\r
806 Macros['EFI_SOURCE'] = GlobalData.gWorkspace\r
807 File = NormPath(Record[0], Macros)\r
808 if File[0] == '.':\r
809 File = os.path.join(self._ModuleDir, File)\r
810 else:\r
811 File = os.path.join(GlobalData.gWorkspace, File)\r
812 File = RealPath(os.path.normpath(File))\r
813 if File:\r
814 self._Includes.append(File)\r
815 return self._Includes\r
816\r
817 ## Retrieve packages this module depends on\r
818 def _GetPackages(self):\r
4231a819 819 if self._Packages is None:\r
ae7b6df8
LG		 820 self._Packages = []\r
821 RecordList = self._RawData[MODEL_META_DATA_PACKAGE, self._Arch, self._Platform]\r
822 Macros = self._Macros\r
823 Macros['EDK_SOURCE'] = GlobalData.gEcpSource\r
824 for Record in RecordList:\r
825 File = PathClass(NormPath(Record[0], Macros), GlobalData.gWorkspace, Arch=self._Arch)\r
826 LineNo = Record[-1]\r
827 # check the file validation\r
828 ErrorCode, ErrorInfo = File.Validate('.dec')\r
829 if ErrorCode != 0:\r
830 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
831 # parse this package now. we need it to get protocol/ppi/guid value\r
832 Package = self._Bdb[File, self._Arch, self._Target, self._Toolchain]\r
833 self._Packages.append(Package)\r
834 return self._Packages\r
835\r
836 ## Retrieve PCD comments\r
837 def _GetPcdComments(self):\r
838 self._GetPcds()\r
839 return self._PcdComments\r
840 ## Retrieve PCDs used in this module\r
841 def _GetPcds(self):\r
4231a819 842 if self._Pcds is None:\r
a0767bae
CJ		 843 self._Pcds = OrderedDict()\r
844 self._PcdComments = OrderedDict()\r
ae7b6df8
LG		 845 self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
846 self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
847 self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
848 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC))\r
849 self._Pcds.update(self._GetPcd(MODEL_PCD_DYNAMIC_EX))\r
850 return self._Pcds\r
851\r
852 ## Retrieve build options specific to this module\r
853 def _GetBuildOptions(self):\r
4231a819 854 if self._BuildOptions is None:\r
a0767bae 855 self._BuildOptions = OrderedDict()\r
ae7b6df8
LG		 856 RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, self._Platform]\r
857 for Record in RecordList:\r
858 ToolChainFamily = Record[0]\r
859 ToolChain = Record[1]\r
860 Option = Record[2]\r
861 if (ToolChainFamily, ToolChain) not in self._BuildOptions or Option.startswith('='):\r
862 self._BuildOptions[ToolChainFamily, ToolChain] = Option\r
863 else:\r
864 # concatenate the option string if they're for the same tool\r
865 OptionString = self._BuildOptions[ToolChainFamily, ToolChain]\r
866 self._BuildOptions[ToolChainFamily, ToolChain] = OptionString + " " + Option\r
867 return self._BuildOptions\r
868\r
869 ## Retrieve dependency expression\r
870 def _GetDepex(self):\r
4231a819 871 if self._Depex is None:\r
ae7b6df8
LG		 872 self._Depex = tdict(False, 2)\r
873 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
874\r
875 # If the module has only Binaries and no Sources, then ignore [Depex]\r
4231a819
CJ		 876 if self.Sources is None or self.Sources == []:\r
877 if self.Binaries is not None and self.Binaries != []:\r
ae7b6df8
LG		 878 return self._Depex\r
879\r
880 # PEIM and DXE drivers must have a valid [Depex] section\r
881 if len(self.LibraryClass) == 0 and len(RecordList) == 0:\r
8bb63e37
CJ		 882 if self.ModuleType == SUP_MODULE_DXE_DRIVER or self.ModuleType == SUP_MODULE_PEIM or self.ModuleType == SUP_MODULE_DXE_SMM_DRIVER or \\r
883 self.ModuleType == SUP_MODULE_DXE_SAL_DRIVER or self.ModuleType == SUP_MODULE_DXE_RUNTIME_DRIVER:\r
ae7b6df8
LG		 884 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No [Depex] section or no valid expression in [Depex] section for [%s] module" \\r
885 % self.ModuleType, File=self.MetaFile)\r
886\r
8bb63e37 887 if len(RecordList) != 0 and self.ModuleType == SUP_MODULE_USER_DEFINED:\r
ae7b6df8 888 for Record in RecordList:\r
8bb63e37 889 if Record[4] not in [SUP_MODULE_PEIM, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER]:\r
ae7b6df8
LG		 890 EdkLogger.error('build', FORMAT_INVALID,\r
891 "'%s' module must specify the type of [Depex] section" % self.ModuleType,\r
892 File=self.MetaFile)\r
893\r
a0767bae 894 Depex = OrderedDict()\r
ae7b6df8
LG		 895 for Record in RecordList:\r
896 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
897 Arch = Record[3]\r
898 ModuleType = Record[4]\r
899 TokenList = DepexStr.split()\r
900 if (Arch, ModuleType) not in Depex:\r
901 Depex[Arch, ModuleType] = []\r
902 DepexList = Depex[Arch, ModuleType]\r
903 for Token in TokenList:\r
eece4292 904 if Token in DEPEX_SUPPORTED_OPCODE_SET:\r
ae7b6df8
LG		 905 DepexList.append(Token)\r
906 elif Token.endswith(".inf"): # module file name\r
907 ModuleFile = os.path.normpath(Token)\r
908 Module = self.BuildDatabase[ModuleFile]\r
4231a819 909 if Module is None:\r
ae7b6df8
LG		 910 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "Module is not found in active platform",\r
911 ExtraData=Token, File=self.MetaFile, Line=Record[-1])\r
912 DepexList.append(Module.Guid)\r
913 else:\r
914 # get the GUID value now\r
915 Value = ProtocolValue(Token, self.Packages, self.MetaFile.Path)\r
4231a819 916 if Value is None:\r
ae7b6df8 917 Value = PpiValue(Token, self.Packages, self.MetaFile.Path)\r
4231a819 918 if Value is None:\r
ae7b6df8 919 Value = GuidValue(Token, self.Packages, self.MetaFile.Path)\r
4231a819 920 if Value is None:\r
8252e6bf 921 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 922 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
923 "Value of [%s] is not found in" % Token,\r
924 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
925 DepexList.append(Value)\r
926 for Arch, ModuleType in Depex:\r
927 self._Depex[Arch, ModuleType] = Depex[Arch, ModuleType]\r
928 return self._Depex\r
929\r
930 ## Retrieve depedency expression\r
931 def _GetDepexExpression(self):\r
4231a819 932 if self._DepexExpression is None:\r
ae7b6df8
LG		 933 self._DepexExpression = tdict(False, 2)\r
934 RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
a0767bae 935 DepexExpression = OrderedDict()\r
ae7b6df8
LG		 936 for Record in RecordList:\r
937 DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
938 Arch = Record[3]\r
939 ModuleType = Record[4]\r
940 TokenList = DepexStr.split()\r
941 if (Arch, ModuleType) not in DepexExpression:\r
942 DepexExpression[Arch, ModuleType] = ''\r
943 for Token in TokenList:\r
944 DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType] + Token.strip() + ' '\r
945 for Arch, ModuleType in DepexExpression:\r
946 self._DepexExpression[Arch, ModuleType] = DepexExpression[Arch, ModuleType]\r
947 return self._DepexExpression\r
948\r
949 def GetGuidsUsedByPcd(self):\r
950 return self._GuidsUsedByPcd\r
951 ## Retrieve PCD for given type\r
952 def _GetPcd(self, Type):\r
a0767bae 953 Pcds = OrderedDict()\r
ae7b6df8
LG		 954 PcdDict = tdict(True, 4)\r
955 PcdList = []\r
956 RecordList = self._RawData[Type, self._Arch, self._Platform]\r
957 for TokenSpaceGuid, PcdCName, Setting, Arch, Platform, Id, LineNo in RecordList:\r
958 PcdDict[Arch, Platform, PcdCName, TokenSpaceGuid] = (Setting, LineNo)\r
959 PcdList.append((PcdCName, TokenSpaceGuid))\r
960 # get the guid value\r
961 if TokenSpaceGuid not in self.Guids:\r
962 Value = GuidValue(TokenSpaceGuid, self.Packages, self.MetaFile.Path)\r
4231a819 963 if Value is None:\r
8252e6bf 964 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 965 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
966 "Value of Guid [%s] is not found under [Guids] section in" % TokenSpaceGuid,\r
967 ExtraData=PackageList, File=self.MetaFile, Line=LineNo)\r
968 self.Guids[TokenSpaceGuid] = Value\r
969 self._GuidsUsedByPcd[TokenSpaceGuid] = Value\r
970 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Id]\r
971 Comments = []\r
972 for CmtRec in CommentRecords:\r
973 Comments.append(CmtRec[0])\r
974 self._PcdComments[TokenSpaceGuid, PcdCName] = Comments\r
975\r
976 # resolve PCD type, value, datum info, etc. by getting its definition from package\r
e7df35b2 977 _GuidDict = self.Guids.copy()\r
ae7b6df8
LG		 978 for PcdCName, TokenSpaceGuid in PcdList:\r
979 PcdRealName = PcdCName\r
980 Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]\r
4231a819 981 if Setting is None:\r
ae7b6df8
LG		 982 continue\r
983 ValueList = AnalyzePcdData(Setting)\r
984 DefaultValue = ValueList[0]\r
985 Pcd = PcdClassObject(\r
986 PcdCName,\r
987 TokenSpaceGuid,\r
988 '',\r
989 '',\r
990 DefaultValue,\r
991 '',\r
992 '',\r
993 {},\r
994 False,\r
995 self.Guids[TokenSpaceGuid]\r
996 )\r
997 if Type == MODEL_PCD_PATCHABLE_IN_MODULE and ValueList[1]:\r
998 # Patch PCD: TokenSpace.PcdCName|Value|Offset\r
999 Pcd.Offset = ValueList[1]\r
1000\r
1001 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
1002 for Package in self.Packages:\r
1003 for key in Package.Pcds:\r
1004 if (Package.Pcds[key].TokenCName, Package.Pcds[key].TokenSpaceGuidCName) == (PcdRealName, TokenSpaceGuid):\r
1005 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
1006 Pcd_Type = item[0].split('_')[-1]\r
1007 if Pcd_Type == Package.Pcds[key].Type:\r
1008 Value = Package.Pcds[key]\r
1009 Value.TokenCName = Package.Pcds[key].TokenCName + '_' + Pcd_Type\r
1010 if len(key) == 2:\r
1011 newkey = (Value.TokenCName, key[1])\r
1012 elif len(key) == 3:\r
1013 newkey = (Value.TokenCName, key[1], key[2])\r
1014 del Package.Pcds[key]\r
1015 Package.Pcds[newkey] = Value\r
1016 break\r
1017 else:\r
1018 pass\r
1019 else:\r
1020 pass\r
1021\r
1022 # get necessary info from package declaring this PCD\r
1023 for Package in self.Packages:\r
1024 #\r
1025 # 'dynamic' in INF means its type is determined by platform;\r
1026 # if platform doesn't give its type, use 'lowest' one in the\r
1027 # following order, if any\r
1028 #\r
be409b67 1029 # TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX\r
ae7b6df8 1030 #\r
e7df35b2 1031 _GuidDict.update(Package.Guids)\r
ae7b6df8
LG		 1032 PcdType = self._PCD_TYPE_STRING_[Type]\r
1033 if Type == MODEL_PCD_DYNAMIC:\r
1034 Pcd.Pending = True\r
be409b67 1035 for T in PCD_TYPE_LIST:\r
ae7b6df8
LG		 1036 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
1037 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
1038 if str(item[0]).endswith(T) and (item[0], item[1], T) in Package.Pcds:\r
1039 PcdType = T\r
1040 PcdCName = item[0]\r
1041 break\r
1042 else:\r
1043 pass\r
1044 break\r
1045 else:\r
1046 if (PcdRealName, TokenSpaceGuid, T) in Package.Pcds:\r
1047 PcdType = T\r
1048 break\r
1049\r
1050 else:\r
1051 Pcd.Pending = False\r
1052 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
1053 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
1054 Pcd_Type = item[0].split('_')[-1]\r
1055 if Pcd_Type == PcdType:\r
1056 PcdCName = item[0]\r
1057 break\r
1058 else:\r
1059 pass\r
1060 else:\r
1061 pass\r
1062\r
1063 if (PcdCName, TokenSpaceGuid, PcdType) in Package.Pcds:\r
1064 PcdInPackage = Package.Pcds[PcdCName, TokenSpaceGuid, PcdType]\r
1065 Pcd.Type = PcdType\r
1066 Pcd.TokenValue = PcdInPackage.TokenValue\r
1067\r
1068 #\r
1069 # Check whether the token value exist or not.\r
1070 #\r
4231a819 1071 if Pcd.TokenValue is None or Pcd.TokenValue == "":\r
ae7b6df8
LG		 1072 EdkLogger.error(\r
1073 'build',\r
1074 FORMAT_INVALID,\r
1075 "No TokenValue for PCD [%s.%s] in [%s]!" % (TokenSpaceGuid, PcdRealName, str(Package)),\r
1076 File=self.MetaFile, Line=LineNo,\r
1077 ExtraData=None\r
1078 )\r
1079 #\r
1080 # Check hexadecimal token value length and format.\r
1081 #\r
1082 ReIsValidPcdTokenValue = re.compile(r"^[0][x|X][0]*[0-9a-fA-F]{1,8}$", re.DOTALL)\r
1083 if Pcd.TokenValue.startswith("0x") or Pcd.TokenValue.startswith("0X"):\r
4231a819 1084 if ReIsValidPcdTokenValue.match(Pcd.TokenValue) is None:\r
ae7b6df8
LG		 1085 EdkLogger.error(\r
1086 'build',\r
1087 FORMAT_INVALID,\r
1088 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid:" % (Pcd.TokenValue, TokenSpaceGuid, PcdRealName, str(Package)),\r
1089 File=self.MetaFile, Line=LineNo,\r
1090 ExtraData=None\r
1091 )\r
1092\r
1093 #\r
1094 # Check decimal token value length and format.\r
1095 #\r
1096 else:\r
1097 try:\r
1098 TokenValueInt = int (Pcd.TokenValue, 10)\r
1099 if (TokenValueInt < 0 or TokenValueInt > 4294967295):\r
1100 EdkLogger.error(\r
1101 'build',\r
1102 FORMAT_INVALID,\r
1103 "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
1104 File=self.MetaFile, Line=LineNo,\r
1105 ExtraData=None\r
1106 )\r
1107 except:\r
1108 EdkLogger.error(\r
1109 'build',\r
1110 FORMAT_INVALID,\r
1111 "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
1112 File=self.MetaFile, Line=LineNo,\r
1113 ExtraData=None\r
1114 )\r
1115\r
1116 Pcd.DatumType = PcdInPackage.DatumType\r
1117 Pcd.MaxDatumSize = PcdInPackage.MaxDatumSize\r
1118 Pcd.InfDefaultValue = Pcd.DefaultValue\r
c93356ad 1119 if not Pcd.DefaultValue:\r
ae7b6df8 1120 Pcd.DefaultValue = PcdInPackage.DefaultValue\r
726c501c
YZ		 1121 else:\r
1122 try:\r
e7df35b2 1123 Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, _GuidDict)(True)\r
5b0671c1 1124 except BadExpression as Value:\r
726c501c
YZ		 1125 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(TokenSpaceGuid, PcdRealName, Pcd.DefaultValue, Value),\r
1126 File=self.MetaFile, Line=LineNo)\r
ae7b6df8
LG		 1127 break\r
1128 else:\r
1129 EdkLogger.error(\r
1130 'build',\r
1131 FORMAT_INVALID,\r
1132 "PCD [%s.%s] in [%s] is not found in dependent packages:" % (TokenSpaceGuid, PcdRealName, self.MetaFile),\r
1133 File=self.MetaFile, Line=LineNo,\r
8252e6bf 1134 ExtraData="\t%s" % '\n\t'.join(str(P) for P in self.Packages)\r
ae7b6df8
LG		 1135 )\r
1136 Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
1137\r
1138 return Pcds\r
1139\r
1140 ## check whether current module is binary module\r
1141 def _IsBinaryModule(self):\r
1142 if self.Binaries and not self.Sources:\r
1143 return True\r
1144 elif GlobalData.gIgnoreSource:\r
1145 return True\r
1146 else:\r
1147 return False\r
1148\r
1149 _Macros = property(_GetMacros)\r
1150 Arch = property(_GetArch, _SetArch)\r
1151 Platform = property(_GetPlatform, _SetPlatform)\r
1152\r
1153 HeaderComments = property(_GetHeaderComments)\r
1154 TailComments = property(_GetTailComments)\r
1155 AutoGenVersion = property(_GetInfVersion)\r
1156 BaseName = property(_GetBaseName)\r
1157 ModuleType = property(_GetModuleType)\r
1158 ComponentType = property(_GetComponentType)\r
1159 BuildType = property(_GetBuildType)\r
1160 Guid = property(_GetFileGuid)\r
1161 Version = property(_GetVersion)\r
1162 PcdIsDriver = property(_GetPcdIsDriver)\r
1163 Shadow = property(_GetShadow)\r
1164 CustomMakefile = property(_GetMakefile)\r
1165 Specification = property(_GetSpec)\r
1166 LibraryClass = property(_GetLibraryClass)\r
1167 ModuleEntryPointList = property(_GetEntryPoint)\r
1168 ModuleUnloadImageList = property(_GetUnloadImage)\r
1169 ConstructorList = property(_GetConstructor)\r
1170 DestructorList = property(_GetDestructor)\r
1171 Defines = property(_GetDefines)\r
1172 DxsFile = property(_GetDxsFile)\r
1173\r
1174 Binaries = property(_GetBinaryFiles)\r
1175 Sources = property(_GetSourceFiles)\r
1176 LibraryClasses = property(_GetLibraryClassUses)\r
1177 Libraries = property(_GetLibraryNames)\r
1178 Protocols = property(_GetProtocols)\r
1179 ProtocolComments = property(_GetProtocolComments)\r
1180 Ppis = property(_GetPpis)\r
1181 PpiComments = property(_GetPpiComments)\r
1182 Guids = property(_GetGuids)\r
1183 GuidComments = property(_GetGuidComments)\r
1184 Includes = property(_GetIncludes)\r
1185 Packages = property(_GetPackages)\r
1186 Pcds = property(_GetPcds)\r
1187 PcdComments = property(_GetPcdComments)\r
1188 BuildOptions = property(_GetBuildOptions)\r
1189 Depex = property(_GetDepex)\r
1190 DepexExpression = property(_GetDepexExpression)\r
1191 IsBinaryModule = property(_IsBinaryModule)\r
1192 IsSupportedArch = property(_IsSupportedArch)\r
EFI Development Kit II mirror for PVE