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