Skip to content

Commit

Permalink
[GDB] Add GDB stub for remote debugging
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanha authored and Michael Brown committed Jun 4, 2008
1 parent 831db76 commit 04bc50f
Show file tree
Hide file tree
Showing 6 changed files with 626 additions and 11 deletions.
209 changes: 209 additions & 0 deletions src/arch/i386/core/gdbidt.S
@@ -0,0 +1,209 @@
/*
* Interrupt Descriptor Table (IDT) setup and interrupt handlers for GDB stub.
*/

#include <virtaddr.h>

#define SIZEOF_I386_REGS 32
#define SIZEOF_I386_FLAGS 4

/****************************************************************************
* Interrupt Descriptor Table
****************************************************************************
*/
.section ".data16"
.globl idtr
idtr:
idt_limit:
.word idt_length - 1
idt_base:
.long 0

/* IDT entries have the following format:
* offset_lo, segment selector, flags, offset_hi
*
* Since it is not possible to specify relocations in arbitrary
* expressions like (int_overflow & 0xffff), we initialise the
* IDT with entries in an incorrect format.
*
* The entries are shuffled into the correct format in init_librm().
*/
#define IDT_ENTRY_EMPTY(name) .word 0, 0, 0, 0
#define IDT_ENTRY_PRESENT(name) \
.long int_##name; \
.word 0x8e00, VIRTUAL_CS

.align 16
idt:
IDT_ENTRY_PRESENT(divide_error)
IDT_ENTRY_PRESENT(debug_trap)
IDT_ENTRY_EMPTY(non_maskable_interrupt)
IDT_ENTRY_PRESENT(breakpoint)
IDT_ENTRY_PRESENT(overflow)
IDT_ENTRY_PRESENT(bound_range_exceeded)
IDT_ENTRY_PRESENT(invalid_opcode)
IDT_ENTRY_EMPTY(device_not_available)
IDT_ENTRY_PRESENT(double_fault)
IDT_ENTRY_EMPTY(coprocessor_segment_overrun)
IDT_ENTRY_PRESENT(invalid_tss)
IDT_ENTRY_PRESENT(segment_not_present)
IDT_ENTRY_PRESENT(stack_segment_fault)
IDT_ENTRY_PRESENT(general_protection)
IDT_ENTRY_PRESENT(page_fault)
idt_end:
.equ idt_length, idt_end - idt

/* The IDT entries are fixed up (once) in init_librm() */
idt_fixed:
.byte 0

/****************************************************************************
* idt_init (real-mode near call, 16-bit real-mode near return address)
*
* Initialise the IDT, called from init_librm.
*
* Parameters:
* %eax : IDT base address
*
* Destroys %ax, %bx, and %di.
****************************************************************************
*/
.section ".text16"
.code16
.globl idt_init
idt_init:
movl %eax, idt_base
addl $idt, idt_base

/* IDT entries are only fixed up once */
movb idt_fixed, %al
orb %al, %al
jnz 2f
movb $1, idt_fixed

/* Shuffle IDT entries into the correct format */
movb $(idt_length / 8), %al
movw $idt, %bx
or %al, %al
jz 2f
1:
movw 2(%bx), %di
xchg %di, 6(%bx)
movw %di, 2(%bx)
addw $8, %bx
dec %al
jnz 1b
2:
ret

/****************************************************************************
* Interrupt handlers
****************************************************************************
*/
.section ".text"
.code32

/* POSIX signal numbers for reporting traps to GDB */
#define SIGILL 4
#define SIGTRAP 5
#define SIGBUS 7
#define SIGFPE 8
#define SIGSEGV 11
#define SIGSTKFLT 16

int_divide_error:
pushl $SIGFPE
jmp do_interrupt

int_debug_trap:
int_breakpoint:
pushl $SIGTRAP
jmp do_interrupt

int_overflow:
int_bound_range_exceeded:
pushl $SIGSTKFLT
jmp do_interrupt

int_invalid_opcode:
pushl $SIGILL
jmp do_interrupt

int_double_fault:
movl $SIGBUS, (%esp)
jmp do_interrupt

int_invalid_tss:
int_segment_not_present:
int_stack_segment_fault:
int_general_protection:
int_page_fault:
movl $SIGSEGV, (%esp)
jmp do_interrupt

