include/exec/gdbstub.h

   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
  49 #ifdef CONFIG_USER_ONLY
  50 /**
  51  * gdb_handlesig: yield control to gdb
  52  * @cpu: CPU
  53  * @sig: if non-zero, the signal number which caused us to stop
  54  *
  55  * This function yields control to gdb, when a user-mode-only target
  56  * needs to stop execution. If @sig is non-zero, then we will send a
  57  * stop packet to tell gdb that we have stopped because of this signal.
  58  *
  59  * This function will block (handling protocol requests from gdb)
  60  * until gdb tells us to continue target execution. When it does
  61  * return, the return value is a signal to deliver to the target,
  62  * or 0 if no signal should be delivered, ie the signal that caused
  63  * us to stop should be ignored.
  64  */
  65 int gdb_handlesig(CPUState *, int);
  66 void gdb_signalled(CPUArchState *, int);
  67 void gdbserver_fork(CPUState *);
  68 #endif
  69 /* Get or set a register.  Returns the size of the register.  */
  70 typedef int (*gdb_get_reg_cb)(CPUArchState *env, GByteArray *buf, int reg);
  71 typedef int (*gdb_set_reg_cb)(CPUArchState *env, uint8_t *buf, int reg);
  72 void gdb_register_coprocessor(CPUState *cpu,
  73                               gdb_get_reg_cb get_reg, gdb_set_reg_cb set_reg,
  74                               int num_regs, const char *xml, int g_pos);
  75
  76 /*
  77  * The GDB remote protocol transfers values in target byte order. As
  78  * the gdbstub may be batching up several register values we always
  79  * append to the array.
  80  */
  81
  82 static inline int gdb_get_reg8(GByteArray *buf, uint8_t val)
  83 {
  84     g_byte_array_append(buf, &val, 1);
  85     return 1;
  86 }
  87
  88 static inline int gdb_get_reg16(GByteArray *buf, uint16_t val)
  89 {
  90     uint16_t to_word = tswap16(val);
  91     g_byte_array_append(buf, (uint8_t *) &to_word, 2);
  92     return 2;
  93 }
  94
  95 static inline int gdb_get_reg32(GByteArray *buf, uint32_t val)
  96 {
  97     uint32_t to_long = tswap32(val);
  98     g_byte_array_append(buf, (uint8_t *) &to_long, 4);
  99     return 4;
 100 }
 101
 102 static inline int gdb_get_reg64(GByteArray *buf, uint64_t val)
 103 {
 104     uint64_t to_quad = tswap64(val);
 105     g_byte_array_append(buf, (uint8_t *) &to_quad, 8);
 106     return 8;
 107 }
 108
 109 static inline int gdb_get_reg128(GByteArray *buf, uint64_t val_hi,
 110                                  uint64_t val_lo)
 111 {
 112     uint64_t to_quad;
 113 #if TARGET_BIG_ENDIAN
 114     to_quad = tswap64(val_hi);
 115     g_byte_array_append(buf, (uint8_t *) &to_quad, 8);
 116     to_quad = tswap64(val_lo);
 117     g_byte_array_append(buf, (uint8_t *) &to_quad, 8);
 118 #else
 119     to_quad = tswap64(val_lo);
 120     g_byte_array_append(buf, (uint8_t *) &to_quad, 8);
 121     to_quad = tswap64(val_hi);
 122     g_byte_array_append(buf, (uint8_t *) &to_quad, 8);
 123 #endif
 124     return 16;
 125 }
 126
 127 static inline int gdb_get_zeroes(GByteArray *array, size_t len)
 128 {
 129     guint oldlen = array->len;
 130     g_byte_array_set_size(array, oldlen + len);
 131     memset(array->data + oldlen, 0, len);
 132
 133     return len;
 134 }
 135
 136 /**
 137  * gdb_get_reg_ptr: get pointer to start of last element
 138  * @len: length of element
 139  *
 140  * This is a helper function to extract the pointer to the last
 141  * element for additional processing. Some front-ends do additional
 142  * dynamic swapping of the elements based on CPU state.
 143  */
 144 static inline uint8_t * gdb_get_reg_ptr(GByteArray *buf, int len)
 145 {
 146     return buf->data + buf->len - len;
 147 }
 148
 149 #if TARGET_LONG_BITS == 64
 150 #define gdb_get_regl(buf, val) gdb_get_reg64(buf, val)
 151 #define ldtul_p(addr) ldq_p(addr)
 152 #else
 153 #define gdb_get_regl(buf, val) gdb_get_reg32(buf, val)
 154 #define ldtul_p(addr) ldl_p(addr)
 155 #endif
 156
 157 #endif /* NEED_CPU_H */
 158
 159 /**
 160  * gdbserver_start: start the gdb server
 161  * @port_or_device: connection spec for gdb
 162  *
 163  * For CONFIG_USER this is either a tcp port or a path to a fifo. For
 164  * system emulation you can use a full chardev spec for your gdbserver
 165  * port.
 166  */
 167 int gdbserver_start(const char *port_or_device);
 168
 169 /**
 170  * gdb_exit: exit gdb session, reporting inferior status
 171  * @code: exit code reported
 172  *
 173  * This closes the session and sends a final packet to GDB reporting
 174  * the exit status of the program. It also cleans up any connections
 175  * detritus before returning.
 176  */
 177 void gdb_exit(int code);
 178
 179 void gdb_set_stop_cpu(CPUState *cpu);
 180
 181 /**
 182  * gdb_has_xml:
 183  * This is an ugly hack to cope with both new and old gdb.
 184  * If gdb sends qXfer:features:read then assume we're talking to a newish
 185  * gdb that understands target descriptions.
 186  */
 187 extern bool gdb_has_xml;
 188
 189 /* in gdbstub-xml.c, generated by scripts/feature_to_c.sh */
 190 extern const char *const xml_builtin[][2];
 191
 192 #endif