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