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