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

#
#  Copyright (c) 2011-2012, ARM Limited. All rights reserved.
#  
#  This program and the accompanying materials                          
#  are licensed and made available under the terms and conditions of the BSD License         
#  which accompanies this distribution.  The full text of the license may be found at        
#  http://opensource.org/licenses/bsd-license.php                                            
#
#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
#

import os

import firmware_volume
import build_report
import system_table

# Reload external classes
reload(firmware_volume)
reload(build_report)
reload(system_table)

def readMem32(executionContext, address):
    bytes = executionContext.getMemoryService().read(address, 4, 32)
    return struct.unpack('<I',bytes)[0]

def dump_fv(ec, fv_base, fv_size):
    fv = firmware_volume.FirmwareVolume(ec,
                                        int(build.PCDs['gArmTokenSpaceGuid']['PcdFvBaseAddress'][0],16),
                                        int(build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16))
    
    ffs = fv.get_next_ffs()
    while ffs != None:    
        print "# %s" % ffs
    
        section = ffs.get_next_section()
        while section != None:
            print "\t%s" % section
            try:
                print "\t\t- %s" % section.get_debug_filepath()
            except Exception:
                pass
            section = ffs.get_next_section(section)
            
        ffs = fv.get_next_ffs(ffs)

def dump_system_table(ec, mem_base, mem_size):
    st = system_table.SystemTable(ec, mem_base, mem_size)
    
    debug_info_table_base = st.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
    
    debug_info_table = system_table.DebugInfoTable(ec, debug_info_table_base)
    debug_info_table.dump()

def load_symbol_from_file(ec, filename, address):
    try:
        ec.getImageService().addSymbols(filename, address)
    except:
        try:
            # We could get an exception if the symbols are already loaded
            ec.getImageService().unloadSymbols(filename)
            ec.getImageService().addSymbols(filename, address)
        except:
            print "Warning: not possible to load symbols from %s" % filename
            pass

class ArmPlatform:
    def __init__(self, sysmembase=None, sysmemsize=None, fvs={}):
        self.sysmembase = sysmembase
        self.sysmemsize = sysmemsize
        self.fvs = fvs
        
