BaseTools: Eot - fix variable names

1) currently a couple classes use m instead of self (including some mixed
functions that should have previously failed).
2) deleted some blank lines.

Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>
This commit is contained in:
Carsey, Jaben
2018-08-08 06:37:14 +08:00
committed by Yonghong Zhu
parent 9ddd4f7f94
commit 4fea08b9c9

View File

@ -123,49 +123,49 @@ class CompressedImage(Image):
_ORIG_SIZE_ = struct.Struct("1I") _ORIG_SIZE_ = struct.Struct("1I")
_CMPRS_TYPE_ = struct.Struct("4x 1B") _CMPRS_TYPE_ = struct.Struct("4x 1B")
def __init__(m, CompressedData=None, CompressionType=None, UncompressedLength=None): def __init__(self, CompressedData=None, CompressionType=None, UncompressedLength=None):
Image.__init__(m) Image.__init__(self)
if UncompressedLength is not None: if UncompressedLength is not None:
m.UncompressedLength = UncompressedLength self.UncompressedLength = UncompressedLength
if CompressionType is not None: if CompressionType is not None:
m.CompressionType = CompressionType self.CompressionType = CompressionType
if CompressedData is not None: if CompressedData is not None:
m.Data = CompressedData self.Data = CompressedData
def __str__(m): def __str__(self):
global gIndention global gIndention
S = "algorithm=%s uncompressed=%x" % (m.CompressionType, m.UncompressedLength) S = "algorithm=%s uncompressed=%x" % (self.CompressionType, self.UncompressedLength)
for Sec in m.Sections: for Sec in self.Sections:
S += '\n' + str(Sec) S += '\n' + str(Sec)
return S return S
def _SetOriginalSize(m, Size): def _SetOriginalSize(self, Size):
m.SetField(m._ORIG_SIZE_, 0, Size) self.SetField(self._ORIG_SIZE_, 0, Size)
def _GetOriginalSize(m): def _GetOriginalSize(self):
return m.GetField(m._ORIG_SIZE_)[0] return self.GetField(self._ORIG_SIZE_)[0]
def _SetCompressionType(m, Type): def _SetCompressionType(self, Type):
m.SetField(m._CMPRS_TYPE_, 0, Type) self.SetField(self._CMPRS_TYPE_, 0, Type)
def _GetCompressionType(m): def _GetCompressionType(self):
return m.GetField(m._CMPRS_TYPE_)[0] return self.GetField(self._CMPRS_TYPE_)[0]
def _GetSections(m): def _GetSections(self):
try: try:
from . import EfiCompressor from . import EfiCompressor
TmpData = EfiCompressor.FrameworkDecompress( TmpData = EfiCompressor.FrameworkDecompress(
m[m._HEADER_SIZE_:], self[self._HEADER_SIZE_:],
len(m) - m._HEADER_SIZE_ len(self) - self._HEADER_SIZE_
) )
DecData = array('B') DecData = array('B')
DecData.fromstring(TmpData) DecData.fromstring(TmpData)
except: except:
from . import EfiCompressor from . import EfiCompressor
TmpData = EfiCompressor.UefiDecompress( TmpData = EfiCompressor.UefiDecompress(
m[m._HEADER_SIZE_:], self[self._HEADER_SIZE_:],
len(m) - m._HEADER_SIZE_ len(self) - self._HEADER_SIZE_
) )
DecData = array('B') DecData = array('B')
DecData.fromstring(TmpData) DecData.fromstring(TmpData)
@ -195,20 +195,20 @@ class Ui(Image):
_HEADER_ = struct.Struct("") _HEADER_ = struct.Struct("")
_HEADER_SIZE_ = 0 _HEADER_SIZE_ = 0
def __init__(m): def __init__(self):
Image.__init__(m) Image.__init__(self)
def __str__(m): def __str__(self):
return m.String return self.String
def _Unpack(m): def _Unpack(self):
# keep header in this Image object # keep header in this Image object
m.empty() self.empty()
m.extend(m._BUF_[m._OFF_ : m._OFF_ + m._LEN_]) self.extend(self._BUF_[self._OFF_ : self._OFF_ + self._LEN_])
return len(m) return len(self)
def _GetUiString(m): def _GetUiString(self):
return codecs.utf_16_decode(m[0:-2].tostring())[0] return codecs.utf_16_decode(self[0:-2].tostring())[0]
String = property(_GetUiString) String = property(_GetUiString)
@ -250,18 +250,18 @@ class Depex(Image):
0x09 : _OPCODE_, #"SOR" 0x09 : _OPCODE_, #"SOR"
} }
def __init__(m): def __init__(self):
Image.__init__(m) Image.__init__(self)
m._ExprList = [] self._ExprList = []
def __str__(m): def __str__(self):
global gIndention global gIndention
gIndention += 4 gIndention += 4
Indention = ' ' * gIndention Indention = ' ' * gIndention
S = '\n' S = '\n'
for T in m.Expression: for T in self.Expression:
if T in m._OPCODE_STRING_: if T in self._OPCODE_STRING_:
S += Indention + m._OPCODE_STRING_[T] S += Indention + self._OPCODE_STRING_[T]
if T not in [0x00, 0x01, 0x02]: if T not in [0x00, 0x01, 0x02]:
S += '\n' S += '\n'
else: else:
@ -269,31 +269,31 @@ class Depex(Image):
gIndention -= 4 gIndention -= 4
return S return S
def _Unpack(m): def _Unpack(self):
# keep header in this Image object # keep header in this Image object
m.empty() self.empty()
m.extend(m._BUF_[m._OFF_ : m._OFF_ + m._LEN_]) self.extend(self._BUF_[self._OFF_ : self._OFF_ + self._LEN_])
return len(m) return len(self)
def _GetExpression(m): def _GetExpression(self):
if m._ExprList == []: if self._ExprList == []:
Offset = 0 Offset = 0
CurrentData = m._OPCODE_ CurrentData = self._OPCODE_
while Offset < len(m): while Offset < len(self):
Token = CurrentData.unpack_from(m, Offset) Token = CurrentData.unpack_from(self, Offset)
Offset += CurrentData.size Offset += CurrentData.size
if len(Token) == 1: if len(Token) == 1:
Token = Token[0] Token = Token[0]
if Token in m._NEXT_: if Token in self._NEXT_:
CurrentData = m._NEXT_[Token] CurrentData = self._NEXT_[Token]
else: else:
CurrentData = m._GUID_ CurrentData = self._GUID_
else: else:
CurrentData = m._OPCODE_ CurrentData = self._OPCODE_
m._ExprList.append(Token) self._ExprList.append(Token)
if CurrentData is None: if CurrentData is None:
break break
return m._ExprList return self._ExprList
Expression = property(_GetExpression) Expression = property(_GetExpression)
@ -326,9 +326,7 @@ class FirmwareVolume(Image):
def CheckArchProtocol(self): def CheckArchProtocol(self):
for Item in EotGlobalData.gArchProtocolGuids: for Item in EotGlobalData.gArchProtocolGuids:
if Item.lower() not in EotGlobalData.gProtocolList: if Item.lower() not in EotGlobalData.gProtocolList:
return False return False
return True return True
def ParseDepex(self, Depex, Type): def ParseDepex(self, Depex, Type):
@ -441,7 +439,6 @@ class FirmwareVolume(Image):
if GuidString in self.UnDispatchedFfsDict: if GuidString in self.UnDispatchedFfsDict:
self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString) self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString)
self.LoadPpi(Db, GuidString) self.LoadPpi(Db, GuidString)
self.DisPatchPei(Db) self.DisPatchPei(Db)
# Parse DXE then # Parse DXE then
@ -463,7 +460,6 @@ class FirmwareVolume(Image):
if GuidString in self.UnDispatchedFfsDict: if GuidString in self.UnDispatchedFfsDict:
self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString) self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString)
self.LoadProtocol(Db, GuidString) self.LoadProtocol(Db, GuidString)
self.DisPatchDxe(Db) self.DisPatchDxe(Db)
def LoadProtocol(self, Db, ModuleGuid): def LoadProtocol(self, Db, ModuleGuid):
@ -564,7 +560,6 @@ class FirmwareVolume(Image):
RecordSet = Db.TblReport.Exec(SqlCommand) RecordSet = Db.TblReport.Exec(SqlCommand)
if RecordSet != []: if RecordSet != []:
FfsName = RecordSet[0][0] FfsName = RecordSet[0][0]
if IsInstalled: if IsInstalled:
self.DisPatchDxe(Db) self.DisPatchDxe(Db)
@ -608,7 +603,6 @@ class FirmwareVolume(Image):
if IsInstalled: if IsInstalled:
self.DisPatchPei(Db) self.DisPatchPei(Db)
def __str__(self): def __str__(self):
global gIndention global gIndention
gIndention += 4 gIndention += 4
@ -690,69 +684,69 @@ class GuidDefinedImage(Image):
TIANO_COMPRESS_GUID = 'A31280AD-481E-41B6-95E8-127F4C984779' TIANO_COMPRESS_GUID = 'A31280AD-481E-41B6-95E8-127F4C984779'
LZMA_COMPRESS_GUID = 'EE4E5898-3914-4259-9D6E-DC7BD79403CF' LZMA_COMPRESS_GUID = 'EE4E5898-3914-4259-9D6E-DC7BD79403CF'
def __init__(m, SectionDefinitionGuid=None, DataOffset=None, Attributes=None, Data=None): def __init__(self, SectionDefinitionGuid=None, DataOffset=None, Attributes=None, Data=None):
Image.__init__(m) Image.__init__(self)
if SectionDefinitionGuid is not None: if SectionDefinitionGuid is not None:
m.SectionDefinitionGuid = SectionDefinitionGuid self.SectionDefinitionGuid = SectionDefinitionGuid
if DataOffset is not None: if DataOffset is not None:
m.DataOffset = DataOffset self.DataOffset = DataOffset
if Attributes is not None: if Attributes is not None:
m.Attributes = Attributes self.Attributes = Attributes
if Data is not None: if Data is not None:
m.Data = Data self.Data = Data
def __str__(m): def __str__(self):
S = "guid=%s" % (gGuidStringFormat % m.SectionDefinitionGuid) S = "guid=%s" % (gGuidStringFormat % self.SectionDefinitionGuid)
for Sec in m.Sections: for Sec in self.Sections:
S += "\n" + str(Sec) S += "\n" + str(Sec)
return S return S
def _Unpack(m): def _Unpack(self):
# keep header in this Image object # keep header in this Image object
m.empty() self.empty()
m.extend(m._BUF_[m._OFF_ : m._OFF_ + m._LEN_]) self.extend(self._BUF_[self._OFF_ : self._OFF_ + self._LEN_])
return len(m) return len(self)
def _SetAttribute(m, Attribute): def _SetAttribute(self, Attribute):
m.SetField(m._ATTR_, 0, Attribute) self.SetField(self._ATTR_, 0, Attribute)
def _GetAttribute(m): def _GetAttribute(self):
return m.GetField(m._ATTR_)[0] return self.GetField(self._ATTR_)[0]
def _SetGuid(m, Guid): def _SetGuid(self, Guid):
m.SetField(m._GUID_, 0, Guid) self.SetField(self._GUID_, 0, Guid)
def _GetGuid(m): def _GetGuid(self):
return m.GetField(m._GUID_) return self.GetField(self._GUID_)
def _SetDataOffset(m, Offset): def _SetDataOffset(self, Offset):
m.SetField(m._DATA_OFFSET_, 0, Offset) self.SetField(self._DATA_OFFSET_, 0, Offset)
def _GetDataOffset(m): def _GetDataOffset(self):
return m.GetField(m._DATA_OFFSET_)[0] return self.GetField(self._DATA_OFFSET_)[0]
def _GetSections(m): def _GetSections(self):
SectionList = [] SectionList = []
Guid = gGuidStringFormat % m.SectionDefinitionGuid Guid = gGuidStringFormat % self.SectionDefinitionGuid
if Guid == m.CRC32_GUID: if Guid == self.CRC32_GUID:
# skip the CRC32 value, we don't do CRC32 verification here # skip the CRC32 value, we don't do CRC32 verification here
Offset = m.DataOffset - 4 Offset = self.DataOffset - 4
while Offset < len(m): while Offset < len(self):
Sec = Section() Sec = Section()
try: try:
Sec.frombuffer(m, Offset) Sec.frombuffer(self, Offset)
Offset += Sec.Size Offset += Sec.Size
# the section is aligned to 4-byte boundary # the section is aligned to 4-byte boundary
Offset = (Offset + 3) & (~3) Offset = (Offset + 3) & (~3)
except: except:
break break
SectionList.append(Sec) SectionList.append(Sec)
elif Guid == m.TIANO_COMPRESS_GUID: elif Guid == self.TIANO_COMPRESS_GUID:
try: try:
from . import EfiCompressor from . import EfiCompressor
# skip the header # skip the header
Offset = m.DataOffset - 4 Offset = self.DataOffset - 4
TmpData = EfiCompressor.FrameworkDecompress(m[Offset:], len(m)-Offset) TmpData = EfiCompressor.FrameworkDecompress(self[Offset:], len(self)-Offset)
DecData = array('B') DecData = array('B')
DecData.fromstring(TmpData) DecData.fromstring(TmpData)
Offset = 0 Offset = 0
@ -768,12 +762,12 @@ class GuidDefinedImage(Image):
SectionList.append(Sec) SectionList.append(Sec)
except: except:
pass pass
elif Guid == m.LZMA_COMPRESS_GUID: elif Guid == self.LZMA_COMPRESS_GUID:
try: try:
from . import LzmaCompressor from . import LzmaCompressor
# skip the header # skip the header
Offset = m.DataOffset - 4 Offset = self.DataOffset - 4
TmpData = LzmaCompressor.LzmaDecompress(m[Offset:], len(m)-Offset) TmpData = LzmaCompressor.LzmaDecompress(self[Offset:], len(self)-Offset)
DecData = array('B') DecData = array('B')
DecData.fromstring(TmpData) DecData.fromstring(TmpData)
Offset = 0 Offset = 0
@ -835,90 +829,89 @@ class Section(Image):
# SubTypeGuid # SubTypeGuid
# _FREE_FORM_SUBTYPE_GUID_HEADER_ = struct.Struct("1I2H8B") # _FREE_FORM_SUBTYPE_GUID_HEADER_ = struct.Struct("1I2H8B")
_SIZE_ = struct.Struct("3B") _SIZE_ = struct.Struct("3B")
_TYPE_ = struct.Struct("3x 1B") _TYPE_ = struct.Struct("3x 1B")
def __init__(m, Type=None, Size=None): def __init__(self, Type=None, Size=None):
Image.__init__(m) Image.__init__(self)
m._Alignment = 1 self._Alignment = 1
if Type is not None: if Type is not None:
m.Type = Type self.Type = Type
if Size is not None: if Size is not None:
m.Size = Size self.Size = Size
def __str__(m): def __str__(self):
global gIndention global gIndention
gIndention += 4 gIndention += 4
SectionInfo = ' ' * gIndention SectionInfo = ' ' * gIndention
if m.Type in m._TypeName: if self.Type in self._TypeName:
SectionInfo += "[SECTION:%s] offset=%x size=%x" % (m._TypeName[m.Type], m._OFF_, m.Size) SectionInfo += "[SECTION:%s] offset=%x size=%x" % (self._TypeName[self.Type], self._OFF_, self.Size)
else: else:
SectionInfo += "[SECTION:%x<unknown>] offset=%x size=%x " % (m.Type, m._OFF_, m.Size) SectionInfo += "[SECTION:%x<unknown>] offset=%x size=%x " % (self.Type, self._OFF_, self.Size)
for Offset in m._SubImages: for Offset in self._SubImages:
SectionInfo += ", " + str(m._SubImages[Offset]) SectionInfo += ", " + str(self._SubImages[Offset])
gIndention -= 4 gIndention -= 4
return SectionInfo return SectionInfo
def _Unpack(m): def _Unpack(self):
m.empty() self.empty()
Type, = m._TYPE_.unpack_from(m._BUF_, m._OFF_) Type, = self._TYPE_.unpack_from(self._BUF_, self._OFF_)
Size1, Size2, Size3 = m._SIZE_.unpack_from(m._BUF_, m._OFF_) Size1, Size2, Size3 = self._SIZE_.unpack_from(self._BUF_, self._OFF_)
Size = Size1 + (Size2 << 8) + (Size3 << 16) Size = Size1 + (Size2 << 8) + (Size3 << 16)
if Type not in m._SectionSubImages: if Type not in self._SectionSubImages:
# no need to extract sub-image, keep all in this Image object # no need to extract sub-image, keep all in this Image object
m.extend(m._BUF_[m._OFF_ : m._OFF_ + Size]) self.extend(self._BUF_[self._OFF_ : self._OFF_ + Size])
else: else:
# keep header in this Image object # keep header in this Image object
m.extend(m._BUF_[m._OFF_ : m._OFF_ + m._HEADER_SIZE_]) self.extend(self._BUF_[self._OFF_ : self._OFF_ + self._HEADER_SIZE_])
# #
# use new Image object to represent payload, which may be another kind # use new Image object to represent payload, which may be another kind
# of image such as PE32 # of image such as PE32
# #
PayloadOffset = m._HEADER_SIZE_ PayloadOffset = self._HEADER_SIZE_
PayloadLen = m.Size - m._HEADER_SIZE_ PayloadLen = self.Size - self._HEADER_SIZE_
Payload = m._SectionSubImages[m.Type]() Payload = self._SectionSubImages[self.Type]()
Payload.frombuffer(m._BUF_, m._OFF_ + m._HEADER_SIZE_, PayloadLen) Payload.frombuffer(self._BUF_, self._OFF_ + self._HEADER_SIZE_, PayloadLen)
m._SubImages[PayloadOffset] = Payload self._SubImages[PayloadOffset] = Payload
return Size return Size
def _SetSize(m, Size): def _SetSize(self, Size):
Size1 = Size & 0xFF Size1 = Size & 0xFF
Size2 = (Size & 0xFF00) >> 8 Size2 = (Size & 0xFF00) >> 8
Size3 = (Size & 0xFF0000) >> 16 Size3 = (Size & 0xFF0000) >> 16
m.SetField(m._SIZE_, 0, Size1, Size2, Size3) self.SetField(self._SIZE_, 0, Size1, Size2, Size3)
def _GetSize(m): def _GetSize(self):
Size1, Size2, Size3 = m.GetField(m._SIZE_) Size1, Size2, Size3 = self.GetField(self._SIZE_)
return Size1 + (Size2 << 8) + (Size3 << 16) return Size1 + (Size2 << 8) + (Size3 << 16)
def _SetType(m, Type): def _SetType(self, Type):
m.SetField(m._TYPE_, 0, Type) self.SetField(self._TYPE_, 0, Type)
def _GetType(m): def _GetType(self):
return m.GetField(m._TYPE_)[0] return self.GetField(self._TYPE_)[0]
def _GetAlignment(m): def _GetAlignment(self):
return m._Alignment return self._Alignment
def _SetAlignment(m, Alignment): def _SetAlignment(self, Alignment):
m._Alignment = Alignment self._Alignment = Alignment
AlignmentMask = Alignment - 1 AlignmentMask = Alignment - 1
# section alignment is actually for payload, so we need to add header size # section alignment is actually for payload, so we need to add header size
PayloadOffset = m._OFF_ + m._HEADER_SIZE_ PayloadOffset = self._OFF_ + self._HEADER_SIZE_
if (PayloadOffset & (~AlignmentMask)) == 0: if (PayloadOffset & (~AlignmentMask)) == 0:
return return
NewOffset = (PayloadOffset + AlignmentMask) & (~AlignmentMask) NewOffset = (PayloadOffset + AlignmentMask) & (~AlignmentMask)
while (NewOffset - PayloadOffset) < m._HEADER_SIZE_: while (NewOffset - PayloadOffset) < self._HEADER_SIZE_:
NewOffset += m._Alignment NewOffset += self._Alignment
def tofile(m, f): def tofile(self, f):
m.Size = len(m) self.Size = len(self)
Image.tofile(m, f) Image.tofile(self, f)
for Offset in m._SubImages: for Offset in self._SubImages:
m._SubImages[Offset].tofile(f) self._SubImages[Offset].tofile(f)
Type = property(_GetType, _SetType) Type = property(_GetType, _SetType)
Size = property(_GetSize, _SetSize) Size = property(_GetSize, _SetSize)
@ -1043,24 +1036,24 @@ class Ffs(Image):
# Guid1, Guid2, Guid3, Guid4, Guid5, Guid6, Guid7, Guid8, Guid9, Guid10, Guid11 # Guid1, Guid2, Guid3, Guid4, Guid5, Guid6, Guid7, Guid8, Guid9, Guid10, Guid11
return self.GetField(self._NAME_) return self.GetField(self._NAME_)
def _SetSize(m, Size): def _SetSize(self, Size):
Size1 = Size & 0xFF Size1 = Size & 0xFF
Size2 = (Size & 0xFF00) >> 8 Size2 = (Size & 0xFF00) >> 8
Size3 = (Size & 0xFF0000) >> 16 Size3 = (Size & 0xFF0000) >> 16
m.SetField(m._SIZE_, 0, Size1, Size2, Size3) self.SetField(self._SIZE_, 0, Size1, Size2, Size3)
def _GetSize(m): def _GetSize(self):
Size1, Size2, Size3 = m.GetField(m._SIZE_) Size1, Size2, Size3 = self.GetField(self._SIZE_)
return Size1 + (Size2 << 8) + (Size3 << 16) return Size1 + (Size2 << 8) + (Size3 << 16)
def _SetType(m, Type): def _SetType(self, Type):
m.SetField(m._TYPE_, 0, Type) self.SetField(self._TYPE_, 0, Type)
def _GetType(m): def _GetType(self):
return m.GetField(m._TYPE_)[0] return self.GetField(self._TYPE_)[0]
def _SetAttributes(self, Value): def _SetAttributes(self, Value):
self.SetField(m._ATTR_, 0, Value) self.SetField(self._ATTR_, 0, Value)
def _GetAttributes(self): def _GetAttributes(self):
return self.GetField(self._ATTR_)[0] return self.GetField(self._ATTR_)[0]
@ -1079,10 +1072,10 @@ class Ffs(Image):
return (self.Attributes & self.FFS_ATTRIB_DATA_ALIGNMENT) >> 3 return (self.Attributes & self.FFS_ATTRIB_DATA_ALIGNMENT) >> 3
def _SetState(self, Value): def _SetState(self, Value):
self.SetField(m._STATE_, 0, Value) self.SetField(self._STATE_, 0, Value)
def _GetState(self): def _GetState(self):
return self.GetField(m._STATE_)[0] return self.GetField(self._STATE_)[0]
Name = property(_GetName, _SetName) Name = property(_GetName, _SetName)
Guid = property(_GetGuid) Guid = property(_GetGuid)
@ -1123,9 +1116,7 @@ class FirmwareVolume(Image):
def CheckArchProtocol(self): def CheckArchProtocol(self):
for Item in EotGlobalData.gArchProtocolGuids: for Item in EotGlobalData.gArchProtocolGuids:
if Item.lower() not in EotGlobalData.gProtocolList: if Item.lower() not in EotGlobalData.gProtocolList:
return False return False
return True return True
def ParseDepex(self, Depex, Type): def ParseDepex(self, Depex, Type):
@ -1378,7 +1369,6 @@ class FirmwareVolume(Image):
if Section.Type == 0x1B: if Section.Type == 0x1B:
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(Section._SubImages[4], 'Ppi') CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(Section._SubImages[4], 'Ppi')
break break
if Section.Type == 0x01: if Section.Type == 0x01:
CompressSections = Section._SubImages[4] CompressSections = Section._SubImages[4]
for CompressSection in CompressSections.Sections: for CompressSection in CompressSections.Sections: