ArmPlatformPkg/DS-5: fix 64-bit PE/COFF header parsing bug

[mirror_edk2.git] / ArmPlatformPkg / Scripts / Ds5 / firmware_volume.py

#\r
#  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
#\r
#  This program and the accompanying materials\r
#  are licensed and made available under the terms and conditions of the BSD License\r
#  which accompanies this distribution.  The full text of the license may be found at\r
#  http://opensource.org/licenses/bsd-license.php\r
#\r
#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
from arm_ds.debugger_v1 import DebugException\r
\r
import struct\r
import string\r
\r
import edk2_debugger\r
\r
class EfiFileSection(object):\r
    EFI_SECTION_PE32                  = 0x10\r
    EFI_SECTION_PIC                   = 0x11\r
    EFI_SECTION_TE                    = 0x12\r
\r
    EFI_IMAGE_DEBUG_TYPE_CODEVIEW     = 0x2\r
\r
    SIZEOF_EFI_FFS_FILE_HEADER        = 0x28\r
\r
    def __init__(self, ec, base):\r
        self.base = base\r
        self.ec = ec\r
\r
    def __str__(self):\r
        return "FileSection(type:0x%X, size:0x%x)" % (self.get_type(), self.get_size())\r
\r
    def get_base(self):\r
        return self.base\r
\r
    def get_type(self):\r
        return struct.unpack("B", self.ec.getMemoryService().read(self.base + 0x3, 1, 8))[0]\r
\r
    def get_size(self):\r
        return (struct.unpack("<I", self.ec.getMemoryService().read(self.base, 4, 32))[0] & 0x00ffffff)\r
\r
    def get_debug_filepath(self):\r
        type = self.get_type()\r
        if type == EfiFileSection.EFI_SECTION_TE:\r
            section = EfiSectionTE(self, ec, self.base + 0x4)\r
        elif type == EfiFileSection.EFI_SECTION_PE32:\r
            section = EfiSectionPE32(self, ec, self.base + 0x4)\r
        else:\r
            raise Exception("EfiFileSection", "No debug section")\r
        return section.get_debug_filepath()\r
\r
class EfiSectionTE:\r
    SIZEOF_EFI_TE_IMAGE_HEADER        = 0x28\r
    EFI_TE_IMAGE_SIGNATURE            = ('V','Z')\r
\r
    def __init__(self, ec, base_te):\r
        self.ec = ec\r
        self.base_te = int(base_te)\r
        te_sig = struct.unpack("cc", self.ec.getMemoryService().read(self.base_te, 2, 32))\r
        if te_sig != EfiSectionTE.EFI_TE_IMAGE_SIGNATURE:\r
            raise Exception("EfiFileSectionTE","TE Signature incorrect")\r
\r
    def get_debug_filepath(self):\r
        stripped_size = struct.unpack("<H", self.ec.getMemoryService().read(self.base_te + 0x6, 2, 32))[0]\r
        stripped_size -= EfiSectionTE.SIZEOF_EFI_TE_IMAGE_HEADER\r
\r
        debug_dir_entry_rva = self.ec.getMemoryService().readMemory32(self.base_te + 0x20)\r
        if debug_dir_entry_rva == 0:\r
            raise Exception("EfiFileSectionTE","No debug directory for image")\r
        debug_dir_entry_rva -= stripped_size\r
\r
        debug_type = self.ec.getMemoryService().readMemory32(self.base_te + debug_dir_entry_rva + 0xC)\r
        if (debug_type != 0xdf) and (debug_type != EfiFileSection.EFI_IMAGE_DEBUG_TYPE_CODEVIEW):\r
            raise Exception("EfiFileSectionTE","Debug type is not dwarf")\r
\r
        debug_rva = self.ec.getMemoryService().readMemory32(self.base_te + debug_dir_entry_rva + 0x14)\r
        debug_rva -= stripped_size\r
