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