]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/InfBuildData.py
BaseTools: fix an incremental build 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 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
62 # dict used to convert PCD type in database to string used by build tool\r
63 _PCD_TYPE_STRING_ = {\r
be409b67
CJ
64 MODEL_PCD_FIXED_AT_BUILD : TAB_PCDS_FIXED_AT_BUILD,\r
65 MODEL_PCD_PATCHABLE_IN_MODULE : TAB_PCDS_PATCHABLE_IN_MODULE,\r
66 MODEL_PCD_FEATURE_FLAG : TAB_PCDS_FEATURE_FLAG,\r
67 MODEL_PCD_DYNAMIC : TAB_PCDS_DYNAMIC,\r
68 MODEL_PCD_DYNAMIC_DEFAULT : TAB_PCDS_DYNAMIC,\r
69 MODEL_PCD_DYNAMIC_HII : TAB_PCDS_DYNAMIC_HII,\r
70 MODEL_PCD_DYNAMIC_VPD : TAB_PCDS_DYNAMIC_VPD,\r
71 MODEL_PCD_DYNAMIC_EX : TAB_PCDS_DYNAMIC_EX,\r
72 MODEL_PCD_DYNAMIC_EX_DEFAULT : TAB_PCDS_DYNAMIC_EX,\r
73 MODEL_PCD_DYNAMIC_EX_HII : TAB_PCDS_DYNAMIC_EX_HII,\r
74 MODEL_PCD_DYNAMIC_EX_VPD : TAB_PCDS_DYNAMIC_EX_VPD,\r
ae7b6df8
LG
75 }\r
76\r
77 # dict used to convert part of [Defines] to members of InfBuildData directly\r
78 _PROPERTY_ = {\r
79 #\r
80 # Required Fields\r
81 #\r
82 TAB_INF_DEFINES_BASE_NAME : "_BaseName",\r
83 TAB_INF_DEFINES_FILE_GUID : "_Guid",\r
84 TAB_INF_DEFINES_MODULE_TYPE : "_ModuleType",\r
85 #\r
86 # Optional Fields\r
87 #\r
88 # TAB_INF_DEFINES_INF_VERSION : "_AutoGenVersion",\r
89 TAB_INF_DEFINES_COMPONENT_TYPE : "_ComponentType",\r
90 TAB_INF_DEFINES_MAKEFILE_NAME : "_MakefileName",\r
91 # TAB_INF_DEFINES_CUSTOM_MAKEFILE : "_CustomMakefile",\r
92 TAB_INF_DEFINES_DPX_SOURCE :"_DxsFile",\r
93 TAB_INF_DEFINES_VERSION_NUMBER : "_Version",\r
94 TAB_INF_DEFINES_VERSION_STRING : "_Version",\r
95 TAB_INF_DEFINES_VERSION : "_Version",\r
96 TAB_INF_DEFINES_PCD_IS_DRIVER : "_PcdIsDriver",\r
2f2c51ac 97 TAB_INF_DEFINES_SHADOW : "_Shadow"\r
ae7b6df8
LG
98 }\r
99\r
ae7b6df8
LG
100 # regular expression for converting XXX_FLAGS in [nmake] section to new type\r
101 _NMAKE_FLAG_PATTERN_ = re.compile("(?:EBC_)?([A-Z]+)_(?:STD_|PROJ_|ARCH_)?FLAGS(?:_DLL|_ASL|_EXE)?", re.UNICODE)\r
102 # dict used to convert old tool name used in [nmake] section to new ones\r
103 _TOOL_CODE_ = {\r
104 "C" : "CC",\r
91fa33ee 105 BINARY_FILE_TYPE_LIB : "SLINK",\r
ae7b6df8
LG
106 "LINK" : "DLINK",\r
107 }\r
108\r
109\r
719fd85c 110 ## Constructor of InfBuildData\r
ae7b6df8 111 #\r
719fd85c 112 # Initialize object of InfBuildData\r
ae7b6df8
LG
113 #\r
114 # @param FilePath The path of platform description file\r
115 # @param RawData The raw data of DSC file\r
116 # @param BuildDataBase Database used to retrieve module/package information\r
117 # @param Arch The target architecture\r
118 # @param Platform The name of platform employing this module\r
119 # @param Macros Macros used for replacement in DSC file\r
120 #\r
55c84777 121 def __init__(self, FilePath, RawData, BuildDatabase, Arch=TAB_ARCH_COMMON, Target=None, Toolchain=None):\r
ae7b6df8
LG
122 self.MetaFile = FilePath\r
123 self._ModuleDir = FilePath.Dir\r
124 self._RawData = RawData\r
125 self._Bdb = BuildDatabase\r
126 self._Arch = Arch\r
127 self._Target = Target\r
128 self._Toolchain = Toolchain\r
55c84777 129 self._Platform = TAB_COMMON\r
719fd85c
CJ
130 self._TailComments = None\r
131 self._BaseName = None\r
132 self._DxsFile = None\r
133 self._ModuleType = None\r
134 self._ComponentType = None\r
135 self._BuildType = None\r
136 self._Guid = None\r
137 self._Version = None\r
138 self._PcdIsDriver = None\r
139 self._BinaryModule = None\r
140 self._Shadow = None\r
141 self._MakefileName = None\r
142 self._CustomMakefile = None\r
143 self._Specification = None\r
144 self._LibraryClass = None\r
145 self._ModuleEntryPointList = None\r
146 self._ModuleUnloadImageList = None\r
147 self._ConstructorList = None\r
148 self._DestructorList = None\r
149 self._Defs = OrderedDict()\r
150 self._ProtocolComments = None\r
151 self._PpiComments = None\r
152 self._GuidsUsedByPcd = OrderedDict()\r
153 self._GuidComments = None\r
154 self._PcdComments = None\r
155 self._BuildOptions = None\r
156 self._DependencyFileList = None\r
e8449e1d
FB
157 self.LibInstances = []\r
158 self.ReferenceModules = set()\r
159 self.Guids\r
160 self.Pcds\r
161 def SetReferenceModule(self,Module):\r
162 self.ReferenceModules.add(Module)\r
163 return self\r
ae7b6df8
LG
164\r
165 ## XXX[key] = value\r
166 def __setitem__(self, key, value):\r
167 self.__dict__[self._PROPERTY_[key]] = value\r
168\r
169 ## value = XXX[key]\r
170 def __getitem__(self, key):\r
171 return self.__dict__[self._PROPERTY_[key]]\r
172\r
173 ## "in" test support\r
174 def __contains__(self, key):\r
175 return key in self._PROPERTY_\r
176\r
ae7b6df8 177 ## Get current effective macros\r
719fd85c 178 @cached_property\r
71cac3f7 179 def _Macros(self):\r
719fd85c 180 RetVal = {}\r
719fd85c 181 return RetVal\r
ae7b6df8
LG
182\r
183 ## Get architecture\r
719fd85c 184 @cached_property\r
71cac3f7 185 def Arch(self):\r
ae7b6df8
LG
186 return self._Arch\r
187\r
ae7b6df8 188 ## Return the name of platform employing this module\r
719fd85c 189 @cached_property\r
71cac3f7 190 def Platform(self):\r
ae7b6df8
LG
191 return self._Platform\r
192\r
719fd85c 193 @cached_property\r
71cac3f7 194 def HeaderComments(self):\r
719fd85c 195 return [a[0] for a in self._RawData[MODEL_META_DATA_HEADER_COMMENT]]\r
71cac3f7 196\r
719fd85c 197 @cached_property\r
71cac3f7 198 def TailComments(self):\r
719fd85c 199 return [a[0] for a in self._RawData[MODEL_META_DATA_TAIL_COMMENT]]\r
71cac3f7 200\r
ae7b6df8
LG
201 ## Retrieve all information in [Defines] section\r
202 #\r
fb0b35e0 203 # (Retrieving all [Defines] information in one-shot is just to save time.)\r
ae7b6df8 204 #\r
719fd85c 205 @cached_class_function\r
ae7b6df8
LG
206 def _GetHeaderInfo(self):\r
207 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
208 for Record in RecordList:\r
209 Name, Value = Record[1], ReplaceMacro(Record[2], self._Macros, False)\r
210 # items defined _PROPERTY_ don't need additional processing\r
211 if Name in self:\r
212 self[Name] = Value\r
ae7b6df8
LG
213 self._Defs[Name] = Value\r
214 self._Macros[Name] = Value\r
215 # some special items in [Defines] section need special treatment\r
216 elif Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION', 'EDK_RELEASE_VERSION', 'PI_SPECIFICATION_VERSION'):\r
217 if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):\r
218 Name = 'UEFI_SPECIFICATION_VERSION'\r
4231a819 219 if self._Specification is None:\r
a0767bae 220 self._Specification = OrderedDict()\r
ae7b6df8 221 self._Specification[Name] = GetHexVerValue(Value)\r
4231a819 222 if self._Specification[Name] is None:\r
ae7b6df8
LG
223 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
224 "'%s' format is not supported for %s" % (Value, Name),\r
225 File=self.MetaFile, Line=Record[-1])\r
226 elif Name == 'LIBRARY_CLASS':\r
4231a819 227 if self._LibraryClass is None:\r
ae7b6df8
LG
228 self._LibraryClass = []\r
229 ValueList = GetSplitValueList(Value)\r
230 LibraryClass = ValueList[0]\r
231 if len(ValueList) > 1:\r
232 SupModuleList = GetSplitValueList(ValueList[1], ' ')\r
233 else:\r
234 SupModuleList = SUP_MODULE_LIST\r
235 self._LibraryClass.append(LibraryClassObject(LibraryClass, SupModuleList))\r
236 elif Name == 'ENTRY_POINT':\r
4231a819 237 if self._ModuleEntryPointList is None:\r
ae7b6df8
LG
238 self._ModuleEntryPointList = []\r
239 self._ModuleEntryPointList.append(Value)\r
240 elif Name == 'UNLOAD_IMAGE':\r
4231a819 241 if self._ModuleUnloadImageList is None:\r
ae7b6df8
LG
242 self._ModuleUnloadImageList = []\r
243 if not Value:\r
244 continue\r
245 self._ModuleUnloadImageList.append(Value)\r
246 elif Name == 'CONSTRUCTOR':\r
4231a819 247 if self._ConstructorList is None:\r
ae7b6df8
LG
248 self._ConstructorList = []\r
249 if not Value:\r
250 continue\r
251 self._ConstructorList.append(Value)\r
252 elif Name == 'DESTRUCTOR':\r
4231a819 253 if self._DestructorList is None:\r
ae7b6df8
LG
254 self._DestructorList = []\r
255 if not Value:\r
256 continue\r
257 self._DestructorList.append(Value)\r
258 elif Name == TAB_INF_DEFINES_CUSTOM_MAKEFILE:\r
259 TokenList = GetSplitValueList(Value)\r
4231a819 260 if self._CustomMakefile is None:\r
ae7b6df8
LG
261 self._CustomMakefile = {}\r
262 if len(TokenList) < 2:\r
94c04559 263 self._CustomMakefile[TAB_COMPILER_MSFT] = TokenList[0]\r
ae7b6df8
LG
264 self._CustomMakefile['GCC'] = TokenList[0]\r
265 else:\r
94c04559 266 if TokenList[0] not in [TAB_COMPILER_MSFT, 'GCC']:\r
ae7b6df8
LG
267 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
268 "No supported family [%s]" % TokenList[0],\r
269 File=self.MetaFile, Line=Record[-1])\r
270 self._CustomMakefile[TokenList[0]] = TokenList[1]\r
271 else:\r
ae7b6df8
LG
272 self._Defs[Name] = Value\r
273 self._Macros[Name] = Value\r
274\r
275 #\r
276 # Retrieve information in sections specific to Edk.x modules\r
277 #\r
82292501
FB
278 if not self._ModuleType:\r
279 EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
280 "MODULE_TYPE is not given", File=self.MetaFile)\r
281 if self._ModuleType not in SUP_MODULE_LIST:\r
282 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
283 for Record in RecordList:\r
284 Name = Record[1]\r
285 if Name == "MODULE_TYPE":\r
286 LineNo = Record[6]\r
287 break\r
288 EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
289 "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
290 File=self.MetaFile, Line=LineNo)\r
291 if (self._Specification is None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x0001000A):\r
292 if self._ModuleType == SUP_MODULE_SMM_CORE:\r
293 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
294 if (self._Specification is None) or (not 'PI_SPECIFICATION_VERSION' in self._Specification) or (int(self._Specification['PI_SPECIFICATION_VERSION'], 16) < 0x00010032):\r
295 if self._ModuleType == SUP_MODULE_MM_CORE_STANDALONE:\r
296 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
297 if self._ModuleType == SUP_MODULE_MM_STANDALONE:\r
298 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
299 if 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
300 and 'PCI_CLASS_CODE' in self._Defs and 'PCI_REVISION' in self._Defs:\r
301 self._BuildType = 'UEFI_OPTIONROM'\r
302 if 'PCI_COMPRESS' in self._Defs:\r
303 if self._Defs['PCI_COMPRESS'] not in ('TRUE', 'FALSE'):\r
304 EdkLogger.error("build", FORMAT_INVALID, "Expected TRUE/FALSE for PCI_COMPRESS: %s" % self.MetaFile)\r
305\r
306 elif 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
307 and self._Defs['UEFI_HII_RESOURCE_SECTION'] == 'TRUE':\r
308 self._BuildType = 'UEFI_HII'\r
ae7b6df8 309 else:\r
82292501
FB
310 self._BuildType = self._ModuleType.upper()\r
311\r
312 if self._DxsFile:\r
313 File = PathClass(NormPath(self._DxsFile), self._ModuleDir, Arch=self._Arch)\r
314 # check the file validation\r
315 ErrorCode, ErrorInfo = File.Validate(".dxs", CaseSensitive=False)\r
316 if ErrorCode != 0:\r
317 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo,\r
318 File=self.MetaFile, Line=LineNo)\r
319 if not self._DependencyFileList:\r
320 self._DependencyFileList = []\r
321 self._DependencyFileList.append(File)\r
ae7b6df8
LG
322\r
323 ## Retrieve file version\r
719fd85c 324 @cached_property\r
71cac3f7 325 def AutoGenVersion(self):\r
719fd85c
CJ
326 RetVal = 0x00010000\r
327 RecordList = self._RawData[MODEL_META_DATA_HEADER, self._Arch, self._Platform]\r
328 for Record in RecordList:\r
329 if Record[1] == TAB_INF_DEFINES_INF_VERSION:\r
330 if '.' in Record[2]:\r
331 ValueList = Record[2].split('.')\r
332 Major = '%04o' % int(ValueList[0], 0)\r
333 Minor = '%04o' % int(ValueList[1], 0)\r
334 RetVal = int('0x' + Major + Minor, 0)\r
335 else:\r
336 RetVal = int(Record[2], 0)\r
337 break\r
338 return RetVal\r
ae7b6df8
LG
339\r
340 ## Retrieve BASE_NAME\r
719fd85c 341 @cached_property\r
71cac3f7 342 def BaseName(self):\r
4231a819 343 if self._BaseName is None:\r
719fd85c 344 self._GetHeaderInfo()\r
4231a819 345 if self._BaseName is None:\r
ae7b6df8
LG
346 EdkLogger.error('build', ATTRIBUTE_NOT_AVAILABLE, "No BASE_NAME name", File=self.MetaFile)\r
347 return self._BaseName\r
348\r
349 ## Retrieve DxsFile\r
719fd85c 350 @cached_property\r
71cac3f7 351 def DxsFile(self):\r
4231a819 352 if self._DxsFile is None:\r
719fd85c 353 self._GetHeaderInfo()\r
4231a819 354 if self._DxsFile is None:\r
ae7b6df8
LG
355 self._DxsFile = ''\r
356 return self._DxsFile\r
357\r
358 ## Retrieve MODULE_TYPE\r
719fd85c 359 @cached_property\r
71cac3f7 360 def ModuleType(self):\r
4231a819 361 if self._ModuleType is None:\r
719fd85c 362 self._GetHeaderInfo()\r
4231a819 363 if self._ModuleType is None:\r
8bb63e37 364 self._ModuleType = SUP_MODULE_BASE\r
ae7b6df8 365 if self._ModuleType not in SUP_MODULE_LIST:\r
8bb63e37 366 self._ModuleType = SUP_MODULE_USER_DEFINED\r
ae7b6df8
LG
367 return self._ModuleType\r
368\r
369 ## Retrieve COMPONENT_TYPE\r
719fd85c 370 @cached_property\r
71cac3f7 371 def ComponentType(self):\r
4231a819 372 if self._ComponentType is None:\r
719fd85c 373 self._GetHeaderInfo()\r
4231a819 374 if self._ComponentType is None:\r
8bb63e37 375 self._ComponentType = SUP_MODULE_USER_DEFINED\r
ae7b6df8
LG
376 return self._ComponentType\r
377\r
378 ## Retrieve "BUILD_TYPE"\r
719fd85c 379 @cached_property\r
71cac3f7 380 def BuildType(self):\r
4231a819 381 if self._BuildType is None:\r
719fd85c 382 self._GetHeaderInfo()\r
ae7b6df8 383 if not self._BuildType:\r
8bb63e37 384 self._BuildType = SUP_MODULE_BASE\r
ae7b6df8
LG
385 return self._BuildType\r
386\r
387 ## Retrieve file guid\r
719fd85c 388 @cached_property\r
71cac3f7 389 def Guid(self):\r
4231a819 390 if self._Guid is None:\r
719fd85c 391 self._GetHeaderInfo()\r
4231a819 392 if self._Guid is None:\r
ae7b6df8
LG
393 self._Guid = '00000000-0000-0000-0000-000000000000'\r
394 return self._Guid\r
395\r
396 ## Retrieve module version\r
719fd85c 397 @cached_property\r
71cac3f7 398 def Version(self):\r
4231a819 399 if self._Version is None:\r
719fd85c 400 self._GetHeaderInfo()\r
4231a819 401 if self._Version is None:\r
ae7b6df8
LG
402 self._Version = '0.0'\r
403 return self._Version\r
404\r
405 ## Retrieve PCD_IS_DRIVER\r
719fd85c 406 @cached_property\r
71cac3f7 407 def PcdIsDriver(self):\r
4231a819 408 if self._PcdIsDriver is None:\r
719fd85c 409 self._GetHeaderInfo()\r
4231a819 410 if self._PcdIsDriver is None:\r
ae7b6df8
LG
411 self._PcdIsDriver = ''\r
412 return self._PcdIsDriver\r
413\r
414 ## Retrieve SHADOW\r
719fd85c 415 @cached_property\r
71cac3f7 416 def Shadow(self):\r
4231a819 417 if self._Shadow is None:\r
719fd85c
CJ
418 self._GetHeaderInfo()\r
419 if self._Shadow and self._Shadow.upper() == 'TRUE':\r
ae7b6df8
LG
420 self._Shadow = True\r
421 else:\r
422 self._Shadow = False\r
423 return self._Shadow\r
424\r
425 ## Retrieve CUSTOM_MAKEFILE\r
719fd85c 426 @cached_property\r
71cac3f7 427 def CustomMakefile(self):\r
4231a819 428 if self._CustomMakefile is None:\r
719fd85c 429 self._GetHeaderInfo()\r
4231a819 430 if self._CustomMakefile is None:\r
ae7b6df8
LG
431 self._CustomMakefile = {}\r
432 return self._CustomMakefile\r
433\r
434 ## Retrieve EFI_SPECIFICATION_VERSION\r
719fd85c 435 @cached_property\r
71cac3f7 436 def Specification(self):\r
4231a819 437 if self._Specification is None:\r
719fd85c 438 self._GetHeaderInfo()\r
4231a819 439 if self._Specification is None:\r
ae7b6df8
LG
440 self._Specification = {}\r
441 return self._Specification\r
442\r
443 ## Retrieve LIBRARY_CLASS\r
719fd85c 444 @cached_property\r
71cac3f7 445 def LibraryClass(self):\r
4231a819 446 if self._LibraryClass is None:\r
719fd85c 447 self._GetHeaderInfo()\r
4231a819 448 if self._LibraryClass is None:\r
ae7b6df8
LG
449 self._LibraryClass = []\r
450 return self._LibraryClass\r
451\r
452 ## Retrieve ENTRY_POINT\r
719fd85c 453 @cached_property\r
71cac3f7 454 def ModuleEntryPointList(self):\r
4231a819 455 if self._ModuleEntryPointList is None:\r
719fd85c 456 self._GetHeaderInfo()\r
4231a819 457 if self._ModuleEntryPointList is None:\r
ae7b6df8
LG
458 self._ModuleEntryPointList = []\r
459 return self._ModuleEntryPointList\r
460\r
461 ## Retrieve UNLOAD_IMAGE\r
719fd85c 462 @cached_property\r
71cac3f7 463 def ModuleUnloadImageList(self):\r
4231a819 464 if self._ModuleUnloadImageList is None:\r
719fd85c 465 self._GetHeaderInfo()\r
4231a819 466 if self._ModuleUnloadImageList is None:\r
ae7b6df8
LG
467 self._ModuleUnloadImageList = []\r
468 return self._ModuleUnloadImageList\r
469\r
470 ## Retrieve CONSTRUCTOR\r
719fd85c 471 @cached_property\r
71cac3f7 472 def ConstructorList(self):\r
4231a819 473 if self._ConstructorList is None:\r
719fd85c 474 self._GetHeaderInfo()\r
4231a819 475 if self._ConstructorList is None:\r
ae7b6df8
LG
476 self._ConstructorList = []\r
477 return self._ConstructorList\r
478\r
479 ## Retrieve DESTRUCTOR\r
719fd85c 480 @cached_property\r
71cac3f7 481 def DestructorList(self):\r
4231a819 482 if self._DestructorList is None:\r
719fd85c 483 self._GetHeaderInfo()\r
4231a819 484 if self._DestructorList is None:\r
ae7b6df8
LG
485 self._DestructorList = []\r
486 return self._DestructorList\r
487\r
488 ## Retrieve definies other than above ones\r
719fd85c 489 @cached_property\r
71cac3f7 490 def Defines(self):\r
719fd85c 491 self._GetHeaderInfo()\r
ae7b6df8
LG
492 return self._Defs\r
493\r
494 ## Retrieve binary files\r
719fd85c 495 @cached_class_function\r
ae7b6df8 496 def _GetBinaries(self):\r
719fd85c
CJ
497 RetVal = []\r
498 RecordList = self._RawData[MODEL_EFI_BINARY_FILE, self._Arch, self._Platform]\r
499 Macros = self._Macros\r
719fd85c
CJ
500 Macros['PROCESSOR'] = self._Arch\r
501 for Record in RecordList:\r
502 FileType = Record[0]\r
503 LineNo = Record[-1]\r
504 Target = TAB_COMMON\r
505 FeatureFlag = []\r
506 if Record[2]:\r
507 TokenList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
508 if TokenList:\r
509 Target = TokenList[0]\r
510 if len(TokenList) > 1:\r
511 FeatureFlag = Record[1:]\r
512\r
513 File = PathClass(NormPath(Record[1], Macros), self._ModuleDir, '', FileType, True, self._Arch, '', Target)\r
514 # check the file validation\r
515 ErrorCode, ErrorInfo = File.Validate()\r
516 if ErrorCode != 0:\r
517 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
518 RetVal.append(File)\r
519 return RetVal\r
ae7b6df8
LG
520\r
521 ## Retrieve binary files with error check.\r
719fd85c 522 @cached_property\r
71cac3f7 523 def Binaries(self):\r
719fd85c
CJ
524 RetVal = self._GetBinaries()\r
525 if GlobalData.gIgnoreSource and not RetVal:\r
526 ErrorInfo = "The INF file does not contain any RetVal to use in creating the image\n"\r
ae7b6df8
LG
527 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, ExtraData=ErrorInfo, File=self.MetaFile)\r
528\r
719fd85c 529 return RetVal\r
f5f4667d 530\r
ae7b6df8 531 ## Retrieve source files\r
719fd85c 532 @cached_property\r
71cac3f7 533 def Sources(self):\r
719fd85c 534 self._GetHeaderInfo()\r
ae7b6df8
LG
535 # Ignore all source files in a binary build mode\r
536 if GlobalData.gIgnoreSource:\r
719fd85c 537 return []\r
ae7b6df8 538\r
719fd85c
CJ
539 RetVal = []\r
540 RecordList = self._RawData[MODEL_EFI_SOURCE_FILE, self._Arch, self._Platform]\r
541 Macros = self._Macros\r
542 for Record in RecordList:\r
543 LineNo = Record[-1]\r
544 ToolChainFamily = Record[1]\r
545 TagName = Record[2]\r
546 ToolCode = Record[3]\r
82292501
FB
547\r
548 File = PathClass(NormPath(Record[0], Macros), self._ModuleDir, '',\r
549 '', False, self._Arch, ToolChainFamily, '', TagName, ToolCode)\r
550 # check the file validation\r
551 ErrorCode, ErrorInfo = File.Validate()\r
552 if ErrorCode != 0:\r
553 EdkLogger.error('build', ErrorCode, ExtraData=ErrorInfo, File=self.MetaFile, Line=LineNo)\r
ae7b6df8 554\r
719fd85c
CJ
555 RetVal.append(File)\r
556 # add any previously found dependency files to the source list\r
557 if self._DependencyFileList:\r
558 RetVal.extend(self._DependencyFileList)\r
559 return RetVal\r
ae7b6df8
LG
560\r
561 ## Retrieve library classes employed by this module\r
719fd85c 562 @cached_property\r
71cac3f7 563 def LibraryClasses(self):\r
719fd85c
CJ
564 RetVal = OrderedDict()\r
565 RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, self._Platform]\r
566 for Record in RecordList:\r
567 Lib = Record[0]\r
568 Instance = Record[1]\r
569 if Instance:\r
570 Instance = NormPath(Instance, self._Macros)\r
4e375707
B
571 RetVal[Lib] = Instance\r
572 else:\r
573 RetVal[Lib] = None\r
719fd85c 574 return RetVal\r
ae7b6df8
LG
575\r
576 ## Retrieve library names (for Edk.x style of modules)\r
719fd85c 577 @cached_property\r
71cac3f7 578 def Libraries(self):\r
719fd85c
CJ
579 RetVal = []\r
580 RecordList = self._RawData[MODEL_EFI_LIBRARY_INSTANCE, self._Arch, self._Platform]\r
581 for Record in RecordList:\r
582 LibraryName = ReplaceMacro(Record[0], self._Macros, False)\r
583 # in case of name with '.lib' extension, which is unusual in Edk.x inf\r
584 LibraryName = os.path.splitext(LibraryName)[0]\r
585 if LibraryName not in RetVal:\r
586 RetVal.append(LibraryName)\r
587 return RetVal\r
588\r
589 @cached_property\r
71cac3f7
CJ
590 def ProtocolComments(self):\r
591 self.Protocols\r
ae7b6df8 592 return self._ProtocolComments\r
71cac3f7 593\r
ae7b6df8 594 ## Retrieve protocols consumed/produced by this module\r
719fd85c 595 @cached_property\r
71cac3f7 596 def Protocols(self):\r
719fd85c
CJ
597 RetVal = OrderedDict()\r
598 self._ProtocolComments = OrderedDict()\r
599 RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]\r
600 for Record in RecordList:\r
601 CName = Record[0]\r
12ba816e 602 Value = _ProtocolValue(CName, self.Packages, self.MetaFile.Path)\r
719fd85c
CJ
603 if Value is None:\r
604 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
605 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
606 "Value of Protocol [%s] is not found under [Protocols] section in" % CName,\r
607 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
608 RetVal[CName] = Value\r
609 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
610 self._ProtocolComments[CName] = [a[0] for a in CommentRecords]\r
611 return RetVal\r
612\r
613 @cached_property\r
71cac3f7
CJ
614 def PpiComments(self):\r
615 self.Ppis\r
ae7b6df8 616 return self._PpiComments\r
71cac3f7 617\r
ae7b6df8 618 ## Retrieve PPIs consumed/produced by this module\r
719fd85c 619 @cached_property\r
71cac3f7 620 def Ppis(self):\r
719fd85c
CJ
621 RetVal = OrderedDict()\r
622 self._PpiComments = OrderedDict()\r
623 RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]\r
624 for Record in RecordList:\r
625 CName = Record[0]\r
12ba816e 626 Value = _PpiValue(CName, self.Packages, self.MetaFile.Path)\r
719fd85c
CJ
627 if Value is None:\r
628 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
629 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
630 "Value of PPI [%s] is not found under [Ppis] section in " % CName,\r
631 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
632 RetVal[CName] = Value\r
633 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
634 self._PpiComments[CName] = [a[0] for a in CommentRecords]\r
635 return RetVal\r
636\r
637 @cached_property\r
71cac3f7
CJ
638 def GuidComments(self):\r
639 self.Guids\r
ae7b6df8 640 return self._GuidComments\r
71cac3f7 641\r
ae7b6df8 642 ## Retrieve GUIDs consumed/produced by this module\r
719fd85c 643 @cached_property\r
71cac3f7 644 def Guids(self):\r
719fd85c
CJ
645 RetVal = OrderedDict()\r
646 self._GuidComments = OrderedDict()\r
647 RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]\r
648 for Record in RecordList:\r
649 CName = Record[0]\r
650 Value = GuidValue(CName, self.Packages, self.MetaFile.Path)\r
651 if Value is None:\r
652 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
653 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
654 "Value of Guid [%s] is not found under [Guids] section in" % CName,\r
655 ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
656 RetVal[CName] = Value\r
657 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Record[5]]\r
658 self._GuidComments[CName] = [a[0] for a in CommentRecords]\r
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
719fd85c 861 self.Pcds\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
873 # get the guid value\r
874 if TokenSpaceGuid not in self.Guids:\r
875 Value = GuidValue(TokenSpaceGuid, self.Packages, self.MetaFile.Path)\r
4231a819 876 if Value is None:\r
8252e6bf 877 PackageList = "\n\t".join(str(P) for P in self.Packages)\r
ae7b6df8
LG
878 EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
879 "Value of Guid [%s] is not found under [Guids] section in" % TokenSpaceGuid,\r
880 ExtraData=PackageList, File=self.MetaFile, Line=LineNo)\r
881 self.Guids[TokenSpaceGuid] = Value\r
882 self._GuidsUsedByPcd[TokenSpaceGuid] = Value\r
883 CommentRecords = self._RawData[MODEL_META_DATA_COMMENT, self._Arch, self._Platform, Id]\r
884 Comments = []\r
885 for CmtRec in CommentRecords:\r
886 Comments.append(CmtRec[0])\r
887 self._PcdComments[TokenSpaceGuid, PcdCName] = Comments\r
888\r
889 # resolve PCD type, value, datum info, etc. by getting its definition from package\r
e7df35b2 890 _GuidDict = self.Guids.copy()\r
ae7b6df8
LG
891 for PcdCName, TokenSpaceGuid in PcdList:\r
892 PcdRealName = PcdCName\r
893 Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]\r
4231a819 894 if Setting is None:\r
ae7b6df8
LG
895 continue\r
896 ValueList = AnalyzePcdData(Setting)\r
897 DefaultValue = ValueList[0]\r
898 Pcd = PcdClassObject(\r
899 PcdCName,\r
900 TokenSpaceGuid,\r
901 '',\r
902 '',\r
903 DefaultValue,\r
904 '',\r
905 '',\r
906 {},\r
907 False,\r
908 self.Guids[TokenSpaceGuid]\r
909 )\r
910 if Type == MODEL_PCD_PATCHABLE_IN_MODULE and ValueList[1]:\r
911 # Patch PCD: TokenSpace.PcdCName|Value|Offset\r
912 Pcd.Offset = ValueList[1]\r
913\r
914 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
915 for Package in self.Packages:\r
916 for key in Package.Pcds:\r
917 if (Package.Pcds[key].TokenCName, Package.Pcds[key].TokenSpaceGuidCName) == (PcdRealName, TokenSpaceGuid):\r
918 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
919 Pcd_Type = item[0].split('_')[-1]\r
920 if Pcd_Type == Package.Pcds[key].Type:\r
921 Value = Package.Pcds[key]\r
922 Value.TokenCName = Package.Pcds[key].TokenCName + '_' + Pcd_Type\r
923 if len(key) == 2:\r
924 newkey = (Value.TokenCName, key[1])\r
925 elif len(key) == 3:\r
926 newkey = (Value.TokenCName, key[1], key[2])\r
927 del Package.Pcds[key]\r
928 Package.Pcds[newkey] = Value\r
929 break\r
930 else:\r
931 pass\r
932 else:\r
933 pass\r
934\r
935 # get necessary info from package declaring this PCD\r
936 for Package in self.Packages:\r
937 #\r
938 # 'dynamic' in INF means its type is determined by platform;\r
939 # if platform doesn't give its type, use 'lowest' one in the\r
940 # following order, if any\r
941 #\r
be409b67 942 # TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX\r
ae7b6df8 943 #\r
e7df35b2 944 _GuidDict.update(Package.Guids)\r
ae7b6df8
LG
945 PcdType = self._PCD_TYPE_STRING_[Type]\r
946 if Type == MODEL_PCD_DYNAMIC:\r
947 Pcd.Pending = True\r
be409b67 948 for T in PCD_TYPE_LIST:\r
ae7b6df8
LG
949 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
950 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
951 if str(item[0]).endswith(T) and (item[0], item[1], T) in Package.Pcds:\r
952 PcdType = T\r
953 PcdCName = item[0]\r
954 break\r
955 else:\r
956 pass\r
957 break\r
958 else:\r
959 if (PcdRealName, TokenSpaceGuid, T) in Package.Pcds:\r
960 PcdType = T\r
961 break\r
962\r
963 else:\r
964 Pcd.Pending = False\r
965 if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
966 for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
967 Pcd_Type = item[0].split('_')[-1]\r
968 if Pcd_Type == PcdType:\r
969 PcdCName = item[0]\r
970 break\r
971 else:\r
972 pass\r
973 else:\r
974 pass\r
975\r
976 if (PcdCName, TokenSpaceGuid, PcdType) in Package.Pcds:\r
977 PcdInPackage = Package.Pcds[PcdCName, TokenSpaceGuid, PcdType]\r
978 Pcd.Type = PcdType\r
979 Pcd.TokenValue = PcdInPackage.TokenValue\r
980\r
981 #\r
982 # Check whether the token value exist or not.\r
983 #\r
4231a819 984 if Pcd.TokenValue is None or Pcd.TokenValue == "":\r
ae7b6df8
LG
985 EdkLogger.error(\r
986 'build',\r
987 FORMAT_INVALID,\r
988 "No TokenValue for PCD [%s.%s] in [%s]!" % (TokenSpaceGuid, PcdRealName, str(Package)),\r
989 File=self.MetaFile, Line=LineNo,\r
990 ExtraData=None\r
991 )\r
992 #\r
993 # Check hexadecimal token value length and format.\r
994 #\r
995 ReIsValidPcdTokenValue = re.compile(r"^[0][x|X][0]*[0-9a-fA-F]{1,8}$", re.DOTALL)\r
996 if Pcd.TokenValue.startswith("0x") or Pcd.TokenValue.startswith("0X"):\r
4231a819 997 if ReIsValidPcdTokenValue.match(Pcd.TokenValue) is None:\r
ae7b6df8
LG
998 EdkLogger.error(\r
999 'build',\r
1000 FORMAT_INVALID,\r
1001 "The format of TokenValue [%s] of PCD [%s.%s] in [%s] is invalid:" % (Pcd.TokenValue, TokenSpaceGuid, PcdRealName, str(Package)),\r
1002 File=self.MetaFile, Line=LineNo,\r
1003 ExtraData=None\r
1004 )\r
1005\r
1006 #\r
1007 # Check decimal token value length and format.\r
1008 #\r
1009 else:\r
1010 try:\r
1011 TokenValueInt = int (Pcd.TokenValue, 10)\r
1012 if (TokenValueInt < 0 or TokenValueInt > 4294967295):\r
1013 EdkLogger.error(\r
1014 'build',\r
1015 FORMAT_INVALID,\r
1016 "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
1017 File=self.MetaFile, Line=LineNo,\r
1018 ExtraData=None\r
1019 )\r
1020 except:\r
1021 EdkLogger.error(\r
1022 'build',\r
1023 FORMAT_INVALID,\r
1024 "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
1025 File=self.MetaFile, Line=LineNo,\r
1026 ExtraData=None\r
1027 )\r
1028\r
1029 Pcd.DatumType = PcdInPackage.DatumType\r
1030 Pcd.MaxDatumSize = PcdInPackage.MaxDatumSize\r
1031 Pcd.InfDefaultValue = Pcd.DefaultValue\r
c93356ad 1032 if not Pcd.DefaultValue:\r
ae7b6df8 1033 Pcd.DefaultValue = PcdInPackage.DefaultValue\r
726c501c
YZ
1034 else:\r
1035 try:\r
e7df35b2 1036 Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, _GuidDict)(True)\r
5b0671c1 1037 except BadExpression as Value:\r
726c501c
YZ
1038 EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(TokenSpaceGuid, PcdRealName, Pcd.DefaultValue, Value),\r
1039 File=self.MetaFile, Line=LineNo)\r
ae7b6df8
LG
1040 break\r
1041 else:\r
1042 EdkLogger.error(\r
1043 'build',\r
1044 FORMAT_INVALID,\r
1045 "PCD [%s.%s] in [%s] is not found in dependent packages:" % (TokenSpaceGuid, PcdRealName, self.MetaFile),\r
1046 File=self.MetaFile, Line=LineNo,\r
8252e6bf 1047 ExtraData="\t%s" % '\n\t'.join(str(P) for P in self.Packages)\r
ae7b6df8
LG
1048 )\r
1049 Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
1050\r
1051 return Pcds\r
1052\r
1053 ## check whether current module is binary module\r
71cac3f7
CJ
1054 @property\r
1055 def IsBinaryModule(self):\r
1056 if (self.Binaries and not self.Sources) or GlobalData.gIgnoreSource:\r
ae7b6df8 1057 return True\r
71cac3f7 1058 return False\r
e8449e1d
FB
1059def ExtendCopyDictionaryLists(CopyToDict, CopyFromDict):\r
1060 for Key in CopyFromDict:\r
1061 CopyToDict[Key].extend(CopyFromDict[Key])\r