\r
        dwarf_sig = struct.unpack("cccc", self.ec.getMemoryService().read(self.base_te + debug_rva, 4, 32))\r
        if (dwarf_sig != 0x66727764) and (dwarf_sig != FirmwareFile.CONST_NB10_SIGNATURE):\r
            raise Exception("EfiFileSectionTE","Dwarf debug signature not found")\r
\r
        if dwarf_sig == 0x66727764:\r
            filename = self.base_te + debug_rva + 0xc\r
        else:\r
            filename = self.base_te + debug_rva + 0x10\r
        filename = struct.unpack("200s", self.ec.getMemoryService().read(filename, 200, 32))[0]\r
        return filename[0:string.find(filename,'\0')]\r
\r
    def get_debug_elfbase(self):\r
        stripped_size = struct.unpack("<H", self.ec.getMemoryService().read(self.base_te + 0x6, 2, 32))[0]\r
        stripped_size -= EfiSectionTE.SIZEOF_EFI_TE_IMAGE_HEADER\r
\r
        return self.base_te - stripped_size\r
\r
class EfiSectionPE32:\r
    def __init__(self, ec, base_pe32):\r
        self.ec = ec\r
        self.base_pe32 = base_pe32\r
\r
    def get_debug_filepath(self):\r
        # Offset from dos hdr to PE file hdr\r
        file_header_offset = self.ec.getMemoryService().readMemory32(self.base_pe32 + 0x3C)\r
\r
        # Offset to debug dir in PE hdrs\r
        debug_dir_entry_rva = self.ec.getMemoryService().readMemory32(self.base_pe32 + file_header_offset + 0xA8)\r
        if debug_dir_entry_rva == 0:\r
            raise Exception("EfiFileSectionPE32","No Debug Directory")\r
\r
        debug_type = self.ec.getMemoryService().readMemory32(self.base_pe32 + debug_dir_entry_rva + 0xC)\r
        if (debug_type != 0xdf) and (debug_type != EfiFileSection.EFI_IMAGE_DEBUG_TYPE_CODEVIEW):\r
            raise Exception("EfiFileSectionPE32","Debug type is not dwarf")\r
\r
\r
        debug_rva = self.ec.getMemoryService().readMemory32(self.base_pe32 + debug_dir_entry_rva + 0x14)\r
\r
        dwarf_sig = struct.unpack("cccc", self.ec.getMemoryService().read(str(self.base_pe32 + debug_rva), 4, 32))\r
        if (dwarf_sig != 0x66727764) and (dwarf_sig != FirmwareFile.CONST_NB10_SIGNATURE):\r
            raise Exception("EfiFileSectionPE32","Dwarf debug signature not found")\r
\r
        if dwarf_sig == 0x66727764:\r
            filename = self.base_pe32 + debug_rva + 0xc\r
        else:\r
            filename = self.base_pe32 + debug_rva + 0x10\r
        filename = struct.unpack("200s", self.ec.getMemoryService().read(str(filename), 200, 32))[0]\r
        return filename[0:string.find(filename,'\0')]\r
\r
    def get_debug_elfbase(self):\r
        return self.base_pe32\r
\r
class EfiSectionPE64:\r
    def __init__(self, ec, base_pe64):\r
        self.ec = ec\r
        self.base_pe64 = base_pe64\r
\r
    def get_debug_filepath(self):\r
        # Offset from dos hdr to PE file hdr (EFI_IMAGE_NT_HEADERS64)\r
        file_header_offset = self.ec.getMemoryService().readMemory32(self.base_pe64 + 0x3C)\r
\r
        # Offset to debug dir in PE hdrs\r
        debug_dir_entry_rva = self.ec.getMemoryService().readMemory32(self.base_pe64 + file_header_offset + 0xB8)\r
        if debug_dir_entry_rva == 0:\r
            raise Exception("EfiFileSectionPE64","No Debug Directory")\r
\r
        debug_type = self.ec.getMemoryService().readMemory32(self.base_pe64 + debug_dir_entry_rva + 0xC)\r
        if (debug_type != 0xdf) and (debug_type != EfiFileSection.EFI_IMAGE_DEBUG_TYPE_CODEVIEW):\r
            raise Exception("EfiFileSectionPE64","Debug type is not dwarf")\r
