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