/* When invoked, the stack contains: eflags, cs, eip, signo. */
#define IH_OFFSET_GDB_REGS ( 0 )
#define IH_OFFSET_GDB_EIP ( IH_OFFSET_GDB_REGS + SIZEOF_I386_REGS )
#define IH_OFFSET_GDB_EFLAGS ( IH_OFFSET_GDB_EIP + 4 )
#define IH_OFFSET_GDB_SEG_REGS ( IH_OFFSET_GDB_EFLAGS + SIZEOF_I386_FLAGS )
#define IH_OFFSET_GDB_END ( IH_OFFSET_GDB_SEG_REGS + 6 * 4 )
#define IH_OFFSET_SIGNO ( IH_OFFSET_GDB_END )
#define IH_OFFSET_OLD_EIP ( IH_OFFSET_SIGNO + 4 )
#define IH_OFFSET_OLD_CS ( IH_OFFSET_OLD_EIP + 4 )
#define IH_OFFSET_OLD_EFLAGS ( IH_OFFSET_OLD_CS + 4 )
#define IH_OFFSET_END ( IH_OFFSET_OLD_EFLAGS + 4 )

/* We also access the stack whilst still storing or restoring
* the register snapshot. Since ESP is in flux, we need
* special offsets.
*/
#define IH_OFFSET_FLUX_OLD_CS ( IH_OFFSET_OLD_CS - 44 )
#define IH_OFFSET_FLUX_OLD_EFLAGS ( IH_OFFSET_OLD_EFLAGS - 40 )
#define IH_OFFSET_FLUX_OLD_EIP ( IH_OFFSET_OLD_EIP - 36 )
#define IH_OFFSET_FLUX_END ( IH_OFFSET_END - 20 )
do_interrupt:
/* Store CPU state in GDB register snapshot */
pushl %gs
pushl %fs
pushl %es
pushl %ds
pushl %ss
pushl IH_OFFSET_FLUX_OLD_CS(%esp)
pushl IH_OFFSET_FLUX_OLD_EFLAGS(%esp)
pushl IH_OFFSET_FLUX_OLD_EIP(%esp)
pushl %edi
pushl %esi
pushl %ebp
leal IH_OFFSET_FLUX_END(%esp), %edi
pushl %edi /* old ESP */
pushl %ebx
pushl %edx
pushl %ecx
pushl %eax

/* Call GDB stub exception handler */
pushl %esp
pushl (IH_OFFSET_SIGNO + 4)(%esp)
call gdbstub_handler
addl $8, %esp

/* Restore CPU state from GDB register snapshot */
popl %eax
popl %ecx
popl %edx
popl %ebx
addl $4, %esp /* Changing ESP currently not supported */
popl %ebp
popl %esi
popl %edi
popl IH_OFFSET_FLUX_OLD_EIP(%esp)
popl IH_OFFSET_FLUX_OLD_EFLAGS(%esp)
popl IH_OFFSET_FLUX_OLD_CS(%esp)
popl %ss
popl %ds
popl %es
popl %fs
popl %gs

addl $4, %esp /* drop signo */
iret
51 changes: 51 additions & 0 deletions src/arch/i386/include/gdbmach.h
@@ -0,0 +1,51 @@
#ifndef GDBMACH_H
#define GDBMACH_H

/** @file
*
* GDB architecture specifics
*
* This file declares functions for manipulating the machine state and
* debugging context.
*
*/

typedef uint32_t gdbreg_t;

/* The register snapshot, this must be in sync with interrupt handler and the
* GDB protocol. */
enum {
GDBMACH_EAX,
GDBMACH_ECX,
GDBMACH_EDX,
GDBMACH_EBX,
GDBMACH_ESP,
GDBMACH_EBP,
GDBMACH_ESI,
GDBMACH_EDI,
GDBMACH_EIP,
GDBMACH_EFLAGS,
GDBMACH_CS,
GDBMACH_SS,
GDBMACH_DS,
GDBMACH_ES,
GDBMACH_FS,
GDBMACH_GS,
GDBMACH_NREGS,
GDBMACH_SIZEOF_REGS = GDBMACH_NREGS * sizeof ( gdbreg_t )
};

static inline void gdbmach_set_pc ( gdbreg_t *regs, gdbreg_t pc ) {
regs [ GDBMACH_EIP ] = pc;
}

static inline void gdbmach_set_single_step ( gdbreg_t *regs, int step ) {
regs [ GDBMACH_EFLAGS ] &= ~( 1 << 8 ); /* Trace Flag (TF) */
regs [ GDBMACH_EFLAGS ] |= ( step << 8 );
}

static inline void gdbmach_breakpoint ( void ) {
__asm__ __volatile__ ( "int $3\n" );
}

