4f71086665
gdb_handlesig()'s behaviour is not entirely obvious at first glance. Add a doc comment for it, and also add a comment explaining why it's ok for gdb_do_syscallv() to ignore gdb_handlesig()'s return value. (Coverity complains about this: CID 1390850.) Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Message-Id: <20180515181958.25837-1-peter.maydell@linaro.org> Signed-off-by: Laurent Vivier <laurent@vivier.eu>
135 lines
4.0 KiB
C
135 lines
4.0 KiB
C
#ifndef GDBSTUB_H
|
|
#define GDBSTUB_H
|
|
|
|
#define DEFAULT_GDBSTUB_PORT "1234"
|
|
|
|
/* GDB breakpoint/watchpoint types */
|
|
#define GDB_BREAKPOINT_SW 0
|
|
#define GDB_BREAKPOINT_HW 1
|
|
#define GDB_WATCHPOINT_WRITE 2
|
|
#define GDB_WATCHPOINT_READ 3
|
|
#define GDB_WATCHPOINT_ACCESS 4
|
|
|
|
#ifdef NEED_CPU_H
|
|
#include "cpu.h"
|
|
|
|
typedef void (*gdb_syscall_complete_cb)(CPUState *cpu,
|
|
target_ulong ret, target_ulong err);
|
|
|
|
/**
|
|
* gdb_do_syscall:
|
|
* @cb: function to call when the system call has completed
|
|
* @fmt: gdb syscall format string
|
|
* ...: list of arguments to interpolate into @fmt
|
|
*
|
|
* Send a GDB syscall request. This function will return immediately;
|
|
* the callback function will be called later when the remote system
|
|
* call has completed.
|
|
*
|
|
* @fmt should be in the 'call-id,parameter,parameter...' format documented
|
|
* for the F request packet in the GDB remote protocol. A limited set of
|
|
* printf-style format specifiers is supported:
|
|
* %x - target_ulong argument printed in hex
|
|
* %lx - 64-bit argument printed in hex
|
|
* %s - string pointer (target_ulong) and length (int) pair
|
|
*/
|
|
void gdb_do_syscall(gdb_syscall_complete_cb cb, const char *fmt, ...);
|
|
/**
|
|
* gdb_do_syscallv:
|
|
* @cb: function to call when the system call has completed
|
|
* @fmt: gdb syscall format string
|
|
* @va: arguments to interpolate into @fmt
|
|
*
|
|
* As gdb_do_syscall, but taking a va_list rather than a variable
|
|
* argument list.
|
|
*/
|
|
void gdb_do_syscallv(gdb_syscall_complete_cb cb, const char *fmt, va_list va);
|
|
int use_gdb_syscalls(void);
|
|
void gdb_set_stop_cpu(CPUState *cpu);
|
|
void gdb_exit(CPUArchState *, int);
|
|
#ifdef CONFIG_USER_ONLY
|
|
/**
|
|
* gdb_handlesig: yield control to gdb
|
|
* @cpu: CPU
|
|
* @sig: if non-zero, the signal number which caused us to stop
|
|
*
|
|
* This function yields control to gdb, when a user-mode-only target
|
|
* needs to stop execution. If @sig is non-zero, then we will send a
|
|
* stop packet to tell gdb that we have stopped because of this signal.
|
|
*
|
|
* This function will block (handling protocol requests from gdb)
|
|
* until gdb tells us to continue target execution. When it does
|
|
* return, the return value is a signal to deliver to the target,
|
|
* or 0 if no signal should be delivered, ie the signal that caused
|
|
* us to stop should be ignored.
|
|
*/
|
|
int gdb_handlesig(CPUState *, int);
|
|
void gdb_signalled(CPUArchState *, int);
|
|
void gdbserver_fork(CPUState *);
|
|
#endif
|
|
/* Get or set a register. Returns the size of the register. */
|
|
typedef int (*gdb_reg_cb)(CPUArchState *env, uint8_t *buf, int reg);
|
|
void gdb_register_coprocessor(CPUState *cpu,
|
|
gdb_reg_cb get_reg, gdb_reg_cb set_reg,
|
|
int num_regs, const char *xml, int g_pos);
|
|
|
|
/* The GDB remote protocol transfers values in target byte order. This means
|
|
* we can use the raw memory access routines to access the value buffer.
|
|
* Conveniently, these also handle the case where the buffer is mis-aligned.
|
|
*/
|
|
|
|
static inline int gdb_get_reg8(uint8_t *mem_buf, uint8_t val)
|
|
{
|
|
stb_p(mem_buf, val);
|
|
return 1;
|
|
}
|
|
|
|
static inline int gdb_get_reg16(uint8_t *mem_buf, uint16_t val)
|
|
{
|
|
stw_p(mem_buf, val);
|
|
return 2;
|
|
}
|
|
|
|
static inline int gdb_get_reg32(uint8_t *mem_buf, uint32_t val)
|
|
{
|
|
stl_p(mem_buf, val);
|
|
return 4;
|
|
}
|
|
|
|
static inline int gdb_get_reg64(uint8_t *mem_buf, uint64_t val)
|
|
{
|
|
stq_p(mem_buf, val);
|
|
return 8;
|
|
}
|
|
|
|
#if TARGET_LONG_BITS == 64
|
|
#define gdb_get_regl(buf, val) gdb_get_reg64(buf, val)
|
|
#define ldtul_p(addr) ldq_p(addr)
|
|
#else
|
|
#define gdb_get_regl(buf, val) gdb_get_reg32(buf, val)
|
|
#define ldtul_p(addr) ldl_p(addr)
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#ifdef CONFIG_USER_ONLY
|
|
int gdbserver_start(int);
|
|
#else
|
|
int gdbserver_start(const char *port);
|
|
#endif
|
|
|
|
void gdbserver_cleanup(void);
|
|
|
|
/**
|
|
* gdb_has_xml:
|
|
* This is an ugly hack to cope with both new and old gdb.
|
|
* If gdb sends qXfer:features:read then assume we're talking to a newish
|
|
* gdb that understands target descriptions.
|
|
*/
|
|
extern bool gdb_has_xml;
|
|
|
|
/* in gdbstub-xml.c, generated by scripts/feature_to_c.sh */
|
|
extern const char *const xml_builtin[][2];
|
|
|
|
#endif
|