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