#endif /* GDBMACH_H */
43 changes: 32 additions & 11 deletions src/arch/i386/transitions/librm.S
Expand Up @@ -50,6 +50,7 @@
.section ".data16"
.align 16
gdt:
gdtr: /* The first GDT entry is unused, the GDTR can fit here. */
gdt_limit: .word gdt_length - 1
gdt_base: .long 0
.word 0 /* padding */
Expand Down Expand Up @@ -127,7 +128,7 @@ init_librm:
addr32 leal (%eax, %edi), %ebx
movl %ebx, _text16

/* Store rm_ds and _data16, set up real_ds segment and set GDT base */
/* Store rm_ds and _data16, set up real_ds segment */
xorl %eax, %eax
movw %ds, %ax
movw %ax, %cs:rm_ds
Expand All @@ -136,9 +137,12 @@ init_librm:
call set_seg_base
addr32 leal (%eax, %edi), %ebx
movl %ebx, _data16
addl $gdt, %eax

/* Set GDT and IDT base */
movl %eax, gdt_base

addl $gdt, gdt_base
call idt_init

/* Restore registers */
negl %edi
popl %ebx
Expand All @@ -147,14 +151,16 @@ init_librm:

.section ".text16"
.code16
.weak idt_init
set_seg_base:
1: movw %ax, 2(%bx)
rorl $16, %eax
movb %al, 4(%bx)
movb %ah, 7(%bx)
roll $16, %eax
idt_init: /* Reuse the return opcode here */
ret

/****************************************************************************
* real_to_prot (real-mode near call, 32-bit virtual return address)
*
Expand Down Expand Up @@ -197,7 +203,8 @@ real_to_prot:

/* Switch to protected mode */
cli
data32 lgdt gdt
data32 lgdt gdtr
data32 lidt idtr
movl %cr0, %eax
orb $CR0_PE, %al
movl %eax, %cr0
Expand Down Expand Up @@ -232,6 +239,14 @@ real_to_prot:
/* Return to virtual address */
ret

/* Default IDTR with no interrupts */
.section ".data16"
.weak idtr
idtr:
rm_idtr:
.word 0xffff /* limit */
.long 0 /* base */

/****************************************************************************
* prot_to_real (protected-mode near call, 32-bit real-mode return address)
*
Expand Down Expand Up @@ -300,6 +315,9 @@ p2r_jump_target:
movw %bp, %ss
movl %edx, %esp

/* Reset IDTR to the real-mode defaults */
lidt rm_idtr

/* Return to real-mode address */
data32 ret

Expand All @@ -318,7 +336,7 @@ rm_cs: .word 0
.globl rm_ds
.section ".text16.data"
rm_ds: .word 0

/****************************************************************************
* prot_call (real-mode far call, 16-bit real-mode far return address)
*
Expand Down Expand Up @@ -354,7 +372,8 @@ rm_ds: .word 0
*/

#define PC_OFFSET_GDT ( 0 )
#define PC_OFFSET_IX86 ( PC_OFFSET_GDT + 8 /* pad to 8 to keep alignment */ )
#define PC_OFFSET_IDT ( PC_OFFSET_GDT + 8 /* pad to 8 to keep alignment */ )
#define PC_OFFSET_IX86 ( PC_OFFSET_IDT + 8 /* pad to 8 to keep alignment */ )
#define PC_OFFSET_RETADDR ( PC_OFFSET_IX86 + SIZEOF_I386_ALL_REGS )
#define PC_OFFSET_FUNCTION ( PC_OFFSET_RETADDR + 4 )
#define PC_OFFSET_END ( PC_OFFSET_FUNCTION + 4 )
Expand All @@ -372,8 +391,9 @@ prot_call:
pushw %ds
pushw %ss
pushw %cs
subw $8, %sp
subw $16, %sp
movw %sp, %bp
sidt 8(%bp)
sgdt (%bp)

/* For sanity's sake, clear the direction flag as soon as possible */
Expand Down Expand Up @@ -402,10 +422,11 @@ prot_call:
.section ".text16"
.code16
1:
/* Reload GDT, restore registers and flags and return */
/* Reload GDT and IDT, restore registers and flags and return */
movw %sp, %bp
lgdt (%bp)
addw $12, %sp /* also skip %cs and %ss */
lidt 8(%bp)
addw $20, %sp /* also skip %cs and %ss */
popw %ds
popw %es
popw %fs
Expand Down Expand Up @@ -495,7 +516,7 @@ real_call:
*/
.section ".data16"
rc_function: .word 0, 0

/****************************************************************************
* Stored real-mode and protected-mode stack pointers
*
Expand Down

0 comments on commit 04bc50f

Please sign in to comment.