class ArmPlatformDebugger:
    system_table = None
    firmware_volumes = {}
    
    REGION_TYPE_SYSMEM = 1
    REGION_TYPE_ROM    = 2
    REGION_TYPE_FV     = 3
    
    def __init__(self, ec, report_log, regions):
        self.ec = ec
        fvs = []
        sysmem_base = None
        sysmem_size = None
        
        if report_log and os.path.isfile(report_log):
            try:
                self.build = build_report.BuildReport(report_log)
            except IOError:
                raise IOError(2, 'Report \'%s\' isnot valid' % report_log)
            
            # Generate list of supported Firmware Volumes
            if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16) != 0:
                fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16)))
            if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdSecureFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvSize'][0],16) != 0:
                fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvSize'][0],16)))
            if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdHypFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvSize'][0],16) != 0:
                fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvSize'][0],16)))
            
            sysmem_base = int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSystemMemoryBase'][0],16)
            sysmem_size = int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSystemMemorySize'][0],16)
        else:
            for region in regions:
                if region[0] == ArmPlatformDebugger.REGION_TYPE_SYSMEM:
                    sysmem_base = region[1]
                    sysmem_size = region[2]
                elif region[0] == ArmPlatformDebugger.REGION_TYPE_FV:
                    fvs.append((region[1],region[2]))
                elif region[0] == ArmPlatformDebugger.REGION_TYPE_ROM:
                    for base in xrange(region[1], region[1] + region[2], 0x400000):
                        signature = struct.unpack("cccc", self.ec.getMemoryService().read(base, 4, 32))
                        if signature == FirmwareVolume.CONST_FV_SIGNATURE:
                            fvs.append((base,0))
                else:
                    print "Region type '%d' Not Supported" % region[0]
                    
        self.platform = ArmPlatform(sysmem_base, sysmem_size, fvs)
        
    def in_sysmem(self, addr):
        return (self.platform.sysmembase is not None) and (self.platform.sysmembase <= addr) and (addr < self.platform.sysmembase + self.platform.sysmemsize)

    def in_fv(self, addr):
        return (self.get_fv_at(addr) != None)

    def get_fv_at(self, addr):
        for fv in self.platform.fvs:
            if (fv[0] <= addr) and (addr < fv[0] + fv[1]):
                return fv
        return None

    def load_current_symbols(self):
        pc = int(self.ec.getRegisterService().getValue('PC')) & 0xFFFFFFFF
        if self.in_fv(pc):
            debug_infos = []
            
            (fv_base, fv_size) = self.get_fv_at(pc)
            
            if self.firmware_volumes.has_key(fv_base) == False:
                self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)
                
            stack_frame = self.ec.getTopLevelStackFrame()
            info = self.firmware_volumes[fv_base].load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)
            debug_infos.append(info)
            while stack_frame.next() is not None:
                stack_frame = stack_frame.next()
                
                # Stack frame attached to 'PC'
                pc = int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF
                
                # Check if the symbols for this stack frame have already been loaded
                found = False
                for debug_info in debug_infos:
                    if (pc >= debug_info[0]) and (pc < debug_info[0] + debug_info[1]):
                        found = True
                if found == False:
                    info = self.firmware_volumes[fv_base].load_symbols_at(pc)
                    debug_infos.append(info)
                    
            #self.firmware_volumes[fv_base].load_symbols_at(pc)
        elif self.in_sysmem(pc):
            debug_infos = []
            
            if self.system_table is None:
                # Find the System Table
                self.system_table = system_table.SystemTable(self.ec, self.platform.sysmembase, self.platform.sysmemsize)
                
                # Find the Debug Info Table
                debug_info_table_base = self.system_table.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
                self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)
                
            stack_frame = self.ec.getTopLevelStackFrame()
            info = self.debug_info_table.load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)
            debug_infos.append(info)
            while stack_frame.next() is not None:
                stack_frame = stack_frame.next()
                
                # Stack frame attached to 'PC'
                pc = int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF
                
                # Check if the symbols for this stack frame have already been loaded
                found = False
                for debug_info in debug_infos:
                    if (pc >= debug_info[0]) and (pc < debug_info[0] + debug_info[1]):
                        found = True
                if found == False:
                    info = self.debug_info_table.load_symbols_at(pc)
                    debug_infos.append(info)
                
            #self.debug_info_table.load_symbols_at(pc)
        else:
            raise Exception('ArmPlatformDebugger', "Not supported region")
        
    def load_all_symbols(self):
        # Load all the XIP symbols attached to the Firmware Volume
        for (fv_base, fv_size) in self.platform.fvs:
            if self.firmware_volumes.has_key(fv_base) == False:
                self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)    
            self.firmware_volumes[fv_base].load_all_symbols()

        try:
            # Load all symbols of module loaded into System Memory
            if self.system_table is None:
                # Find the System Table
                self.system_table = system_table.SystemTable(self.ec, self.platform.sysmembase, self.platform.sysmemsize)
        
                
                # Find the Debug Info Table
                debug_info_table_base = self.system_table.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
                self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)
            
            self.debug_info_table.load_all_symbols()
        except:
            # Debugger exception could be excepted if DRAM has not been initialized or if we have not started to run from DRAM yet
            print "Note: no symbols have been found in System Memory (possible cause: the UEFI permanent memory has been installed yet)"
            pass
