1 | #ifndef GDBSTUB_H |
2 | #define GDBSTUB_H |
3 | |
4 | #define DEFAULT_GDBSTUB_PORT "1234" |
5 | |
6 | /* GDB breakpoint/watchpoint types */ |
7 | #define GDB_BREAKPOINT_SW 0 |
8 | #define GDB_BREAKPOINT_HW 1 |
9 | #define GDB_WATCHPOINT_WRITE 2 |
10 | #define GDB_WATCHPOINT_READ 3 |
11 | #define GDB_WATCHPOINT_ACCESS 4 |
12 | |
13 | #ifdef NEED_CPU_H |
14 | #include "cpu.h" |
15 | |
16 | typedef void (*gdb_syscall_complete_cb)(CPUState *cpu, |
17 | target_ulong ret, target_ulong err); |
18 | |
19 | /** |
20 | * gdb_do_syscall: |
21 | * @cb: function to call when the system call has completed |
22 | * @fmt: gdb syscall format string |
23 | * ...: list of arguments to interpolate into @fmt |
24 | * |
25 | * Send a GDB syscall request. This function will return immediately; |
26 | * the callback function will be called later when the remote system |
27 | * call has completed. |
28 | * |
29 | * @fmt should be in the 'call-id,parameter,parameter...' format documented |
30 | * for the F request packet in the GDB remote protocol. A limited set of |
31 | * printf-style format specifiers is supported: |
32 | * %x - target_ulong argument printed in hex |
33 | * %lx - 64-bit argument printed in hex |
34 | * %s - string pointer (target_ulong) and length (int) pair |
35 | */ |
36 | void gdb_do_syscall(gdb_syscall_complete_cb cb, const char *fmt, ...); |
37 | /** |
38 | * gdb_do_syscallv: |
39 | * @cb: function to call when the system call has completed |
40 | * @fmt: gdb syscall format string |
41 | * @va: arguments to interpolate into @fmt |
42 | * |
43 | * As gdb_do_syscall, but taking a va_list rather than a variable |
44 | * argument list. |
45 | */ |
46 | void gdb_do_syscallv(gdb_syscall_complete_cb cb, const char *fmt, va_list va); |
47 | int use_gdb_syscalls(void); |
48 | void gdb_set_stop_cpu(CPUState *cpu); |
49 | void gdb_exit(CPUArchState *, int); |
50 | #ifdef CONFIG_USER_ONLY |
51 | /** |
52 | * gdb_handlesig: yield control to gdb |
53 | * @cpu: CPU |
54 | * @sig: if non-zero, the signal number which caused us to stop |
55 | * |
56 | * This function yields control to gdb, when a user-mode-only target |
57 | * needs to stop execution. If @sig is non-zero, then we will send a |
58 | * stop packet to tell gdb that we have stopped because of this signal. |
59 | * |
60 | * This function will block (handling protocol requests from gdb) |
61 | * until gdb tells us to continue target execution. When it does |
62 | * return, the return value is a signal to deliver to the target, |
63 | * or 0 if no signal should be delivered, ie the signal that caused |
64 | * us to stop should be ignored. |
65 | */ |
66 | int gdb_handlesig(CPUState *, int); |
67 | void gdb_signalled(CPUArchState *, int); |
68 | void gdbserver_fork(CPUState *); |
69 | #endif |
70 | /* Get or set a register. Returns the size of the register. */ |
71 | typedef int (*gdb_reg_cb)(CPUArchState *env, uint8_t *buf, int reg); |
72 | void gdb_register_coprocessor(CPUState *cpu, |
73 | gdb_reg_cb get_reg, gdb_reg_cb set_reg, |
74 | int num_regs, const char *xml, int g_pos); |
75 | |
76 | /* The GDB remote protocol transfers values in target byte order. This means |
77 | * we can use the raw memory access routines to access the value buffer. |
78 | * Conveniently, these also handle the case where the buffer is mis-aligned. |
79 | */ |
80 | |
81 | static inline int gdb_get_reg8(uint8_t *mem_buf, uint8_t val) |
82 | { |
83 | stb_p(mem_buf, val); |
84 | return 1; |
85 | } |
86 | |
87 | static inline int gdb_get_reg16(uint8_t *mem_buf, uint16_t val) |
88 | { |
89 | stw_p(mem_buf, val); |
90 | return 2; |
91 | } |
92 | |
93 | static inline int gdb_get_reg32(uint8_t *mem_buf, uint32_t val) |
94 | { |
95 | stl_p(mem_buf, val); |
96 | return 4; |
97 | } |
98 | |
99 | static inline int gdb_get_reg64(uint8_t *mem_buf, uint64_t val) |
100 | { |
101 | stq_p(mem_buf, val); |
102 | return 8; |
103 | } |
104 | |
105 | #if TARGET_LONG_BITS == 64 |
106 | #define gdb_get_regl(buf, val) gdb_get_reg64(buf, val) |
107 | #define ldtul_p(addr) ldq_p(addr) |
108 | #else |
109 | #define gdb_get_regl(buf, val) gdb_get_reg32(buf, val) |
110 | #define ldtul_p(addr) ldl_p(addr) |
111 | #endif |
112 | |
113 | #endif |
114 | |
115 | #ifdef CONFIG_USER_ONLY |
116 | int gdbserver_start(int); |
117 | #else |
118 | int gdbserver_start(const char *port); |
119 | #endif |
120 | |
121 | void gdbserver_cleanup(void); |
122 | |
123 | /** |
124 | * gdb_has_xml: |
125 | * This is an ugly hack to cope with both new and old gdb. |
126 | * If gdb sends qXfer:features:read then assume we're talking to a newish |
127 | * gdb that understands target descriptions. |
128 | */ |
129 | extern bool gdb_has_xml; |
130 | |
131 | /* in gdbstub-xml.c, generated by scripts/feature_to_c.sh */ |
132 | extern const char *const xml_builtin[][2]; |
133 | |
134 | #endif |
135 | |