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