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