\r
\r
        debug_rva = self.ec.getMemoryService().readMemory32(self.base_pe64 + debug_dir_entry_rva + 0x14)\r
\r
        dwarf_sig = struct.unpack("cccc", self.ec.getMemoryService().read(str(self.base_pe64 + debug_rva), 4, 32))\r
        if (dwarf_sig != 0x66727764) and (dwarf_sig != FirmwareFile.CONST_NB10_SIGNATURE):\r
            raise Exception("EfiFileSectionPE64","Dwarf debug signature not found")\r
\r
        if dwarf_sig == 0x66727764:\r
            filename = self.base_pe64 + debug_rva + 0xc\r
        else:\r
            filename = self.base_pe64 + debug_rva + 0x10\r
        filename = struct.unpack("200s", self.ec.getMemoryService().read(str(filename), 200, 32))[0]\r
        return filename[0:string.find(filename,'\0')]\r
\r
    def get_debug_elfbase(self):\r
        return self.base_pe64\r
\r
class FirmwareFile:\r
    EFI_FV_FILETYPE_RAW                   = 0x01\r
    EFI_FV_FILETYPE_FREEFORM              = 0x02\r
    EFI_FV_FILETYPE_SECURITY_CORE         = 0x03\r
    EFI_FV_FILETYPE_PEI_CORE              = 0x04\r
    EFI_FV_FILETYPE_DXE_CORE              = 0x05\r
    EFI_FV_FILETYPE_PEIM                  = 0x06\r
    EFI_FV_FILETYPE_DRIVER                = 0x07\r
    EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER  = 0x08\r
    EFI_FV_FILETYPE_APPLICATION           = 0x09\r
    EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE = 0x0B\r
    EFI_FV_FILETYPE_FFS_MIN               = 0xF0\r
\r
    CONST_NB10_SIGNATURE = ('N','B','1','0')\r
\r
    def __init__(self, fv, base, ec):\r
        self.fv = fv\r
        self.base = base\r
        self.ec = ec\r
\r
    def __str__(self):\r
        return "FFS(state:0x%x, type:0x%X, size:0x%x)" % (self.get_state(), self.get_type(), self.get_size())\r
\r
    def get_base(self):\r
        return self.base\r
\r
    def get_size(self):\r
        size = (self.ec.getMemoryService().readMemory32(self.base + 0x14) & 0x00ffffff)\r
\r
        # Occupied size is the size considering the alignment\r
        return size + ((0x8 - (size & 0x7)) & 0x7)\r
\r
    def get_type(self):\r
        return self.ec.getMemoryService().readMemory8(self.base + 0x12)\r
\r
    def get_state(self):\r
        state = self.ec.getMemoryService().readMemory8(self.base + 0x17)\r
\r
        polarity = self.fv.get_polarity()\r
        if polarity:\r
            state = ~state\r
\r
        highest_bit = 0x80;\r
        while (highest_bit != 0) and ((highest_bit & state) == 0):\r
            highest_bit >>= 1\r
\r
        return highest_bit\r
\r
    def get_next_section(self, section=None):\r
        if section == None:\r
            if self.get_type() != FirmwareFile.EFI_FV_FILETYPE_FFS_MIN:\r
                section_base = self.get_base() + 0x18;\r
            else:\r
                return None\r
        else:\r
            section_base = int(section.get_base() + section.get_size())\r
\r
            # Align to next 4 byte boundary\r
            if (section_base & 0x3) != 0:\r
                section_base = section_base + 0x4 - (section_base & 0x3)\r
\r
        if section_base < self.get_base() + self.get_size():\r
            return EfiFileSection(self.ec, section_base)\r
        else:\r
            return None\r
\r
class FirmwareVolume:\r
    CONST_FV_SIGNATURE = ('_','F','V','H')\r
    EFI_FVB2_ERASE_POLARITY = 0x800\r
\r
    DebugInfos = []\r
\r
    def __init__(self, ec, fv_base, fv_size):\r
        self.ec = ec\r
        self.fv_base = fv_base\r
        self.fv_size = fv_size\r