Commit	Line	Data
a8e812de	1	#
	2	# Copyright (c) 2011-2012, 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	import os
	14
	15	import firmware_volume
	16	import build_report
	17	import system_table
	18
	19	# Reload external classes
	20	reload(firmware_volume)
	21	reload(build_report)
	22	reload(system_table)
	23
	24	def readMem32(executionContext, address):
	25	bytes = executionContext.getMemoryService().read(address, 4, 32)
	26	return struct.unpack('<I',bytes)[0]
	27
	28	def dump_fv(ec, fv_base, fv_size):
	29	fv = firmware_volume.FirmwareVolume(ec,
	30	int(build.PCDs['gArmTokenSpaceGuid']['PcdFvBaseAddress'][0],16),
	31	int(build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16))
	32
	33	ffs = fv.get_next_ffs()
	34	while ffs != None:
	35	print "# %s" % ffs
	36
	37	section = ffs.get_next_section()
	38	while section != None:
	39	print "\t%s" % section
	40	try:
	41	print "\t\t- %s" % section.get_debug_filepath()
	42	except Exception:
	43	pass
	44	section = ffs.get_next_section(section)
	45
	46	ffs = fv.get_next_ffs(ffs)
	47
	48	def dump_system_table(ec, mem_base, mem_size):
	49	st = system_table.SystemTable(ec, mem_base, mem_size)
	50
	51	debug_info_table_base = st.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
	52
	53	debug_info_table = system_table.DebugInfoTable(ec, debug_info_table_base)
	54	debug_info_table.dump()
	55
	56	def load_symbol_from_file(ec, filename, address):
	57	try:
6e9ed5b8	58	ec.getImageService().addSymbols(filename, address)
a8e812de	59	except:
6e9ed5b8	60	try:
	61	# We could get an exception if the symbols are already loaded
	62	ec.getImageService().unloadSymbols(filename)
	63	ec.getImageService().addSymbols(filename, address)
	64	except:
	65	print "Warning: not possible to load symbols from %s" % filename
	66	pass
