xref: /openbmc/qemu/include/exec/gdbstub.h (revision dc5bd18f)
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 int gdb_handlesig(CPUState *, int);
52 void gdb_signalled(CPUArchState *, int);
53 void gdbserver_fork(CPUState *);
54 #endif
55 /* Get or set a register.  Returns the size of the register.  */
56 typedef int (*gdb_reg_cb)(CPUArchState *env, uint8_t *buf, int reg);
57 void gdb_register_coprocessor(CPUState *cpu,
58                               gdb_reg_cb get_reg, gdb_reg_cb set_reg,
59                               int num_regs, const char *xml, int g_pos);
60 
61 /* The GDB remote protocol transfers values in target byte order.  This means
62  * we can use the raw memory access routines to access the value buffer.
63  * Conveniently, these also handle the case where the buffer is mis-aligned.
64  */
65 
66 static inline int gdb_get_reg8(uint8_t *mem_buf, uint8_t val)
67 {
68     stb_p(mem_buf, val);
69     return 1;
70 }
71 
72 static inline int gdb_get_reg16(uint8_t *mem_buf, uint16_t val)
73 {
74     stw_p(mem_buf, val);
75     return 2;
76 }
77 
78 static inline int gdb_get_reg32(uint8_t *mem_buf, uint32_t val)
79 {
80     stl_p(mem_buf, val);
81     return 4;
82 }
83 
84 static inline int gdb_get_reg64(uint8_t *mem_buf, uint64_t val)
85 {
86     stq_p(mem_buf, val);
87     return 8;
88 }
89 
90 #if TARGET_LONG_BITS == 64
91 #define gdb_get_regl(buf, val) gdb_get_reg64(buf, val)
92 #define ldtul_p(addr) ldq_p(addr)
93 #else
94 #define gdb_get_regl(buf, val) gdb_get_reg32(buf, val)
95 #define ldtul_p(addr) ldl_p(addr)
96 #endif
97 
98 #endif
99 
100 #ifdef CONFIG_USER_ONLY
101 int gdbserver_start(int);
102 #else
103 int gdbserver_start(const char *port);
104 #endif
105 
106 /**
107  * gdb_has_xml:
108  * This is an ugly hack to cope with both new and old gdb.
109  * If gdb sends qXfer:features:read then assume we're talking to a newish
110  * gdb that understands target descriptions.
111  */
112 extern bool gdb_has_xml;
113 
114 /* in gdbstub-xml.c, generated by scripts/feature_to_c.sh */
115 extern const char *const xml_builtin[][2];
116 
117 #endif
118