\r
        try:\r
            signature = struct.unpack("cccc", self.ec.getMemoryService().read(fv_base + 0x28, 4, 32))\r
        except DebugException:\r
            raise Exception("FirmwareVolume", "Not possible to access the defined firmware volume at [0x%X,0x%X]. Could be the used build report does not correspond to your current debugging context." % (int(fv_base),int(fv_base+fv_size)))\r
        if signature != FirmwareVolume.CONST_FV_SIGNATURE:\r
            raise Exception("FirmwareVolume", "This is not a valid firmware volume")\r
\r
    def get_size(self):\r
        return self.ec.getMemoryService().readMemory32(self.fv_base + 0x20)\r
\r
    def get_attributes(self):\r
        return self.ec.getMemoryService().readMemory32(self.fv_base + 0x2C)\r
\r
    def get_polarity(self):\r
        attributes = self.get_attributes()\r
        if attributes & FirmwareVolume.EFI_FVB2_ERASE_POLARITY:\r
            return 1\r
        else:\r
            return 0\r
\r
    def get_next_ffs(self, ffs=None):\r
        if ffs == None:\r
            # Get the offset of the first FFS file from the FV header\r
            ffs_base = self.fv_base +  self.ec.getMemoryService().readMemory16(self.fv_base + 0x30)\r
        else:\r
            # Goto the next FFS file\r
            ffs_base = int(ffs.get_base() + ffs.get_size())\r
\r
            # Align to next 8 byte boundary\r
            if (ffs_base & 0x7) != 0:\r
                ffs_base = ffs_base + 0x8 - (ffs_base & 0x7)\r
\r
        if ffs_base < self.fv_base + self.get_size():\r
            return FirmwareFile(self, ffs_base, self.ec)\r
        else:\r
            return None\r
\r
    def get_debug_info(self):\r
        self.DebugInfos = []\r
\r
        ffs = self.get_next_ffs()\r
        while ffs != None:\r
            section = ffs.get_next_section()\r
            while section != None:\r
                type = section.get_type()\r
                if (type == EfiFileSection.EFI_SECTION_TE) or (type == EfiFileSection.EFI_SECTION_PE32):\r
                    self.DebugInfos.append((section.get_base(), section.get_size(), section.get_type()))\r
                section = ffs.get_next_section(section)\r
            ffs = self.get_next_ffs(ffs)\r
\r
    def load_symbols_at(self, addr, verbose = False):\r
        if self.DebugInfos == []:\r
            self.get_debug_info()\r
\r
        for debug_info in self.DebugInfos:\r
            if (addr >= debug_info[0]) and (addr < debug_info[0] + debug_info[1]):\r
                if debug_info[2] == EfiFileSection.EFI_SECTION_TE:\r
                    section = EfiSectionTE(self.ec, debug_info[0] + 0x4)\r
                elif debug_info[2] == EfiFileSection.EFI_SECTION_PE32:\r
                    section = EfiSectionPE32(self.ec, debug_info[0] + 0x4)\r
                else:\r
                    raise Exception('FirmwareVolume','Section Type not supported')\r
\r
                try:\r
                    edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
                except Exception, (ErrorClass, ErrorMessage):\r
                    if verbose:\r
                        print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
\r
                return debug_info\r
\r
    def load_all_symbols(self, verbose = False):\r
        if self.DebugInfos == []:\r
            self.get_debug_info()\r
\r
        for debug_info in self.DebugInfos:\r
            if debug_info[2] == EfiFileSection.EFI_SECTION_TE:\r
                section = EfiSectionTE(self.ec, debug_info[0] + 0x4)\r
            elif debug_info[2] == EfiFileSection.EFI_SECTION_PE32:\r
                section = EfiSectionPE32(self.ec, debug_info[0] + 0x4)\r
            else:\r
                continue\r
\r
            try:\r
                edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)\r
            except Exception, (ErrorClass, ErrorMessage):\r
                if verbose:\r
                    print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)\r
\r