BaseTools/GenFds: cleanup GenFds
1) remove wildcard imports and use explicit imports 2) refactor to use shared variables from Common/DataType 3) rename to not shadow imports 4) don't assign a variable in a loop (just do final assignment) 5) remove spaces, parens, unused or commented out code, etc. 6) merge unnecessary parent classes into child 7) refactor to share DXE and PEI apriori GUIDs from one place this includes changes to Build and EOT files 8) for PEP8, dont use __ for custom methods. Cc: Yonghong Zhu <yonghong.zhu@intel.com> Cc: Liming Gao <liming.gao@intel.com> Cc: Bob C Feng <bob.c.feng@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
committed by
Yonghong Zhu
Yonghong Zhu
parent
0019375fbc
commit
9e47e6f908
@ -36,10 +36,9 @@ import struct
|
||||
import uuid
|
||||
import copy
|
||||
import codecs
|
||||
from GenFds.AprioriSection import DXE_APRIORI_GUID, PEI_APRIORI_GUID
|
||||
|
||||
gGuidStringFormat = "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X"
|
||||
gPeiAprioriFileNameGuid = '1b45cc0a-156a-428a-af62-49864da0e6e6'
|
||||
gAprioriGuid = 'fc510ee7-ffdc-11d4-bd41-0080c73c8881'
|
||||
gIndention = -4
|
||||
|
||||
class Image(array):
|
||||
@ -402,10 +401,10 @@ class FirmwareVolume(Image):
|
||||
if Ffs.Type == 0x05:
|
||||
FfsDxeCoreGuid = FfsID
|
||||
continue
|
||||
if Ffs.Guid.lower() == gPeiAprioriFileNameGuid:
|
||||
if Ffs.Guid.lower() == PEI_APRIORI_GUID.lower():
|
||||
FfsPeiPrioriGuid = FfsID
|
||||
continue
|
||||
if Ffs.Guid.lower() == gAprioriGuid:
|
||||
if Ffs.Guid.lower() == DXE_APRIORI_GUID.lower():
|
||||
FfsDxePrioriGuid = FfsID
|
||||
continue
|
||||
|
||||
@ -1084,6 +1083,371 @@ class Ffs(Image):
|
||||
State = property(_GetState, _SetState)
|
||||
|
||||
|
||||
_FfsGuid = "8C8CE578-8A3D-4F1C-9935-896185C32DD3"
|
||||
|
||||
_GUID_ = struct.Struct("16x 1I2H8B")
|
||||
_LENGTH_ = struct.Struct("16x 16x 1Q")
|
||||
_SIG_ = struct.Struct("16x 16x 8x 1I")
|
||||
_ATTR_ = struct.Struct("16x 16x 8x 4x 1I")
|
||||
_HLEN_ = struct.Struct("16x 16x 8x 4x 4x 1H")
|
||||
_CHECKSUM_ = struct.Struct("16x 16x 8x 4x 4x 2x 1H")
|
||||
|
||||
def __init__(self, Name=''):
|
||||
Image.__init__(self)
|
||||
self.Name = Name
|
||||
self.FfsDict = sdict()
|
||||
self.OrderedFfsDict = sdict()
|
||||
self.UnDispatchedFfsDict = sdict()
|
||||
self.ProtocolList = sdict()
|
||||
|
||||
def CheckArchProtocol(self):
|
||||
for Item in EotGlobalData.gArchProtocolGuids:
|
||||
if Item.lower() not in EotGlobalData.gProtocolList:
|
||||
return False
|
||||
return True
|
||||
|
||||
def ParseDepex(self, Depex, Type):
|
||||
List = None
|
||||
if Type == 'Ppi':
|
||||
List = EotGlobalData.gPpiList
|
||||
if Type == 'Protocol':
|
||||
List = EotGlobalData.gProtocolList
|
||||
DepexStack = []
|
||||
DepexList = []
|
||||
DepexString = ''
|
||||
FileDepex = None
|
||||
CouldBeLoaded = True
|
||||
for Index in range(0, len(Depex.Expression)):
|
||||
Item = Depex.Expression[Index]
|
||||
if Item == 0x00:
|
||||
Index = Index + 1
|
||||
Guid = gGuidStringFormat % Depex.Expression[Index]
|
||||
if Guid in self.OrderedFfsDict and Depex.Expression[Index + 1] == 0x08:
|
||||
return (True, 'BEFORE %s' % Guid, [Guid, 'BEFORE'])
|
||||
elif Item == 0x01:
|
||||
Index = Index + 1
|
||||
Guid = gGuidStringFormat % Depex.Expression[Index]
|
||||
if Guid in self.OrderedFfsDict and Depex.Expression[Index + 1] == 0x08:
|
||||
return (True, 'AFTER %s' % Guid, [Guid, 'AFTER'])
|
||||
elif Item == 0x02:
|
||||
Index = Index + 1
|
||||
Guid = gGuidStringFormat % Depex.Expression[Index]
|
||||
if Guid.lower() in List:
|
||||
DepexStack.append(True)
|
||||
DepexList.append(Guid)
|
||||
else:
|
||||
DepexStack.append(False)
|
||||
DepexList.append(Guid)
|
||||
continue
|
||||
elif Item == 0x03 or Item == 0x04:
|
||||
DepexStack.append(eval(str(DepexStack.pop()) + ' ' + Depex._OPCODE_STRING_[Item].lower() + ' ' + str(DepexStack.pop())))
|
||||
DepexList.append(str(DepexList.pop()) + ' ' + Depex._OPCODE_STRING_[Item].upper() + ' ' + str(DepexList.pop()))
|
||||
elif Item == 0x05:
|
||||
DepexStack.append(eval(Depex._OPCODE_STRING_[Item].lower() + ' ' + str(DepexStack.pop())))
|
||||
DepexList.append(Depex._OPCODE_STRING_[Item].lower() + ' ' + str(DepexList.pop()))
|
||||
elif Item == 0x06:
|
||||
DepexStack.append(True)
|
||||
DepexList.append('TRUE')
|
||||
DepexString = DepexString + 'TRUE' + ' '
|
||||
elif Item == 0x07:
|
||||
DepexStack.append(False)
|
||||
DepexList.append('False')
|
||||
DepexString = DepexString + 'FALSE' + ' '
|
||||
elif Item == 0x08:
|
||||
if Index != len(Depex.Expression) - 1:
|
||||
CouldBeLoaded = False
|
||||
else:
|
||||
CouldBeLoaded = DepexStack.pop()
|
||||
else:
|
||||
CouldBeLoaded = False
|
||||
if DepexList != []:
|
||||
DepexString = DepexList[0].strip()
|
||||
return (CouldBeLoaded, DepexString, FileDepex)
|
||||
|
||||
def Dispatch(self, Db = None):
|
||||
if Db is None:
|
||||
return False
|
||||
self.UnDispatchedFfsDict = copy.copy(self.FfsDict)
|
||||
# Find PeiCore, DexCore, PeiPriori, DxePriori first
|
||||
FfsSecCoreGuid = None
|
||||
FfsPeiCoreGuid = None
|
||||
FfsDxeCoreGuid = None
|
||||
FfsPeiPrioriGuid = None
|
||||
FfsDxePrioriGuid = None
|
||||
for FfsID in self.UnDispatchedFfsDict:
|
||||
Ffs = self.UnDispatchedFfsDict[FfsID]
|
||||
if Ffs.Type == 0x03:
|
||||
FfsSecCoreGuid = FfsID
|
||||
continue
|
||||
if Ffs.Type == 0x04:
|
||||
FfsPeiCoreGuid = FfsID
|
||||
continue
|
||||
if Ffs.Type == 0x05:
|
||||
FfsDxeCoreGuid = FfsID
|
||||
continue
|
||||
if Ffs.Guid.lower() == PEI_APRIORI_GUID.lower():
|
||||
FfsPeiPrioriGuid = FfsID
|
||||
continue
|
||||
if Ffs.Guid.lower() == DXE_APRIORI_GUID.lower():
|
||||
FfsDxePrioriGuid = FfsID
|
||||
continue
|
||||
|
||||
# Parse SEC_CORE first
|
||||
if FfsSecCoreGuid is not None:
|
||||
self.OrderedFfsDict[FfsSecCoreGuid] = self.UnDispatchedFfsDict.pop(FfsSecCoreGuid)
|
||||
self.LoadPpi(Db, FfsSecCoreGuid)
|
||||
|
||||
# Parse PEI first
|
||||
if FfsPeiCoreGuid is not None:
|
||||
self.OrderedFfsDict[FfsPeiCoreGuid] = self.UnDispatchedFfsDict.pop(FfsPeiCoreGuid)
|
||||
self.LoadPpi(Db, FfsPeiCoreGuid)
|
||||
if FfsPeiPrioriGuid is not None:
|
||||
# Load PEIM described in priori file
|
||||
FfsPeiPriori = self.UnDispatchedFfsDict.pop(FfsPeiPrioriGuid)
|
||||
if len(FfsPeiPriori.Sections) == 1:
|
||||
Section = FfsPeiPriori.Sections.popitem()[1]
|
||||
if Section.Type == 0x19:
|
||||
GuidStruct = struct.Struct('1I2H8B')
|
||||
Start = 4
|
||||
while len(Section) > Start:
|
||||
Guid = GuidStruct.unpack_from(Section[Start : Start + 16])
|
||||
GuidString = gGuidStringFormat % Guid
|
||||
Start = Start + 16
|
||||
if GuidString in self.UnDispatchedFfsDict:
|
||||
self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString)
|
||||
self.LoadPpi(Db, GuidString)
|
||||
|
||||
self.DisPatchPei(Db)
|
||||
|
||||
# Parse DXE then
|
||||
if FfsDxeCoreGuid is not None:
|
||||
self.OrderedFfsDict[FfsDxeCoreGuid] = self.UnDispatchedFfsDict.pop(FfsDxeCoreGuid)
|
||||
self.LoadProtocol(Db, FfsDxeCoreGuid)
|
||||
if FfsDxePrioriGuid is not None:
|
||||
# Load PEIM described in priori file
|
||||
FfsDxePriori = self.UnDispatchedFfsDict.pop(FfsDxePrioriGuid)
|
||||
if len(FfsDxePriori.Sections) == 1:
|
||||
Section = FfsDxePriori.Sections.popitem()[1]
|
||||
if Section.Type == 0x19:
|
||||
GuidStruct = struct.Struct('1I2H8B')
|
||||
Start = 4
|
||||
while len(Section) > Start:
|
||||
Guid = GuidStruct.unpack_from(Section[Start : Start + 16])
|
||||
GuidString = gGuidStringFormat % Guid
|
||||
Start = Start + 16
|
||||
if GuidString in self.UnDispatchedFfsDict:
|
||||
self.OrderedFfsDict[GuidString] = self.UnDispatchedFfsDict.pop(GuidString)
|
||||
self.LoadProtocol(Db, GuidString)
|
||||
|
||||
self.DisPatchDxe(Db)
|
||||
|
||||
def LoadProtocol(self, Db, ModuleGuid):
|
||||
SqlCommand = """select GuidValue from Report
|
||||
where SourceFileFullPath in
|
||||
(select Value1 from Inf where BelongsToFile =
|
||||
(select BelongsToFile from Inf
|
||||
where Value1 = 'FILE_GUID' and Value2 like '%s' and Model = %s)
|
||||
and Model = %s)
|
||||
and ItemType = 'Protocol' and ItemMode = 'Produced'""" \
|
||||
% (ModuleGuid, 5001, 3007)
|
||||
RecordSet = Db.TblReport.Exec(SqlCommand)
|
||||
for Record in RecordSet:
|
||||
SqlCommand = """select Value2 from Inf where BelongsToFile =
|
||||
(select DISTINCT BelongsToFile from Inf
|
||||
where Value1 =
|
||||
(select SourceFileFullPath from Report
|
||||
where GuidValue like '%s' and ItemMode = 'Callback'))
|
||||
and Value1 = 'FILE_GUID'""" % Record[0]
|
||||
CallBackSet = Db.TblReport.Exec(SqlCommand)
|
||||
if CallBackSet != []:
|
||||
EotGlobalData.gProtocolList[Record[0].lower()] = ModuleGuid
|
||||
else:
|
||||
EotGlobalData.gProtocolList[Record[0].lower()] = ModuleGuid
|
||||
|
||||
def LoadPpi(self, Db, ModuleGuid):
|
||||
SqlCommand = """select GuidValue from Report
|
||||
where SourceFileFullPath in
|
||||
(select Value1 from Inf where BelongsToFile =
|
||||
(select BelongsToFile from Inf
|
||||
where Value1 = 'FILE_GUID' and Value2 like '%s' and Model = %s)
|
||||
and Model = %s)
|
||||
and ItemType = 'Ppi' and ItemMode = 'Produced'""" \
|
||||
% (ModuleGuid, 5001, 3007)
|
||||
RecordSet = Db.TblReport.Exec(SqlCommand)
|
||||
for Record in RecordSet:
|
||||
EotGlobalData.gPpiList[Record[0].lower()] = ModuleGuid
|
||||
|
||||
def DisPatchDxe(self, Db):
|
||||
IsInstalled = False
|
||||
ScheduleList = sdict()
|
||||
for FfsID in self.UnDispatchedFfsDict:
|
||||
CouldBeLoaded = False
|
||||
DepexString = ''
|
||||
FileDepex = None
|
||||
Ffs = self.UnDispatchedFfsDict[FfsID]
|
||||
if Ffs.Type == 0x07:
|
||||
# Get Depex
|
||||
IsFoundDepex = False
|
||||
for Section in Ffs.Sections.values():
|
||||
# Find Depex
|
||||
if Section.Type == 0x13:
|
||||
IsFoundDepex = True
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(Section._SubImages[4], 'Protocol')
|
||||
break
|
||||
if Section.Type == 0x01:
|
||||
CompressSections = Section._SubImages[4]
|
||||
for CompressSection in CompressSections.Sections:
|
||||
if CompressSection.Type == 0x13:
|
||||
IsFoundDepex = True
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(CompressSection._SubImages[4], 'Protocol')
|
||||
break
|
||||
if CompressSection.Type == 0x02:
|
||||
NewSections = CompressSection._SubImages[4]
|
||||
for NewSection in NewSections.Sections:
|
||||
if NewSection.Type == 0x13:
|
||||
IsFoundDepex = True
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(NewSection._SubImages[4], 'Protocol')
|
||||
break
|
||||
|
||||
# Not find Depex
|
||||
if not IsFoundDepex:
|
||||
CouldBeLoaded = self.CheckArchProtocol()
|
||||
DepexString = ''
|
||||
FileDepex = None
|
||||
|
||||
# Append New Ffs
|
||||
if CouldBeLoaded:
|
||||
IsInstalled = True
|
||||
NewFfs = self.UnDispatchedFfsDict.pop(FfsID)
|
||||
NewFfs.Depex = DepexString
|
||||
if FileDepex is not None:
|
||||
ScheduleList.insert(FileDepex[1], FfsID, NewFfs, FileDepex[0])
|
||||
else:
|
||||
ScheduleList[FfsID] = NewFfs
|
||||
else:
|
||||
self.UnDispatchedFfsDict[FfsID].Depex = DepexString
|
||||
|
||||
for FfsID in ScheduleList:
|
||||
NewFfs = ScheduleList.pop(FfsID)
|
||||
FfsName = 'UnKnown'
|
||||
self.OrderedFfsDict[FfsID] = NewFfs
|
||||
self.LoadProtocol(Db, FfsID)
|
||||
|
||||
SqlCommand = """select Value2 from Inf
|
||||
where BelongsToFile = (select BelongsToFile from Inf where Value1 = 'FILE_GUID' and lower(Value2) = lower('%s') and Model = %s)
|
||||
and Model = %s and Value1='BASE_NAME'""" % (FfsID, 5001, 5001)
|
||||
RecordSet = Db.TblReport.Exec(SqlCommand)
|
||||
if RecordSet != []:
|
||||
FfsName = RecordSet[0][0]
|
||||
|
||||
if IsInstalled:
|
||||
self.DisPatchDxe(Db)
|
||||
|
||||
def DisPatchPei(self, Db):
|
||||
IsInstalled = False
|
||||
for FfsID in self.UnDispatchedFfsDict:
|
||||
CouldBeLoaded = True
|
||||
DepexString = ''
|
||||
FileDepex = None
|
||||
Ffs = self.UnDispatchedFfsDict[FfsID]
|
||||
if Ffs.Type == 0x06 or Ffs.Type == 0x08:
|
||||
# Get Depex
|
||||
for Section in Ffs.Sections.values():
|
||||
if Section.Type == 0x1B:
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(Section._SubImages[4], 'Ppi')
|
||||
break
|
||||
if Section.Type == 0x01:
|
||||
CompressSections = Section._SubImages[4]
|
||||
for CompressSection in CompressSections.Sections:
|
||||
if CompressSection.Type == 0x1B:
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(CompressSection._SubImages[4], 'Ppi')
|
||||
break
|
||||
if CompressSection.Type == 0x02:
|
||||
NewSections = CompressSection._SubImages[4]
|
||||
for NewSection in NewSections.Sections:
|
||||
if NewSection.Type == 0x1B:
|
||||
CouldBeLoaded, DepexString, FileDepex = self.ParseDepex(NewSection._SubImages[4], 'Ppi')
|
||||
break
|
||||
|
||||
# Append New Ffs
|
||||
if CouldBeLoaded:
|
||||
IsInstalled = True
|
||||
NewFfs = self.UnDispatchedFfsDict.pop(FfsID)
|
||||
NewFfs.Depex = DepexString
|
||||
self.OrderedFfsDict[FfsID] = NewFfs
|
||||
self.LoadPpi(Db, FfsID)
|
||||
else:
|
||||
self.UnDispatchedFfsDict[FfsID].Depex = DepexString
|
||||
|
||||
if IsInstalled:
|
||||
self.DisPatchPei(Db)
|
||||
|
||||
|
||||
def __str__(self):
|
||||
global gIndention
|
||||
gIndention += 4
|
||||
FvInfo = '\n' + ' ' * gIndention
|
||||
FvInfo += "[FV:%s] file_system=%s size=%x checksum=%s\n" % (self.Name, self.FileSystemGuid, self.Size, self.Checksum)
|
||||
FfsInfo = "\n".join([str(self.FfsDict[FfsId]) for FfsId in self.FfsDict])
|
||||
gIndention -= 4
|
||||
return FvInfo + FfsInfo
|
||||
|
||||
def _Unpack(self):
|
||||
Size = self._LENGTH_.unpack_from(self._BUF_, self._OFF_)[0]
|
||||
self.empty()
|
||||
self.extend(self._BUF_[self._OFF_:self._OFF_+Size])
|
||||
|
||||
# traverse the FFS
|
||||
EndOfFv = Size
|
||||
FfsStartAddress = self.HeaderSize
|
||||
LastFfsObj = None
|
||||
while FfsStartAddress < EndOfFv:
|
||||
FfsObj = Ffs()
|
||||
FfsObj.frombuffer(self, FfsStartAddress)
|
||||
FfsId = repr(FfsObj)
|
||||
if ((self.Attributes & 0x00000800) != 0 and len(FfsObj) == 0xFFFFFF) \
|
||||
or ((self.Attributes & 0x00000800) == 0 and len(FfsObj) == 0):
|
||||
if LastFfsObj is not None:
|
||||
LastFfsObj.FreeSpace = EndOfFv - LastFfsObj._OFF_ - len(LastFfsObj)
|
||||
else:
|
||||
if FfsId in self.FfsDict:
|
||||
EdkLogger.error("FV", 0, "Duplicate GUID in FFS",
|
||||
ExtraData="\t%s @ %s\n\t%s @ %s" \
|
||||
% (FfsObj.Guid, FfsObj.Offset,
|
||||
self.FfsDict[FfsId].Guid, self.FfsDict[FfsId].Offset))
|
||||
self.FfsDict[FfsId] = FfsObj
|
||||
if LastFfsObj is not None:
|
||||
LastFfsObj.FreeSpace = FfsStartAddress - LastFfsObj._OFF_ - len(LastFfsObj)
|
||||
|
||||
FfsStartAddress += len(FfsObj)
|
||||
#
|
||||
# align to next 8-byte aligned address: A = (A + 8 - 1) & (~(8 - 1))
|
||||
# The next FFS must be at the latest next 8-byte aligned address
|
||||
#
|
||||
FfsStartAddress = (FfsStartAddress + 7) & (~7)
|
||||
LastFfsObj = FfsObj
|
||||
|
||||
def _GetAttributes(self):
|
||||
return self.GetField(self._ATTR_, 0)[0]
|
||||
|
||||
def _GetSize(self):
|
||||
return self.GetField(self._LENGTH_, 0)[0]
|
||||
|
||||
def _GetChecksum(self):
|
||||
return self.GetField(self._CHECKSUM_, 0)[0]
|
||||
|
||||
def _GetHeaderLength(self):
|
||||
return self.GetField(self._HLEN_, 0)[0]
|
||||
|
||||
def _GetFileSystemGuid(self):
|
||||
return gGuidStringFormat % self.GetField(self._GUID_, 0)
|
||||
|
||||
Attributes = property(_GetAttributes)
|
||||
Size = property(_GetSize)
|
||||
Checksum = property(_GetChecksum)
|
||||
HeaderSize = property(_GetHeaderLength)
|
||||
FileSystemGuid = property(_GetFileSystemGuid)
|
||||
|
||||
## MultipleFv() class
|
||||
#
|
||||
# A class for Multiple FV
|
||||
|
||||
Reference in New Issue
Block a user