4 * This implements a subset of the remote protocol as described in:
6 * https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
8 * Copyright (c) 2003-2005 Fabrice Bellard
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
23 * SPDX-License-Identifier: LGPL-2.0+
26 #include "qemu/osdep.h"
27 #include "qemu/ctype.h"
28 #include "qemu/cutils.h"
29 #include "qemu/module.h"
30 #include "qemu/error-report.h"
32 #include "exec/gdbstub.h"
33 #include "gdbstub/syscalls.h"
34 #ifdef CONFIG_USER_ONLY
35 #include "gdbstub/user.h"
37 #include "hw/cpu/cluster.h"
38 #include "hw/boards.h"
41 #include "sysemu/hw_accel.h"
42 #include "sysemu/runstate.h"
43 #include "exec/replay-core.h"
44 #include "exec/hwaddr.h"
46 #include "internals.h"
48 typedef struct GDBRegisterState {
51 gdb_get_reg_cb get_reg;
52 gdb_set_reg_cb set_reg;
54 struct GDBRegisterState *next;
57 GDBState gdbserver_state;
59 void gdb_init_gdbserver_state(void)
61 g_assert(!gdbserver_state.init);
62 memset(&gdbserver_state, 0, sizeof(GDBState));
63 gdbserver_state.init = true;
64 gdbserver_state.str_buf = g_string_new(NULL);
65 gdbserver_state.mem_buf = g_byte_array_sized_new(MAX_PACKET_LENGTH);
66 gdbserver_state.last_packet = g_byte_array_sized_new(MAX_PACKET_LENGTH + 4);
69 * What single-step modes are supported is accelerator dependent.
70 * By default try to use no IRQs and no timers while single
71 * stepping so as to make single stepping like a typical ICE HW step.
73 gdbserver_state.supported_sstep_flags = accel_supported_gdbstub_sstep_flags();
74 gdbserver_state.sstep_flags = SSTEP_ENABLE | SSTEP_NOIRQ | SSTEP_NOTIMER;
75 gdbserver_state.sstep_flags &= gdbserver_state.supported_sstep_flags;
78 /* writes 2*len+1 bytes in buf */
79 void gdb_memtohex(GString *buf, const uint8_t *mem, int len)
82 for(i = 0; i < len; i++) {
84 g_string_append_c(buf, tohex(c >> 4));
85 g_string_append_c(buf, tohex(c & 0xf));
87 g_string_append_c(buf, '\0');
90 void gdb_hextomem(GByteArray *mem, const char *buf, int len)
94 for(i = 0; i < len; i++) {
95 guint8 byte = fromhex(buf[0]) << 4 | fromhex(buf[1]);
96 g_byte_array_append(mem, &byte, 1);
101 static void hexdump(const char *buf, int len,
102 void (*trace_fn)(size_t ofs, char const *text))
104 char line_buffer[3 * 16 + 4 + 16 + 1];
107 for (i = 0; i < len || (i & 0xF); ++i) {
108 size_t byte_ofs = i & 15;
111 memset(line_buffer, ' ', 3 * 16 + 4 + 16);
112 line_buffer[3 * 16 + 4 + 16] = 0;
115 size_t col_group = (i >> 2) & 3;
116 size_t hex_col = byte_ofs * 3 + col_group;
117 size_t txt_col = 3 * 16 + 4 + byte_ofs;
122 line_buffer[hex_col + 0] = tohex((value >> 4) & 0xF);
123 line_buffer[hex_col + 1] = tohex((value >> 0) & 0xF);
124 line_buffer[txt_col + 0] = (value >= ' ' && value < 127)
130 trace_fn(i & -16, line_buffer);
134 /* return -1 if error, 0 if OK */
135 int gdb_put_packet_binary(const char *buf, int len, bool dump)
140 if (dump && trace_event_get_state_backends(TRACE_GDBSTUB_IO_BINARYREPLY)) {
141 hexdump(buf, len, trace_gdbstub_io_binaryreply);
145 g_byte_array_set_size(gdbserver_state.last_packet, 0);
146 g_byte_array_append(gdbserver_state.last_packet,
147 (const uint8_t *) "$", 1);
148 g_byte_array_append(gdbserver_state.last_packet,
149 (const uint8_t *) buf, len);
151 for(i = 0; i < len; i++) {
155 footer[1] = tohex((csum >> 4) & 0xf);
156 footer[2] = tohex((csum) & 0xf);
157 g_byte_array_append(gdbserver_state.last_packet, footer, 3);
159 gdb_put_buffer(gdbserver_state.last_packet->data,
160 gdbserver_state.last_packet->len);
162 if (gdb_got_immediate_ack()) {
169 /* return -1 if error, 0 if OK */
170 int gdb_put_packet(const char *buf)
172 trace_gdbstub_io_reply(buf);
174 return gdb_put_packet_binary(buf, strlen(buf), false);
177 void gdb_put_strbuf(void)
179 gdb_put_packet(gdbserver_state.str_buf->str);
182 /* Encode data using the encoding for 'x' packets. */
183 void gdb_memtox(GString *buf, const char *mem, int len)
190 case '#': case '$': case '*': case '}':
191 g_string_append_c(buf, '}');
192 g_string_append_c(buf, c ^ 0x20);
195 g_string_append_c(buf, c);
201 static uint32_t gdb_get_cpu_pid(CPUState *cpu)
203 #ifdef CONFIG_USER_ONLY
206 if (cpu->cluster_index == UNASSIGNED_CLUSTER_INDEX) {
207 /* Return the default process' PID */
208 int index = gdbserver_state.process_num - 1;
209 return gdbserver_state.processes[index].pid;
211 return cpu->cluster_index + 1;
215 GDBProcess *gdb_get_process(uint32_t pid)
220 /* 0 means any process, we take the first one */
221 return &gdbserver_state.processes[0];
224 for (i = 0; i < gdbserver_state.process_num; i++) {
225 if (gdbserver_state.processes[i].pid == pid) {
226 return &gdbserver_state.processes[i];
233 static GDBProcess *gdb_get_cpu_process(CPUState *cpu)
235 return gdb_get_process(gdb_get_cpu_pid(cpu));
238 static CPUState *find_cpu(uint32_t thread_id)
243 if (gdb_get_cpu_index(cpu) == thread_id) {
251 CPUState *gdb_get_first_cpu_in_process(GDBProcess *process)
256 if (gdb_get_cpu_pid(cpu) == process->pid) {
264 static CPUState *gdb_next_cpu_in_process(CPUState *cpu)
266 uint32_t pid = gdb_get_cpu_pid(cpu);
270 if (gdb_get_cpu_pid(cpu) == pid) {
280 /* Return the cpu following @cpu, while ignoring unattached processes. */
281 static CPUState *gdb_next_attached_cpu(CPUState *cpu)
286 if (gdb_get_cpu_process(cpu)->attached) {
296 /* Return the first attached cpu */
297 CPUState *gdb_first_attached_cpu(void)
299 CPUState *cpu = first_cpu;
300 GDBProcess *process = gdb_get_cpu_process(cpu);
302 if (!process->attached) {
303 return gdb_next_attached_cpu(cpu);
309 static CPUState *gdb_get_cpu(uint32_t pid, uint32_t tid)
315 /* 0 means any process/thread, we take the first attached one */
316 return gdb_first_attached_cpu();
317 } else if (pid && !tid) {
318 /* any thread in a specific process */
319 process = gdb_get_process(pid);
321 if (process == NULL) {
325 if (!process->attached) {
329 return gdb_get_first_cpu_in_process(process);
331 /* a specific thread */
338 process = gdb_get_cpu_process(cpu);
340 if (pid && process->pid != pid) {
344 if (!process->attached) {
352 static const char *get_feature_xml(const char *p, const char **newp,
355 CPUState *cpu = gdb_get_first_cpu_in_process(process);
356 CPUClass *cc = CPU_GET_CLASS(cpu);
360 * qXfer:features:read:ANNEX:OFFSET,LENGTH'
363 char *term = strchr(p, ':');
367 /* Is it the main target xml? */
368 if (strncmp(p, "target.xml", len) == 0) {
369 if (!process->target_xml) {
371 g_autoptr(GPtrArray) xml = g_ptr_array_new_with_free_func(g_free);
375 g_strdup("<?xml version=\"1.0\"?>"
376 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">"
379 if (cc->gdb_arch_name) {
382 g_markup_printf_escaped("<architecture>%s</architecture>",
383 cc->gdb_arch_name(cpu)));
387 g_markup_printf_escaped("<xi:include href=\"%s\"/>",
388 cc->gdb_core_xml_file));
389 for (r = cpu->gdb_regs; r; r = r->next) {
392 g_markup_printf_escaped("<xi:include href=\"%s\"/>",
395 g_ptr_array_add(xml, g_strdup("</target>"));
396 g_ptr_array_add(xml, NULL);
398 process->target_xml = g_strjoinv(NULL, (void *)xml->pdata);
400 return process->target_xml;
402 /* Is it dynamically generated by the target? */
403 if (cc->gdb_get_dynamic_xml) {
404 g_autofree char *xmlname = g_strndup(p, len);
405 const char *xml = cc->gdb_get_dynamic_xml(cpu, xmlname);
410 /* Is it one of the encoded gdb-xml/ files? */
411 for (int i = 0; gdb_static_features[i].xmlname; i++) {
412 const char *name = gdb_static_features[i].xmlname;
413 if ((strncmp(name, p, len) == 0) &&
414 strlen(name) == len) {
415 return gdb_static_features[i].xml;
423 static int gdb_read_register(CPUState *cpu, GByteArray *buf, int reg)
425 CPUClass *cc = CPU_GET_CLASS(cpu);
426 CPUArchState *env = cpu_env(cpu);
429 if (reg < cc->gdb_num_core_regs) {
430 return cc->gdb_read_register(cpu, buf, reg);
433 for (r = cpu->gdb_regs; r; r = r->next) {
434 if (r->base_reg <= reg && reg < r->base_reg + r->num_regs) {
435 return r->get_reg(env, buf, reg - r->base_reg);
441 static int gdb_write_register(CPUState *cpu, uint8_t *mem_buf, int reg)
443 CPUClass *cc = CPU_GET_CLASS(cpu);
444 CPUArchState *env = cpu_env(cpu);
447 if (reg < cc->gdb_num_core_regs) {
448 return cc->gdb_write_register(cpu, mem_buf, reg);
451 for (r = cpu->gdb_regs; r; r = r->next) {
452 if (r->base_reg <= reg && reg < r->base_reg + r->num_regs) {
453 return r->set_reg(env, mem_buf, reg - r->base_reg);
459 void gdb_register_coprocessor(CPUState *cpu,
460 gdb_get_reg_cb get_reg, gdb_set_reg_cb set_reg,
461 int num_regs, const char *xml, int g_pos)
464 GDBRegisterState **p;
468 /* Check for duplicates. */
469 if (strcmp((*p)->xml, xml) == 0)
474 s = g_new0(GDBRegisterState, 1);
475 s->base_reg = cpu->gdb_num_regs;
476 s->num_regs = num_regs;
477 s->get_reg = get_reg;
478 s->set_reg = set_reg;
481 /* Add to end of list. */
482 cpu->gdb_num_regs += num_regs;
485 if (g_pos != s->base_reg) {
486 error_report("Error: Bad gdb register numbering for '%s', "
487 "expected %d got %d", xml, g_pos, s->base_reg);
489 cpu->gdb_num_g_regs = cpu->gdb_num_regs;
494 static void gdb_process_breakpoint_remove_all(GDBProcess *p)
496 CPUState *cpu = gdb_get_first_cpu_in_process(p);
499 gdb_breakpoint_remove_all(cpu);
500 cpu = gdb_next_cpu_in_process(cpu);
505 static void gdb_set_cpu_pc(vaddr pc)
507 CPUState *cpu = gdbserver_state.c_cpu;
509 cpu_synchronize_state(cpu);
513 void gdb_append_thread_id(CPUState *cpu, GString *buf)
515 if (gdbserver_state.multiprocess) {
516 g_string_append_printf(buf, "p%02x.%02x",
517 gdb_get_cpu_pid(cpu), gdb_get_cpu_index(cpu));
519 g_string_append_printf(buf, "%02x", gdb_get_cpu_index(cpu));
523 static GDBThreadIdKind read_thread_id(const char *buf, const char **end_buf,
524 uint32_t *pid, uint32_t *tid)
531 ret = qemu_strtoul(buf, &buf, 16, &p);
534 return GDB_READ_THREAD_ERR;
543 ret = qemu_strtoul(buf, &buf, 16, &t);
546 return GDB_READ_THREAD_ERR;
552 return GDB_ALL_PROCESSES;
560 return GDB_ALL_THREADS;
567 return GDB_ONE_THREAD;
571 * gdb_handle_vcont - Parses and handles a vCont packet.
572 * returns -ENOTSUP if a command is unsupported, -EINVAL or -ERANGE if there is
573 * a format error, 0 on success.
575 static int gdb_handle_vcont(const char *p)
583 GDBThreadIdKind kind;
584 unsigned int max_cpus = gdb_get_max_cpus();
585 /* uninitialised CPUs stay 0 */
586 g_autofree char *newstates = g_new0(char, max_cpus);
588 /* mark valid CPUs with 1 */
590 newstates[cpu->cpu_index] = 1;
594 * res keeps track of what error we are returning, with -ENOTSUP meaning
595 * that the command is unknown or unsupported, thus returning an empty
596 * packet, while -EINVAL and -ERANGE cause an E22 packet, due to invalid,
597 * or incorrect parameters passed.
602 * target_count and last_target keep track of how many CPUs we are going to
603 * step or resume, and a pointer to the state structure of one of them,
606 int target_count = 0;
607 CPUState *last_target = NULL;
615 if (cur_action == 'C' || cur_action == 'S') {
616 cur_action = qemu_tolower(cur_action);
617 res = qemu_strtoul(p, &p, 16, &tmp);
621 signal = gdb_signal_to_target(tmp);
622 } else if (cur_action != 'c' && cur_action != 's') {
623 /* unknown/invalid/unsupported command */
627 if (*p == '\0' || *p == ';') {
629 * No thread specifier, action is on "all threads". The
630 * specification is unclear regarding the process to act on. We
631 * choose all processes.
633 kind = GDB_ALL_PROCESSES;
634 } else if (*p++ == ':') {
635 kind = read_thread_id(p, &p, &pid, &tid);
641 case GDB_READ_THREAD_ERR:
644 case GDB_ALL_PROCESSES:
645 cpu = gdb_first_attached_cpu();
647 if (newstates[cpu->cpu_index] == 1) {
648 newstates[cpu->cpu_index] = cur_action;
654 cpu = gdb_next_attached_cpu(cpu);
658 case GDB_ALL_THREADS:
659 process = gdb_get_process(pid);
661 if (!process->attached) {
665 cpu = gdb_get_first_cpu_in_process(process);
667 if (newstates[cpu->cpu_index] == 1) {
668 newstates[cpu->cpu_index] = cur_action;
674 cpu = gdb_next_cpu_in_process(cpu);
679 cpu = gdb_get_cpu(pid, tid);
681 /* invalid CPU/thread specified */
686 /* only use if no previous match occourred */
687 if (newstates[cpu->cpu_index] == 1) {
688 newstates[cpu->cpu_index] = cur_action;
698 * if we're about to resume a specific set of CPUs/threads, make it so that
699 * in case execution gets interrupted, we can send GDB a stop reply with a
700 * correct value. it doesn't really matter which CPU we tell GDB the signal
701 * happened in (VM pauses stop all of them anyway), so long as it is one of
702 * the ones we resumed/single stepped here.
704 if (target_count > 0) {
705 gdbserver_state.c_cpu = last_target;
708 gdbserver_state.signal = signal;
709 gdb_continue_partial(newstates);
713 static const char *cmd_next_param(const char *param, const char delimiter)
715 static const char all_delimiters[] = ",;:=";
716 char curr_delimiters[2] = {0};
717 const char *delimiters;
719 if (delimiter == '?') {
720 delimiters = all_delimiters;
721 } else if (delimiter == '0') {
722 return strchr(param, '\0');
723 } else if (delimiter == '.' && *param) {
726 curr_delimiters[0] = delimiter;
727 delimiters = curr_delimiters;
730 param += strcspn(param, delimiters);
737 static int cmd_parse_params(const char *data, const char *schema,
740 const char *curr_schema, *curr_data;
743 g_assert(params->len == 0);
745 curr_schema = schema;
747 while (curr_schema[0] && curr_schema[1] && *curr_data) {
748 GdbCmdVariant this_param;
750 switch (curr_schema[0]) {
752 if (qemu_strtoul(curr_data, &curr_data, 16,
753 &this_param.val_ul)) {
756 curr_data = cmd_next_param(curr_data, curr_schema[1]);
757 g_array_append_val(params, this_param);
760 if (qemu_strtou64(curr_data, &curr_data, 16,
761 (uint64_t *)&this_param.val_ull)) {
764 curr_data = cmd_next_param(curr_data, curr_schema[1]);
765 g_array_append_val(params, this_param);
768 this_param.data = curr_data;
769 curr_data = cmd_next_param(curr_data, curr_schema[1]);
770 g_array_append_val(params, this_param);
773 this_param.opcode = *(uint8_t *)curr_data;
774 curr_data = cmd_next_param(curr_data, curr_schema[1]);
775 g_array_append_val(params, this_param);
778 this_param.thread_id.kind =
779 read_thread_id(curr_data, &curr_data,
780 &this_param.thread_id.pid,
781 &this_param.thread_id.tid);
782 curr_data = cmd_next_param(curr_data, curr_schema[1]);
783 g_array_append_val(params, this_param);
786 curr_data = cmd_next_param(curr_data, curr_schema[1]);
797 typedef void (*GdbCmdHandler)(GArray *params, void *user_ctx);
800 * cmd_startswith -> cmd is compared using startswith
802 * allow_stop_reply -> true iff the gdbstub can respond to this command with a
803 * "stop reply" packet. The list of commands that accept such response is
804 * defined at the GDB Remote Serial Protocol documentation. see:
805 * https://sourceware.org/gdb/onlinedocs/gdb/Stop-Reply-Packets.html#Stop-Reply-Packets.
807 * schema definitions:
808 * Each schema parameter entry consists of 2 chars,
809 * the first char represents the parameter type handling
810 * the second char represents the delimiter for the next parameter
812 * Currently supported schema types:
813 * 'l' -> unsigned long (stored in .val_ul)
814 * 'L' -> unsigned long long (stored in .val_ull)
815 * 's' -> string (stored in .data)
816 * 'o' -> single char (stored in .opcode)
817 * 't' -> thread id (stored in .thread_id)
818 * '?' -> skip according to delimiter
820 * Currently supported delimiters:
821 * '?' -> Stop at any delimiter (",;:=\0")
822 * '0' -> Stop at "\0"
823 * '.' -> Skip 1 char unless reached "\0"
824 * Any other value is treated as the delimiter value itself
826 typedef struct GdbCmdParseEntry {
827 GdbCmdHandler handler;
831 bool allow_stop_reply;
834 static inline int startswith(const char *string, const char *pattern)
836 return !strncmp(string, pattern, strlen(pattern));
839 static int process_string_cmd(const char *data,
840 const GdbCmdParseEntry *cmds, int num_cmds)
843 g_autoptr(GArray) params = g_array_new(false, true, sizeof(GdbCmdVariant));
849 for (i = 0; i < num_cmds; i++) {
850 const GdbCmdParseEntry *cmd = &cmds[i];
851 g_assert(cmd->handler && cmd->cmd);
853 if ((cmd->cmd_startswith && !startswith(data, cmd->cmd)) ||
854 (!cmd->cmd_startswith && strcmp(cmd->cmd, data))) {
859 if (cmd_parse_params(&data[strlen(cmd->cmd)],
860 cmd->schema, params)) {
865 gdbserver_state.allow_stop_reply = cmd->allow_stop_reply;
866 cmd->handler(params, NULL);
873 static void run_cmd_parser(const char *data, const GdbCmdParseEntry *cmd)
879 g_string_set_size(gdbserver_state.str_buf, 0);
880 g_byte_array_set_size(gdbserver_state.mem_buf, 0);
882 /* In case there was an error during the command parsing we must
883 * send a NULL packet to indicate the command is not supported */
884 if (process_string_cmd(data, cmd, 1)) {
889 static void handle_detach(GArray *params, void *user_ctx)
894 if (gdbserver_state.multiprocess) {
896 gdb_put_packet("E22");
900 pid = get_param(params, 0)->val_ul;
903 process = gdb_get_process(pid);
904 gdb_process_breakpoint_remove_all(process);
905 process->attached = false;
907 if (pid == gdb_get_cpu_pid(gdbserver_state.c_cpu)) {
908 gdbserver_state.c_cpu = gdb_first_attached_cpu();
911 if (pid == gdb_get_cpu_pid(gdbserver_state.g_cpu)) {
912 gdbserver_state.g_cpu = gdb_first_attached_cpu();
915 if (!gdbserver_state.c_cpu) {
916 /* No more process attached */
917 gdb_disable_syscalls();
920 gdb_put_packet("OK");
923 static void handle_thread_alive(GArray *params, void *user_ctx)
928 gdb_put_packet("E22");
932 if (get_param(params, 0)->thread_id.kind == GDB_READ_THREAD_ERR) {
933 gdb_put_packet("E22");
937 cpu = gdb_get_cpu(get_param(params, 0)->thread_id.pid,
938 get_param(params, 0)->thread_id.tid);
940 gdb_put_packet("E22");
944 gdb_put_packet("OK");
947 static void handle_continue(GArray *params, void *user_ctx)
950 gdb_set_cpu_pc(get_param(params, 0)->val_ull);
953 gdbserver_state.signal = 0;
957 static void handle_cont_with_sig(GArray *params, void *user_ctx)
959 unsigned long signal = 0;
962 * Note: C sig;[addr] is currently unsupported and we simply
963 * omit the addr parameter
966 signal = get_param(params, 0)->val_ul;
969 gdbserver_state.signal = gdb_signal_to_target(signal);
970 if (gdbserver_state.signal == -1) {
971 gdbserver_state.signal = 0;
976 static void handle_set_thread(GArray *params, void *user_ctx)
980 if (params->len != 2) {
981 gdb_put_packet("E22");
985 if (get_param(params, 1)->thread_id.kind == GDB_READ_THREAD_ERR) {
986 gdb_put_packet("E22");
990 if (get_param(params, 1)->thread_id.kind != GDB_ONE_THREAD) {
991 gdb_put_packet("OK");
995 cpu = gdb_get_cpu(get_param(params, 1)->thread_id.pid,
996 get_param(params, 1)->thread_id.tid);
998 gdb_put_packet("E22");
1003 * Note: This command is deprecated and modern gdb's will be using the
1004 * vCont command instead.
1006 switch (get_param(params, 0)->opcode) {
1008 gdbserver_state.c_cpu = cpu;
1009 gdb_put_packet("OK");
1012 gdbserver_state.g_cpu = cpu;
1013 gdb_put_packet("OK");
1016 gdb_put_packet("E22");
1021 static void handle_insert_bp(GArray *params, void *user_ctx)
1025 if (params->len != 3) {
1026 gdb_put_packet("E22");
1030 res = gdb_breakpoint_insert(gdbserver_state.c_cpu,
1031 get_param(params, 0)->val_ul,
1032 get_param(params, 1)->val_ull,
1033 get_param(params, 2)->val_ull);
1035 gdb_put_packet("OK");
1037 } else if (res == -ENOSYS) {
1042 gdb_put_packet("E22");
1045 static void handle_remove_bp(GArray *params, void *user_ctx)
1049 if (params->len != 3) {
1050 gdb_put_packet("E22");
1054 res = gdb_breakpoint_remove(gdbserver_state.c_cpu,
1055 get_param(params, 0)->val_ul,
1056 get_param(params, 1)->val_ull,
1057 get_param(params, 2)->val_ull);
1059 gdb_put_packet("OK");
1061 } else if (res == -ENOSYS) {
1066 gdb_put_packet("E22");
1070 * handle_set/get_reg
1072 * Older gdb are really dumb, and don't use 'G/g' if 'P/p' is available.
1073 * This works, but can be very slow. Anything new enough to understand
1074 * XML also knows how to use this properly. However to use this we
1075 * need to define a local XML file as well as be talking to a
1076 * reasonably modern gdb. Responding with an empty packet will cause
1077 * the remote gdb to fallback to older methods.
1080 static void handle_set_reg(GArray *params, void *user_ctx)
1084 if (params->len != 2) {
1085 gdb_put_packet("E22");
1089 reg_size = strlen(get_param(params, 1)->data) / 2;
1090 gdb_hextomem(gdbserver_state.mem_buf, get_param(params, 1)->data, reg_size);
1091 gdb_write_register(gdbserver_state.g_cpu, gdbserver_state.mem_buf->data,
1092 get_param(params, 0)->val_ull);
1093 gdb_put_packet("OK");
1096 static void handle_get_reg(GArray *params, void *user_ctx)
1101 gdb_put_packet("E14");
1105 reg_size = gdb_read_register(gdbserver_state.g_cpu,
1106 gdbserver_state.mem_buf,
1107 get_param(params, 0)->val_ull);
1109 gdb_put_packet("E14");
1112 g_byte_array_set_size(gdbserver_state.mem_buf, reg_size);
1115 gdb_memtohex(gdbserver_state.str_buf,
1116 gdbserver_state.mem_buf->data, reg_size);
1120 static void handle_write_mem(GArray *params, void *user_ctx)
1122 if (params->len != 3) {
1123 gdb_put_packet("E22");
1127 /* gdb_hextomem() reads 2*len bytes */
1128 if (get_param(params, 1)->val_ull >
1129 strlen(get_param(params, 2)->data) / 2) {
1130 gdb_put_packet("E22");
1134 gdb_hextomem(gdbserver_state.mem_buf, get_param(params, 2)->data,
1135 get_param(params, 1)->val_ull);
1136 if (gdb_target_memory_rw_debug(gdbserver_state.g_cpu,
1137 get_param(params, 0)->val_ull,
1138 gdbserver_state.mem_buf->data,
1139 gdbserver_state.mem_buf->len, true)) {
1140 gdb_put_packet("E14");
1144 gdb_put_packet("OK");
1147 static void handle_read_mem(GArray *params, void *user_ctx)
1149 if (params->len != 2) {
1150 gdb_put_packet("E22");
1154 /* gdb_memtohex() doubles the required space */
1155 if (get_param(params, 1)->val_ull > MAX_PACKET_LENGTH / 2) {
1156 gdb_put_packet("E22");
1160 g_byte_array_set_size(gdbserver_state.mem_buf,
1161 get_param(params, 1)->val_ull);
1163 if (gdb_target_memory_rw_debug(gdbserver_state.g_cpu,
1164 get_param(params, 0)->val_ull,
1165 gdbserver_state.mem_buf->data,
1166 gdbserver_state.mem_buf->len, false)) {
1167 gdb_put_packet("E14");
1171 gdb_memtohex(gdbserver_state.str_buf, gdbserver_state.mem_buf->data,
1172 gdbserver_state.mem_buf->len);
1176 static void handle_write_all_regs(GArray *params, void *user_ctx)
1187 cpu_synchronize_state(gdbserver_state.g_cpu);
1188 len = strlen(get_param(params, 0)->data) / 2;
1189 gdb_hextomem(gdbserver_state.mem_buf, get_param(params, 0)->data, len);
1190 registers = gdbserver_state.mem_buf->data;
1192 reg_id < gdbserver_state.g_cpu->gdb_num_g_regs && len > 0;
1194 reg_size = gdb_write_register(gdbserver_state.g_cpu, registers, reg_id);
1196 registers += reg_size;
1198 gdb_put_packet("OK");
1201 static void handle_read_all_regs(GArray *params, void *user_ctx)
1206 cpu_synchronize_state(gdbserver_state.g_cpu);
1207 g_byte_array_set_size(gdbserver_state.mem_buf, 0);
1209 for (reg_id = 0; reg_id < gdbserver_state.g_cpu->gdb_num_g_regs; reg_id++) {
1210 len += gdb_read_register(gdbserver_state.g_cpu,
1211 gdbserver_state.mem_buf,
1214 g_assert(len == gdbserver_state.mem_buf->len);
1216 gdb_memtohex(gdbserver_state.str_buf, gdbserver_state.mem_buf->data, len);
1221 static void handle_step(GArray *params, void *user_ctx)
1224 gdb_set_cpu_pc(get_param(params, 0)->val_ull);
1227 cpu_single_step(gdbserver_state.c_cpu, gdbserver_state.sstep_flags);
1231 static void handle_backward(GArray *params, void *user_ctx)
1233 if (!gdb_can_reverse()) {
1234 gdb_put_packet("E22");
1236 if (params->len == 1) {
1237 switch (get_param(params, 0)->opcode) {
1239 if (replay_reverse_step()) {
1242 gdb_put_packet("E14");
1246 if (replay_reverse_continue()) {
1249 gdb_put_packet("E14");
1255 /* Default invalid command */
1259 static void handle_v_cont_query(GArray *params, void *user_ctx)
1261 gdb_put_packet("vCont;c;C;s;S");
1264 static void handle_v_cont(GArray *params, void *user_ctx)
1272 res = gdb_handle_vcont(get_param(params, 0)->data);
1273 if ((res == -EINVAL) || (res == -ERANGE)) {
1274 gdb_put_packet("E22");
1280 static void handle_v_attach(GArray *params, void *user_ctx)
1282 GDBProcess *process;
1285 g_string_assign(gdbserver_state.str_buf, "E22");
1290 process = gdb_get_process(get_param(params, 0)->val_ul);
1295 cpu = gdb_get_first_cpu_in_process(process);
1300 process->attached = true;
1301 gdbserver_state.g_cpu = cpu;
1302 gdbserver_state.c_cpu = cpu;
1304 if (gdbserver_state.allow_stop_reply) {
1305 g_string_printf(gdbserver_state.str_buf, "T%02xthread:", GDB_SIGNAL_TRAP);
1306 gdb_append_thread_id(cpu, gdbserver_state.str_buf);
1307 g_string_append_c(gdbserver_state.str_buf, ';');
1308 gdbserver_state.allow_stop_reply = false;
1314 static void handle_v_kill(GArray *params, void *user_ctx)
1316 /* Kill the target */
1317 gdb_put_packet("OK");
1318 error_report("QEMU: Terminated via GDBstub");
1323 static const GdbCmdParseEntry gdb_v_commands_table[] = {
1324 /* Order is important if has same prefix */
1326 .handler = handle_v_cont_query,
1331 .handler = handle_v_cont,
1333 .cmd_startswith = 1,
1334 .allow_stop_reply = true,
1338 .handler = handle_v_attach,
1340 .cmd_startswith = 1,
1341 .allow_stop_reply = true,
1345 .handler = handle_v_kill,
1349 #ifdef CONFIG_USER_ONLY
1351 * Host I/O Packets. See [1] for details.
1352 * [1] https://sourceware.org/gdb/onlinedocs/gdb/Host-I_002fO-Packets.html
1355 .handler = gdb_handle_v_file_open,
1356 .cmd = "File:open:",
1357 .cmd_startswith = 1,
1361 .handler = gdb_handle_v_file_close,
1362 .cmd = "File:close:",
1363 .cmd_startswith = 1,
1367 .handler = gdb_handle_v_file_pread,
1368 .cmd = "File:pread:",
1369 .cmd_startswith = 1,
1373 .handler = gdb_handle_v_file_readlink,
1374 .cmd = "File:readlink:",
1375 .cmd_startswith = 1,
1381 static void handle_v_commands(GArray *params, void *user_ctx)
1387 if (process_string_cmd(get_param(params, 0)->data,
1388 gdb_v_commands_table,
1389 ARRAY_SIZE(gdb_v_commands_table))) {
1394 static void handle_query_qemu_sstepbits(GArray *params, void *user_ctx)
1396 g_string_printf(gdbserver_state.str_buf, "ENABLE=%x", SSTEP_ENABLE);
1398 if (gdbserver_state.supported_sstep_flags & SSTEP_NOIRQ) {
1399 g_string_append_printf(gdbserver_state.str_buf, ",NOIRQ=%x",
1403 if (gdbserver_state.supported_sstep_flags & SSTEP_NOTIMER) {
1404 g_string_append_printf(gdbserver_state.str_buf, ",NOTIMER=%x",
1411 static void handle_set_qemu_sstep(GArray *params, void *user_ctx)
1413 int new_sstep_flags;
1419 new_sstep_flags = get_param(params, 0)->val_ul;
1421 if (new_sstep_flags & ~gdbserver_state.supported_sstep_flags) {
1422 gdb_put_packet("E22");
1426 gdbserver_state.sstep_flags = new_sstep_flags;
1427 gdb_put_packet("OK");
1430 static void handle_query_qemu_sstep(GArray *params, void *user_ctx)
1432 g_string_printf(gdbserver_state.str_buf, "0x%x",
1433 gdbserver_state.sstep_flags);
1437 static void handle_query_curr_tid(GArray *params, void *user_ctx)
1440 GDBProcess *process;
1443 * "Current thread" remains vague in the spec, so always return
1444 * the first thread of the current process (gdb returns the
1447 process = gdb_get_cpu_process(gdbserver_state.g_cpu);
1448 cpu = gdb_get_first_cpu_in_process(process);
1449 g_string_assign(gdbserver_state.str_buf, "QC");
1450 gdb_append_thread_id(cpu, gdbserver_state.str_buf);
1454 static void handle_query_threads(GArray *params, void *user_ctx)
1456 if (!gdbserver_state.query_cpu) {
1457 gdb_put_packet("l");
1461 g_string_assign(gdbserver_state.str_buf, "m");
1462 gdb_append_thread_id(gdbserver_state.query_cpu, gdbserver_state.str_buf);
1464 gdbserver_state.query_cpu = gdb_next_attached_cpu(gdbserver_state.query_cpu);
1467 static void handle_query_first_threads(GArray *params, void *user_ctx)
1469 gdbserver_state.query_cpu = gdb_first_attached_cpu();
1470 handle_query_threads(params, user_ctx);
1473 static void handle_query_thread_extra(GArray *params, void *user_ctx)
1475 g_autoptr(GString) rs = g_string_new(NULL);
1479 get_param(params, 0)->thread_id.kind == GDB_READ_THREAD_ERR) {
1480 gdb_put_packet("E22");
1484 cpu = gdb_get_cpu(get_param(params, 0)->thread_id.pid,
1485 get_param(params, 0)->thread_id.tid);
1490 cpu_synchronize_state(cpu);
1492 if (gdbserver_state.multiprocess && (gdbserver_state.process_num > 1)) {
1493 /* Print the CPU model and name in multiprocess mode */
1494 ObjectClass *oc = object_get_class(OBJECT(cpu));
1495 const char *cpu_model = object_class_get_name(oc);
1496 const char *cpu_name =
1497 object_get_canonical_path_component(OBJECT(cpu));
1498 g_string_printf(rs, "%s %s [%s]", cpu_model, cpu_name,
1499 cpu->halted ? "halted " : "running");
1501 g_string_printf(rs, "CPU#%d [%s]", cpu->cpu_index,
1502 cpu->halted ? "halted " : "running");
1504 trace_gdbstub_op_extra_info(rs->str);
1505 gdb_memtohex(gdbserver_state.str_buf, (uint8_t *)rs->str, rs->len);
1509 static void handle_query_supported(GArray *params, void *user_ctx)
1513 g_string_printf(gdbserver_state.str_buf, "PacketSize=%x", MAX_PACKET_LENGTH);
1514 cc = CPU_GET_CLASS(first_cpu);
1515 if (cc->gdb_core_xml_file) {
1516 g_string_append(gdbserver_state.str_buf, ";qXfer:features:read+");
1519 if (gdb_can_reverse()) {
1520 g_string_append(gdbserver_state.str_buf,
1521 ";ReverseStep+;ReverseContinue+");
1524 #if defined(CONFIG_USER_ONLY)
1525 #if defined(CONFIG_LINUX)
1526 if (gdbserver_state.c_cpu->opaque) {
1527 g_string_append(gdbserver_state.str_buf, ";qXfer:auxv:read+");
1530 g_string_append(gdbserver_state.str_buf, ";qXfer:exec-file:read+");
1534 strstr(get_param(params, 0)->data, "multiprocess+")) {
1535 gdbserver_state.multiprocess = true;
1538 g_string_append(gdbserver_state.str_buf, ";vContSupported+;multiprocess+");
1542 static void handle_query_xfer_features(GArray *params, void *user_ctx)
1544 GDBProcess *process;
1546 unsigned long len, total_len, addr;
1550 if (params->len < 3) {
1551 gdb_put_packet("E22");
1555 process = gdb_get_cpu_process(gdbserver_state.g_cpu);
1556 cc = CPU_GET_CLASS(gdbserver_state.g_cpu);
1557 if (!cc->gdb_core_xml_file) {
1562 p = get_param(params, 0)->data;
1563 xml = get_feature_xml(p, &p, process);
1565 gdb_put_packet("E00");
1569 addr = get_param(params, 1)->val_ul;
1570 len = get_param(params, 2)->val_ul;
1571 total_len = strlen(xml);
1572 if (addr > total_len) {
1573 gdb_put_packet("E00");
1577 if (len > (MAX_PACKET_LENGTH - 5) / 2) {
1578 len = (MAX_PACKET_LENGTH - 5) / 2;
1581 if (len < total_len - addr) {
1582 g_string_assign(gdbserver_state.str_buf, "m");
1583 gdb_memtox(gdbserver_state.str_buf, xml + addr, len);
1585 g_string_assign(gdbserver_state.str_buf, "l");
1586 gdb_memtox(gdbserver_state.str_buf, xml + addr, total_len - addr);
1589 gdb_put_packet_binary(gdbserver_state.str_buf->str,
1590 gdbserver_state.str_buf->len, true);
1593 static void handle_query_qemu_supported(GArray *params, void *user_ctx)
1595 g_string_printf(gdbserver_state.str_buf, "sstepbits;sstep");
1596 #ifndef CONFIG_USER_ONLY
1597 g_string_append(gdbserver_state.str_buf, ";PhyMemMode");
1602 static const GdbCmdParseEntry gdb_gen_query_set_common_table[] = {
1603 /* Order is important if has same prefix */
1605 .handler = handle_query_qemu_sstepbits,
1606 .cmd = "qemu.sstepbits",
1609 .handler = handle_query_qemu_sstep,
1610 .cmd = "qemu.sstep",
1613 .handler = handle_set_qemu_sstep,
1614 .cmd = "qemu.sstep=",
1615 .cmd_startswith = 1,
1620 static const GdbCmdParseEntry gdb_gen_query_table[] = {
1622 .handler = handle_query_curr_tid,
1626 .handler = handle_query_threads,
1627 .cmd = "sThreadInfo",
1630 .handler = handle_query_first_threads,
1631 .cmd = "fThreadInfo",
1634 .handler = handle_query_thread_extra,
1635 .cmd = "ThreadExtraInfo,",
1636 .cmd_startswith = 1,
1639 #ifdef CONFIG_USER_ONLY
1641 .handler = gdb_handle_query_offsets,
1646 .handler = gdb_handle_query_rcmd,
1648 .cmd_startswith = 1,
1653 .handler = handle_query_supported,
1654 .cmd = "Supported:",
1655 .cmd_startswith = 1,
1659 .handler = handle_query_supported,
1664 .handler = handle_query_xfer_features,
1665 .cmd = "Xfer:features:read:",
1666 .cmd_startswith = 1,
1669 #if defined(CONFIG_USER_ONLY)
1670 #if defined(CONFIG_LINUX)
1672 .handler = gdb_handle_query_xfer_auxv,
1673 .cmd = "Xfer:auxv:read::",
1674 .cmd_startswith = 1,
1679 .handler = gdb_handle_query_xfer_exec_file,
1680 .cmd = "Xfer:exec-file:read:",
1681 .cmd_startswith = 1,
1686 .handler = gdb_handle_query_attached,
1691 .handler = gdb_handle_query_attached,
1695 .handler = handle_query_qemu_supported,
1696 .cmd = "qemu.Supported",
1698 #ifndef CONFIG_USER_ONLY
1700 .handler = gdb_handle_query_qemu_phy_mem_mode,
1701 .cmd = "qemu.PhyMemMode",
1706 static const GdbCmdParseEntry gdb_gen_set_table[] = {
1707 /* Order is important if has same prefix */
1709 .handler = handle_set_qemu_sstep,
1710 .cmd = "qemu.sstep:",
1711 .cmd_startswith = 1,
1714 #ifndef CONFIG_USER_ONLY
1716 .handler = gdb_handle_set_qemu_phy_mem_mode,
1717 .cmd = "qemu.PhyMemMode:",
1718 .cmd_startswith = 1,
1724 static void handle_gen_query(GArray *params, void *user_ctx)
1730 if (!process_string_cmd(get_param(params, 0)->data,
1731 gdb_gen_query_set_common_table,
1732 ARRAY_SIZE(gdb_gen_query_set_common_table))) {
1736 if (process_string_cmd(get_param(params, 0)->data,
1737 gdb_gen_query_table,
1738 ARRAY_SIZE(gdb_gen_query_table))) {
1743 static void handle_gen_set(GArray *params, void *user_ctx)
1749 if (!process_string_cmd(get_param(params, 0)->data,
1750 gdb_gen_query_set_common_table,
1751 ARRAY_SIZE(gdb_gen_query_set_common_table))) {
1755 if (process_string_cmd(get_param(params, 0)->data,
1757 ARRAY_SIZE(gdb_gen_set_table))) {
1762 static void handle_target_halt(GArray *params, void *user_ctx)
1764 if (gdbserver_state.allow_stop_reply) {
1765 g_string_printf(gdbserver_state.str_buf, "T%02xthread:", GDB_SIGNAL_TRAP);
1766 gdb_append_thread_id(gdbserver_state.c_cpu, gdbserver_state.str_buf);
1767 g_string_append_c(gdbserver_state.str_buf, ';');
1769 gdbserver_state.allow_stop_reply = false;
1772 * Remove all the breakpoints when this query is issued,
1773 * because gdb is doing an initial connect and the state
1774 * should be cleaned up.
1776 gdb_breakpoint_remove_all(gdbserver_state.c_cpu);
1779 static int gdb_handle_packet(const char *line_buf)
1781 const GdbCmdParseEntry *cmd_parser = NULL;
1783 trace_gdbstub_io_command(line_buf);
1785 switch (line_buf[0]) {
1787 gdb_put_packet("OK");
1791 static const GdbCmdParseEntry target_halted_cmd_desc = {
1792 .handler = handle_target_halt,
1794 .cmd_startswith = 1,
1795 .allow_stop_reply = true,
1797 cmd_parser = &target_halted_cmd_desc;
1802 static const GdbCmdParseEntry continue_cmd_desc = {
1803 .handler = handle_continue,
1805 .cmd_startswith = 1,
1806 .allow_stop_reply = true,
1809 cmd_parser = &continue_cmd_desc;
1814 static const GdbCmdParseEntry cont_with_sig_cmd_desc = {
1815 .handler = handle_cont_with_sig,
1817 .cmd_startswith = 1,
1818 .allow_stop_reply = true,
1821 cmd_parser = &cont_with_sig_cmd_desc;
1826 static const GdbCmdParseEntry v_cmd_desc = {
1827 .handler = handle_v_commands,
1829 .cmd_startswith = 1,
1832 cmd_parser = &v_cmd_desc;
1836 /* Kill the target */
1837 error_report("QEMU: Terminated via GDBstub");
1842 static const GdbCmdParseEntry detach_cmd_desc = {
1843 .handler = handle_detach,
1845 .cmd_startswith = 1,
1848 cmd_parser = &detach_cmd_desc;
1853 static const GdbCmdParseEntry step_cmd_desc = {
1854 .handler = handle_step,
1856 .cmd_startswith = 1,
1857 .allow_stop_reply = true,
1860 cmd_parser = &step_cmd_desc;
1865 static const GdbCmdParseEntry backward_cmd_desc = {
1866 .handler = handle_backward,
1868 .cmd_startswith = 1,
1869 .allow_stop_reply = true,
1872 cmd_parser = &backward_cmd_desc;
1877 static const GdbCmdParseEntry file_io_cmd_desc = {
1878 .handler = gdb_handle_file_io,
1880 .cmd_startswith = 1,
1883 cmd_parser = &file_io_cmd_desc;
1888 static const GdbCmdParseEntry read_all_regs_cmd_desc = {
1889 .handler = handle_read_all_regs,
1893 cmd_parser = &read_all_regs_cmd_desc;
1898 static const GdbCmdParseEntry write_all_regs_cmd_desc = {
1899 .handler = handle_write_all_regs,
1901 .cmd_startswith = 1,
1904 cmd_parser = &write_all_regs_cmd_desc;
1909 static const GdbCmdParseEntry read_mem_cmd_desc = {
1910 .handler = handle_read_mem,
1912 .cmd_startswith = 1,
1915 cmd_parser = &read_mem_cmd_desc;
1920 static const GdbCmdParseEntry write_mem_cmd_desc = {
1921 .handler = handle_write_mem,
1923 .cmd_startswith = 1,
1926 cmd_parser = &write_mem_cmd_desc;
1931 static const GdbCmdParseEntry get_reg_cmd_desc = {
1932 .handler = handle_get_reg,
1934 .cmd_startswith = 1,
1937 cmd_parser = &get_reg_cmd_desc;
1942 static const GdbCmdParseEntry set_reg_cmd_desc = {
1943 .handler = handle_set_reg,
1945 .cmd_startswith = 1,
1948 cmd_parser = &set_reg_cmd_desc;
1953 static const GdbCmdParseEntry insert_bp_cmd_desc = {
1954 .handler = handle_insert_bp,
1956 .cmd_startswith = 1,
1959 cmd_parser = &insert_bp_cmd_desc;
1964 static const GdbCmdParseEntry remove_bp_cmd_desc = {
1965 .handler = handle_remove_bp,
1967 .cmd_startswith = 1,
1970 cmd_parser = &remove_bp_cmd_desc;
1975 static const GdbCmdParseEntry set_thread_cmd_desc = {
1976 .handler = handle_set_thread,
1978 .cmd_startswith = 1,
1981 cmd_parser = &set_thread_cmd_desc;
1986 static const GdbCmdParseEntry thread_alive_cmd_desc = {
1987 .handler = handle_thread_alive,
1989 .cmd_startswith = 1,
1992 cmd_parser = &thread_alive_cmd_desc;
1997 static const GdbCmdParseEntry gen_query_cmd_desc = {
1998 .handler = handle_gen_query,
2000 .cmd_startswith = 1,
2003 cmd_parser = &gen_query_cmd_desc;
2008 static const GdbCmdParseEntry gen_set_cmd_desc = {
2009 .handler = handle_gen_set,
2011 .cmd_startswith = 1,
2014 cmd_parser = &gen_set_cmd_desc;
2018 /* put empty packet */
2024 run_cmd_parser(line_buf, cmd_parser);
2030 void gdb_set_stop_cpu(CPUState *cpu)
2032 GDBProcess *p = gdb_get_cpu_process(cpu);
2036 * Having a stop CPU corresponding to a process that is not attached
2037 * confuses GDB. So we ignore the request.
2042 gdbserver_state.c_cpu = cpu;
2043 gdbserver_state.g_cpu = cpu;
2046 void gdb_read_byte(uint8_t ch)
2050 gdbserver_state.allow_stop_reply = false;
2051 #ifndef CONFIG_USER_ONLY
2052 if (gdbserver_state.last_packet->len) {
2053 /* Waiting for a response to the last packet. If we see the start
2054 of a new command then abandon the previous response. */
2056 trace_gdbstub_err_got_nack();
2057 gdb_put_buffer(gdbserver_state.last_packet->data,
2058 gdbserver_state.last_packet->len);
2059 } else if (ch == '+') {
2060 trace_gdbstub_io_got_ack();
2062 trace_gdbstub_io_got_unexpected(ch);
2065 if (ch == '+' || ch == '$') {
2066 g_byte_array_set_size(gdbserver_state.last_packet, 0);
2071 if (runstate_is_running()) {
2073 * When the CPU is running, we cannot do anything except stop
2074 * it when receiving a char. This is expected on a Ctrl-C in the
2075 * gdb client. Because we are in all-stop mode, gdb sends a
2076 * 0x03 byte which is not a usual packet, so we handle it specially
2077 * here, but it does expect a stop reply.
2080 trace_gdbstub_err_unexpected_runpkt(ch);
2082 gdbserver_state.allow_stop_reply = true;
2084 vm_stop(RUN_STATE_PAUSED);
2088 switch(gdbserver_state.state) {
2091 /* start of command packet */
2092 gdbserver_state.line_buf_index = 0;
2093 gdbserver_state.line_sum = 0;
2094 gdbserver_state.state = RS_GETLINE;
2095 } else if (ch == '+') {
2097 * do nothing, gdb may preemptively send out ACKs on
2098 * initial connection
2101 trace_gdbstub_err_garbage(ch);
2106 /* start escape sequence */
2107 gdbserver_state.state = RS_GETLINE_ESC;
2108 gdbserver_state.line_sum += ch;
2109 } else if (ch == '*') {
2110 /* start run length encoding sequence */
2111 gdbserver_state.state = RS_GETLINE_RLE;
2112 gdbserver_state.line_sum += ch;
2113 } else if (ch == '#') {
2114 /* end of command, start of checksum*/
2115 gdbserver_state.state = RS_CHKSUM1;
2116 } else if (gdbserver_state.line_buf_index >= sizeof(gdbserver_state.line_buf) - 1) {
2117 trace_gdbstub_err_overrun();
2118 gdbserver_state.state = RS_IDLE;
2120 /* unescaped command character */
2121 gdbserver_state.line_buf[gdbserver_state.line_buf_index++] = ch;
2122 gdbserver_state.line_sum += ch;
2125 case RS_GETLINE_ESC:
2127 /* unexpected end of command in escape sequence */
2128 gdbserver_state.state = RS_CHKSUM1;
2129 } else if (gdbserver_state.line_buf_index >= sizeof(gdbserver_state.line_buf) - 1) {
2130 /* command buffer overrun */
2131 trace_gdbstub_err_overrun();
2132 gdbserver_state.state = RS_IDLE;
2134 /* parse escaped character and leave escape state */
2135 gdbserver_state.line_buf[gdbserver_state.line_buf_index++] = ch ^ 0x20;
2136 gdbserver_state.line_sum += ch;
2137 gdbserver_state.state = RS_GETLINE;
2140 case RS_GETLINE_RLE:
2142 * Run-length encoding is explained in "Debugging with GDB /
2143 * Appendix E GDB Remote Serial Protocol / Overview".
2145 if (ch < ' ' || ch == '#' || ch == '$' || ch > 126) {
2146 /* invalid RLE count encoding */
2147 trace_gdbstub_err_invalid_repeat(ch);
2148 gdbserver_state.state = RS_GETLINE;
2150 /* decode repeat length */
2151 int repeat = ch - ' ' + 3;
2152 if (gdbserver_state.line_buf_index + repeat >= sizeof(gdbserver_state.line_buf) - 1) {
2153 /* that many repeats would overrun the command buffer */
2154 trace_gdbstub_err_overrun();
2155 gdbserver_state.state = RS_IDLE;
2156 } else if (gdbserver_state.line_buf_index < 1) {
2157 /* got a repeat but we have nothing to repeat */
2158 trace_gdbstub_err_invalid_rle();
2159 gdbserver_state.state = RS_GETLINE;
2161 /* repeat the last character */
2162 memset(gdbserver_state.line_buf + gdbserver_state.line_buf_index,
2163 gdbserver_state.line_buf[gdbserver_state.line_buf_index - 1], repeat);
2164 gdbserver_state.line_buf_index += repeat;
2165 gdbserver_state.line_sum += ch;
2166 gdbserver_state.state = RS_GETLINE;
2171 /* get high hex digit of checksum */
2172 if (!isxdigit(ch)) {
2173 trace_gdbstub_err_checksum_invalid(ch);
2174 gdbserver_state.state = RS_GETLINE;
2177 gdbserver_state.line_buf[gdbserver_state.line_buf_index] = '\0';
2178 gdbserver_state.line_csum = fromhex(ch) << 4;
2179 gdbserver_state.state = RS_CHKSUM2;
2182 /* get low hex digit of checksum */
2183 if (!isxdigit(ch)) {
2184 trace_gdbstub_err_checksum_invalid(ch);
2185 gdbserver_state.state = RS_GETLINE;
2188 gdbserver_state.line_csum |= fromhex(ch);
2190 if (gdbserver_state.line_csum != (gdbserver_state.line_sum & 0xff)) {
2191 trace_gdbstub_err_checksum_incorrect(gdbserver_state.line_sum, gdbserver_state.line_csum);
2192 /* send NAK reply */
2194 gdb_put_buffer(&reply, 1);
2195 gdbserver_state.state = RS_IDLE;
2197 /* send ACK reply */
2199 gdb_put_buffer(&reply, 1);
2200 gdbserver_state.state = gdb_handle_packet(gdbserver_state.line_buf);
2210 * Create the process that will contain all the "orphan" CPUs (that are not
2211 * part of a CPU cluster). Note that if this process contains no CPUs, it won't
2212 * be attachable and thus will be invisible to the user.
2214 void gdb_create_default_process(GDBState *s)
2216 GDBProcess *process;
2219 #ifdef CONFIG_USER_ONLY
2220 assert(gdbserver_state.process_num == 0);
2223 if (gdbserver_state.process_num) {
2224 pid = s->processes[s->process_num - 1].pid;
2228 /* We need an available PID slot for this process */
2229 assert(pid < UINT32_MAX);
2233 s->processes = g_renew(GDBProcess, s->processes, ++s->process_num);
2234 process = &s->processes[s->process_num - 1];
2236 process->attached = false;
2237 process->target_xml = NULL;