4 * Copyright (c) 2022 Linaro Ltd
6 * SPDX-License-Identifier: GPL-2.0-or-later
9 #ifndef GDBSTUB_INTERNALS_H
10 #define GDBSTUB_INTERNALS_H
12 #include "exec/cpu-common.h"
14 #define MAX_PACKET_LENGTH 4096
17 * Shared structures and definitions
29 GDB_SIGNAL_UNKNOWN = 143
32 typedef struct GDBProcess {
36 char target_xml[1024];
49 typedef struct GDBState {
50 bool init; /* have we been initialised? */
51 CPUState *c_cpu; /* current CPU for step/continue ops */
52 CPUState *g_cpu; /* current CPU for other ops */
53 CPUState *query_cpu; /* for q{f|s}ThreadInfo */
54 enum RSState state; /* parsing state */
55 char line_buf[MAX_PACKET_LENGTH];
57 int line_sum; /* running checksum */
58 int line_csum; /* checksum at the end of the packet */
59 GByteArray *last_packet;
62 GDBProcess *processes;
67 int supported_sstep_flags;
69 * Whether we are allowed to send a stop reply packet at this moment.
70 * Must be set off after sending the stop reply itself.
72 bool allow_stop_reply;
75 /* lives in main gdbstub.c */
76 extern GDBState gdbserver_state;
79 * Inline utility function, convert from int to hex and back
82 static inline int fromhex(int v)
84 if (v >= '0' && v <= '9') {
86 } else if (v >= 'A' && v <= 'F') {
88 } else if (v >= 'a' && v <= 'f') {
95 static inline int tohex(int v)
105 * Connection helpers for both softmmu and user backends
108 void gdb_put_strbuf(void);
109 int gdb_put_packet(const char *buf);
110 int gdb_put_packet_binary(const char *buf, int len, bool dump);
111 void gdb_hextomem(GByteArray *mem, const char *buf, int len);
112 void gdb_memtohex(GString *buf, const uint8_t *mem, int len);
113 void gdb_memtox(GString *buf, const char *mem, int len);
114 void gdb_read_byte(uint8_t ch);
117 * Packet acknowledgement - we handle this slightly differently
118 * between user and softmmu mode, mainly to deal with the differences
119 * between the flexible chardev and the direct fd approaches.
121 * We currently don't support a negotiated QStartNoAckMode
125 * gdb_got_immediate_ack() - check ok to continue
127 * Returns true to continue, false to re-transmit for user only, the
128 * softmmu stub always returns true.
130 bool gdb_got_immediate_ack(void);
131 /* utility helpers */
132 CPUState *gdb_first_attached_cpu(void);
133 void gdb_append_thread_id(CPUState *cpu, GString *buf);
134 int gdb_get_cpu_index(CPUState *cpu);
135 unsigned int gdb_get_max_cpus(void); /* both */
136 bool gdb_can_reverse(void); /* softmmu, stub for user */
138 void gdb_create_default_process(GDBState *s);
140 /* signal mapping, common for softmmu, specialised for user-mode */
141 int gdb_signal_to_target(int sig);
142 int gdb_target_signal_to_gdb(int sig);
144 int gdb_get_char(void); /* user only */
147 * gdb_continue() - handle continue in mode specific way.
149 void gdb_continue(void);
152 * gdb_continue_partial() - handle partial continue in mode specific way.
154 int gdb_continue_partial(char *newstates);
157 * Helpers with separate softmmu and user implementations
159 void gdb_put_buffer(const uint8_t *buf, int len);
162 * Command handlers - either specialised or softmmu or user only
164 void gdb_init_gdbserver_state(void);
166 typedef enum GDBThreadIdKind {
168 GDB_ALL_THREADS, /* One process, all threads */
173 typedef union GdbCmdVariant {
176 unsigned long val_ul;
177 unsigned long long val_ull;
179 GDBThreadIdKind kind;
185 #define get_param(p, i) (&g_array_index(p, GdbCmdVariant, i))
187 void gdb_handle_query_rcmd(GArray *params, void *user_ctx); /* softmmu */
188 void gdb_handle_query_offsets(GArray *params, void *user_ctx); /* user */
189 void gdb_handle_query_xfer_auxv(GArray *params, void *user_ctx); /*user */
191 void gdb_handle_query_attached(GArray *params, void *user_ctx); /* both */
194 void gdb_handle_query_qemu_phy_mem_mode(GArray *params, void *user_ctx);
195 void gdb_handle_set_qemu_phy_mem_mode(GArray *params, void *user_ctx);
197 /* sycall handling */
198 void gdb_handle_file_io(GArray *params, void *user_ctx);
199 bool gdb_handled_syscall(void);
200 void gdb_disable_syscalls(void);
201 void gdb_syscall_reset(void);
203 /* user/softmmu specific syscall handling */
204 void gdb_syscall_handling(const char *syscall_packet);
207 * Break/Watch point support - there is an implementation for softmmu
210 bool gdb_supports_guest_debug(void);
211 int gdb_breakpoint_insert(CPUState *cs, int type, vaddr addr, vaddr len);
212 int gdb_breakpoint_remove(CPUState *cs, int type, vaddr addr, vaddr len);
213 void gdb_breakpoint_remove_all(CPUState *cs);
216 * gdb_target_memory_rw_debug() - handle debug access to memory
218 * @addr: nominal address, could be an entire physical address
220 * @len: length of access
221 * @is_write: is it a write operation
223 * This function is specialised depending on the mode we are running
224 * in. For softmmu guests we can switch the interpretation of the
225 * address to a physical address.
227 int gdb_target_memory_rw_debug(CPUState *cs, hwaddr addr,
228 uint8_t *buf, int len, bool is_write);
230 #endif /* GDBSTUB_INTERNALS_H */