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