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
;
56 GDBState gdbserver_state
;
58 void gdb_init_gdbserver_state(void)
60 g_assert(!gdbserver_state
.init
);
61 memset(&gdbserver_state
, 0, sizeof(GDBState
));
62 gdbserver_state
.init
= true;
63 gdbserver_state
.str_buf
= g_string_new(NULL
);
64 gdbserver_state
.mem_buf
= g_byte_array_sized_new(MAX_PACKET_LENGTH
);
65 gdbserver_state
.last_packet
= g_byte_array_sized_new(MAX_PACKET_LENGTH
+ 4);
68 * What single-step modes are supported is accelerator dependent.
69 * By default try to use no IRQs and no timers while single
70 * stepping so as to make single stepping like a typical ICE HW step.
72 gdbserver_state
.supported_sstep_flags
= accel_supported_gdbstub_sstep_flags();
73 gdbserver_state
.sstep_flags
= SSTEP_ENABLE
| SSTEP_NOIRQ
| SSTEP_NOTIMER
;
74 gdbserver_state
.sstep_flags
&= gdbserver_state
.supported_sstep_flags
;
77 /* writes 2*len+1 bytes in buf */
78 void gdb_memtohex(GString
*buf
, const uint8_t *mem
, int len
)
81 for(i
= 0; i
< len
; i
++) {
83 g_string_append_c(buf
, tohex(c
>> 4));
84 g_string_append_c(buf
, tohex(c
& 0xf));
86 g_string_append_c(buf
, '\0');
89 void gdb_hextomem(GByteArray
*mem
, const char *buf
, int len
)
93 for(i
= 0; i
< len
; i
++) {
94 guint8 byte
= fromhex(buf
[0]) << 4 | fromhex(buf
[1]);
95 g_byte_array_append(mem
, &byte
, 1);
100 static void hexdump(const char *buf
, int len
,
101 void (*trace_fn
)(size_t ofs
, char const *text
))
103 char line_buffer
[3 * 16 + 4 + 16 + 1];
106 for (i
= 0; i
< len
|| (i
& 0xF); ++i
) {
107 size_t byte_ofs
= i
& 15;
110 memset(line_buffer
, ' ', 3 * 16 + 4 + 16);
111 line_buffer
[3 * 16 + 4 + 16] = 0;
114 size_t col_group
= (i
>> 2) & 3;
115 size_t hex_col
= byte_ofs
* 3 + col_group
;
116 size_t txt_col
= 3 * 16 + 4 + byte_ofs
;
121 line_buffer
[hex_col
+ 0] = tohex((value
>> 4) & 0xF);
122 line_buffer
[hex_col
+ 1] = tohex((value
>> 0) & 0xF);
123 line_buffer
[txt_col
+ 0] = (value
>= ' ' && value
< 127)
129 trace_fn(i
& -16, line_buffer
);
133 /* return -1 if error, 0 if OK */
134 int gdb_put_packet_binary(const char *buf
, int len
, bool dump
)
139 if (dump
&& trace_event_get_state_backends(TRACE_GDBSTUB_IO_BINARYREPLY
)) {
140 hexdump(buf
, len
, trace_gdbstub_io_binaryreply
);
144 g_byte_array_set_size(gdbserver_state
.last_packet
, 0);
145 g_byte_array_append(gdbserver_state
.last_packet
,
146 (const uint8_t *) "$", 1);
147 g_byte_array_append(gdbserver_state
.last_packet
,
148 (const uint8_t *) buf
, len
);
150 for(i
= 0; i
< len
; i
++) {
154 footer
[1] = tohex((csum
>> 4) & 0xf);
155 footer
[2] = tohex((csum
) & 0xf);
156 g_byte_array_append(gdbserver_state
.last_packet
, footer
, 3);
158 gdb_put_buffer(gdbserver_state
.last_packet
->data
,
159 gdbserver_state
.last_packet
->len
);
161 if (gdb_got_immediate_ack()) {
168 /* return -1 if error, 0 if OK */
169 int gdb_put_packet(const char *buf
)
171 trace_gdbstub_io_reply(buf
);
173 return gdb_put_packet_binary(buf
, strlen(buf
), false);
176 void gdb_put_strbuf(void)
178 gdb_put_packet(gdbserver_state
.str_buf
->str
);
181 /* Encode data using the encoding for 'x' packets. */
182 void gdb_memtox(GString
*buf
, const char *mem
, int len
)
189 case '#': case '$': case '*': case '}':
190 g_string_append_c(buf
, '}');
191 g_string_append_c(buf
, c
^ 0x20);
194 g_string_append_c(buf
, c
);
200 static uint32_t gdb_get_cpu_pid(CPUState
*cpu
)
202 #ifdef CONFIG_USER_ONLY
205 if (cpu
->cluster_index
== UNASSIGNED_CLUSTER_INDEX
) {
206 /* Return the default process' PID */
207 int index
= gdbserver_state
.process_num
- 1;
208 return gdbserver_state
.processes
[index
].pid
;
210 return cpu
->cluster_index
+ 1;
214 GDBProcess
*gdb_get_process(uint32_t pid
)
219 /* 0 means any process, we take the first one */
220 return &gdbserver_state
.processes
[0];
223 for (i
= 0; i
< gdbserver_state
.process_num
; i
++) {
224 if (gdbserver_state
.processes
[i
].pid
== pid
) {
225 return &gdbserver_state
.processes
[i
];
232 static GDBProcess
*gdb_get_cpu_process(CPUState
*cpu
)
234 return gdb_get_process(gdb_get_cpu_pid(cpu
));
237 static CPUState
*find_cpu(uint32_t thread_id
)
242 if (gdb_get_cpu_index(cpu
) == thread_id
) {
250 CPUState
*gdb_get_first_cpu_in_process(GDBProcess
*process
)
255 if (gdb_get_cpu_pid(cpu
) == process
->pid
) {
263 static CPUState
*gdb_next_cpu_in_process(CPUState
*cpu
)
265 uint32_t pid
= gdb_get_cpu_pid(cpu
);
269 if (gdb_get_cpu_pid(cpu
) == pid
) {
279 /* Return the cpu following @cpu, while ignoring unattached processes. */
280 static CPUState
*gdb_next_attached_cpu(CPUState
*cpu
)
285 if (gdb_get_cpu_process(cpu
)->attached
) {
295 /* Return the first attached cpu */
296 CPUState
*gdb_first_attached_cpu(void)
298 CPUState
*cpu
= first_cpu
;
299 GDBProcess
*process
= gdb_get_cpu_process(cpu
);
301 if (!process
->attached
) {
302 return gdb_next_attached_cpu(cpu
);
308 static CPUState
*gdb_get_cpu(uint32_t pid
, uint32_t tid
)
314 /* 0 means any process/thread, we take the first attached one */
315 return gdb_first_attached_cpu();
316 } else if (pid
&& !tid
) {
317 /* any thread in a specific process */
318 process
= gdb_get_process(pid
);
320 if (process
== NULL
) {
324 if (!process
->attached
) {
328 return gdb_get_first_cpu_in_process(process
);
330 /* a specific thread */
337 process
= gdb_get_cpu_process(cpu
);
339 if (pid
&& process
->pid
!= pid
) {
343 if (!process
->attached
) {
351 static const char *get_feature_xml(const char *p
, const char **newp
,
354 CPUState
*cpu
= gdb_get_first_cpu_in_process(process
);
355 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
359 * qXfer:features:read:ANNEX:OFFSET,LENGTH'
362 char *term
= strchr(p
, ':');
366 /* Is it the main target xml? */
367 if (strncmp(p
, "target.xml", len
) == 0) {
368 if (!process
->target_xml
) {
370 g_autoptr(GPtrArray
) xml
= g_ptr_array_new_with_free_func(g_free
);
374 g_strdup("<?xml version=\"1.0\"?>"
375 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">"
378 if (cc
->gdb_arch_name
) {
381 g_markup_printf_escaped("<architecture>%s</architecture>",
382 cc
->gdb_arch_name(cpu
)));
386 g_markup_printf_escaped("<xi:include href=\"%s\"/>",
387 cc
->gdb_core_xml_file
));
389 for (guint i
= 0; i
< cpu
->gdb_regs
->len
; i
++) {
390 r
= &g_array_index(cpu
->gdb_regs
, GDBRegisterState
, i
);
393 g_markup_printf_escaped("<xi:include href=\"%s\"/>",
397 g_ptr_array_add(xml
, g_strdup("</target>"));
398 g_ptr_array_add(xml
, NULL
);
400 process
->target_xml
= g_strjoinv(NULL
, (void *)xml
->pdata
);
402 return process
->target_xml
;
404 /* Is it dynamically generated by the target? */
405 if (cc
->gdb_get_dynamic_xml
) {
406 g_autofree
char *xmlname
= g_strndup(p
, len
);
407 const char *xml
= cc
->gdb_get_dynamic_xml(cpu
, xmlname
);
412 /* Is it one of the encoded gdb-xml/ files? */
413 for (int i
= 0; gdb_static_features
[i
].xmlname
; i
++) {
414 const char *name
= gdb_static_features
[i
].xmlname
;
415 if ((strncmp(name
, p
, len
) == 0) &&
416 strlen(name
) == len
) {
417 return gdb_static_features
[i
].xml
;
425 void gdb_feature_builder_init(GDBFeatureBuilder
*builder
, GDBFeature
*feature
,
426 const char *name
, const char *xmlname
,
429 char *header
= g_markup_printf_escaped(
430 "<?xml version=\"1.0\"?>"
431 "<!DOCTYPE feature SYSTEM \"gdb-target.dtd\">"
432 "<feature name=\"%s\">",
435 builder
->feature
= feature
;
436 builder
->xml
= g_ptr_array_new();
437 g_ptr_array_add(builder
->xml
, header
);
438 builder
->base_reg
= base_reg
;
439 feature
->xmlname
= xmlname
;
440 feature
->num_regs
= 0;
443 void gdb_feature_builder_append_tag(const GDBFeatureBuilder
*builder
,
444 const char *format
, ...)
447 va_start(ap
, format
);
448 g_ptr_array_add(builder
->xml
, g_markup_vprintf_escaped(format
, ap
));
452 void gdb_feature_builder_append_reg(const GDBFeatureBuilder
*builder
,
459 if (builder
->feature
->num_regs
< regnum
) {
460 builder
->feature
->num_regs
= regnum
;
464 gdb_feature_builder_append_tag(
466 "<reg name=\"%s\" bitsize=\"%d\" regnum=\"%d\" type=\"%s\" group=\"%s\"/>",
467 name
, bitsize
, builder
->base_reg
+ regnum
, type
, group
);
469 gdb_feature_builder_append_tag(
471 "<reg name=\"%s\" bitsize=\"%d\" regnum=\"%d\" type=\"%s\"/>",
472 name
, bitsize
, builder
->base_reg
+ regnum
, type
);
476 void gdb_feature_builder_end(const GDBFeatureBuilder
*builder
)
478 g_ptr_array_add(builder
->xml
, (void *)"</feature>");
479 g_ptr_array_add(builder
->xml
, NULL
);
481 builder
->feature
->xml
= g_strjoinv(NULL
, (void *)builder
->xml
->pdata
);
483 for (guint i
= 0; i
< builder
->xml
->len
- 2; i
++) {
484 g_free(g_ptr_array_index(builder
->xml
, i
));
487 g_ptr_array_free(builder
->xml
, TRUE
);
490 const GDBFeature
*gdb_find_static_feature(const char *xmlname
)
492 const GDBFeature
*feature
;
494 for (feature
= gdb_static_features
; feature
->xmlname
; feature
++) {
495 if (!strcmp(feature
->xmlname
, xmlname
)) {
500 g_assert_not_reached();
503 static int gdb_read_register(CPUState
*cpu
, GByteArray
*buf
, int reg
)
505 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
506 CPUArchState
*env
= cpu_env(cpu
);
509 if (reg
< cc
->gdb_num_core_regs
) {
510 return cc
->gdb_read_register(cpu
, buf
, reg
);
514 for (guint i
= 0; i
< cpu
->gdb_regs
->len
; i
++) {
515 r
= &g_array_index(cpu
->gdb_regs
, GDBRegisterState
, i
);
516 if (r
->base_reg
<= reg
&& reg
< r
->base_reg
+ r
->num_regs
) {
517 return r
->get_reg(env
, buf
, reg
- r
->base_reg
);
524 static int gdb_write_register(CPUState
*cpu
, uint8_t *mem_buf
, int reg
)
526 CPUClass
*cc
= CPU_GET_CLASS(cpu
);
527 CPUArchState
*env
= cpu_env(cpu
);
530 if (reg
< cc
->gdb_num_core_regs
) {
531 return cc
->gdb_write_register(cpu
, mem_buf
, reg
);
535 for (guint i
= 0; i
< cpu
->gdb_regs
->len
; i
++) {
536 r
= &g_array_index(cpu
->gdb_regs
, GDBRegisterState
, i
);
537 if (r
->base_reg
<= reg
&& reg
< r
->base_reg
+ r
->num_regs
) {
538 return r
->set_reg(env
, mem_buf
, reg
- r
->base_reg
);
545 void gdb_register_coprocessor(CPUState
*cpu
,
546 gdb_get_reg_cb get_reg
, gdb_set_reg_cb set_reg
,
547 int num_regs
, const char *xml
, int g_pos
)
553 for (i
= 0; i
< cpu
->gdb_regs
->len
; i
++) {
554 /* Check for duplicates. */
555 s
= &g_array_index(cpu
->gdb_regs
, GDBRegisterState
, i
);
556 if (strcmp(s
->xml
, xml
) == 0) {
561 cpu
->gdb_regs
= g_array_new(false, false, sizeof(GDBRegisterState
));
565 g_array_set_size(cpu
->gdb_regs
, i
+ 1);
566 s
= &g_array_index(cpu
->gdb_regs
, GDBRegisterState
, i
);
567 s
->base_reg
= cpu
->gdb_num_regs
;
568 s
->num_regs
= num_regs
;
569 s
->get_reg
= get_reg
;
570 s
->set_reg
= set_reg
;
573 /* Add to end of list. */
574 cpu
->gdb_num_regs
+= num_regs
;
576 if (g_pos
!= s
->base_reg
) {
577 error_report("Error: Bad gdb register numbering for '%s', "
578 "expected %d got %d", xml
, g_pos
, s
->base_reg
);
580 cpu
->gdb_num_g_regs
= cpu
->gdb_num_regs
;
585 static void gdb_process_breakpoint_remove_all(GDBProcess
*p
)
587 CPUState
*cpu
= gdb_get_first_cpu_in_process(p
);
590 gdb_breakpoint_remove_all(cpu
);
591 cpu
= gdb_next_cpu_in_process(cpu
);
596 static void gdb_set_cpu_pc(vaddr pc
)
598 CPUState
*cpu
= gdbserver_state
.c_cpu
;
600 cpu_synchronize_state(cpu
);
604 void gdb_append_thread_id(CPUState
*cpu
, GString
*buf
)
606 if (gdbserver_state
.multiprocess
) {
607 g_string_append_printf(buf
, "p%02x.%02x",
608 gdb_get_cpu_pid(cpu
), gdb_get_cpu_index(cpu
));
610 g_string_append_printf(buf
, "%02x", gdb_get_cpu_index(cpu
));
614 static GDBThreadIdKind
read_thread_id(const char *buf
, const char **end_buf
,
615 uint32_t *pid
, uint32_t *tid
)
622 ret
= qemu_strtoul(buf
, &buf
, 16, &p
);
625 return GDB_READ_THREAD_ERR
;
634 ret
= qemu_strtoul(buf
, &buf
, 16, &t
);
637 return GDB_READ_THREAD_ERR
;
643 return GDB_ALL_PROCESSES
;
651 return GDB_ALL_THREADS
;
658 return GDB_ONE_THREAD
;
662 * gdb_handle_vcont - Parses and handles a vCont packet.
663 * returns -ENOTSUP if a command is unsupported, -EINVAL or -ERANGE if there is
664 * a format error, 0 on success.
666 static int gdb_handle_vcont(const char *p
)
674 GDBThreadIdKind kind
;
675 unsigned int max_cpus
= gdb_get_max_cpus();
676 /* uninitialised CPUs stay 0 */
677 g_autofree
char *newstates
= g_new0(char, max_cpus
);
679 /* mark valid CPUs with 1 */
681 newstates
[cpu
->cpu_index
] = 1;
685 * res keeps track of what error we are returning, with -ENOTSUP meaning
686 * that the command is unknown or unsupported, thus returning an empty
687 * packet, while -EINVAL and -ERANGE cause an E22 packet, due to invalid,
688 * or incorrect parameters passed.
693 * target_count and last_target keep track of how many CPUs we are going to
694 * step or resume, and a pointer to the state structure of one of them,
697 int target_count
= 0;
698 CPUState
*last_target
= NULL
;
706 if (cur_action
== 'C' || cur_action
== 'S') {
707 cur_action
= qemu_tolower(cur_action
);
708 res
= qemu_strtoul(p
, &p
, 16, &tmp
);
712 signal
= gdb_signal_to_target(tmp
);
713 } else if (cur_action
!= 'c' && cur_action
!= 's') {
714 /* unknown/invalid/unsupported command */
718 if (*p
== '\0' || *p
== ';') {
720 * No thread specifier, action is on "all threads". The
721 * specification is unclear regarding the process to act on. We
722 * choose all processes.
724 kind
= GDB_ALL_PROCESSES
;
725 } else if (*p
++ == ':') {
726 kind
= read_thread_id(p
, &p
, &pid
, &tid
);
732 case GDB_READ_THREAD_ERR
:
735 case GDB_ALL_PROCESSES
:
736 cpu
= gdb_first_attached_cpu();
738 if (newstates
[cpu
->cpu_index
] == 1) {
739 newstates
[cpu
->cpu_index
] = cur_action
;
745 cpu
= gdb_next_attached_cpu(cpu
);
749 case GDB_ALL_THREADS
:
750 process
= gdb_get_process(pid
);
752 if (!process
->attached
) {
756 cpu
= gdb_get_first_cpu_in_process(process
);
758 if (newstates
[cpu
->cpu_index
] == 1) {
759 newstates
[cpu
->cpu_index
] = cur_action
;
765 cpu
= gdb_next_cpu_in_process(cpu
);
770 cpu
= gdb_get_cpu(pid
, tid
);
772 /* invalid CPU/thread specified */
777 /* only use if no previous match occourred */
778 if (newstates
[cpu
->cpu_index
] == 1) {
779 newstates
[cpu
->cpu_index
] = cur_action
;
789 * if we're about to resume a specific set of CPUs/threads, make it so that
790 * in case execution gets interrupted, we can send GDB a stop reply with a
791 * correct value. it doesn't really matter which CPU we tell GDB the signal
792 * happened in (VM pauses stop all of them anyway), so long as it is one of
793 * the ones we resumed/single stepped here.
795 if (target_count
> 0) {
796 gdbserver_state
.c_cpu
= last_target
;
799 gdbserver_state
.signal
= signal
;
800 gdb_continue_partial(newstates
);
804 static const char *cmd_next_param(const char *param
, const char delimiter
)
806 static const char all_delimiters
[] = ",;:=";
807 char curr_delimiters
[2] = {0};
808 const char *delimiters
;
810 if (delimiter
== '?') {
811 delimiters
= all_delimiters
;
812 } else if (delimiter
== '0') {
813 return strchr(param
, '\0');
814 } else if (delimiter
== '.' && *param
) {
817 curr_delimiters
[0] = delimiter
;
818 delimiters
= curr_delimiters
;
821 param
+= strcspn(param
, delimiters
);
828 static int cmd_parse_params(const char *data
, const char *schema
,
831 const char *curr_schema
, *curr_data
;
834 g_assert(params
->len
== 0);
836 curr_schema
= schema
;
838 while (curr_schema
[0] && curr_schema
[1] && *curr_data
) {
839 GdbCmdVariant this_param
;
841 switch (curr_schema
[0]) {
843 if (qemu_strtoul(curr_data
, &curr_data
, 16,
844 &this_param
.val_ul
)) {
847 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
848 g_array_append_val(params
, this_param
);
851 if (qemu_strtou64(curr_data
, &curr_data
, 16,
852 (uint64_t *)&this_param
.val_ull
)) {
855 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
856 g_array_append_val(params
, this_param
);
859 this_param
.data
= curr_data
;
860 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
861 g_array_append_val(params
, this_param
);
864 this_param
.opcode
= *(uint8_t *)curr_data
;
865 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
866 g_array_append_val(params
, this_param
);
869 this_param
.thread_id
.kind
=
870 read_thread_id(curr_data
, &curr_data
,
871 &this_param
.thread_id
.pid
,
872 &this_param
.thread_id
.tid
);
873 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
874 g_array_append_val(params
, this_param
);
877 curr_data
= cmd_next_param(curr_data
, curr_schema
[1]);
888 typedef void (*GdbCmdHandler
)(GArray
*params
, void *user_ctx
);
891 * cmd_startswith -> cmd is compared using startswith
893 * allow_stop_reply -> true iff the gdbstub can respond to this command with a
894 * "stop reply" packet. The list of commands that accept such response is
895 * defined at the GDB Remote Serial Protocol documentation. see:
896 * https://sourceware.org/gdb/onlinedocs/gdb/Stop-Reply-Packets.html#Stop-Reply-Packets.
898 * schema definitions:
899 * Each schema parameter entry consists of 2 chars,
900 * the first char represents the parameter type handling
901 * the second char represents the delimiter for the next parameter
903 * Currently supported schema types:
904 * 'l' -> unsigned long (stored in .val_ul)
905 * 'L' -> unsigned long long (stored in .val_ull)
906 * 's' -> string (stored in .data)
907 * 'o' -> single char (stored in .opcode)
908 * 't' -> thread id (stored in .thread_id)
909 * '?' -> skip according to delimiter
911 * Currently supported delimiters:
912 * '?' -> Stop at any delimiter (",;:=\0")
913 * '0' -> Stop at "\0"
914 * '.' -> Skip 1 char unless reached "\0"
915 * Any other value is treated as the delimiter value itself
917 typedef struct GdbCmdParseEntry
{
918 GdbCmdHandler handler
;
922 bool allow_stop_reply
;
925 static inline int startswith(const char *string
, const char *pattern
)
927 return !strncmp(string
, pattern
, strlen(pattern
));
930 static int process_string_cmd(const char *data
,
931 const GdbCmdParseEntry
*cmds
, int num_cmds
)
934 g_autoptr(GArray
) params
= g_array_new(false, true, sizeof(GdbCmdVariant
));
940 for (i
= 0; i
< num_cmds
; i
++) {
941 const GdbCmdParseEntry
*cmd
= &cmds
[i
];
942 g_assert(cmd
->handler
&& cmd
->cmd
);
944 if ((cmd
->cmd_startswith
&& !startswith(data
, cmd
->cmd
)) ||
945 (!cmd
->cmd_startswith
&& strcmp(cmd
->cmd
, data
))) {
950 if (cmd_parse_params(&data
[strlen(cmd
->cmd
)],
951 cmd
->schema
, params
)) {
956 gdbserver_state
.allow_stop_reply
= cmd
->allow_stop_reply
;
957 cmd
->handler(params
, NULL
);
964 static void run_cmd_parser(const char *data
, const GdbCmdParseEntry
*cmd
)
970 g_string_set_size(gdbserver_state
.str_buf
, 0);
971 g_byte_array_set_size(gdbserver_state
.mem_buf
, 0);
973 /* In case there was an error during the command parsing we must
974 * send a NULL packet to indicate the command is not supported */
975 if (process_string_cmd(data
, cmd
, 1)) {
980 static void handle_detach(GArray
*params
, void *user_ctx
)
985 if (gdbserver_state
.multiprocess
) {
987 gdb_put_packet("E22");
991 pid
= get_param(params
, 0)->val_ul
;
994 process
= gdb_get_process(pid
);
995 gdb_process_breakpoint_remove_all(process
);
996 process
->attached
= false;
998 if (pid
== gdb_get_cpu_pid(gdbserver_state
.c_cpu
)) {
999 gdbserver_state
.c_cpu
= gdb_first_attached_cpu();
1002 if (pid
== gdb_get_cpu_pid(gdbserver_state
.g_cpu
)) {
1003 gdbserver_state
.g_cpu
= gdb_first_attached_cpu();
1006 if (!gdbserver_state
.c_cpu
) {
1007 /* No more process attached */
1008 gdb_disable_syscalls();
1011 gdb_put_packet("OK");
1014 static void handle_thread_alive(GArray
*params
, void *user_ctx
)
1019 gdb_put_packet("E22");
1023 if (get_param(params
, 0)->thread_id
.kind
== GDB_READ_THREAD_ERR
) {
1024 gdb_put_packet("E22");
1028 cpu
= gdb_get_cpu(get_param(params
, 0)->thread_id
.pid
,
1029 get_param(params
, 0)->thread_id
.tid
);
1031 gdb_put_packet("E22");
1035 gdb_put_packet("OK");
1038 static void handle_continue(GArray
*params
, void *user_ctx
)
1041 gdb_set_cpu_pc(get_param(params
, 0)->val_ull
);
1044 gdbserver_state
.signal
= 0;
1048 static void handle_cont_with_sig(GArray
*params
, void *user_ctx
)
1050 unsigned long signal
= 0;
1053 * Note: C sig;[addr] is currently unsupported and we simply
1054 * omit the addr parameter
1057 signal
= get_param(params
, 0)->val_ul
;
1060 gdbserver_state
.signal
= gdb_signal_to_target(signal
);
1061 if (gdbserver_state
.signal
== -1) {
1062 gdbserver_state
.signal
= 0;
1067 static void handle_set_thread(GArray
*params
, void *user_ctx
)
1071 if (params
->len
!= 2) {
1072 gdb_put_packet("E22");
1076 if (get_param(params
, 1)->thread_id
.kind
== GDB_READ_THREAD_ERR
) {
1077 gdb_put_packet("E22");
1081 if (get_param(params
, 1)->thread_id
.kind
!= GDB_ONE_THREAD
) {
1082 gdb_put_packet("OK");
1086 cpu
= gdb_get_cpu(get_param(params
, 1)->thread_id
.pid
,
1087 get_param(params
, 1)->thread_id
.tid
);
1089 gdb_put_packet("E22");
1094 * Note: This command is deprecated and modern gdb's will be using the
1095 * vCont command instead.
1097 switch (get_param(params
, 0)->opcode
) {
1099 gdbserver_state
.c_cpu
= cpu
;
1100 gdb_put_packet("OK");
1103 gdbserver_state
.g_cpu
= cpu
;
1104 gdb_put_packet("OK");
1107 gdb_put_packet("E22");
1112 static void handle_insert_bp(GArray
*params
, void *user_ctx
)
1116 if (params
->len
!= 3) {
1117 gdb_put_packet("E22");
1121 res
= gdb_breakpoint_insert(gdbserver_state
.c_cpu
,
1122 get_param(params
, 0)->val_ul
,
1123 get_param(params
, 1)->val_ull
,
1124 get_param(params
, 2)->val_ull
);
1126 gdb_put_packet("OK");
1128 } else if (res
== -ENOSYS
) {
1133 gdb_put_packet("E22");
1136 static void handle_remove_bp(GArray
*params
, void *user_ctx
)
1140 if (params
->len
!= 3) {
1141 gdb_put_packet("E22");
1145 res
= gdb_breakpoint_remove(gdbserver_state
.c_cpu
,
1146 get_param(params
, 0)->val_ul
,
1147 get_param(params
, 1)->val_ull
,
1148 get_param(params
, 2)->val_ull
);
1150 gdb_put_packet("OK");
1152 } else if (res
== -ENOSYS
) {
1157 gdb_put_packet("E22");
1161 * handle_set/get_reg
1163 * Older gdb are really dumb, and don't use 'G/g' if 'P/p' is available.
1164 * This works, but can be very slow. Anything new enough to understand
1165 * XML also knows how to use this properly. However to use this we
1166 * need to define a local XML file as well as be talking to a
1167 * reasonably modern gdb. Responding with an empty packet will cause
1168 * the remote gdb to fallback to older methods.
1171 static void handle_set_reg(GArray
*params
, void *user_ctx
)
1175 if (params
->len
!= 2) {
1176 gdb_put_packet("E22");
1180 reg_size
= strlen(get_param(params
, 1)->data
) / 2;
1181 gdb_hextomem(gdbserver_state
.mem_buf
, get_param(params
, 1)->data
, reg_size
);
1182 gdb_write_register(gdbserver_state
.g_cpu
, gdbserver_state
.mem_buf
->data
,
1183 get_param(params
, 0)->val_ull
);
1184 gdb_put_packet("OK");
1187 static void handle_get_reg(GArray
*params
, void *user_ctx
)
1192 gdb_put_packet("E14");
1196 reg_size
= gdb_read_register(gdbserver_state
.g_cpu
,
1197 gdbserver_state
.mem_buf
,
1198 get_param(params
, 0)->val_ull
);
1200 gdb_put_packet("E14");
1203 g_byte_array_set_size(gdbserver_state
.mem_buf
, reg_size
);
1206 gdb_memtohex(gdbserver_state
.str_buf
,
1207 gdbserver_state
.mem_buf
->data
, reg_size
);
1211 static void handle_write_mem(GArray
*params
, void *user_ctx
)
1213 if (params
->len
!= 3) {
1214 gdb_put_packet("E22");
1218 /* gdb_hextomem() reads 2*len bytes */
1219 if (get_param(params
, 1)->val_ull
>
1220 strlen(get_param(params
, 2)->data
) / 2) {
1221 gdb_put_packet("E22");
1225 gdb_hextomem(gdbserver_state
.mem_buf
, get_param(params
, 2)->data
,
1226 get_param(params
, 1)->val_ull
);
1227 if (gdb_target_memory_rw_debug(gdbserver_state
.g_cpu
,
1228 get_param(params
, 0)->val_ull
,
1229 gdbserver_state
.mem_buf
->data
,
1230 gdbserver_state
.mem_buf
->len
, true)) {
1231 gdb_put_packet("E14");
1235 gdb_put_packet("OK");
1238 static void handle_read_mem(GArray
*params
, void *user_ctx
)
1240 if (params
->len
!= 2) {
1241 gdb_put_packet("E22");
1245 /* gdb_memtohex() doubles the required space */
1246 if (get_param(params
, 1)->val_ull
> MAX_PACKET_LENGTH
/ 2) {
1247 gdb_put_packet("E22");
1251 g_byte_array_set_size(gdbserver_state
.mem_buf
,
1252 get_param(params
, 1)->val_ull
);
1254 if (gdb_target_memory_rw_debug(gdbserver_state
.g_cpu
,
1255 get_param(params
, 0)->val_ull
,
1256 gdbserver_state
.mem_buf
->data
,
1257 gdbserver_state
.mem_buf
->len
, false)) {
1258 gdb_put_packet("E14");
1262 gdb_memtohex(gdbserver_state
.str_buf
, gdbserver_state
.mem_buf
->data
,
1263 gdbserver_state
.mem_buf
->len
);
1267 static void handle_write_all_regs(GArray
*params
, void *user_ctx
)
1278 cpu_synchronize_state(gdbserver_state
.g_cpu
);
1279 len
= strlen(get_param(params
, 0)->data
) / 2;
1280 gdb_hextomem(gdbserver_state
.mem_buf
, get_param(params
, 0)->data
, len
);
1281 registers
= gdbserver_state
.mem_buf
->data
;
1283 reg_id
< gdbserver_state
.g_cpu
->gdb_num_g_regs
&& len
> 0;
1285 reg_size
= gdb_write_register(gdbserver_state
.g_cpu
, registers
, reg_id
);
1287 registers
+= reg_size
;
1289 gdb_put_packet("OK");
1292 static void handle_read_all_regs(GArray
*params
, void *user_ctx
)
1297 cpu_synchronize_state(gdbserver_state
.g_cpu
);
1298 g_byte_array_set_size(gdbserver_state
.mem_buf
, 0);
1300 for (reg_id
= 0; reg_id
< gdbserver_state
.g_cpu
->gdb_num_g_regs
; reg_id
++) {
1301 len
+= gdb_read_register(gdbserver_state
.g_cpu
,
1302 gdbserver_state
.mem_buf
,
1305 g_assert(len
== gdbserver_state
.mem_buf
->len
);
1307 gdb_memtohex(gdbserver_state
.str_buf
, gdbserver_state
.mem_buf
->data
, len
);
1312 static void handle_step(GArray
*params
, void *user_ctx
)
1315 gdb_set_cpu_pc(get_param(params
, 0)->val_ull
);
1318 cpu_single_step(gdbserver_state
.c_cpu
, gdbserver_state
.sstep_flags
);
1322 static void handle_backward(GArray
*params
, void *user_ctx
)
1324 if (!gdb_can_reverse()) {
1325 gdb_put_packet("E22");
1327 if (params
->len
== 1) {
1328 switch (get_param(params
, 0)->opcode
) {
1330 if (replay_reverse_step()) {
1333 gdb_put_packet("E14");
1337 if (replay_reverse_continue()) {
1340 gdb_put_packet("E14");
1346 /* Default invalid command */
1350 static void handle_v_cont_query(GArray
*params
, void *user_ctx
)
1352 gdb_put_packet("vCont;c;C;s;S");
1355 static void handle_v_cont(GArray
*params
, void *user_ctx
)
1363 res
= gdb_handle_vcont(get_param(params
, 0)->data
);
1364 if ((res
== -EINVAL
) || (res
== -ERANGE
)) {
1365 gdb_put_packet("E22");
1371 static void handle_v_attach(GArray
*params
, void *user_ctx
)
1373 GDBProcess
*process
;
1376 g_string_assign(gdbserver_state
.str_buf
, "E22");
1381 process
= gdb_get_process(get_param(params
, 0)->val_ul
);
1386 cpu
= gdb_get_first_cpu_in_process(process
);
1391 process
->attached
= true;
1392 gdbserver_state
.g_cpu
= cpu
;
1393 gdbserver_state
.c_cpu
= cpu
;
1395 if (gdbserver_state
.allow_stop_reply
) {
1396 g_string_printf(gdbserver_state
.str_buf
, "T%02xthread:", GDB_SIGNAL_TRAP
);
1397 gdb_append_thread_id(cpu
, gdbserver_state
.str_buf
);
1398 g_string_append_c(gdbserver_state
.str_buf
, ';');
1399 gdbserver_state
.allow_stop_reply
= false;
1405 static void handle_v_kill(GArray
*params
, void *user_ctx
)
1407 /* Kill the target */
1408 gdb_put_packet("OK");
1409 error_report("QEMU: Terminated via GDBstub");
1414 static const GdbCmdParseEntry gdb_v_commands_table
[] = {
1415 /* Order is important if has same prefix */
1417 .handler
= handle_v_cont_query
,
1422 .handler
= handle_v_cont
,
1424 .cmd_startswith
= 1,
1425 .allow_stop_reply
= true,
1429 .handler
= handle_v_attach
,
1431 .cmd_startswith
= 1,
1432 .allow_stop_reply
= true,
1436 .handler
= handle_v_kill
,
1440 #ifdef CONFIG_USER_ONLY
1442 * Host I/O Packets. See [1] for details.
1443 * [1] https://sourceware.org/gdb/onlinedocs/gdb/Host-I_002fO-Packets.html
1446 .handler
= gdb_handle_v_file_open
,
1447 .cmd
= "File:open:",
1448 .cmd_startswith
= 1,
1452 .handler
= gdb_handle_v_file_close
,
1453 .cmd
= "File:close:",
1454 .cmd_startswith
= 1,
1458 .handler
= gdb_handle_v_file_pread
,
1459 .cmd
= "File:pread:",
1460 .cmd_startswith
= 1,
1464 .handler
= gdb_handle_v_file_readlink
,
1465 .cmd
= "File:readlink:",
1466 .cmd_startswith
= 1,
1472 static void handle_v_commands(GArray
*params
, void *user_ctx
)
1478 if (process_string_cmd(get_param(params
, 0)->data
,
1479 gdb_v_commands_table
,
1480 ARRAY_SIZE(gdb_v_commands_table
))) {
1485 static void handle_query_qemu_sstepbits(GArray
*params
, void *user_ctx
)
1487 g_string_printf(gdbserver_state
.str_buf
, "ENABLE=%x", SSTEP_ENABLE
);
1489 if (gdbserver_state
.supported_sstep_flags
& SSTEP_NOIRQ
) {
1490 g_string_append_printf(gdbserver_state
.str_buf
, ",NOIRQ=%x",
1494 if (gdbserver_state
.supported_sstep_flags
& SSTEP_NOTIMER
) {
1495 g_string_append_printf(gdbserver_state
.str_buf
, ",NOTIMER=%x",
1502 static void handle_set_qemu_sstep(GArray
*params
, void *user_ctx
)
1504 int new_sstep_flags
;
1510 new_sstep_flags
= get_param(params
, 0)->val_ul
;
1512 if (new_sstep_flags
& ~gdbserver_state
.supported_sstep_flags
) {
1513 gdb_put_packet("E22");
1517 gdbserver_state
.sstep_flags
= new_sstep_flags
;
1518 gdb_put_packet("OK");
1521 static void handle_query_qemu_sstep(GArray
*params
, void *user_ctx
)
1523 g_string_printf(gdbserver_state
.str_buf
, "0x%x",
1524 gdbserver_state
.sstep_flags
);
1528 static void handle_query_curr_tid(GArray
*params
, void *user_ctx
)
1531 GDBProcess
*process
;
1534 * "Current thread" remains vague in the spec, so always return
1535 * the first thread of the current process (gdb returns the
1538 process
= gdb_get_cpu_process(gdbserver_state
.g_cpu
);
1539 cpu
= gdb_get_first_cpu_in_process(process
);
1540 g_string_assign(gdbserver_state
.str_buf
, "QC");
1541 gdb_append_thread_id(cpu
, gdbserver_state
.str_buf
);
1545 static void handle_query_threads(GArray
*params
, void *user_ctx
)
1547 if (!gdbserver_state
.query_cpu
) {
1548 gdb_put_packet("l");
1552 g_string_assign(gdbserver_state
.str_buf
, "m");
1553 gdb_append_thread_id(gdbserver_state
.query_cpu
, gdbserver_state
.str_buf
);
1555 gdbserver_state
.query_cpu
= gdb_next_attached_cpu(gdbserver_state
.query_cpu
);
1558 static void handle_query_first_threads(GArray
*params
, void *user_ctx
)
1560 gdbserver_state
.query_cpu
= gdb_first_attached_cpu();
1561 handle_query_threads(params
, user_ctx
);
1564 static void handle_query_thread_extra(GArray
*params
, void *user_ctx
)
1566 g_autoptr(GString
) rs
= g_string_new(NULL
);
1570 get_param(params
, 0)->thread_id
.kind
== GDB_READ_THREAD_ERR
) {
1571 gdb_put_packet("E22");
1575 cpu
= gdb_get_cpu(get_param(params
, 0)->thread_id
.pid
,
1576 get_param(params
, 0)->thread_id
.tid
);
1581 cpu_synchronize_state(cpu
);
1583 if (gdbserver_state
.multiprocess
&& (gdbserver_state
.process_num
> 1)) {
1584 /* Print the CPU model and name in multiprocess mode */
1585 ObjectClass
*oc
= object_get_class(OBJECT(cpu
));
1586 const char *cpu_model
= object_class_get_name(oc
);
1587 const char *cpu_name
=
1588 object_get_canonical_path_component(OBJECT(cpu
));
1589 g_string_printf(rs
, "%s %s [%s]", cpu_model
, cpu_name
,
1590 cpu
->halted
? "halted " : "running");
1592 g_string_printf(rs
, "CPU#%d [%s]", cpu
->cpu_index
,
1593 cpu
->halted
? "halted " : "running");
1595 trace_gdbstub_op_extra_info(rs
->str
);
1596 gdb_memtohex(gdbserver_state
.str_buf
, (uint8_t *)rs
->str
, rs
->len
);
1600 static void handle_query_supported(GArray
*params
, void *user_ctx
)
1604 g_string_printf(gdbserver_state
.str_buf
, "PacketSize=%x", MAX_PACKET_LENGTH
);
1605 cc
= CPU_GET_CLASS(first_cpu
);
1606 if (cc
->gdb_core_xml_file
) {
1607 g_string_append(gdbserver_state
.str_buf
, ";qXfer:features:read+");
1610 if (gdb_can_reverse()) {
1611 g_string_append(gdbserver_state
.str_buf
,
1612 ";ReverseStep+;ReverseContinue+");
1615 #if defined(CONFIG_USER_ONLY)
1616 #if defined(CONFIG_LINUX)
1617 if (gdbserver_state
.c_cpu
->opaque
) {
1618 g_string_append(gdbserver_state
.str_buf
, ";qXfer:auxv:read+");
1620 g_string_append(gdbserver_state
.str_buf
, ";QCatchSyscalls+");
1622 g_string_append(gdbserver_state
.str_buf
, ";qXfer:exec-file:read+");
1626 strstr(get_param(params
, 0)->data
, "multiprocess+")) {
1627 gdbserver_state
.multiprocess
= true;
1630 g_string_append(gdbserver_state
.str_buf
, ";vContSupported+;multiprocess+");
1634 static void handle_query_xfer_features(GArray
*params
, void *user_ctx
)
1636 GDBProcess
*process
;
1638 unsigned long len
, total_len
, addr
;
1642 if (params
->len
< 3) {
1643 gdb_put_packet("E22");
1647 process
= gdb_get_cpu_process(gdbserver_state
.g_cpu
);
1648 cc
= CPU_GET_CLASS(gdbserver_state
.g_cpu
);
1649 if (!cc
->gdb_core_xml_file
) {
1654 p
= get_param(params
, 0)->data
;
1655 xml
= get_feature_xml(p
, &p
, process
);
1657 gdb_put_packet("E00");
1661 addr
= get_param(params
, 1)->val_ul
;
1662 len
= get_param(params
, 2)->val_ul
;
1663 total_len
= strlen(xml
);
1664 if (addr
> total_len
) {
1665 gdb_put_packet("E00");
1669 if (len
> (MAX_PACKET_LENGTH
- 5) / 2) {
1670 len
= (MAX_PACKET_LENGTH
- 5) / 2;
1673 if (len
< total_len
- addr
) {
1674 g_string_assign(gdbserver_state
.str_buf
, "m");
1675 gdb_memtox(gdbserver_state
.str_buf
, xml
+ addr
, len
);
1677 g_string_assign(gdbserver_state
.str_buf
, "l");
1678 gdb_memtox(gdbserver_state
.str_buf
, xml
+ addr
, total_len
- addr
);
1681 gdb_put_packet_binary(gdbserver_state
.str_buf
->str
,
1682 gdbserver_state
.str_buf
->len
, true);
1685 static void handle_query_qemu_supported(GArray
*params
, void *user_ctx
)
1687 g_string_printf(gdbserver_state
.str_buf
, "sstepbits;sstep");
1688 #ifndef CONFIG_USER_ONLY
1689 g_string_append(gdbserver_state
.str_buf
, ";PhyMemMode");
1694 static const GdbCmdParseEntry gdb_gen_query_set_common_table
[] = {
1695 /* Order is important if has same prefix */
1697 .handler
= handle_query_qemu_sstepbits
,
1698 .cmd
= "qemu.sstepbits",
1701 .handler
= handle_query_qemu_sstep
,
1702 .cmd
= "qemu.sstep",
1705 .handler
= handle_set_qemu_sstep
,
1706 .cmd
= "qemu.sstep=",
1707 .cmd_startswith
= 1,
1712 static const GdbCmdParseEntry gdb_gen_query_table
[] = {
1714 .handler
= handle_query_curr_tid
,
1718 .handler
= handle_query_threads
,
1719 .cmd
= "sThreadInfo",
1722 .handler
= handle_query_first_threads
,
1723 .cmd
= "fThreadInfo",
1726 .handler
= handle_query_thread_extra
,
1727 .cmd
= "ThreadExtraInfo,",
1728 .cmd_startswith
= 1,
1731 #ifdef CONFIG_USER_ONLY
1733 .handler
= gdb_handle_query_offsets
,
1738 .handler
= gdb_handle_query_rcmd
,
1740 .cmd_startswith
= 1,
1745 .handler
= handle_query_supported
,
1746 .cmd
= "Supported:",
1747 .cmd_startswith
= 1,
1751 .handler
= handle_query_supported
,
1756 .handler
= handle_query_xfer_features
,
1757 .cmd
= "Xfer:features:read:",
1758 .cmd_startswith
= 1,
1761 #if defined(CONFIG_USER_ONLY)
1762 #if defined(CONFIG_LINUX)
1764 .handler
= gdb_handle_query_xfer_auxv
,
1765 .cmd
= "Xfer:auxv:read::",
1766 .cmd_startswith
= 1,
1771 .handler
= gdb_handle_query_xfer_exec_file
,
1772 .cmd
= "Xfer:exec-file:read:",
1773 .cmd_startswith
= 1,
1778 .handler
= gdb_handle_query_attached
,
1783 .handler
= gdb_handle_query_attached
,
1787 .handler
= handle_query_qemu_supported
,
1788 .cmd
= "qemu.Supported",
1790 #ifndef CONFIG_USER_ONLY
1792 .handler
= gdb_handle_query_qemu_phy_mem_mode
,
1793 .cmd
= "qemu.PhyMemMode",
1798 static const GdbCmdParseEntry gdb_gen_set_table
[] = {
1799 /* Order is important if has same prefix */
1801 .handler
= handle_set_qemu_sstep
,
1802 .cmd
= "qemu.sstep:",
1803 .cmd_startswith
= 1,
1806 #ifndef CONFIG_USER_ONLY
1808 .handler
= gdb_handle_set_qemu_phy_mem_mode
,
1809 .cmd
= "qemu.PhyMemMode:",
1810 .cmd_startswith
= 1,
1814 #if defined(CONFIG_USER_ONLY)
1816 .handler
= gdb_handle_set_catch_syscalls
,
1817 .cmd
= "CatchSyscalls:",
1818 .cmd_startswith
= 1,
1824 static void handle_gen_query(GArray
*params
, void *user_ctx
)
1830 if (!process_string_cmd(get_param(params
, 0)->data
,
1831 gdb_gen_query_set_common_table
,
1832 ARRAY_SIZE(gdb_gen_query_set_common_table
))) {
1836 if (process_string_cmd(get_param(params
, 0)->data
,
1837 gdb_gen_query_table
,
1838 ARRAY_SIZE(gdb_gen_query_table
))) {
1843 static void handle_gen_set(GArray
*params
, void *user_ctx
)
1849 if (!process_string_cmd(get_param(params
, 0)->data
,
1850 gdb_gen_query_set_common_table
,
1851 ARRAY_SIZE(gdb_gen_query_set_common_table
))) {
1855 if (process_string_cmd(get_param(params
, 0)->data
,
1857 ARRAY_SIZE(gdb_gen_set_table
))) {
1862 static void handle_target_halt(GArray
*params
, void *user_ctx
)
1864 if (gdbserver_state
.allow_stop_reply
) {
1865 g_string_printf(gdbserver_state
.str_buf
, "T%02xthread:", GDB_SIGNAL_TRAP
);
1866 gdb_append_thread_id(gdbserver_state
.c_cpu
, gdbserver_state
.str_buf
);
1867 g_string_append_c(gdbserver_state
.str_buf
, ';');
1869 gdbserver_state
.allow_stop_reply
= false;
1872 * Remove all the breakpoints when this query is issued,
1873 * because gdb is doing an initial connect and the state
1874 * should be cleaned up.
1876 gdb_breakpoint_remove_all(gdbserver_state
.c_cpu
);
1879 static int gdb_handle_packet(const char *line_buf
)
1881 const GdbCmdParseEntry
*cmd_parser
= NULL
;
1883 trace_gdbstub_io_command(line_buf
);
1885 switch (line_buf
[0]) {
1887 gdb_put_packet("OK");
1891 static const GdbCmdParseEntry target_halted_cmd_desc
= {
1892 .handler
= handle_target_halt
,
1894 .cmd_startswith
= 1,
1895 .allow_stop_reply
= true,
1897 cmd_parser
= &target_halted_cmd_desc
;
1902 static const GdbCmdParseEntry continue_cmd_desc
= {
1903 .handler
= handle_continue
,
1905 .cmd_startswith
= 1,
1906 .allow_stop_reply
= true,
1909 cmd_parser
= &continue_cmd_desc
;
1914 static const GdbCmdParseEntry cont_with_sig_cmd_desc
= {
1915 .handler
= handle_cont_with_sig
,
1917 .cmd_startswith
= 1,
1918 .allow_stop_reply
= true,
1921 cmd_parser
= &cont_with_sig_cmd_desc
;
1926 static const GdbCmdParseEntry v_cmd_desc
= {
1927 .handler
= handle_v_commands
,
1929 .cmd_startswith
= 1,
1932 cmd_parser
= &v_cmd_desc
;
1936 /* Kill the target */
1937 error_report("QEMU: Terminated via GDBstub");
1943 static const GdbCmdParseEntry detach_cmd_desc
= {
1944 .handler
= handle_detach
,
1946 .cmd_startswith
= 1,
1949 cmd_parser
= &detach_cmd_desc
;
1954 static const GdbCmdParseEntry step_cmd_desc
= {
1955 .handler
= handle_step
,
1957 .cmd_startswith
= 1,
1958 .allow_stop_reply
= true,
1961 cmd_parser
= &step_cmd_desc
;
1966 static const GdbCmdParseEntry backward_cmd_desc
= {
1967 .handler
= handle_backward
,
1969 .cmd_startswith
= 1,
1970 .allow_stop_reply
= true,
1973 cmd_parser
= &backward_cmd_desc
;
1978 static const GdbCmdParseEntry file_io_cmd_desc
= {
1979 .handler
= gdb_handle_file_io
,
1981 .cmd_startswith
= 1,
1984 cmd_parser
= &file_io_cmd_desc
;
1989 static const GdbCmdParseEntry read_all_regs_cmd_desc
= {
1990 .handler
= handle_read_all_regs
,
1994 cmd_parser
= &read_all_regs_cmd_desc
;
1999 static const GdbCmdParseEntry write_all_regs_cmd_desc
= {
2000 .handler
= handle_write_all_regs
,
2002 .cmd_startswith
= 1,
2005 cmd_parser
= &write_all_regs_cmd_desc
;
2010 static const GdbCmdParseEntry read_mem_cmd_desc
= {
2011 .handler
= handle_read_mem
,
2013 .cmd_startswith
= 1,
2016 cmd_parser
= &read_mem_cmd_desc
;
2021 static const GdbCmdParseEntry write_mem_cmd_desc
= {
2022 .handler
= handle_write_mem
,
2024 .cmd_startswith
= 1,
2027 cmd_parser
= &write_mem_cmd_desc
;
2032 static const GdbCmdParseEntry get_reg_cmd_desc
= {
2033 .handler
= handle_get_reg
,
2035 .cmd_startswith
= 1,
2038 cmd_parser
= &get_reg_cmd_desc
;
2043 static const GdbCmdParseEntry set_reg_cmd_desc
= {
2044 .handler
= handle_set_reg
,
2046 .cmd_startswith
= 1,
2049 cmd_parser
= &set_reg_cmd_desc
;
2054 static const GdbCmdParseEntry insert_bp_cmd_desc
= {
2055 .handler
= handle_insert_bp
,
2057 .cmd_startswith
= 1,
2060 cmd_parser
= &insert_bp_cmd_desc
;
2065 static const GdbCmdParseEntry remove_bp_cmd_desc
= {
2066 .handler
= handle_remove_bp
,
2068 .cmd_startswith
= 1,
2071 cmd_parser
= &remove_bp_cmd_desc
;
2076 static const GdbCmdParseEntry set_thread_cmd_desc
= {
2077 .handler
= handle_set_thread
,
2079 .cmd_startswith
= 1,
2082 cmd_parser
= &set_thread_cmd_desc
;
2087 static const GdbCmdParseEntry thread_alive_cmd_desc
= {
2088 .handler
= handle_thread_alive
,
2090 .cmd_startswith
= 1,
2093 cmd_parser
= &thread_alive_cmd_desc
;
2098 static const GdbCmdParseEntry gen_query_cmd_desc
= {
2099 .handler
= handle_gen_query
,
2101 .cmd_startswith
= 1,
2104 cmd_parser
= &gen_query_cmd_desc
;
2109 static const GdbCmdParseEntry gen_set_cmd_desc
= {
2110 .handler
= handle_gen_set
,
2112 .cmd_startswith
= 1,
2115 cmd_parser
= &gen_set_cmd_desc
;
2119 /* put empty packet */
2125 run_cmd_parser(line_buf
, cmd_parser
);
2131 void gdb_set_stop_cpu(CPUState
*cpu
)
2133 GDBProcess
*p
= gdb_get_cpu_process(cpu
);
2137 * Having a stop CPU corresponding to a process that is not attached
2138 * confuses GDB. So we ignore the request.
2143 gdbserver_state
.c_cpu
= cpu
;
2144 gdbserver_state
.g_cpu
= cpu
;
2147 void gdb_read_byte(uint8_t ch
)
2151 gdbserver_state
.allow_stop_reply
= false;
2152 #ifndef CONFIG_USER_ONLY
2153 if (gdbserver_state
.last_packet
->len
) {
2154 /* Waiting for a response to the last packet. If we see the start
2155 of a new command then abandon the previous response. */
2157 trace_gdbstub_err_got_nack();
2158 gdb_put_buffer(gdbserver_state
.last_packet
->data
,
2159 gdbserver_state
.last_packet
->len
);
2160 } else if (ch
== '+') {
2161 trace_gdbstub_io_got_ack();
2163 trace_gdbstub_io_got_unexpected(ch
);
2166 if (ch
== '+' || ch
== '$') {
2167 g_byte_array_set_size(gdbserver_state
.last_packet
, 0);
2172 if (runstate_is_running()) {
2174 * When the CPU is running, we cannot do anything except stop
2175 * it when receiving a char. This is expected on a Ctrl-C in the
2176 * gdb client. Because we are in all-stop mode, gdb sends a
2177 * 0x03 byte which is not a usual packet, so we handle it specially
2178 * here, but it does expect a stop reply.
2181 trace_gdbstub_err_unexpected_runpkt(ch
);
2183 gdbserver_state
.allow_stop_reply
= true;
2185 vm_stop(RUN_STATE_PAUSED
);
2189 switch(gdbserver_state
.state
) {
2192 /* start of command packet */
2193 gdbserver_state
.line_buf_index
= 0;
2194 gdbserver_state
.line_sum
= 0;
2195 gdbserver_state
.state
= RS_GETLINE
;
2196 } else if (ch
== '+') {
2198 * do nothing, gdb may preemptively send out ACKs on
2199 * initial connection
2202 trace_gdbstub_err_garbage(ch
);
2207 /* start escape sequence */
2208 gdbserver_state
.state
= RS_GETLINE_ESC
;
2209 gdbserver_state
.line_sum
+= ch
;
2210 } else if (ch
== '*') {
2211 /* start run length encoding sequence */
2212 gdbserver_state
.state
= RS_GETLINE_RLE
;
2213 gdbserver_state
.line_sum
+= ch
;
2214 } else if (ch
== '#') {
2215 /* end of command, start of checksum*/
2216 gdbserver_state
.state
= RS_CHKSUM1
;
2217 } else if (gdbserver_state
.line_buf_index
>= sizeof(gdbserver_state
.line_buf
) - 1) {
2218 trace_gdbstub_err_overrun();
2219 gdbserver_state
.state
= RS_IDLE
;
2221 /* unescaped command character */
2222 gdbserver_state
.line_buf
[gdbserver_state
.line_buf_index
++] = ch
;
2223 gdbserver_state
.line_sum
+= ch
;
2226 case RS_GETLINE_ESC
:
2228 /* unexpected end of command in escape sequence */
2229 gdbserver_state
.state
= RS_CHKSUM1
;
2230 } else if (gdbserver_state
.line_buf_index
>= sizeof(gdbserver_state
.line_buf
) - 1) {
2231 /* command buffer overrun */
2232 trace_gdbstub_err_overrun();
2233 gdbserver_state
.state
= RS_IDLE
;
2235 /* parse escaped character and leave escape state */
2236 gdbserver_state
.line_buf
[gdbserver_state
.line_buf_index
++] = ch
^ 0x20;
2237 gdbserver_state
.line_sum
+= ch
;
2238 gdbserver_state
.state
= RS_GETLINE
;
2241 case RS_GETLINE_RLE
:
2243 * Run-length encoding is explained in "Debugging with GDB /
2244 * Appendix E GDB Remote Serial Protocol / Overview".
2246 if (ch
< ' ' || ch
== '#' || ch
== '$' || ch
> 126) {
2247 /* invalid RLE count encoding */
2248 trace_gdbstub_err_invalid_repeat(ch
);
2249 gdbserver_state
.state
= RS_GETLINE
;
2251 /* decode repeat length */
2252 int repeat
= ch
- ' ' + 3;
2253 if (gdbserver_state
.line_buf_index
+ repeat
>= sizeof(gdbserver_state
.line_buf
) - 1) {
2254 /* that many repeats would overrun the command buffer */
2255 trace_gdbstub_err_overrun();
2256 gdbserver_state
.state
= RS_IDLE
;
2257 } else if (gdbserver_state
.line_buf_index
< 1) {
2258 /* got a repeat but we have nothing to repeat */
2259 trace_gdbstub_err_invalid_rle();
2260 gdbserver_state
.state
= RS_GETLINE
;
2262 /* repeat the last character */
2263 memset(gdbserver_state
.line_buf
+ gdbserver_state
.line_buf_index
,
2264 gdbserver_state
.line_buf
[gdbserver_state
.line_buf_index
- 1], repeat
);
2265 gdbserver_state
.line_buf_index
+= repeat
;
2266 gdbserver_state
.line_sum
+= ch
;
2267 gdbserver_state
.state
= RS_GETLINE
;
2272 /* get high hex digit of checksum */
2273 if (!isxdigit(ch
)) {
2274 trace_gdbstub_err_checksum_invalid(ch
);
2275 gdbserver_state
.state
= RS_GETLINE
;
2278 gdbserver_state
.line_buf
[gdbserver_state
.line_buf_index
] = '\0';
2279 gdbserver_state
.line_csum
= fromhex(ch
) << 4;
2280 gdbserver_state
.state
= RS_CHKSUM2
;
2283 /* get low hex digit of checksum */
2284 if (!isxdigit(ch
)) {
2285 trace_gdbstub_err_checksum_invalid(ch
);
2286 gdbserver_state
.state
= RS_GETLINE
;
2289 gdbserver_state
.line_csum
|= fromhex(ch
);
2291 if (gdbserver_state
.line_csum
!= (gdbserver_state
.line_sum
& 0xff)) {
2292 trace_gdbstub_err_checksum_incorrect(gdbserver_state
.line_sum
, gdbserver_state
.line_csum
);
2293 /* send NAK reply */
2295 gdb_put_buffer(&reply
, 1);
2296 gdbserver_state
.state
= RS_IDLE
;
2298 /* send ACK reply */
2300 gdb_put_buffer(&reply
, 1);
2301 gdbserver_state
.state
= gdb_handle_packet(gdbserver_state
.line_buf
);
2311 * Create the process that will contain all the "orphan" CPUs (that are not
2312 * part of a CPU cluster). Note that if this process contains no CPUs, it won't
2313 * be attachable and thus will be invisible to the user.
2315 void gdb_create_default_process(GDBState
*s
)
2317 GDBProcess
*process
;
2320 #ifdef CONFIG_USER_ONLY
2321 assert(gdbserver_state
.process_num
== 0);
2324 if (gdbserver_state
.process_num
) {
2325 pid
= s
->processes
[s
->process_num
- 1].pid
;
2329 /* We need an available PID slot for this process */
2330 assert(pid
< UINT32_MAX
);
2334 s
->processes
= g_renew(GDBProcess
, s
->processes
, ++s
->process_num
);
2335 process
= &s
->processes
[s
->process_num
- 1];
2337 process
->attached
= false;
2338 process
->target_xml
= NULL
;