a8e812de	67
	68	class ArmPlatform:
	69	def __init__(self, sysmembase=None, sysmemsize=None, fvs={}):
	70	self.sysmembase = sysmembase
	71	self.sysmemsize = sysmemsize
	72	self.fvs = fvs
	73
	74	class ArmPlatformDebugger:
	75	system_table = None
	76	firmware_volumes = {}
	77
	78	REGION_TYPE_SYSMEM = 1
	79	REGION_TYPE_ROM = 2
	80	REGION_TYPE_FV = 3
	81
	82	def __init__(self, ec, report_log, regions):
	83	self.ec = ec
	84	fvs = []
	85	sysmem_base = None
	86	sysmem_size = None
	87
	88	if report_log and os.path.isfile(report_log):
	89	try:
	90	self.build = build_report.BuildReport(report_log)
	91	except IOError:
	92	raise IOError(2, 'Report \'%s\' isnot valid' % report_log)
	93
	94	# Generate list of supported Firmware Volumes
	95	if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16) != 0:
	96	fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdFvSize'][0],16)))
	97	if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdSecureFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvSize'][0],16) != 0:
	98	fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSecureFvSize'][0],16)))
	99	if self.build.PCDs['gArmTokenSpaceGuid'].has_key('PcdHypFvSize') and int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvSize'][0],16) != 0:
	100	fvs.append((int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvBaseAddress'][0],16),int(self.build.PCDs['gArmTokenSpaceGuid']['PcdHypFvSize'][0],16)))
	101
	102	sysmem_base = int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSystemMemoryBase'][0],16)
	103	sysmem_size = int(self.build.PCDs['gArmTokenSpaceGuid']['PcdSystemMemorySize'][0],16)
	104	else:
	105	for region in regions:
	106	if region[0] == ArmPlatformDebugger.REGION_TYPE_SYSMEM:
	107	sysmem_base = region[1]
	108	sysmem_size = region[2]
	109	elif region[0] == ArmPlatformDebugger.REGION_TYPE_FV:
	110	fvs.append((region[1],region[2]))
	111	elif region[0] == ArmPlatformDebugger.REGION_TYPE_ROM:
	112	for base in xrange(region[1], region[1] + region[2], 0x400000):
	113	signature = struct.unpack("cccc", self.ec.getMemoryService().read(base, 4, 32))
	114	if signature == FirmwareVolume.CONST_FV_SIGNATURE:
	115	fvs.append((base,0))
	116	else:
	117	print "Region type '%d' Not Supported" % region[0]
	118
	119	self.platform = ArmPlatform(sysmem_base, sysmem_size, fvs)
	120
	121	def in_sysmem(self, addr):
	122	return (self.platform.sysmembase is not None) and (self.platform.sysmembase <= addr) and (addr < self.platform.sysmembase + self.platform.sysmemsize)
	123
	124	def in_fv(self, addr):
	125	return (self.get_fv_at(addr) != None)
	126
	127	def get_fv_at(self, addr):
	128	for fv in self.platform.fvs:
	129	if (fv[0] <= addr) and (addr < fv[0] + fv[1]):
	130	return fv
131	return None
132
133	def load_current_symbols(self):
134	pc = int(self.ec.getRegisterService().getValue('PC')) & 0xFFFFFFFF
135	if self.in_fv(pc):
136	debug_infos = []
137
138	(fv_base, fv_size) = self.get_fv_at(pc)
139
140	if self.firmware_volumes.has_key(fv_base) == False:
141	self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)
142
143	stack_frame = self.ec.getTopLevelStackFrame()
144	info = self.firmware_volumes[fv_base].load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)
145	debug_infos.append(info)
146	while stack_frame.next() is not None:
147	stack_frame = stack_frame.next()
148
149	# Stack frame attached to 'PC'
150	pc = int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF
151
152	# Check if the symbols for this stack frame have already been loaded
153	found = False
154	for debug_info in debug_infos:
155	if (pc >= debug_info[0]) and (pc < debug_info[0] + debug_info[1]):
156	found = True
157	if found == False:
158	info = self.firmware_volumes[fv_base].load_symbols_at(pc)
159	debug_infos.append(info)
160
161	#self.firmware_volumes[fv_base].load_symbols_at(pc)
162	elif self.in_sysmem(pc):
163	debug_infos = []
164
165	if self.system_table is None:
166	# Find the System Table
167	self.system_table = system_table.SystemTable(self.ec, self.platform.sysmembase, self.platform.sysmemsize)
168
169	# Find the Debug Info Table
170	debug_info_table_base = self.system_table.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
171	self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)
172
173	stack_frame = self.ec.getTopLevelStackFrame()
174	info = self.debug_info_table.load_symbols_at(int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF)
175	debug_infos.append(info)
176	while stack_frame.next() is not None:
177	stack_frame = stack_frame.next()
178
179	# Stack frame attached to 'PC'
180	pc = int(stack_frame.getRegisterService().getValue('PC')) & 0xFFFFFFFF
181
182	# Check if the symbols for this stack frame have already been loaded
183	found = False
184	for debug_info in debug_infos:
185	if (pc >= debug_info[0]) and (pc < debug_info[0] + debug_info[1]):
186	found = True
187	if found == False:
188	info = self.debug_info_table.load_symbols_at(pc)
189	debug_infos.append(info)
190
191	#self.debug_info_table.load_symbols_at(pc)
192	else:
193	raise Exception('ArmPlatformDebugger', "Not supported region")
194
195	def load_all_symbols(self):
196	# Load all the XIP symbols attached to the Firmware Volume
197	for (fv_base, fv_size) in self.platform.fvs:
198	if self.firmware_volumes.has_key(fv_base) == False:
199	self.firmware_volumes[fv_base] = firmware_volume.FirmwareVolume(self.ec, fv_base, fv_size)
200	self.firmware_volumes[fv_base].load_all_symbols()
201
202	try:
203	# Load all symbols of module loaded into System Memory
204	if self.system_table is None:
205	# Find the System Table
206	self.system_table = system_table.SystemTable(self.ec, self.platform.sysmembase, self.platform.sysmemsize)
207
208
209	# Find the Debug Info Table
210	debug_info_table_base = self.system_table.get_configuration_table(system_table.DebugInfoTable.CONST_DEBUG_INFO_TABLE_GUID)
211	self.debug_info_table = system_table.DebugInfoTable(self.ec, debug_info_table_base)
212
213	self.debug_info_table.load_all_symbols()
214	except:
215	# Debugger exception could be excepted if DRAM has not been initialized or if we have not started to run from DRAM yet
216	print "Note: no symbols have been found in System Memory (possible cause: the UEFI permanent memory has been installed yet)"
217	pass