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