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