ArmPlatformPkg/Scripts/Ds5/system_table.py

   1 #
   2 #  Copyright (c) 2011-2013, ARM Limited. All rights reserved.
   3 #
   4 #  This program and the accompanying materials
   5 #  are licensed and made available under the terms and conditions of the BSD License
   6 #  which accompanies this distribution.  The full text of the license may be found at
   7 #  http://opensource.org/licenses/bsd-license.php
   8 #
   9 #  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11 #
  12
  13 from arm_ds.debugger_v1 import DebugException
  14
  15 import struct
  16
  17 import edk2_debugger
  18 import firmware_volume
  19
  20 class DebugInfoTable:
  21     CONST_DEBUG_INFO_TABLE_GUID = ( 0x49152E77L, 0x47641ADAL, 0xFE7AA2B7L, 0x8B5ED9FEL)
  22
  23     DebugInfos = []
  24
  25     def __init__(self, ec, debug_info_table_header_offset):
  26         self.ec = ec
  27         self.base = debug_info_table_header_offset
  28
  29     def get_debug_info(self):
  30         count = self.ec.getMemoryService().readMemory32(self.base + 0x4)
  31         debug_info_table_base = self.ec.getMemoryService().readMemory32(self.base + 0x8)
  32
  33         self.DebugInfos = []
  34
  35         for i in range(0, count):
  36             # Get the address of the structure EFI_DEBUG_IMAGE_INFO
  37             debug_info = self.ec.getMemoryService().readMemory32(debug_info_table_base + (i * 4))
  38             if debug_info:
  39                 debug_info_type = self.ec.getMemoryService().readMemory32(debug_info)
  40                 # Normal Debug Info Type
  41                 if debug_info_type == 1:
  42                     # Get the base address of the structure EFI_LOADED_IMAGE_PROTOCOL
  43                     loaded_image_protocol = self.ec.getMemoryService().readMemory32(debug_info + 0x4)
  44
  45                     image_base = self.ec.getMemoryService().readMemory32(loaded_image_protocol + 0x20)
  46                     image_size = self.ec.getMemoryService().readMemory32(loaded_image_protocol + 0x28)
  47
  48                     self.DebugInfos.append((image_base,image_size))
  49
  50     # Return (base, size)
  51     def load_symbols_at(self, addr, verbose = False):
  52         if self.DebugInfos == []:
  53             self.get_debug_info()
  54
  55         found = False
  56         for debug_info in self.DebugInfos:
  57             if (addr >= debug_info[0]) and (addr < debug_info[0] + debug_info[1]):
  58                 section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])
  59
  60                 try:
  61                     edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)
  62                 except Exception, (ErrorClass, ErrorMessage):
  63                     if verbose:
  64                         print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)
  65                     pass
  66
  67                 found = True
  68                 return debug_info
  69
  70         if found == False:
  71             raise Exception('DebugInfoTable','No symbol found at 0x%x' % addr)
  72
  73     def load_all_symbols(self, verbose = False):
  74         if self.DebugInfos == []:
  75             self.get_debug_info()
  76
  77         for debug_info in self.DebugInfos:
  78             section = firmware_volume.EfiSectionPE32(self.ec, debug_info[0])
  79
  80             try:
  81                 edk2_debugger.load_symbol_from_file(self.ec, section.get_debug_filepath(), section.get_debug_elfbase(), verbose)
  82             except Exception, (ErrorClass, ErrorMessage):
  83                 if verbose:
  84                     print "Error while loading a symbol file (%s: %s)" % (ErrorClass, ErrorMessage)
  85                 pass
  86
  87     def dump(self):
  88         self.get_debug_info()
  89         for debug_info in self.DebugInfos:
  90             base_pe32 = debug_info[0]
  91             section = firmware_volume.EfiSectionPE32(self.ec, base_pe32)
  92             print section.get_debug_filepath()
  93
  94 class SystemTable:
  95     CONST_ST_SIGNATURE = ('I','B','I',' ','S','Y','S','T')
  96
  97     def __init__(self, ec, membase, memsize):
  98         self.membase = membase
  99         self.memsize = memsize
 100         self.ec = ec
 101
 102         found = False
 103
 104         # Start from the top of the memory
 105         offset = self.membase + self.memsize
 106         # Align to highest 4MB boundary
 107         offset = offset & ~0x3FFFFF
 108         # We should not have a System Table at the top of the System Memory
 109         offset = offset - 0x400000
 110
 111         # Start at top and look on 4MB boundaries for system table ptr structure
 112         while offset > self.membase:
 113             try:
 114                 signature = struct.unpack("cccccccc", self.ec.getMemoryService().read(str(offset), 8, 32))
 115             except DebugException:
 116                 raise Exception('SystemTable','Fail to access System Memory. Ensure all the memory in the region [0x%x;0x%X] is accessible.' % (membase,membase+memsize))
 117             if signature == SystemTable.CONST_ST_SIGNATURE:
 118                 found = True
 119                 self.system_table_base = self.ec.getMemoryService().readMemory32(offset + 0x8)
 120                 break
 121             offset = offset - 0x400000
 122
 123         if not found:
 124             raise Exception('SystemTable','System Table not found in System Memory [0x%x;0x%X]' % (membase,membase+memsize))
 125
 126     def get_configuration_table(self, conf_table_guid):
 127         # Number of configuration Table entry
 128         conf_table_entry_count = self.ec.getMemoryService().readMemory32(self.system_table_base + 0x40)
 129
 130         # Get location of the Configuration Table entries
 131         conf_table_offset = self.ec.getMemoryService().readMemory32(self.system_table_base + 0x44)
 132
 133         for i in range(0, conf_table_entry_count):
 134             offset = conf_table_offset + (i * 0x14)
 135             guid = struct.unpack("<IIII", self.ec.getMemoryService().read(str(offset), 16, 32))
 136             if guid == conf_table_guid:
 137                 return self.ec.getMemoryService().readMemory32(offset + 0x10)
 138
 139         raise Exception('SystemTable','Configuration Table not found')