## @file\r
# This file is used to create a database used by build tool\r
#\r
-# Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
# (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
-from Common.String import *\r
+from Common.StringUtils import *\r
from Common.DataType import *\r
from Common.Misc import *\r
from types import *\r
from MetaFileParser import *\r
+from collections import OrderedDict\r
\r
from Workspace.BuildClassObject import ModuleBuildClassObject, LibraryClassObject, PcdClassObject\r
## Module build information from INF file\r
class InfBuildData(ModuleBuildClassObject):\r
# dict used to convert PCD type in database to string used by build tool\r
_PCD_TYPE_STRING_ = {\r
- MODEL_PCD_FIXED_AT_BUILD : "FixedAtBuild",\r
- MODEL_PCD_PATCHABLE_IN_MODULE : "PatchableInModule",\r
- MODEL_PCD_FEATURE_FLAG : "FeatureFlag",\r
- MODEL_PCD_DYNAMIC : "Dynamic",\r
- MODEL_PCD_DYNAMIC_DEFAULT : "Dynamic",\r
- MODEL_PCD_DYNAMIC_HII : "DynamicHii",\r
- MODEL_PCD_DYNAMIC_VPD : "DynamicVpd",\r
- MODEL_PCD_DYNAMIC_EX : "DynamicEx",\r
- MODEL_PCD_DYNAMIC_EX_DEFAULT : "DynamicEx",\r
- MODEL_PCD_DYNAMIC_EX_HII : "DynamicExHii",\r
- MODEL_PCD_DYNAMIC_EX_VPD : "DynamicExVpd",\r
+ MODEL_PCD_FIXED_AT_BUILD : TAB_PCDS_FIXED_AT_BUILD,\r
+ MODEL_PCD_PATCHABLE_IN_MODULE : TAB_PCDS_PATCHABLE_IN_MODULE,\r
+ MODEL_PCD_FEATURE_FLAG : TAB_PCDS_FEATURE_FLAG,\r
+ MODEL_PCD_DYNAMIC : TAB_PCDS_DYNAMIC,\r
+ MODEL_PCD_DYNAMIC_DEFAULT : TAB_PCDS_DYNAMIC,\r
+ MODEL_PCD_DYNAMIC_HII : TAB_PCDS_DYNAMIC_HII,\r
+ MODEL_PCD_DYNAMIC_VPD : TAB_PCDS_DYNAMIC_VPD,\r
+ MODEL_PCD_DYNAMIC_EX : TAB_PCDS_DYNAMIC_EX,\r
+ MODEL_PCD_DYNAMIC_EX_DEFAULT : TAB_PCDS_DYNAMIC_EX,\r
+ MODEL_PCD_DYNAMIC_EX_HII : TAB_PCDS_DYNAMIC_EX_HII,\r
+ MODEL_PCD_DYNAMIC_EX_VPD : TAB_PCDS_DYNAMIC_EX_VPD,\r
}\r
\r
# dict used to convert part of [Defines] to members of InfBuildData directly\r
TAB_COMPONENTS_SOURCE_OVERRIDE_PATH : "_SourceOverridePath",\r
}\r
\r
- # dict used to convert Component type to Module type\r
- _MODULE_TYPE_ = {\r
- "LIBRARY" : "BASE",\r
- "SECURITY_CORE" : "SEC",\r
- "PEI_CORE" : "PEI_CORE",\r
- "COMBINED_PEIM_DRIVER" : "PEIM",\r
- "PIC_PEIM" : "PEIM",\r
- "RELOCATABLE_PEIM" : "PEIM",\r
- "PE32_PEIM" : "PEIM",\r
- "BS_DRIVER" : "DXE_DRIVER",\r
- "RT_DRIVER" : "DXE_RUNTIME_DRIVER",\r
- "SAL_RT_DRIVER" : "DXE_SAL_DRIVER",\r
- "DXE_SMM_DRIVER" : "DXE_SMM_DRIVER",\r
- # "SMM_DRIVER" : "DXE_SMM_DRIVER",\r
- # "BS_DRIVER" : "DXE_SMM_DRIVER",\r
- # "BS_DRIVER" : "UEFI_DRIVER",\r
- "APPLICATION" : "UEFI_APPLICATION",\r
- "LOGO" : "BASE",\r
- }\r
-\r
# regular expression for converting XXX_FLAGS in [nmake] section to new type\r
_NMAKE_FLAG_PATTERN_ = re.compile("(?:EBC_)?([A-Z]+)_(?:STD_|PROJ_|ARCH_)?FLAGS(?:_DLL|_ASL|_EXE)?", re.UNICODE)\r
# dict used to convert old tool name used in [nmake] section to new ones\r
_TOOL_CODE_ = {\r
"C" : "CC",\r
- "LIB" : "SLINK",\r
+ BINARY_FILE_TYPE_LIB : "SLINK",\r
"LINK" : "DLINK",\r
}\r
\r
# @param Platform The name of platform employing this module\r
# @param Macros Macros used for replacement in DSC file\r
#\r
- def __init__(self, FilePath, RawData, BuildDatabase, Arch='COMMON', Target=None, Toolchain=None):\r
+ def __init__(self, FilePath, RawData, BuildDatabase, Arch=TAB_ARCH_COMMON, Target=None, Toolchain=None):\r
self.MetaFile = FilePath\r
self._ModuleDir = FilePath.Dir\r
self._RawData = RawData\r
self._Arch = Arch\r
self._Target = Target\r
self._Toolchain = Toolchain\r
- self._Platform = 'COMMON'\r
+ self._Platform = TAB_COMMON\r
self._SourceOverridePath = None\r
if FilePath.Key in GlobalData.gOverrideDir:\r
self._SourceOverridePath = GlobalData.gOverrideDir[FilePath.Key]\r
self._ModuleUnloadImageList = None\r
self._ConstructorList = None\r
self._DestructorList = None\r
- self._Defs = None\r
+ self._Defs = OrderedDict()\r
self._Binaries = None\r
self._Sources = None\r
self._LibraryClasses = None\r
self._Ppis = None\r
self._PpiComments = None\r
self._Guids = None\r
- self._GuidsUsedByPcd = sdict()\r
+ self._GuidsUsedByPcd = OrderedDict()\r
self._GuidComments = None\r
self._Includes = None\r
self._Packages = None\r
# items defined _PROPERTY_ don't need additional processing\r
if Name in self:\r
self[Name] = Value\r
- if self._Defs is None:\r
- self._Defs = sdict()\r
self._Defs[Name] = Value\r
self._Macros[Name] = Value\r
# some special items in [Defines] section need special treatment\r
if Name in ('EFI_SPECIFICATION_VERSION', 'UEFI_SPECIFICATION_VERSION'):\r
Name = 'UEFI_SPECIFICATION_VERSION'\r
if self._Specification is None:\r
- self._Specification = sdict()\r
+ self._Specification = OrderedDict()\r
self._Specification[Name] = GetHexVerValue(Value)\r
if self._Specification[Name] is None:\r
EdkLogger.error("build", FORMAT_NOT_SUPPORTED,\r
File=self.MetaFile, Line=Record[-1])\r
self._CustomMakefile[TokenList[0]] = TokenList[1]\r
else:\r
- if self._Defs is None:\r
- self._Defs = sdict()\r
self._Defs[Name] = Value\r
self._Macros[Name] = Value\r
\r
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
if self._ModuleType == SUP_MODULE_MM_STANDALONE:\r
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
- if self._Defs and 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
+ if 'PCI_DEVICE_ID' in self._Defs and 'PCI_VENDOR_ID' in self._Defs \\r
and 'PCI_CLASS_CODE' in self._Defs and 'PCI_REVISION' in self._Defs:\r
self._BuildType = 'UEFI_OPTIONROM'\r
if 'PCI_COMPRESS' in self._Defs:\r
if self._Defs['PCI_COMPRESS'] not in ('TRUE', 'FALSE'):\r
EdkLogger.error("build", FORMAT_INVALID, "Expected TRUE/FALSE for PCI_COMPRESS: %s" % self.MetaFile)\r
\r
- elif self._Defs and 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
+ elif 'UEFI_HII_RESOURCE_SECTION' in self._Defs \\r
and self._Defs['UEFI_HII_RESOURCE_SECTION'] == 'TRUE':\r
self._BuildType = 'UEFI_HII'\r
else:\r
EdkLogger.error("build", ATTRIBUTE_NOT_AVAILABLE,\r
"COMPONENT_TYPE is not given", File=self.MetaFile)\r
self._BuildType = self._ComponentType.upper()\r
- if self._ComponentType in self._MODULE_TYPE_:\r
- self._ModuleType = self._MODULE_TYPE_[self._ComponentType]\r
- if self._ComponentType == 'LIBRARY':\r
+ if self._ComponentType in COMPONENT_TO_MODULE_MAP_DICT:\r
+ self._ModuleType = COMPONENT_TO_MODULE_MAP_DICT[self._ComponentType]\r
+ if self._ComponentType == EDK_COMPONENT_TYPE_LIBRARY:\r
self._LibraryClass = [LibraryClassObject(self._BaseName, SUP_MODULE_LIST)]\r
# make use some [nmake] section macros\r
Macros = self._Macros\r
# File=self.MetaFile, Line=LineNo)\r
else:\r
if self._BuildOptions is None:\r
- self._BuildOptions = sdict()\r
+ self._BuildOptions = OrderedDict()\r
\r
if ToolList[0] in self._TOOL_CODE_:\r
Tool = self._TOOL_CODE_[ToolList[0]]\r
if self._Header_ is None:\r
self._GetHeaderInfo()\r
if self._ModuleType is None:\r
- self._ModuleType = 'BASE'\r
+ self._ModuleType = SUP_MODULE_BASE\r
if self._ModuleType not in SUP_MODULE_LIST:\r
- self._ModuleType = "USER_DEFINED"\r
+ self._ModuleType = SUP_MODULE_USER_DEFINED\r
return self._ModuleType\r
\r
## Retrieve COMPONENT_TYPE\r
if self._Header_ is None:\r
self._GetHeaderInfo()\r
if self._ComponentType is None:\r
- self._ComponentType = 'USER_DEFINED'\r
+ self._ComponentType = SUP_MODULE_USER_DEFINED\r
return self._ComponentType\r
\r
## Retrieve "BUILD_TYPE"\r
if self._Header_ is None:\r
self._GetHeaderInfo()\r
if not self._BuildType:\r
- self._BuildType = "BASE"\r
+ self._BuildType = SUP_MODULE_BASE\r
return self._BuildType\r
\r
## Retrieve file guid\r
\r
## Retrieve definies other than above ones\r
def _GetDefines(self):\r
- if self._Defs is None:\r
- if self._Header_ is None:\r
- self._GetHeaderInfo()\r
- if self._Defs is None:\r
- self._Defs = sdict()\r
+ if len(self._Defs) == 0 and self._Header_ is None:\r
+ self._GetHeaderInfo()\r
return self._Defs\r
\r
## Retrieve binary files\r
for Record in RecordList:\r
FileType = Record[0]\r
LineNo = Record[-1]\r
- Target = 'COMMON'\r
+ Target = TAB_COMMON\r
FeatureFlag = []\r
if Record[2]:\r
TokenList = GetSplitValueList(Record[2], TAB_VALUE_SPLIT)\r
## Retrieve library classes employed by this module\r
def _GetLibraryClassUses(self):\r
if self._LibraryClasses is None:\r
- self._LibraryClasses = sdict()\r
+ self._LibraryClasses = OrderedDict()\r
RecordList = self._RawData[MODEL_EFI_LIBRARY_CLASS, self._Arch, self._Platform]\r
for Record in RecordList:\r
Lib = Record[0]\r
## Retrieve protocols consumed/produced by this module\r
def _GetProtocols(self):\r
if self._Protocols is None:\r
- self._Protocols = sdict()\r
- self._ProtocolComments = sdict()\r
+ self._Protocols = OrderedDict()\r
+ self._ProtocolComments = OrderedDict()\r
RecordList = self._RawData[MODEL_EFI_PROTOCOL, self._Arch, self._Platform]\r
for Record in RecordList:\r
CName = Record[0]\r
Value = ProtocolValue(CName, self.Packages, self.MetaFile.Path)\r
if Value is None:\r
- PackageList = "\n\t".join([str(P) for P in self.Packages])\r
+ PackageList = "\n\t".join(str(P) for P in self.Packages)\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
"Value of Protocol [%s] is not found under [Protocols] section in" % CName,\r
ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
## Retrieve PPIs consumed/produced by this module\r
def _GetPpis(self):\r
if self._Ppis is None:\r
- self._Ppis = sdict()\r
- self._PpiComments = sdict()\r
+ self._Ppis = OrderedDict()\r
+ self._PpiComments = OrderedDict()\r
RecordList = self._RawData[MODEL_EFI_PPI, self._Arch, self._Platform]\r
for Record in RecordList:\r
CName = Record[0]\r
Value = PpiValue(CName, self.Packages, self.MetaFile.Path)\r
if Value is None:\r
- PackageList = "\n\t".join([str(P) for P in self.Packages])\r
+ PackageList = "\n\t".join(str(P) for P in self.Packages)\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
"Value of PPI [%s] is not found under [Ppis] section in " % CName,\r
ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
## Retrieve GUIDs consumed/produced by this module\r
def _GetGuids(self):\r
if self._Guids is None:\r
- self._Guids = sdict()\r
- self._GuidComments = sdict()\r
+ self._Guids = OrderedDict()\r
+ self._GuidComments = OrderedDict()\r
RecordList = self._RawData[MODEL_EFI_GUID, self._Arch, self._Platform]\r
for Record in RecordList:\r
CName = Record[0]\r
Value = GuidValue(CName, self.Packages, self.MetaFile.Path)\r
if Value is None:\r
- PackageList = "\n\t".join([str(P) for P in self.Packages])\r
+ PackageList = "\n\t".join(str(P) for P in self.Packages)\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
"Value of Guid [%s] is not found under [Guids] section in" % CName,\r
ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
self._Includes.append(self._SourceOverridePath)\r
\r
Macros = self._Macros\r
- if 'PROCESSOR' in GlobalData.gEdkGlobal.keys():\r
- Macros['PROCESSOR'] = GlobalData.gEdkGlobal['PROCESSOR']\r
- else:\r
- Macros['PROCESSOR'] = self._Arch\r
+ Macros['PROCESSOR'] = GlobalData.gEdkGlobal.get('PROCESSOR', self._Arch)\r
RecordList = self._RawData[MODEL_EFI_INCLUDE, self._Arch, self._Platform]\r
for Record in RecordList:\r
if Record[0].find('EDK_SOURCE') > -1:\r
## Retrieve PCDs used in this module\r
def _GetPcds(self):\r
if self._Pcds is None:\r
- self._Pcds = sdict()\r
- self._PcdComments = sdict()\r
+ self._Pcds = OrderedDict()\r
+ self._PcdComments = OrderedDict()\r
self._Pcds.update(self._GetPcd(MODEL_PCD_FIXED_AT_BUILD))\r
self._Pcds.update(self._GetPcd(MODEL_PCD_PATCHABLE_IN_MODULE))\r
self._Pcds.update(self._GetPcd(MODEL_PCD_FEATURE_FLAG))\r
## Retrieve build options specific to this module\r
def _GetBuildOptions(self):\r
if self._BuildOptions is None:\r
- self._BuildOptions = sdict()\r
+ self._BuildOptions = OrderedDict()\r
RecordList = self._RawData[MODEL_META_DATA_BUILD_OPTION, self._Arch, self._Platform]\r
for Record in RecordList:\r
ToolChainFamily = Record[0]\r
\r
# PEIM and DXE drivers must have a valid [Depex] section\r
if len(self.LibraryClass) == 0 and len(RecordList) == 0:\r
- if self.ModuleType == 'DXE_DRIVER' or self.ModuleType == 'PEIM' or self.ModuleType == 'DXE_SMM_DRIVER' or \\r
- self.ModuleType == 'DXE_SAL_DRIVER' or self.ModuleType == 'DXE_RUNTIME_DRIVER':\r
+ if self.ModuleType == SUP_MODULE_DXE_DRIVER or self.ModuleType == SUP_MODULE_PEIM or self.ModuleType == SUP_MODULE_DXE_SMM_DRIVER or \\r
+ self.ModuleType == SUP_MODULE_DXE_SAL_DRIVER or self.ModuleType == SUP_MODULE_DXE_RUNTIME_DRIVER:\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE, "No [Depex] section or no valid expression in [Depex] section for [%s] module" \\r
% self.ModuleType, File=self.MetaFile)\r
\r
- if len(RecordList) != 0 and self.ModuleType == 'USER_DEFINED':\r
+ if len(RecordList) != 0 and self.ModuleType == SUP_MODULE_USER_DEFINED:\r
for Record in RecordList:\r
- if Record[4] not in ['PEIM', 'DXE_DRIVER', 'DXE_SMM_DRIVER']:\r
+ if Record[4] not in [SUP_MODULE_PEIM, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER]:\r
EdkLogger.error('build', FORMAT_INVALID,\r
"'%s' module must specify the type of [Depex] section" % self.ModuleType,\r
File=self.MetaFile)\r
\r
- Depex = sdict()\r
+ Depex = OrderedDict()\r
for Record in RecordList:\r
DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
Arch = Record[3]\r
Depex[Arch, ModuleType] = []\r
DepexList = Depex[Arch, ModuleType]\r
for Token in TokenList:\r
- if Token in DEPEX_SUPPORTED_OPCODE:\r
+ if Token in DEPEX_SUPPORTED_OPCODE_SET:\r
DepexList.append(Token)\r
elif Token.endswith(".inf"): # module file name\r
ModuleFile = os.path.normpath(Token)\r
if Value is None:\r
Value = GuidValue(Token, self.Packages, self.MetaFile.Path)\r
if Value is None:\r
- PackageList = "\n\t".join([str(P) for P in self.Packages])\r
+ PackageList = "\n\t".join(str(P) for P in self.Packages)\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
"Value of [%s] is not found in" % Token,\r
ExtraData=PackageList, File=self.MetaFile, Line=Record[-1])\r
if self._DepexExpression is None:\r
self._DepexExpression = tdict(False, 2)\r
RecordList = self._RawData[MODEL_EFI_DEPEX, self._Arch]\r
- DepexExpression = sdict()\r
+ DepexExpression = OrderedDict()\r
for Record in RecordList:\r
DepexStr = ReplaceMacro(Record[0], self._Macros, False)\r
Arch = Record[3]\r
return self._GuidsUsedByPcd\r
## Retrieve PCD for given type\r
def _GetPcd(self, Type):\r
- Pcds = sdict()\r
+ Pcds = OrderedDict()\r
PcdDict = tdict(True, 4)\r
PcdList = []\r
RecordList = self._RawData[Type, self._Arch, self._Platform]\r
if TokenSpaceGuid not in self.Guids:\r
Value = GuidValue(TokenSpaceGuid, self.Packages, self.MetaFile.Path)\r
if Value is None:\r
- PackageList = "\n\t".join([str(P) for P in self.Packages])\r
+ PackageList = "\n\t".join(str(P) for P in self.Packages)\r
EdkLogger.error('build', RESOURCE_NOT_AVAILABLE,\r
"Value of Guid [%s] is not found under [Guids] section in" % TokenSpaceGuid,\r
ExtraData=PackageList, File=self.MetaFile, Line=LineNo)\r
self._PcdComments[TokenSpaceGuid, PcdCName] = Comments\r
\r
# resolve PCD type, value, datum info, etc. by getting its definition from package\r
+ _GuidDict = self.Guids.copy()\r
for PcdCName, TokenSpaceGuid in PcdList:\r
PcdRealName = PcdCName\r
Setting, LineNo = PcdDict[self._Arch, self.Platform, PcdCName, TokenSpaceGuid]\r
# if platform doesn't give its type, use 'lowest' one in the\r
# following order, if any\r
#\r
- # "FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"\r
+ # TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX\r
#\r
+ _GuidDict.update(Package.Guids)\r
PcdType = self._PCD_TYPE_STRING_[Type]\r
if Type == MODEL_PCD_DYNAMIC:\r
Pcd.Pending = True\r
- for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:\r
+ for T in PCD_TYPE_LIST:\r
if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:\r
for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:\r
if str(item[0]).endswith(T) and (item[0], item[1], T) in Package.Pcds:\r
Pcd.DatumType = PcdInPackage.DatumType\r
Pcd.MaxDatumSize = PcdInPackage.MaxDatumSize\r
Pcd.InfDefaultValue = Pcd.DefaultValue\r
- if Pcd.DefaultValue in [None, '']:\r
+ if not Pcd.DefaultValue:\r
Pcd.DefaultValue = PcdInPackage.DefaultValue\r
else:\r
try:\r
- Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, self.Guids)(True)\r
- except BadExpression, Value:\r
+ Pcd.DefaultValue = ValueExpressionEx(Pcd.DefaultValue, Pcd.DatumType, _GuidDict)(True)\r
+ except BadExpression as Value:\r
EdkLogger.error('Parser', FORMAT_INVALID, 'PCD [%s.%s] Value "%s", %s' %(TokenSpaceGuid, PcdRealName, Pcd.DefaultValue, Value),\r
File=self.MetaFile, Line=LineNo)\r
break\r
FORMAT_INVALID,\r
"PCD [%s.%s] in [%s] is not found in dependent packages:" % (TokenSpaceGuid, PcdRealName, self.MetaFile),\r
File=self.MetaFile, Line=LineNo,\r
- ExtraData="\t%s" % '\n\t'.join([str(P) for P in self.Packages])\r
+ ExtraData="\t%s" % '\n\t'.join(str(P) for P in self.Packages)\r
)\r
Pcds[PcdCName, TokenSpaceGuid] = Pcd\r
\r