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