1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * Copyright (C) 2011 by Broadcom Corporation *
12 * Evan Hunter - ehunter@broadcom.com *
14 * Copyright (C) ST-Ericsson SA 2011 *
15 * michel.jaouen@stericsson.com : smp minimum support *
17 * Copyright (C) 2013 Andes Technology *
18 * Hsiangkai Wang <hkwang@andestech.com> *
20 * Copyright (C) 2013 Franck Jullien *
21 * elec4fun@gmail.com *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
35 ***************************************************************************/
41 #include <target/breakpoints.h>
42 #include <target/target_request.h>
43 #include <target/register.h>
44 #include <target/target.h>
45 #include <target/target_type.h>
46 #include <target/semihosting_common.h>
48 #include <flash/nor/core.h>
49 #include "gdb_server.h"
50 #include <target/image.h>
51 #include <jtag/jtag.h>
52 #include "rtos/rtos.h"
53 #include "target/smp.h"
57 * GDB server implementation.
59 * This implements the GDB Remote Serial Protocol, over TCP connections,
60 * giving GDB access to the JTAG or other hardware debugging facilities
61 * found in most modern embedded processors.
64 enum gdb_output_flag {
65 /* GDB doesn't accept 'O' packets */
67 /* GDB accepts 'O' packets */
71 struct target_desc_format {
73 uint32_t tdesc_length;
76 /* private connection data for GDB */
77 struct gdb_connection {
78 char buffer[GDB_BUFFER_SIZE + 1]; /* Extra byte for null-termination */
82 enum target_state frontend_state;
83 struct image *vflash_image;
87 /* set flag to true if you want the next stepi to return immediately.
88 * allowing GDB to pick up a fresh set of register values from the target
89 * without modifying the target state. */
91 /* We delay reporting memory write errors until next step/continue or memory
92 * write. This improves performance of gdb load significantly as the GDB packet
93 * can be replied immediately and a new GDB packet will be ready without delay
94 * (ca. 10% or so...). */
96 /* with extended-remote it seems we need to better emulate attach/detach.
97 * what this means is we reply with a W stop reply after a kill packet,
98 * normally we reply with a S reply via gdb_last_signal_packet.
99 * as a side note this behaviour only effects gdb > 6.8 */
101 /* set when extended protocol is used */
102 bool extended_protocol;
103 /* temporarily used for target description support */
104 struct target_desc_format target_desc;
105 /* temporarily used for thread list support */
107 /* flag to mask the output from gdb_log_callback() */
108 enum gdb_output_flag output_flag;
112 #define _DEBUG_GDB_IO_
115 static struct gdb_connection *current_gdb_connection;
117 static int gdb_breakpoint_override;
118 static enum breakpoint_type gdb_breakpoint_override_type;
120 static int gdb_error(struct connection *connection, int retval);
121 static char *gdb_port;
122 static char *gdb_port_next;
124 static void gdb_log_callback(void *priv, const char *file, unsigned line,
125 const char *function, const char *string);
127 static void gdb_sig_halted(struct connection *connection);
129 /* number of gdb connections, mainly to suppress gdb related debugging spam
130 * in helper/log.c when no gdb connections are actually active */
131 int gdb_actual_connections;
133 /* set if we are sending a memory map to gdb
134 * via qXfer:memory-map:read packet */
135 /* enabled by default*/
136 static int gdb_use_memory_map = 1;
137 /* enabled by default*/
138 static int gdb_flash_program = 1;
140 /* if set, data aborts cause an error to be reported in memory read packets
141 * see the code in gdb_read_memory_packet() for further explanations.
142 * Disabled by default.
144 static int gdb_report_data_abort;
145 /* If set, errors when accessing registers are reported to gdb. Disabled by
147 static int gdb_report_register_access_error;
149 /* set if we are sending target descriptions to gdb
150 * via qXfer:features:read packet */
151 /* enabled by default */
152 static int gdb_use_target_description = 1;
154 /* current processing free-run type, used by file-I/O */
155 static char gdb_running_type;
157 static int gdb_last_signal(struct target *target)
159 switch (target->debug_reason) {
160 case DBG_REASON_DBGRQ:
161 return 0x2; /* SIGINT */
162 case DBG_REASON_BREAKPOINT:
163 case DBG_REASON_WATCHPOINT:
164 case DBG_REASON_WPTANDBKPT:
165 return 0x05; /* SIGTRAP */
166 case DBG_REASON_SINGLESTEP:
167 return 0x05; /* SIGTRAP */
168 case DBG_REASON_EXC_CATCH:
170 case DBG_REASON_NOTHALTED:
171 return 0x0; /* no signal... shouldn't happen */
173 LOG_USER("undefined debug reason %d - target needs reset",
174 target->debug_reason);
179 static int check_pending(struct connection *connection,
180 int timeout_s, int *got_data)
182 /* a non-blocking socket will block if there is 0 bytes available on the socket,
183 * but return with as many bytes as are available immediately
187 struct gdb_connection *gdb_con = connection->priv;
193 if (gdb_con->buf_cnt > 0) {
199 FD_SET(connection->fd, &read_fds);
201 tv.tv_sec = timeout_s;
203 if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) {
204 /* This can typically be because a "monitor" command took too long
205 * before printing any progress messages
208 return ERROR_GDB_TIMEOUT;
212 *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
216 static int gdb_get_char_inner(struct connection *connection, int *next_char)
218 struct gdb_connection *gdb_con = connection->priv;
219 int retval = ERROR_OK;
221 #ifdef _DEBUG_GDB_IO_
225 if (connection->service->type != CONNECTION_TCP)
226 gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
228 retval = check_pending(connection, 1, NULL);
229 if (retval != ERROR_OK)
231 gdb_con->buf_cnt = read_socket(connection->fd,
236 if (gdb_con->buf_cnt > 0)
238 if (gdb_con->buf_cnt == 0) {
239 LOG_DEBUG("GDB connection closed by the remote client");
240 gdb_con->closed = true;
241 return ERROR_SERVER_REMOTE_CLOSED;
245 errno = WSAGetLastError();
251 case WSAECONNABORTED:
252 gdb_con->closed = true;
253 return ERROR_SERVER_REMOTE_CLOSED;
255 gdb_con->closed = true;
256 return ERROR_SERVER_REMOTE_CLOSED;
258 LOG_ERROR("read: %d", errno);
267 gdb_con->closed = true;
268 return ERROR_SERVER_REMOTE_CLOSED;
270 gdb_con->closed = true;
271 return ERROR_SERVER_REMOTE_CLOSED;
273 LOG_ERROR("read: %s", strerror(errno));
274 gdb_con->closed = true;
275 return ERROR_SERVER_REMOTE_CLOSED;
280 #ifdef _DEBUG_GDB_IO_
281 debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt);
282 LOG_DEBUG("received '%s'", debug_buffer);
286 gdb_con->buf_p = gdb_con->buffer;
288 *next_char = *(gdb_con->buf_p++);
289 if (gdb_con->buf_cnt > 0)
290 connection->input_pending = true;
292 connection->input_pending = false;
293 #ifdef _DEBUG_GDB_IO_
294 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
301 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
302 * held in registers in the inner loop.
304 * For small caches and embedded systems this is important!
306 static inline int gdb_get_char_fast(struct connection *connection,
307 int *next_char, char **buf_p, int *buf_cnt)
309 int retval = ERROR_OK;
311 if ((*buf_cnt)-- > 0) {
312 *next_char = **buf_p;
315 connection->input_pending = true;
317 connection->input_pending = false;
319 #ifdef _DEBUG_GDB_IO_
320 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
326 struct gdb_connection *gdb_con = connection->priv;
327 gdb_con->buf_p = *buf_p;
328 gdb_con->buf_cnt = *buf_cnt;
329 retval = gdb_get_char_inner(connection, next_char);
330 *buf_p = gdb_con->buf_p;
331 *buf_cnt = gdb_con->buf_cnt;
336 static int gdb_get_char(struct connection *connection, int *next_char)
338 struct gdb_connection *gdb_con = connection->priv;
339 return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
342 static int gdb_putback_char(struct connection *connection, int last_char)
344 struct gdb_connection *gdb_con = connection->priv;
346 if (gdb_con->buf_p > gdb_con->buffer) {
347 *(--gdb_con->buf_p) = last_char;
350 LOG_ERROR("BUG: couldn't put character back");
355 /* The only way we can detect that the socket is closed is the first time
356 * we write to it, we will fail. Subsequent write operations will
357 * succeed. Shudder! */
358 static int gdb_write(struct connection *connection, void *data, int len)
360 struct gdb_connection *gdb_con = connection->priv;
361 if (gdb_con->closed) {
362 LOG_DEBUG("GDB socket marked as closed, cannot write to it.");
363 return ERROR_SERVER_REMOTE_CLOSED;
366 if (connection_write(connection, data, len) == len)
369 LOG_WARNING("Error writing to GDB socket. Dropping the connection.");
370 gdb_con->closed = true;
371 return ERROR_SERVER_REMOTE_CLOSED;
374 static void gdb_log_incoming_packet(struct connection *connection, char *packet)
376 if (!LOG_LEVEL_IS(LOG_LVL_DEBUG))
379 struct target *target = get_target_from_connection(connection);
381 /* Avoid dumping non-printable characters to the terminal */
382 const unsigned packet_len = strlen(packet);
383 const char *nonprint = find_nonprint_char(packet, packet_len);
385 /* Does packet at least have a prefix that is printable?
386 * Look within the first 50 chars of the packet. */
387 const char *colon = memchr(packet, ':', MIN(50, packet_len));
388 const bool packet_has_prefix = (colon);
389 const bool packet_prefix_printable = (packet_has_prefix && nonprint > colon);
391 if (packet_prefix_printable) {
392 const unsigned int prefix_len = colon - packet + 1; /* + 1 to include the ':' */
393 const unsigned int payload_len = packet_len - prefix_len;
394 LOG_TARGET_DEBUG(target, "received packet: %.*s<binary-data-%u-bytes>", prefix_len,
395 packet, payload_len);
397 LOG_TARGET_DEBUG(target, "received packet: <binary-data-%u-bytes>", packet_len);
400 /* All chars printable, dump the packet as is */
401 LOG_TARGET_DEBUG(target, "received packet: %s", packet);
405 static void gdb_log_outgoing_packet(struct connection *connection, char *packet_buf,
406 unsigned int packet_len, unsigned char checksum)
408 if (!LOG_LEVEL_IS(LOG_LVL_DEBUG))
411 struct target *target = get_target_from_connection(connection);
413 if (find_nonprint_char(packet_buf, packet_len))
414 LOG_TARGET_DEBUG(target, "sending packet: $<binary-data-%u-bytes>#%2.2x",
415 packet_len, checksum);
417 LOG_TARGET_DEBUG(target, "sending packet: $%.*s#%2.2x", packet_len, packet_buf,
421 static int gdb_put_packet_inner(struct connection *connection,
422 char *buffer, int len)
425 unsigned char my_checksum = 0;
428 struct gdb_connection *gdb_con = connection->priv;
430 for (i = 0; i < len; i++)
431 my_checksum += buffer[i];
433 #ifdef _DEBUG_GDB_IO_
435 * At this point we should have nothing in the input queue from GDB,
436 * however sometimes '-' is sent even though we've already received
437 * an ACK (+) for everything we've sent off.
441 retval = check_pending(connection, 0, &gotdata);
442 if (retval != ERROR_OK)
446 retval = gdb_get_char(connection, &reply);
447 if (retval != ERROR_OK)
450 /* fix a problem with some IAR tools */
451 gdb_putback_char(connection, reply);
452 LOG_DEBUG("Unexpected start of new packet");
456 LOG_WARNING("Discard unexpected char %c", reply);
461 gdb_log_outgoing_packet(connection, buffer, len, my_checksum);
463 char local_buffer[1024];
464 local_buffer[0] = '$';
465 if ((size_t)len + 4 <= sizeof(local_buffer)) {
466 /* performance gain on smaller packets by only a single call to gdb_write() */
467 memcpy(local_buffer + 1, buffer, len++);
468 len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum);
469 retval = gdb_write(connection, local_buffer, len);
470 if (retval != ERROR_OK)
473 /* larger packets are transmitted directly from caller supplied buffer
474 * by several calls to gdb_write() to avoid dynamic allocation */
475 snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum);
476 retval = gdb_write(connection, local_buffer, 1);
477 if (retval != ERROR_OK)
479 retval = gdb_write(connection, buffer, len);
480 if (retval != ERROR_OK)
482 retval = gdb_write(connection, local_buffer + 1, 3);
483 if (retval != ERROR_OK)
487 if (gdb_con->noack_mode)
490 retval = gdb_get_char(connection, &reply);
491 if (retval != ERROR_OK)
495 gdb_log_incoming_packet(connection, "+");
497 } else if (reply == '-') {
498 /* Stop sending output packets for now */
499 gdb_con->output_flag = GDB_OUTPUT_NO;
500 gdb_log_incoming_packet(connection, "-");
501 LOG_WARNING("negative reply, retrying");
502 } else if (reply == 0x3) {
503 gdb_con->ctrl_c = true;
504 gdb_log_incoming_packet(connection, "<Ctrl-C>");
505 retval = gdb_get_char(connection, &reply);
506 if (retval != ERROR_OK)
509 gdb_log_incoming_packet(connection, "+");
511 } else if (reply == '-') {
512 /* Stop sending output packets for now */
513 gdb_con->output_flag = GDB_OUTPUT_NO;
514 gdb_log_incoming_packet(connection, "-");
515 LOG_WARNING("negative reply, retrying");
516 } else if (reply == '$') {
517 LOG_ERROR("GDB missing ack(1) - assumed good");
518 gdb_putback_char(connection, reply);
521 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
522 gdb_con->closed = true;
523 return ERROR_SERVER_REMOTE_CLOSED;
525 } else if (reply == '$') {
526 LOG_ERROR("GDB missing ack(2) - assumed good");
527 gdb_putback_char(connection, reply);
530 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
532 gdb_con->closed = true;
533 return ERROR_SERVER_REMOTE_CLOSED;
537 return ERROR_SERVER_REMOTE_CLOSED;
542 int gdb_put_packet(struct connection *connection, char *buffer, int len)
544 struct gdb_connection *gdb_con = connection->priv;
545 gdb_con->busy = true;
546 int retval = gdb_put_packet_inner(connection, buffer, len);
547 gdb_con->busy = false;
549 /* we sent some data, reset timer for keep alive messages */
555 static inline int fetch_packet(struct connection *connection,
556 int *checksum_ok, int noack, int *len, char *buffer)
558 unsigned char my_checksum = 0;
561 int retval = ERROR_OK;
563 struct gdb_connection *gdb_con = connection->priv;
568 /* move this over into local variables to use registers and give the
569 * more freedom to optimize */
570 char *buf_p = gdb_con->buf_p;
571 int buf_cnt = gdb_con->buf_cnt;
574 /* The common case is that we have an entire packet with no escape chars.
575 * We need to leave at least 2 bytes in the buffer to have
576 * gdb_get_char() update various bits and bobs correctly.
578 if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) {
579 /* The compiler will struggle a bit with constant propagation and
580 * aliasing, so we help it by showing that these values do not
581 * change inside the loop
585 int run = buf_cnt - 2;
591 if (character == '#') {
592 /* Danger! character can be '#' when esc is
593 * used so we need an explicit boolean for done here. */
598 if (character == '}') {
599 /* data transmitted in binary mode (X packet)
600 * uses 0x7d as escape character */
601 my_checksum += character & 0xff;
604 my_checksum += character & 0xff;
605 buffer[count++] = (character ^ 0x20) & 0xff;
607 my_checksum += character & 0xff;
608 buffer[count++] = character & 0xff;
617 LOG_ERROR("packet buffer too small");
618 retval = ERROR_GDB_BUFFER_TOO_SMALL;
622 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
623 if (retval != ERROR_OK)
626 if (character == '#')
629 if (character == '}') {
630 /* data transmitted in binary mode (X packet)
631 * uses 0x7d as escape character */
632 my_checksum += character & 0xff;
634 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
635 if (retval != ERROR_OK)
638 my_checksum += character & 0xff;
639 buffer[count++] = (character ^ 0x20) & 0xff;
641 my_checksum += character & 0xff;
642 buffer[count++] = character & 0xff;
646 gdb_con->buf_p = buf_p;
647 gdb_con->buf_cnt = buf_cnt;
649 if (retval != ERROR_OK)
654 retval = gdb_get_char(connection, &character);
655 if (retval != ERROR_OK)
657 checksum[0] = character;
658 retval = gdb_get_char(connection, &character);
659 if (retval != ERROR_OK)
661 checksum[1] = character;
665 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
670 static int gdb_get_packet_inner(struct connection *connection,
671 char *buffer, int *len)
675 struct gdb_connection *gdb_con = connection->priv;
679 retval = gdb_get_char(connection, &character);
680 if (retval != ERROR_OK)
683 #ifdef _DEBUG_GDB_IO_
684 LOG_DEBUG("character: '%c'", character);
691 gdb_log_incoming_packet(connection, "+");
692 /* According to the GDB documentation
693 * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html):
694 * "gdb sends a final `+` acknowledgment of the stub's `OK`
695 * response, which can be safely ignored by the stub."
696 * However OpenOCD server already is in noack mode at this
697 * point and instead of ignoring this it was emitting a
698 * warning. This code makes server ignore the first ACK
699 * that will be received after going into noack mode,
700 * warning only about subsequent ACK's. */
701 if (gdb_con->noack_mode > 1) {
702 LOG_WARNING("acknowledgment received, but no packet pending");
703 } else if (gdb_con->noack_mode) {
704 LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it.");
705 gdb_con->noack_mode = 2;
709 gdb_log_incoming_packet(connection, "-");
710 LOG_WARNING("negative acknowledgment, but no packet pending");
713 gdb_log_incoming_packet(connection, "<Ctrl-C>");
714 gdb_con->ctrl_c = true;
718 LOG_WARNING("ignoring character 0x%x", character);
721 } while (character != '$');
724 /* explicit code expansion here to get faster inlined code in -O3 by not
725 * calculating checksum */
726 if (gdb_con->noack_mode) {
727 retval = fetch_packet(connection, &checksum_ok, 1, len, buffer);
728 if (retval != ERROR_OK)
731 retval = fetch_packet(connection, &checksum_ok, 0, len, buffer);
732 if (retval != ERROR_OK)
736 if (gdb_con->noack_mode) {
737 /* checksum is not checked in noack mode */
741 retval = gdb_write(connection, "+", 1);
742 if (retval != ERROR_OK)
748 return ERROR_SERVER_REMOTE_CLOSED;
753 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
755 struct gdb_connection *gdb_con = connection->priv;
756 gdb_con->busy = true;
757 int retval = gdb_get_packet_inner(connection, buffer, len);
758 gdb_con->busy = false;
762 static int gdb_output_con(struct connection *connection, const char *line)
767 bin_size = strlen(line);
769 hex_buffer = malloc(bin_size * 2 + 2);
771 return ERROR_GDB_BUFFER_TOO_SMALL;
774 size_t pkt_len = hexify(hex_buffer + 1, (const uint8_t *)line, bin_size,
776 int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1);
782 static int gdb_output(struct command_context *context, const char *line)
784 /* this will be dumped to the log and also sent as an O packet if possible */
785 LOG_USER_N("%s", line);
789 static void gdb_signal_reply(struct target *target, struct connection *connection)
791 struct gdb_connection *gdb_connection = connection->priv;
793 char stop_reason[32];
794 char current_thread[25];
798 rtos_update_threads(target);
800 if (target->debug_reason == DBG_REASON_EXIT) {
801 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "W00");
805 target->rtos->current_threadid = target->rtos->current_thread;
806 target->rtos->gdb_target_for_threadid(connection, target->rtos->current_threadid, &ct);
811 if (gdb_connection->ctrl_c) {
814 signal_var = gdb_last_signal(ct);
816 stop_reason[0] = '\0';
817 if (ct->debug_reason == DBG_REASON_WATCHPOINT) {
818 enum watchpoint_rw hit_wp_type;
819 target_addr_t hit_wp_address;
821 if (watchpoint_hit(ct, &hit_wp_type, &hit_wp_address) == ERROR_OK) {
823 switch (hit_wp_type) {
825 snprintf(stop_reason, sizeof(stop_reason),
826 "watch:%08" TARGET_PRIxADDR ";", hit_wp_address);
829 snprintf(stop_reason, sizeof(stop_reason),
830 "rwatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
833 snprintf(stop_reason, sizeof(stop_reason),
834 "awatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
842 current_thread[0] = '\0';
844 snprintf(current_thread, sizeof(current_thread), "thread:%" PRIx64 ";",
845 target->rtos->current_thread);
847 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "T%2.2x%s%s",
848 signal_var, stop_reason, current_thread);
850 gdb_connection->ctrl_c = false;
853 gdb_put_packet(connection, sig_reply, sig_reply_len);
854 gdb_connection->frontend_state = TARGET_HALTED;
857 static void gdb_fileio_reply(struct target *target, struct connection *connection)
859 struct gdb_connection *gdb_connection = connection->priv;
860 char fileio_command[256];
862 bool program_exited = false;
864 if (strcmp(target->fileio_info->identifier, "open") == 0)
865 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
866 target->fileio_info->param_1,
867 target->fileio_info->param_2 + 1, /* len + trailing zero */
868 target->fileio_info->param_3,
869 target->fileio_info->param_4);
870 else if (strcmp(target->fileio_info->identifier, "close") == 0)
871 sprintf(fileio_command, "F%s,%" PRIx64, target->fileio_info->identifier,
872 target->fileio_info->param_1);
873 else if (strcmp(target->fileio_info->identifier, "read") == 0)
874 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
875 target->fileio_info->param_1,
876 target->fileio_info->param_2,
877 target->fileio_info->param_3);
878 else if (strcmp(target->fileio_info->identifier, "write") == 0)
879 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
880 target->fileio_info->param_1,
881 target->fileio_info->param_2,
882 target->fileio_info->param_3);
883 else if (strcmp(target->fileio_info->identifier, "lseek") == 0)
884 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
885 target->fileio_info->param_1,
886 target->fileio_info->param_2,
887 target->fileio_info->param_3);
888 else if (strcmp(target->fileio_info->identifier, "rename") == 0)
889 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
890 target->fileio_info->param_1,
891 target->fileio_info->param_2 + 1, /* len + trailing zero */
892 target->fileio_info->param_3,
893 target->fileio_info->param_4 + 1); /* len + trailing zero */
894 else if (strcmp(target->fileio_info->identifier, "unlink") == 0)
895 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
896 target->fileio_info->param_1,
897 target->fileio_info->param_2 + 1); /* len + trailing zero */
898 else if (strcmp(target->fileio_info->identifier, "stat") == 0)
899 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
900 target->fileio_info->param_1,
901 target->fileio_info->param_2,
902 target->fileio_info->param_3);
903 else if (strcmp(target->fileio_info->identifier, "fstat") == 0)
904 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
905 target->fileio_info->param_1,
906 target->fileio_info->param_2);
907 else if (strcmp(target->fileio_info->identifier, "gettimeofday") == 0)
908 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
909 target->fileio_info->param_1,
910 target->fileio_info->param_2);
911 else if (strcmp(target->fileio_info->identifier, "isatty") == 0)
912 sprintf(fileio_command, "F%s,%" PRIx64, target->fileio_info->identifier,
913 target->fileio_info->param_1);
914 else if (strcmp(target->fileio_info->identifier, "system") == 0)
915 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
916 target->fileio_info->param_1,
917 target->fileio_info->param_2 + 1); /* len + trailing zero */
918 else if (strcmp(target->fileio_info->identifier, "exit") == 0) {
919 /* If target hits exit syscall, report to GDB the program is terminated.
920 * In addition, let target run its own exit syscall handler. */
921 program_exited = true;
922 sprintf(fileio_command, "W%02" PRIx64, target->fileio_info->param_1);
924 LOG_DEBUG("Unknown syscall: %s", target->fileio_info->identifier);
926 /* encounter unknown syscall, continue */
927 gdb_connection->frontend_state = TARGET_RUNNING;
928 target_resume(target, 1, 0x0, 0, 0);
932 command_len = strlen(fileio_command);
933 gdb_put_packet(connection, fileio_command, command_len);
935 if (program_exited) {
936 /* Use target_resume() to let target run its own exit syscall handler. */
937 gdb_connection->frontend_state = TARGET_RUNNING;
938 target_resume(target, 1, 0x0, 0, 0);
940 gdb_connection->frontend_state = TARGET_HALTED;
941 rtos_update_threads(target);
945 static void gdb_frontend_halted(struct target *target, struct connection *connection)
947 struct gdb_connection *gdb_connection = connection->priv;
949 /* In the GDB protocol when we are stepping or continuing execution,
950 * we have a lingering reply. Upon receiving a halted event
951 * when we have that lingering packet, we reply to the original
952 * step or continue packet.
954 * Executing monitor commands can bring the target in and
955 * out of the running state so we'll see lots of TARGET_EVENT_XXX
956 * that are to be ignored.
958 if (gdb_connection->frontend_state == TARGET_RUNNING) {
959 /* stop forwarding log packets! */
960 gdb_connection->output_flag = GDB_OUTPUT_NO;
962 /* check fileio first */
963 if (target_get_gdb_fileio_info(target, target->fileio_info) == ERROR_OK)
964 gdb_fileio_reply(target, connection);
966 gdb_signal_reply(target, connection);
970 static int gdb_target_callback_event_handler(struct target *target,
971 enum target_event event, void *priv)
973 struct connection *connection = priv;
974 struct gdb_service *gdb_service = connection->service->priv;
976 if (gdb_service->target != target)
980 case TARGET_EVENT_GDB_HALT:
981 gdb_frontend_halted(target, connection);
983 case TARGET_EVENT_HALTED:
984 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
993 static int gdb_new_connection(struct connection *connection)
995 struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
996 struct target *target;
1000 target = get_target_from_connection(connection);
1001 connection->priv = gdb_connection;
1002 connection->cmd_ctx->current_target = target;
1004 /* initialize gdb connection information */
1005 gdb_connection->buf_p = gdb_connection->buffer;
1006 gdb_connection->buf_cnt = 0;
1007 gdb_connection->ctrl_c = false;
1008 gdb_connection->frontend_state = TARGET_HALTED;
1009 gdb_connection->vflash_image = NULL;
1010 gdb_connection->closed = false;
1011 gdb_connection->busy = false;
1012 gdb_connection->noack_mode = 0;
1013 gdb_connection->sync = false;
1014 gdb_connection->mem_write_error = false;
1015 gdb_connection->attached = true;
1016 gdb_connection->extended_protocol = false;
1017 gdb_connection->target_desc.tdesc = NULL;
1018 gdb_connection->target_desc.tdesc_length = 0;
1019 gdb_connection->thread_list = NULL;
1020 gdb_connection->output_flag = GDB_OUTPUT_NO;
1022 /* send ACK to GDB for debug request */
1023 gdb_write(connection, "+", 1);
1025 /* output goes through gdb connection */
1026 command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
1028 /* we must remove all breakpoints registered to the target as a previous
1029 * GDB session could leave dangling breakpoints if e.g. communication
1032 breakpoint_clear_target(target);
1033 watchpoint_clear_target(target);
1035 /* Since version 3.95 (gdb-19990504), with the exclusion of 6.5~6.8, GDB
1036 * sends an ACK at connection with the following comment in its source code:
1037 * "Ack any packet which the remote side has already sent."
1038 * LLDB does the same since the first gdb-remote implementation.
1039 * Remove the initial ACK from the incoming buffer.
1041 retval = gdb_get_char(connection, &initial_ack);
1042 if (retval != ERROR_OK)
1045 if (initial_ack != '+')
1046 gdb_putback_char(connection, initial_ack);
1048 target_call_event_callbacks(target, TARGET_EVENT_GDB_ATTACH);
1051 /* clean previous rtos session if supported*/
1052 if (target->rtos->type->clean)
1053 target->rtos->type->clean(target);
1055 /* update threads */
1056 rtos_update_threads(target);
1059 if (gdb_use_memory_map) {
1060 /* Connect must fail if the memory map can't be set up correctly.
1062 * This will cause an auto_probe to be invoked, which is either
1063 * a no-op or it will fail when the target isn't ready(e.g. not halted).
1065 for (unsigned int i = 0; i < flash_get_bank_count(); i++) {
1066 struct flash_bank *p;
1067 p = get_flash_bank_by_num_noprobe(i);
1068 if (p->target != target)
1070 retval = get_flash_bank_by_num(i, &p);
1071 if (retval != ERROR_OK) {
1072 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target "
1073 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
1079 gdb_actual_connections++;
1080 log_printf_lf(all_targets->next ? LOG_LVL_INFO : LOG_LVL_DEBUG,
1081 __FILE__, __LINE__, __func__,
1082 "New GDB Connection: %d, Target %s, state: %s",
1083 gdb_actual_connections,
1084 target_name(target),
1085 target_state_name(target));
1087 if (!target_was_examined(target)) {
1088 LOG_ERROR("Target %s not examined yet, refuse gdb connection %d!",
1089 target_name(target), gdb_actual_connections);
1090 gdb_actual_connections--;
1091 return ERROR_TARGET_NOT_EXAMINED;
1094 if (target->state != TARGET_HALTED)
1095 LOG_WARNING("GDB connection %d on target %s not halted",
1096 gdb_actual_connections, target_name(target));
1098 /* DANGER! If we fail subsequently, we must remove this handler,
1099 * otherwise we occasionally see crashes as the timer can invoke the
1102 * register callback to be informed about target events */
1103 target_register_event_callback(gdb_target_callback_event_handler, connection);
1105 log_add_callback(gdb_log_callback, connection);
1110 static int gdb_connection_closed(struct connection *connection)
1112 struct target *target;
1113 struct gdb_connection *gdb_connection = connection->priv;
1115 target = get_target_from_connection(connection);
1117 /* we're done forwarding messages. Tear down callback before
1118 * cleaning up connection.
1120 log_remove_callback(gdb_log_callback, connection);
1122 gdb_actual_connections--;
1123 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
1124 target_name(target),
1125 target_state_name(target),
1126 gdb_actual_connections);
1128 /* see if an image built with vFlash commands is left */
1129 if (gdb_connection->vflash_image) {
1130 image_close(gdb_connection->vflash_image);
1131 free(gdb_connection->vflash_image);
1132 gdb_connection->vflash_image = NULL;
1135 /* if this connection registered a debug-message receiver delete it */
1136 delete_debug_msg_receiver(connection->cmd_ctx, target);
1138 free(connection->priv);
1139 connection->priv = NULL;
1141 target_unregister_event_callback(gdb_target_callback_event_handler, connection);
1143 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
1145 target_call_event_callbacks(target, TARGET_EVENT_GDB_DETACH);
1150 static void gdb_send_error(struct connection *connection, uint8_t the_error)
1153 snprintf(err, 4, "E%2.2X", the_error);
1154 gdb_put_packet(connection, err, 3);
1157 static int gdb_last_signal_packet(struct connection *connection,
1158 char const *packet, int packet_size)
1160 struct target *target = get_target_from_connection(connection);
1161 struct gdb_connection *gdb_con = connection->priv;
1165 if (!gdb_con->attached) {
1166 /* if we are here we have received a kill packet
1167 * reply W stop reply otherwise gdb gets very unhappy */
1168 gdb_put_packet(connection, "W00", 3);
1172 signal_var = gdb_last_signal(target);
1174 snprintf(sig_reply, 4, "S%2.2x", signal_var);
1175 gdb_put_packet(connection, sig_reply, 3);
1180 static inline int gdb_reg_pos(struct target *target, int pos, int len)
1182 if (target->endianness == TARGET_LITTLE_ENDIAN)
1185 return len - 1 - pos;
1188 /* Convert register to string of bytes. NB! The # of bits in the
1189 * register might be non-divisible by 8(a byte), in which
1190 * case an entire byte is shown.
1192 * NB! the format on the wire is the target endianness
1194 * The format of reg->value is little endian
1197 static void gdb_str_to_target(struct target *target,
1198 char *tstr, struct reg *reg)
1205 buf_len = DIV_ROUND_UP(reg->size, 8);
1207 for (i = 0; i < buf_len; i++) {
1208 int j = gdb_reg_pos(target, i, buf_len);
1209 tstr += sprintf(tstr, "%02x", buf[j]);
1213 /* copy over in register buffer */
1214 static void gdb_target_to_reg(struct target *target,
1215 char const *tstr, int str_len, uint8_t *bin)
1218 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1223 for (i = 0; i < str_len; i += 2) {
1225 if (sscanf(tstr + i, "%02x", &t) != 1) {
1226 LOG_ERROR("BUG: unable to convert register value");
1230 int j = gdb_reg_pos(target, i/2, str_len/2);
1235 static int gdb_get_registers_packet(struct connection *connection,
1236 char const *packet, int packet_size)
1238 struct target *target = get_target_from_connection(connection);
1239 struct reg **reg_list;
1242 int reg_packet_size = 0;
1247 #ifdef _DEBUG_GDB_IO_
1251 if ((target->rtos) && (rtos_get_gdb_reg_list(connection) == ERROR_OK))
1254 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1256 if (retval != ERROR_OK)
1257 return gdb_error(connection, retval);
1259 for (i = 0; i < reg_list_size; i++) {
1260 if (!reg_list[i] || reg_list[i]->exist == false || reg_list[i]->hidden)
1262 reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1265 assert(reg_packet_size > 0);
1267 reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */
1271 reg_packet_p = reg_packet;
1273 for (i = 0; i < reg_list_size; i++) {
1274 if (!reg_list[i] || reg_list[i]->exist == false || reg_list[i]->hidden)
1276 if (!reg_list[i]->valid) {
1277 retval = reg_list[i]->type->get(reg_list[i]);
1278 if (retval != ERROR_OK && gdb_report_register_access_error) {
1279 LOG_DEBUG("Couldn't get register %s.", reg_list[i]->name);
1282 return gdb_error(connection, retval);
1285 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1286 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1289 #ifdef _DEBUG_GDB_IO_
1291 char *reg_packet_p_debug;
1292 reg_packet_p_debug = strndup(reg_packet, reg_packet_size);
1293 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug);
1294 free(reg_packet_p_debug);
1298 gdb_put_packet(connection, reg_packet, reg_packet_size);
1306 static int gdb_set_registers_packet(struct connection *connection,
1307 char const *packet, int packet_size)
1309 struct target *target = get_target_from_connection(connection);
1311 struct reg **reg_list;
1314 char const *packet_p;
1316 #ifdef _DEBUG_GDB_IO_
1320 /* skip command character */
1324 if (packet_size % 2) {
1325 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1326 return ERROR_SERVER_REMOTE_CLOSED;
1329 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1331 if (retval != ERROR_OK)
1332 return gdb_error(connection, retval);
1335 for (i = 0; i < reg_list_size; i++) {
1337 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1339 if (packet_p + chars > packet + packet_size)
1340 LOG_ERROR("BUG: register packet is too small for registers");
1342 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1343 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1345 retval = reg_list[i]->type->set(reg_list[i], bin_buf);
1346 if (retval != ERROR_OK && gdb_report_register_access_error) {
1347 LOG_DEBUG("Couldn't set register %s.", reg_list[i]->name);
1350 return gdb_error(connection, retval);
1353 /* advance packet pointer */
1359 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1362 gdb_put_packet(connection, "OK", 2);
1367 static int gdb_get_register_packet(struct connection *connection,
1368 char const *packet, int packet_size)
1370 struct target *target = get_target_from_connection(connection);
1372 int reg_num = strtoul(packet + 1, NULL, 16);
1373 struct reg **reg_list;
1377 #ifdef _DEBUG_GDB_IO_
1381 if ((target->rtos) && (rtos_get_gdb_reg(connection, reg_num) == ERROR_OK))
1384 retval = target_get_gdb_reg_list_noread(target, ®_list, ®_list_size,
1386 if (retval != ERROR_OK)
1387 return gdb_error(connection, retval);
1389 if (reg_list_size <= reg_num) {
1390 LOG_ERROR("gdb requested a non-existing register (reg_num=%d)", reg_num);
1391 return ERROR_SERVER_REMOTE_CLOSED;
1394 if (!reg_list[reg_num]->valid) {
1395 retval = reg_list[reg_num]->type->get(reg_list[reg_num]);
1396 if (retval != ERROR_OK && gdb_report_register_access_error) {
1397 LOG_DEBUG("Couldn't get register %s.", reg_list[reg_num]->name);
1399 return gdb_error(connection, retval);
1403 reg_packet = calloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1, 1); /* plus one for string termination null */
1405 gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1407 gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1415 static int gdb_set_register_packet(struct connection *connection,
1416 char const *packet, int packet_size)
1418 struct target *target = get_target_from_connection(connection);
1420 int reg_num = strtoul(packet + 1, &separator, 16);
1421 struct reg **reg_list;
1425 #ifdef _DEBUG_GDB_IO_
1429 if (*separator != '=') {
1430 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1431 return ERROR_SERVER_REMOTE_CLOSED;
1433 size_t chars = strlen(separator + 1);
1434 uint8_t *bin_buf = malloc(chars / 2);
1435 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1437 if ((target->rtos) &&
1438 (rtos_set_reg(connection, reg_num, bin_buf) == ERROR_OK)) {
1440 gdb_put_packet(connection, "OK", 2);
1444 retval = target_get_gdb_reg_list_noread(target, ®_list, ®_list_size,
1446 if (retval != ERROR_OK) {
1448 return gdb_error(connection, retval);
1451 if (reg_list_size <= reg_num) {
1452 LOG_ERROR("gdb requested a non-existing register (reg_num=%d)", reg_num);
1455 return ERROR_SERVER_REMOTE_CLOSED;
1458 if (chars != (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2)) {
1459 LOG_ERROR("gdb sent %zu bits for a %" PRIu32 "-bit register (%s)",
1460 chars * 4, reg_list[reg_num]->size, reg_list[reg_num]->name);
1463 return ERROR_SERVER_REMOTE_CLOSED;
1466 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1468 retval = reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1469 if (retval != ERROR_OK && gdb_report_register_access_error) {
1470 LOG_DEBUG("Couldn't set register %s.", reg_list[reg_num]->name);
1473 return gdb_error(connection, retval);
1476 gdb_put_packet(connection, "OK", 2);
1484 /* No attempt is made to translate the "retval" to
1485 * GDB speak. This has to be done at the calling
1486 * site as no mapping really exists.
1488 static int gdb_error(struct connection *connection, int retval)
1490 LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1491 gdb_send_error(connection, EFAULT);
1495 /* We don't have to worry about the default 2 second timeout for GDB packets,
1496 * because GDB breaks up large memory reads into smaller reads.
1498 static int gdb_read_memory_packet(struct connection *connection,
1499 char const *packet, int packet_size)
1501 struct target *target = get_target_from_connection(connection);
1509 int retval = ERROR_OK;
1511 /* skip command character */
1514 addr = strtoull(packet, &separator, 16);
1516 if (*separator != ',') {
1517 LOG_ERROR("incomplete read memory packet received, dropping connection");
1518 return ERROR_SERVER_REMOTE_CLOSED;
1521 len = strtoul(separator + 1, NULL, 16);
1524 LOG_WARNING("invalid read memory packet received (len == 0)");
1525 gdb_put_packet(connection, "", 0);
1529 buffer = malloc(len);
1531 LOG_DEBUG("addr: 0x%16.16" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1533 retval = ERROR_NOT_IMPLEMENTED;
1535 retval = rtos_read_buffer(target, addr, len, buffer);
1536 if (retval == ERROR_NOT_IMPLEMENTED)
1537 retval = target_read_buffer(target, addr, len, buffer);
1539 if ((retval != ERROR_OK) && !gdb_report_data_abort) {
1540 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1541 * At some point this might be fixed in GDB, in which case this code can be removed.
1543 * OpenOCD developers are acutely aware of this problem, but there is nothing
1544 * gained by involving the user in this problem that hopefully will get resolved
1547 * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1548 * cmd = view%20audit-trail&database = gdb&pr = 2395
1550 * For now, the default is to fix up things to make current GDB versions work.
1551 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1553 memset(buffer, 0, len);
1557 if (retval == ERROR_OK) {
1558 hex_buffer = malloc(len * 2 + 1);
1560 size_t pkt_len = hexify(hex_buffer, buffer, len, len * 2 + 1);
1562 gdb_put_packet(connection, hex_buffer, pkt_len);
1566 retval = gdb_error(connection, retval);
1573 static int gdb_write_memory_packet(struct connection *connection,
1574 char const *packet, int packet_size)
1576 struct target *target = get_target_from_connection(connection);
1584 /* skip command character */
1587 addr = strtoull(packet, &separator, 16);
1589 if (*separator != ',') {
1590 LOG_ERROR("incomplete write memory packet received, dropping connection");
1591 return ERROR_SERVER_REMOTE_CLOSED;
1594 len = strtoul(separator + 1, &separator, 16);
1596 if (*(separator++) != ':') {
1597 LOG_ERROR("incomplete write memory packet received, dropping connection");
1598 return ERROR_SERVER_REMOTE_CLOSED;
1601 buffer = malloc(len);
1603 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1605 if (unhexify(buffer, separator, len) != len)
1606 LOG_ERROR("unable to decode memory packet");
1608 retval = ERROR_NOT_IMPLEMENTED;
1610 retval = rtos_write_buffer(target, addr, len, buffer);
1611 if (retval == ERROR_NOT_IMPLEMENTED)
1612 retval = target_write_buffer(target, addr, len, buffer);
1614 if (retval == ERROR_OK)
1615 gdb_put_packet(connection, "OK", 2);
1617 retval = gdb_error(connection, retval);
1624 static int gdb_write_memory_binary_packet(struct connection *connection,
1625 char const *packet, int packet_size)
1627 struct target *target = get_target_from_connection(connection);
1632 int retval = ERROR_OK;
1633 /* Packets larger than fast_limit bytes will be acknowledged instantly on
1634 * the assumption that we're in a download and it's important to go as fast
1636 uint32_t fast_limit = 8;
1638 /* skip command character */
1641 addr = strtoull(packet, &separator, 16);
1643 if (*separator != ',') {
1644 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1645 return ERROR_SERVER_REMOTE_CLOSED;
1648 len = strtoul(separator + 1, &separator, 16);
1650 if (*(separator++) != ':') {
1651 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1652 return ERROR_SERVER_REMOTE_CLOSED;
1655 struct gdb_connection *gdb_connection = connection->priv;
1657 if (gdb_connection->mem_write_error)
1658 retval = ERROR_FAIL;
1660 if (retval == ERROR_OK) {
1661 if (len >= fast_limit) {
1662 /* By replying the packet *immediately* GDB will send us a new packet
1663 * while we write the last one to the target.
1664 * We only do this for larger writes, so that users who do something like:
1665 * p *((int*)0xdeadbeef)=8675309
1666 * will get immediate feedback that that write failed.
1668 gdb_put_packet(connection, "OK", 2);
1671 retval = gdb_error(connection, retval);
1672 /* now that we have reported the memory write error, we can clear the condition */
1673 gdb_connection->mem_write_error = false;
1674 if (retval != ERROR_OK)
1679 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1681 retval = ERROR_NOT_IMPLEMENTED;
1683 retval = rtos_write_buffer(target, addr, len, (uint8_t *)separator);
1684 if (retval == ERROR_NOT_IMPLEMENTED)
1685 retval = target_write_buffer(target, addr, len, (uint8_t *)separator);
1687 if (retval != ERROR_OK)
1688 gdb_connection->mem_write_error = true;
1691 if (len < fast_limit) {
1692 if (retval != ERROR_OK) {
1693 gdb_error(connection, retval);
1694 gdb_connection->mem_write_error = false;
1696 gdb_put_packet(connection, "OK", 2);
1703 static int gdb_step_continue_packet(struct connection *connection,
1704 char const *packet, int packet_size)
1706 struct target *target = get_target_from_connection(connection);
1708 uint64_t address = 0x0;
1709 int retval = ERROR_OK;
1713 if (packet_size > 1)
1714 address = strtoull(packet + 1, NULL, 16);
1718 gdb_running_type = packet[0];
1719 if (packet[0] == 'c') {
1720 LOG_DEBUG("continue");
1721 /* resume at current address, don't handle breakpoints, not debugging */
1722 retval = target_resume(target, current, address, 0, 0);
1723 } else if (packet[0] == 's') {
1725 /* step at current or address, don't handle breakpoints */
1726 retval = target_step(target, current, address, 0);
1731 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1732 char const *packet, int packet_size)
1734 struct target *target = get_target_from_connection(connection);
1736 enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1737 enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1743 LOG_DEBUG("[%s]", target_name(target));
1745 type = strtoul(packet + 1, &separator, 16);
1747 if (type == 0) /* memory breakpoint */
1748 bp_type = BKPT_SOFT;
1749 else if (type == 1) /* hardware breakpoint */
1750 bp_type = BKPT_HARD;
1751 else if (type == 2) /* write watchpoint */
1752 wp_type = WPT_WRITE;
1753 else if (type == 3) /* read watchpoint */
1755 else if (type == 4) /* access watchpoint */
1756 wp_type = WPT_ACCESS;
1758 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1759 return ERROR_SERVER_REMOTE_CLOSED;
1762 if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD)))
1763 bp_type = gdb_breakpoint_override_type;
1765 if (*separator != ',') {
1766 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1767 return ERROR_SERVER_REMOTE_CLOSED;
1770 address = strtoull(separator + 1, &separator, 16);
1772 if (*separator != ',') {
1773 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1774 return ERROR_SERVER_REMOTE_CLOSED;
1777 size = strtoul(separator + 1, &separator, 16);
1782 if (packet[0] == 'Z') {
1783 retval = breakpoint_add(target, address, size, bp_type);
1784 if (retval != ERROR_OK) {
1785 retval = gdb_error(connection, retval);
1786 if (retval != ERROR_OK)
1789 gdb_put_packet(connection, "OK", 2);
1791 breakpoint_remove(target, address);
1792 gdb_put_packet(connection, "OK", 2);
1799 if (packet[0] == 'Z') {
1800 retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu);
1801 if (retval != ERROR_OK) {
1802 retval = gdb_error(connection, retval);
1803 if (retval != ERROR_OK)
1806 gdb_put_packet(connection, "OK", 2);
1808 watchpoint_remove(target, address);
1809 gdb_put_packet(connection, "OK", 2);
1820 /* print out a string and allocate more space as needed,
1821 * mainly used for XML at this point
1823 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))) void xml_printf(int *retval,
1824 char **xml, int *pos, int *size, const char *fmt, ...)
1826 if (*retval != ERROR_OK)
1831 if ((!*xml) || (!first)) {
1832 /* start by 0 to exercise all the code paths.
1833 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1835 *size = *size * 2 + 2;
1837 *xml = realloc(*xml, *size);
1840 *retval = ERROR_SERVER_REMOTE_CLOSED;
1848 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1850 if ((ret > 0) && ((ret + 1) < *size - *pos)) {
1854 /* there was just enough or not enough space, allocate more. */
1859 static int decode_xfer_read(char const *buf, char **annex, int *ofs, unsigned int *len)
1861 /* Locate the annex. */
1862 const char *annex_end = strchr(buf, ':');
1866 /* After the read marker and annex, qXfer looks like a
1867 * traditional 'm' packet. */
1869 *ofs = strtoul(annex_end + 1, &separator, 16);
1871 if (*separator != ',')
1874 *len = strtoul(separator + 1, NULL, 16);
1876 /* Extract the annex if needed */
1878 *annex = strndup(buf, annex_end - buf);
1886 static int compare_bank(const void *a, const void *b)
1888 struct flash_bank *b1, *b2;
1889 b1 = *((struct flash_bank **)a);
1890 b2 = *((struct flash_bank **)b);
1892 if (b1->base == b2->base)
1894 else if (b1->base > b2->base)
1900 static int gdb_memory_map(struct connection *connection,
1901 char const *packet, int packet_size)
1903 /* We get away with only specifying flash here. Regions that are not
1904 * specified are treated as if we provided no memory map(if not we
1905 * could detect the holes and mark them as RAM).
1906 * Normally we only execute this code once, but no big deal if we
1907 * have to regenerate it a couple of times.
1910 struct target *target = get_target_from_connection(connection);
1911 struct flash_bank *p;
1915 int retval = ERROR_OK;
1916 struct flash_bank **banks;
1920 target_addr_t ram_start = 0;
1921 unsigned int target_flash_banks = 0;
1923 /* skip command character */
1926 offset = strtoul(packet, &separator, 16);
1927 length = strtoul(separator + 1, &separator, 16);
1929 xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1931 /* Sort banks in ascending order. We need to report non-flash
1932 * memory as ram (or rather read/write) by default for GDB, since
1933 * it has no concept of non-cacheable read/write memory (i/o etc).
1935 banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1937 for (unsigned int i = 0; i < flash_get_bank_count(); i++) {
1938 p = get_flash_bank_by_num_noprobe(i);
1939 if (p->target != target)
1941 retval = get_flash_bank_by_num(i, &p);
1942 if (retval != ERROR_OK) {
1944 gdb_error(connection, retval);
1947 banks[target_flash_banks++] = p;
1950 qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1953 for (unsigned int i = 0; i < target_flash_banks; i++) {
1954 unsigned sector_size = 0;
1955 unsigned group_len = 0;
1959 if (ram_start < p->base)
1960 xml_printf(&retval, &xml, &pos, &size,
1961 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT "\" "
1962 "length=\"" TARGET_ADDR_FMT "\"/>\n",
1963 ram_start, p->base - ram_start);
1965 /* Report adjacent groups of same-size sectors. So for
1966 * example top boot CFI flash will list an initial region
1967 * with several large sectors (maybe 128KB) and several
1968 * smaller ones at the end (maybe 32KB). STR7 will have
1969 * regions with 8KB, 32KB, and 64KB sectors; etc.
1971 for (unsigned int j = 0; j < p->num_sectors; j++) {
1973 /* Maybe start a new group of sectors. */
1974 if (sector_size == 0) {
1975 if (p->sectors[j].offset + p->sectors[j].size > p->size) {
1976 LOG_WARNING("The flash sector at offset 0x%08" PRIx32
1977 " overflows the end of %s bank.",
1978 p->sectors[j].offset, p->name);
1979 LOG_WARNING("The rest of bank will not show in gdb memory map.");
1982 target_addr_t start;
1983 start = p->base + p->sectors[j].offset;
1984 xml_printf(&retval, &xml, &pos, &size,
1985 "<memory type=\"flash\" "
1986 "start=\"" TARGET_ADDR_FMT "\" ",
1988 sector_size = p->sectors[j].size;
1989 group_len = sector_size;
1991 group_len += sector_size; /* equal to p->sectors[j].size */
1994 /* Does this finish a group of sectors?
1995 * If not, continue an already-started group.
1997 if (j < p->num_sectors - 1
1998 && p->sectors[j + 1].size == sector_size
1999 && p->sectors[j + 1].offset == p->sectors[j].offset + sector_size
2000 && p->sectors[j + 1].offset + p->sectors[j + 1].size <= p->size)
2003 xml_printf(&retval, &xml, &pos, &size,
2004 "length=\"0x%x\">\n"
2005 "<property name=\"blocksize\">"
2013 ram_start = p->base + p->size;
2017 xml_printf(&retval, &xml, &pos, &size,
2018 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT "\" "
2019 "length=\"" TARGET_ADDR_FMT "\"/>\n",
2020 ram_start, target_address_max(target) - ram_start + 1);
2021 /* ELSE a flash chip could be at the very end of the address space, in
2022 * which case ram_start will be precisely 0 */
2026 xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
2028 if (retval != ERROR_OK) {
2030 gdb_error(connection, retval);
2034 if (offset + length > pos)
2035 length = pos - offset;
2037 char *t = malloc(length + 1);
2039 memcpy(t + 1, xml + offset, length);
2040 gdb_put_packet(connection, t, length + 1);
2047 static const char *gdb_get_reg_type_name(enum reg_type type)
2056 case REG_TYPE_INT16:
2058 case REG_TYPE_INT32:
2060 case REG_TYPE_INT64:
2062 case REG_TYPE_INT128:
2066 case REG_TYPE_UINT8:
2068 case REG_TYPE_UINT16:
2070 case REG_TYPE_UINT32:
2072 case REG_TYPE_UINT64:
2074 case REG_TYPE_UINT128:
2076 case REG_TYPE_CODE_PTR:
2078 case REG_TYPE_DATA_PTR:
2080 case REG_TYPE_FLOAT:
2082 case REG_TYPE_IEEE_SINGLE:
2083 return "ieee_single";
2084 case REG_TYPE_IEEE_DOUBLE:
2085 return "ieee_double";
2086 case REG_TYPE_ARCH_DEFINED:
2087 return "int"; /* return arbitrary string to avoid compile warning. */
2090 return "int"; /* "int" as default value */
2093 static int lookup_add_arch_defined_types(char const **arch_defined_types_list[], const char *type_id,
2094 int *num_arch_defined_types)
2096 int tbl_sz = *num_arch_defined_types;
2098 if (type_id && (strcmp(type_id, ""))) {
2099 for (int j = 0; j < (tbl_sz + 1); j++) {
2100 if (!((*arch_defined_types_list)[j])) {
2101 (*arch_defined_types_list)[tbl_sz++] = type_id;
2102 *arch_defined_types_list = realloc(*arch_defined_types_list,
2103 sizeof(char *) * (tbl_sz + 1));
2104 (*arch_defined_types_list)[tbl_sz] = NULL;
2105 *num_arch_defined_types = tbl_sz;
2108 if (!strcmp((*arch_defined_types_list)[j], type_id))
2117 static int gdb_generate_reg_type_description(struct target *target,
2118 char **tdesc, int *pos, int *size, struct reg_data_type *type,
2119 char const **arch_defined_types_list[], int *num_arch_defined_types)
2121 int retval = ERROR_OK;
2123 if (type->type_class == REG_TYPE_CLASS_VECTOR) {
2124 struct reg_data_type *data_type = type->reg_type_vector->type;
2125 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2126 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2127 num_arch_defined_types))
2128 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2129 arch_defined_types_list,
2130 num_arch_defined_types);
2132 /* <vector id="id" type="type" count="count"/> */
2133 xml_printf(&retval, tdesc, pos, size,
2134 "<vector id=\"%s\" type=\"%s\" count=\"%" PRIu32 "\"/>\n",
2135 type->id, type->reg_type_vector->type->id,
2136 type->reg_type_vector->count);
2138 } else if (type->type_class == REG_TYPE_CLASS_UNION) {
2139 struct reg_data_type_union_field *field;
2140 field = type->reg_type_union->fields;
2142 struct reg_data_type *data_type = field->type;
2143 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2144 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2145 num_arch_defined_types))
2146 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2147 arch_defined_types_list,
2148 num_arch_defined_types);
2151 field = field->next;
2154 * <field name="name" type="type"/> ...
2156 xml_printf(&retval, tdesc, pos, size,
2157 "<union id=\"%s\">\n",
2160 field = type->reg_type_union->fields;
2162 xml_printf(&retval, tdesc, pos, size,
2163 "<field name=\"%s\" type=\"%s\"/>\n",
2164 field->name, field->type->id);
2166 field = field->next;
2169 xml_printf(&retval, tdesc, pos, size,
2172 } else if (type->type_class == REG_TYPE_CLASS_STRUCT) {
2173 struct reg_data_type_struct_field *field;
2174 field = type->reg_type_struct->fields;
2176 if (field->use_bitfields) {
2177 /* <struct id="id" size="size">
2178 * <field name="name" start="start" end="end"/> ...
2180 xml_printf(&retval, tdesc, pos, size,
2181 "<struct id=\"%s\" size=\"%" PRIu32 "\">\n",
2182 type->id, type->reg_type_struct->size);
2184 xml_printf(&retval, tdesc, pos, size,
2185 "<field name=\"%s\" start=\"%" PRIu32 "\" end=\"%" PRIu32 "\" type=\"%s\" />\n",
2186 field->name, field->bitfield->start, field->bitfield->end,
2187 gdb_get_reg_type_name(field->bitfield->type));
2189 field = field->next;
2193 struct reg_data_type *data_type = field->type;
2194 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2195 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2196 num_arch_defined_types))
2197 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2198 arch_defined_types_list,
2199 num_arch_defined_types);
2204 * <field name="name" type="type"/> ...
2206 xml_printf(&retval, tdesc, pos, size,
2207 "<struct id=\"%s\">\n",
2210 xml_printf(&retval, tdesc, pos, size,
2211 "<field name=\"%s\" type=\"%s\"/>\n",
2212 field->name, field->type->id);
2214 field = field->next;
2218 xml_printf(&retval, tdesc, pos, size,
2221 } else if (type->type_class == REG_TYPE_CLASS_FLAGS) {
2222 /* <flags id="id" size="size">
2223 * <field name="name" start="start" end="end"/> ...
2225 xml_printf(&retval, tdesc, pos, size,
2226 "<flags id=\"%s\" size=\"%" PRIu32 "\">\n",
2227 type->id, type->reg_type_flags->size);
2229 struct reg_data_type_flags_field *field;
2230 field = type->reg_type_flags->fields;
2232 xml_printf(&retval, tdesc, pos, size,
2233 "<field name=\"%s\" start=\"%" PRIu32 "\" end=\"%" PRIu32 "\" type=\"%s\" />\n",
2234 field->name, field->bitfield->start, field->bitfield->end,
2235 gdb_get_reg_type_name(field->bitfield->type));
2237 field = field->next;
2240 xml_printf(&retval, tdesc, pos, size,
2248 /* Get a list of available target registers features. feature_list must
2249 * be freed by caller.
2251 static int get_reg_features_list(struct target *target, char const **feature_list[], int *feature_list_size,
2252 struct reg **reg_list, int reg_list_size)
2256 /* Start with only one element */
2257 *feature_list = calloc(1, sizeof(char *));
2259 for (int i = 0; i < reg_list_size; i++) {
2260 if (reg_list[i]->exist == false || reg_list[i]->hidden)
2263 if (reg_list[i]->feature
2264 && reg_list[i]->feature->name
2265 && (strcmp(reg_list[i]->feature->name, ""))) {
2266 /* We found a feature, check if the feature is already in the
2267 * table. If not, allocate a new entry for the table and
2268 * put the new feature in it.
2270 for (int j = 0; j < (tbl_sz + 1); j++) {
2271 if (!((*feature_list)[j])) {
2272 (*feature_list)[tbl_sz++] = reg_list[i]->feature->name;
2273 *feature_list = realloc(*feature_list, sizeof(char *) * (tbl_sz + 1));
2274 (*feature_list)[tbl_sz] = NULL;
2277 if (!strcmp((*feature_list)[j], reg_list[i]->feature->name))
2284 if (feature_list_size)
2285 *feature_list_size = tbl_sz;
2290 /* Create a register list that's the union of all the registers of the SMP
2291 * group this target is in. If the target is not part of an SMP group, this
2292 * returns the same as target_get_gdb_reg_list_noread().
2294 static int smp_reg_list_noread(struct target *target,
2295 struct reg **combined_list[], int *combined_list_size,
2296 enum target_register_class reg_class)
2299 return target_get_gdb_reg_list_noread(target, combined_list,
2300 combined_list_size, REG_CLASS_ALL);
2302 unsigned int combined_allocated = 256;
2303 struct reg **local_list = malloc(combined_allocated * sizeof(struct reg *));
2305 LOG_ERROR("malloc(%zu) failed", combined_allocated * sizeof(struct reg *));
2308 unsigned int local_list_size = 0;
2310 struct target_list *head;
2311 foreach_smp_target(head, target->smp_targets) {
2312 if (!target_was_examined(head->target))
2315 struct reg **reg_list = NULL;
2317 int result = target_get_gdb_reg_list_noread(head->target, ®_list,
2318 ®_list_size, reg_class);
2319 if (result != ERROR_OK) {
2323 for (int i = 0; i < reg_list_size; i++) {
2325 struct reg *a = reg_list[i];
2327 /* Nested loop makes this O(n^2), but this entire function with
2328 * 5 RISC-V targets takes just 2ms on my computer. Fast enough
2330 for (unsigned int j = 0; j < local_list_size; j++) {
2331 struct reg *b = local_list[j];
2332 if (!strcmp(a->name, b->name)) {
2334 if (a->size != b->size) {
2335 LOG_ERROR("SMP register %s is %d bits on one "
2336 "target, but %d bits on another target.",
2337 a->name, a->size, b->size);
2346 LOG_DEBUG("[%s] %s not found in combined list", target_name(target), a->name);
2347 if (local_list_size >= combined_allocated) {
2348 combined_allocated *= 2;
2349 local_list = realloc(local_list, combined_allocated * sizeof(struct reg *));
2351 LOG_ERROR("realloc(%zu) failed", combined_allocated * sizeof(struct reg *));
2355 local_list[local_list_size] = a;
2363 if (local_list_size == 0) {
2364 LOG_ERROR("Unable to get register list");
2369 /* Now warn the user about any registers that weren't found in every target. */
2370 foreach_smp_target(head, target->smp_targets) {
2371 if (!target_was_examined(head->target))
2374 struct reg **reg_list = NULL;
2376 int result = target_get_gdb_reg_list_noread(head->target, ®_list,
2377 ®_list_size, reg_class);
2378 if (result != ERROR_OK) {
2382 for (unsigned int i = 0; i < local_list_size; i++) {
2384 struct reg *a = local_list[i];
2385 for (int j = 0; j < reg_list_size; j++) {
2386 struct reg *b = reg_list[j];
2387 if (b->exist && !strcmp(a->name, b->name)) {
2393 LOG_WARNING("Register %s does not exist in %s, which is part of an SMP group where "
2394 "this register does exist.",
2395 a->name, target_name(head->target));
2401 *combined_list = local_list;
2402 *combined_list_size = local_list_size;
2406 static int gdb_generate_target_description(struct target *target, char **tdesc_out)
2408 int retval = ERROR_OK;
2409 struct reg **reg_list = NULL;
2411 char const *architecture;
2412 char const **features = NULL;
2413 int feature_list_size = 0;
2419 retval = smp_reg_list_noread(target, ®_list, ®_list_size,
2422 if (retval != ERROR_OK) {
2423 LOG_ERROR("get register list failed");
2424 retval = ERROR_FAIL;
2428 if (reg_list_size <= 0) {
2429 LOG_ERROR("get register list failed");
2430 retval = ERROR_FAIL;
2434 /* Get a list of available target registers features */
2435 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2436 if (retval != ERROR_OK) {
2437 LOG_ERROR("Can't get the registers feature list");
2438 retval = ERROR_FAIL;
2442 /* If we found some features associated with registers, create sections */
2443 int current_feature = 0;
2445 xml_printf(&retval, &tdesc, &pos, &size,
2446 "<?xml version=\"1.0\"?>\n"
2447 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2448 "<target version=\"1.0\">\n");
2450 /* generate architecture element if supported by target */
2451 architecture = target_get_gdb_arch(target);
2453 xml_printf(&retval, &tdesc, &pos, &size,
2454 "<architecture>%s</architecture>\n", architecture);
2456 /* generate target description according to register list */
2458 while (features[current_feature]) {
2459 char const **arch_defined_types = NULL;
2460 int num_arch_defined_types = 0;
2462 arch_defined_types = calloc(1, sizeof(char *));
2463 xml_printf(&retval, &tdesc, &pos, &size,
2464 "<feature name=\"%s\">\n",
2465 features[current_feature]);
2468 for (i = 0; i < reg_list_size; i++) {
2470 if (reg_list[i]->exist == false || reg_list[i]->hidden)
2473 if (strcmp(reg_list[i]->feature->name, features[current_feature]))
2476 const char *type_str;
2477 if (reg_list[i]->reg_data_type) {
2478 if (reg_list[i]->reg_data_type->type == REG_TYPE_ARCH_DEFINED) {
2479 /* generate <type... first, if there are architecture-defined types. */
2480 if (lookup_add_arch_defined_types(&arch_defined_types,
2481 reg_list[i]->reg_data_type->id,
2482 &num_arch_defined_types))
2483 gdb_generate_reg_type_description(target, &tdesc, &pos, &size,
2484 reg_list[i]->reg_data_type,
2485 &arch_defined_types,
2486 &num_arch_defined_types);
2488 type_str = reg_list[i]->reg_data_type->id;
2490 /* predefined type */
2491 type_str = gdb_get_reg_type_name(
2492 reg_list[i]->reg_data_type->type);
2495 /* Default type is "int" */
2499 xml_printf(&retval, &tdesc, &pos, &size,
2500 "<reg name=\"%s\"", reg_list[i]->name);
2501 xml_printf(&retval, &tdesc, &pos, &size,
2502 " bitsize=\"%" PRIu32 "\"", reg_list[i]->size);
2503 xml_printf(&retval, &tdesc, &pos, &size,
2504 " regnum=\"%" PRIu32 "\"", reg_list[i]->number);
2505 if (reg_list[i]->caller_save)
2506 xml_printf(&retval, &tdesc, &pos, &size,
2507 " save-restore=\"yes\"");
2509 xml_printf(&retval, &tdesc, &pos, &size,
2510 " save-restore=\"no\"");
2512 xml_printf(&retval, &tdesc, &pos, &size,
2513 " type=\"%s\"", type_str);
2515 if (reg_list[i]->group)
2516 xml_printf(&retval, &tdesc, &pos, &size,
2517 " group=\"%s\"", reg_list[i]->group);
2519 xml_printf(&retval, &tdesc, &pos, &size,
2523 xml_printf(&retval, &tdesc, &pos, &size,
2527 free(arch_defined_types);
2531 xml_printf(&retval, &tdesc, &pos, &size,
2538 if (retval == ERROR_OK)
2546 static int gdb_get_target_description_chunk(struct target *target, struct target_desc_format *target_desc,
2547 char **chunk, int32_t offset, uint32_t length)
2550 LOG_ERROR("Unable to Generate Target Description");
2554 char *tdesc = target_desc->tdesc;
2555 uint32_t tdesc_length = target_desc->tdesc_length;
2558 int retval = gdb_generate_target_description(target, &tdesc);
2559 if (retval != ERROR_OK) {
2560 LOG_ERROR("Unable to Generate Target Description");
2564 tdesc_length = strlen(tdesc);
2569 if (length < (tdesc_length - offset))
2570 transfer_type = 'm';
2572 transfer_type = 'l';
2574 *chunk = malloc(length + 2);
2576 LOG_ERROR("Unable to allocate memory");
2580 (*chunk)[0] = transfer_type;
2581 if (transfer_type == 'm') {
2582 strncpy((*chunk) + 1, tdesc + offset, length);
2583 (*chunk)[1 + length] = '\0';
2585 strncpy((*chunk) + 1, tdesc + offset, tdesc_length - offset);
2586 (*chunk)[1 + (tdesc_length - offset)] = '\0';
2588 /* After gdb-server sends out last chunk, invalidate tdesc. */
2594 target_desc->tdesc = tdesc;
2595 target_desc->tdesc_length = tdesc_length;
2600 static int gdb_target_description_supported(struct target *target, int *supported)
2602 int retval = ERROR_OK;
2603 struct reg **reg_list = NULL;
2604 int reg_list_size = 0;
2605 char const **features = NULL;
2606 int feature_list_size = 0;
2608 char const *architecture = target_get_gdb_arch(target);
2610 retval = target_get_gdb_reg_list_noread(target, ®_list,
2611 ®_list_size, REG_CLASS_ALL);
2612 if (retval != ERROR_OK) {
2613 LOG_ERROR("get register list failed");
2617 if (reg_list_size <= 0) {
2618 LOG_ERROR("get register list failed");
2619 retval = ERROR_FAIL;
2623 /* Get a list of available target registers features */
2624 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2625 if (retval != ERROR_OK) {
2626 LOG_ERROR("Can't get the registers feature list");
2631 if (architecture || feature_list_size)
2645 static int gdb_generate_thread_list(struct target *target, char **thread_list_out)
2647 struct rtos *rtos = target->rtos;
2648 int retval = ERROR_OK;
2649 char *thread_list = NULL;
2653 xml_printf(&retval, &thread_list, &pos, &size,
2654 "<?xml version=\"1.0\"?>\n"
2658 for (int i = 0; i < rtos->thread_count; i++) {
2659 struct thread_detail *thread_detail = &rtos->thread_details[i];
2661 if (!thread_detail->exists)
2664 if (thread_detail->thread_name_str)
2665 xml_printf(&retval, &thread_list, &pos, &size,
2666 "<thread id=\"%" PRIx64 "\" name=\"%s\">",
2667 thread_detail->threadid,
2668 thread_detail->thread_name_str);
2670 xml_printf(&retval, &thread_list, &pos, &size,
2671 "<thread id=\"%" PRIx64 "\">", thread_detail->threadid);
2673 if (thread_detail->thread_name_str)
2674 xml_printf(&retval, &thread_list, &pos, &size,
2675 "Name: %s", thread_detail->thread_name_str);
2677 if (thread_detail->extra_info_str) {
2678 if (thread_detail->thread_name_str)
2679 xml_printf(&retval, &thread_list, &pos, &size,
2681 xml_printf(&retval, &thread_list, &pos, &size,
2682 "%s", thread_detail->extra_info_str);
2685 xml_printf(&retval, &thread_list, &pos, &size,
2690 xml_printf(&retval, &thread_list, &pos, &size,
2693 if (retval == ERROR_OK)
2694 *thread_list_out = thread_list;
2701 static int gdb_get_thread_list_chunk(struct target *target, char **thread_list,
2702 char **chunk, int32_t offset, uint32_t length)
2704 if (!*thread_list) {
2705 int retval = gdb_generate_thread_list(target, thread_list);
2706 if (retval != ERROR_OK) {
2707 LOG_ERROR("Unable to Generate Thread List");
2712 size_t thread_list_length = strlen(*thread_list);
2715 length = MIN(length, thread_list_length - offset);
2716 if (length < (thread_list_length - offset))
2717 transfer_type = 'm';
2719 transfer_type = 'l';
2721 *chunk = malloc(length + 2 + 3);
2722 /* Allocating extra 3 bytes prevents false positive valgrind report
2723 * of strlen(chunk) word access:
2724 * Invalid read of size 4
2725 * Address 0x4479934 is 44 bytes inside a block of size 45 alloc'd */
2727 LOG_ERROR("Unable to allocate memory");
2731 (*chunk)[0] = transfer_type;
2732 strncpy((*chunk) + 1, (*thread_list) + offset, length);
2733 (*chunk)[1 + length] = '\0';
2735 /* After gdb-server sends out last chunk, invalidate thread list. */
2736 if (transfer_type == 'l') {
2738 *thread_list = NULL;
2744 static int gdb_query_packet(struct connection *connection,
2745 char const *packet, int packet_size)
2747 struct command_context *cmd_ctx = connection->cmd_ctx;
2748 struct gdb_connection *gdb_connection = connection->priv;
2749 struct target *target = get_target_from_connection(connection);
2751 if (strncmp(packet, "qRcmd,", 6) == 0) {
2752 if (packet_size > 6) {
2754 cmd = malloc((packet_size - 6) / 2 + 1);
2755 size_t len = unhexify((uint8_t *)cmd, packet + 6, (packet_size - 6) / 2);
2758 /* We want to print all debug output to GDB connection */
2759 gdb_connection->output_flag = GDB_OUTPUT_ALL;
2760 target_call_timer_callbacks_now();
2761 /* some commands need to know the GDB connection, make note of current
2762 * GDB connection. */
2763 current_gdb_connection = gdb_connection;
2764 struct target *saved_target_override = cmd_ctx->current_target_override;
2765 cmd_ctx->current_target_override = target;
2767 int retval = Jim_EvalObj(cmd_ctx->interp, Jim_NewStringObj(cmd_ctx->interp, cmd, -1));
2769 cmd_ctx->current_target_override = saved_target_override;
2770 current_gdb_connection = NULL;
2771 target_call_timer_callbacks_now();
2772 gdb_connection->output_flag = GDB_OUTPUT_NO;
2774 if (retval == JIM_RETURN)
2775 retval = cmd_ctx->interp->returnCode;
2777 const char *cretmsg = Jim_GetString(Jim_GetResult(cmd_ctx->interp), &lenmsg);
2779 if (lenmsg && cretmsg[lenmsg - 1] != '\n') {
2780 retmsg = alloc_printf("%s\n", cretmsg);
2783 retmsg = strdup(cretmsg);
2786 return ERROR_GDB_BUFFER_TOO_SMALL;
2788 if (retval == JIM_OK) {
2790 char *hex_buffer = malloc(lenmsg * 2 + 1);
2793 return ERROR_GDB_BUFFER_TOO_SMALL;
2796 size_t pkt_len = hexify(hex_buffer, (const uint8_t *)retmsg, lenmsg,
2798 gdb_put_packet(connection, hex_buffer, pkt_len);
2801 gdb_put_packet(connection, "OK", 2);
2805 gdb_output_con(connection, retmsg);
2806 gdb_send_error(connection, retval);
2811 gdb_put_packet(connection, "OK", 2);
2813 } else if (strncmp(packet, "qCRC:", 5) == 0) {
2814 if (packet_size > 5) {
2819 target_addr_t addr = 0;
2822 /* skip command character */
2825 addr = strtoull(packet, &separator, 16);
2827 if (*separator != ',') {
2828 LOG_ERROR("incomplete read memory packet received, dropping connection");
2829 return ERROR_SERVER_REMOTE_CLOSED;
2832 len = strtoul(separator + 1, NULL, 16);
2834 retval = target_checksum_memory(target, addr, len, &checksum);
2836 if (retval == ERROR_OK) {
2837 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
2838 gdb_put_packet(connection, gdb_reply, 9);
2840 retval = gdb_error(connection, retval);
2841 if (retval != ERROR_OK)
2847 } else if (strncmp(packet, "qSupported", 10) == 0) {
2848 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2849 * qXfer:features:read is supported for some targets */
2850 int retval = ERROR_OK;
2851 char *buffer = NULL;
2854 int gdb_target_desc_supported = 0;
2856 /* we need to test that the target supports target descriptions */
2857 retval = gdb_target_description_supported(target, &gdb_target_desc_supported);
2858 if (retval != ERROR_OK) {
2859 LOG_INFO("Failed detecting Target Description Support, disabling");
2860 gdb_target_desc_supported = 0;
2863 /* support may be disabled globally */
2864 if (gdb_use_target_description == 0) {
2865 if (gdb_target_desc_supported)
2866 LOG_WARNING("Target Descriptions Supported, but disabled");
2867 gdb_target_desc_supported = 0;
2874 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;qXfer:threads:read+;QStartNoAckMode+;vContSupported+",
2876 ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2877 (gdb_target_desc_supported == 1) ? '+' : '-');
2879 if (retval != ERROR_OK) {
2880 gdb_send_error(connection, 01);
2884 gdb_put_packet(connection, buffer, strlen(buffer));
2888 } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0)
2889 && (flash_get_bank_count() > 0))
2890 return gdb_memory_map(connection, packet, packet_size);
2891 else if (strncmp(packet, "qXfer:features:read:", 20) == 0) {
2893 int retval = ERROR_OK;
2896 unsigned int length;
2898 /* skip command character */
2901 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2902 gdb_send_error(connection, 01);
2906 /* Target should prepare correct target description for annex.
2907 * The first character of returned xml is 'm' or 'l'. 'm' for
2908 * there are *more* chunks to transfer. 'l' for it is the *last*
2909 * chunk of target description.
2911 retval = gdb_get_target_description_chunk(target, &gdb_connection->target_desc,
2912 &xml, offset, length);
2913 if (retval != ERROR_OK) {
2914 gdb_error(connection, retval);
2918 gdb_put_packet(connection, xml, strlen(xml));
2922 } else if (strncmp(packet, "qXfer:threads:read:", 19) == 0) {
2924 int retval = ERROR_OK;
2927 unsigned int length;
2929 /* skip command character */
2932 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2933 gdb_send_error(connection, 01);
2937 /* Target should prepare correct thread list for annex.
2938 * The first character of returned xml is 'm' or 'l'. 'm' for
2939 * there are *more* chunks to transfer. 'l' for it is the *last*
2940 * chunk of target description.
2942 retval = gdb_get_thread_list_chunk(target, &gdb_connection->thread_list,
2943 &xml, offset, length);
2944 if (retval != ERROR_OK) {
2945 gdb_error(connection, retval);
2949 gdb_put_packet(connection, xml, strlen(xml));
2953 } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) {
2954 gdb_connection->noack_mode = 1;
2955 gdb_put_packet(connection, "OK", 2);
2959 gdb_put_packet(connection, "", 0);
2963 static bool gdb_handle_vcont_packet(struct connection *connection, const char *packet, int packet_size)
2965 struct gdb_connection *gdb_connection = connection->priv;
2966 struct target *target = get_target_from_connection(connection);
2967 const char *parse = packet;
2970 /* query for vCont supported */
2971 if (parse[0] == '?') {
2972 if (target->type->step) {
2973 /* gdb doesn't accept c without C and s without S */
2974 gdb_put_packet(connection, "vCont;c;C;s;S", 13);
2980 if (parse[0] == ';') {
2985 /* simple case, a continue packet */
2986 if (parse[0] == 'c') {
2987 gdb_running_type = 'c';
2988 LOG_DEBUG("target %s continue", target_name(target));
2989 gdb_connection->output_flag = GDB_OUTPUT_ALL;
2990 retval = target_resume(target, 1, 0, 0, 0);
2991 if (retval == ERROR_TARGET_NOT_HALTED)
2992 LOG_INFO("target %s was not halted when resume was requested", target_name(target));
2994 /* poll target in an attempt to make its internal state consistent */
2995 if (retval != ERROR_OK) {
2996 retval = target_poll(target);
2997 if (retval != ERROR_OK)
2998 LOG_DEBUG("error polling target %s after failed resume", target_name(target));
3002 * We don't report errors to gdb here, move frontend_state to
3003 * TARGET_RUNNING to stay in sync with gdb's expectation of the
3006 gdb_connection->frontend_state = TARGET_RUNNING;
3007 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
3012 /* single-step or step-over-breakpoint */
3013 if (parse[0] == 's') {
3014 gdb_running_type = 's';
3015 bool fake_step = false;
3017 if (strncmp(parse, "s:", 2) == 0) {
3018 struct target *ct = target;
3026 thread_id = strtoll(parse, &endp, 16);
3028 packet_size -= endp - parse;
3033 /* FIXME: why is this necessary? rtos state should be up-to-date here already! */
3034 rtos_update_threads(target);
3036 target->rtos->gdb_target_for_threadid(connection, thread_id, &ct);
3039 * check if the thread to be stepped is the current rtos thread
3040 * if not, we must fake the step
3042 if (target->rtos->current_thread != thread_id)
3046 if (parse[0] == ';') {
3050 if (parse[0] == 'c') {
3053 /* check if thread-id follows */
3054 if (parse[0] == ':') {
3058 tid = strtoll(parse, &endp, 16);
3059 if (tid == thread_id) {
3061 * Special case: only step a single thread (core),
3062 * keep the other threads halted. Currently, only
3063 * aarch64 target understands it. Other target types don't
3064 * care (nobody checks the actual value of 'current')
3065 * and it doesn't really matter. This deserves
3066 * a symbolic constant and a formal interface documentation
3069 LOG_DEBUG("request to step current core only");
3070 /* uncomment after checking that indeed other targets are safe */
3077 LOG_DEBUG("target %s single-step thread %"PRIx64, target_name(ct), thread_id);
3078 gdb_connection->output_flag = GDB_OUTPUT_ALL;
3079 target_call_event_callbacks(ct, TARGET_EVENT_GDB_START);
3082 * work around an annoying gdb behaviour: when the current thread
3083 * is changed in gdb, it assumes that the target can follow and also
3084 * make the thread current. This is an assumption that cannot hold
3085 * for a real target running a multi-threading OS. We just fake
3086 * the step to not trigger an internal error in gdb. See
3087 * https://sourceware.org/bugzilla/show_bug.cgi?id=22925 for details
3091 char sig_reply[128];
3093 LOG_DEBUG("fake step thread %"PRIx64, thread_id);
3095 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply),
3096 "T05thread:%016"PRIx64";", thread_id);
3098 gdb_put_packet(connection, sig_reply, sig_reply_len);
3099 gdb_connection->output_flag = GDB_OUTPUT_NO;
3104 /* support for gdb_sync command */
3105 if (gdb_connection->sync) {
3106 gdb_connection->sync = false;
3107 if (ct->state == TARGET_HALTED) {
3108 LOG_DEBUG("stepi ignored. GDB will now fetch the register state "
3109 "from the target.");
3110 gdb_sig_halted(connection);
3111 gdb_connection->output_flag = GDB_OUTPUT_NO;
3113 gdb_connection->frontend_state = TARGET_RUNNING;
3117 retval = target_step(ct, current_pc, 0, 0);
3118 if (retval == ERROR_TARGET_NOT_HALTED)
3119 LOG_INFO("target %s was not halted when step was requested", target_name(ct));
3121 /* if step was successful send a reply back to gdb */
3122 if (retval == ERROR_OK) {
3123 retval = target_poll(ct);
3124 if (retval != ERROR_OK)
3125 LOG_DEBUG("error polling target %s after successful step", target_name(ct));
3126 /* send back signal information */
3127 gdb_signal_reply(ct, connection);
3128 /* stop forwarding log packets! */
3129 gdb_connection->output_flag = GDB_OUTPUT_NO;
3131 gdb_connection->frontend_state = TARGET_RUNNING;
3133 LOG_ERROR("Unknown vCont packet");
3142 static char *next_hex_encoded_field(const char **str, char sep)
3145 const char *hex = *str;
3149 const char *end = strchr(hex, sep);
3151 hexlen = strlen(hex);
3154 *str = hex + hexlen + 1;
3156 if (hexlen % 2 != 0) {
3157 /* Malformed hex data */
3161 size_t count = hexlen / 2;
3162 char *decoded = malloc(count + 1);
3166 size_t converted = unhexify((void *)decoded, hex, count);
3167 if (converted != count) {
3172 decoded[count] = '\0';
3176 /* handle extended restart packet */
3177 static void gdb_restart_inferior(struct connection *connection, const char *packet, int packet_size)
3179 struct gdb_connection *gdb_con = connection->priv;
3180 struct target *target = get_target_from_connection(connection);
3182 breakpoint_clear_target(target);
3183 watchpoint_clear_target(target);
3184 command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s",
3185 target_name(target));
3186 /* set connection as attached after reset */
3187 gdb_con->attached = true;
3188 /* info rtos parts */
3189 gdb_thread_packet(connection, packet, packet_size);
3192 static bool gdb_handle_vrun_packet(struct connection *connection, const char *packet, int packet_size)
3194 struct target *target = get_target_from_connection(connection);
3195 const char *parse = packet;
3200 if (parse[0] != ';')
3204 /* Skip first field "filename"; don't know what to do with it. */
3205 free(next_hex_encoded_field(&parse, ';'));
3207 char *cmdline = next_hex_encoded_field(&parse, ';');
3209 char *arg = next_hex_encoded_field(&parse, ';');
3212 char *new_cmdline = alloc_printf("%s %s", cmdline, arg);
3215 cmdline = new_cmdline;
3219 if (target->semihosting) {
3220 LOG_INFO("GDB set inferior command line to '%s'", cmdline);
3221 free(target->semihosting->cmdline);
3222 target->semihosting->cmdline = cmdline;
3224 LOG_INFO("GDB set inferior command line to '%s' but semihosting is unavailable", cmdline);
3229 gdb_restart_inferior(connection, packet, packet_size);
3230 gdb_put_packet(connection, "S00", 3);
3234 static int gdb_v_packet(struct connection *connection,
3235 char const *packet, int packet_size)
3237 struct gdb_connection *gdb_connection = connection->priv;
3240 struct target *target = get_target_from_connection(connection);
3242 if (strncmp(packet, "vCont", 5) == 0) {
3248 handled = gdb_handle_vcont_packet(connection, packet, packet_size);
3250 gdb_put_packet(connection, "", 0);
3255 if (strncmp(packet, "vRun", 4) == 0) {
3258 handled = gdb_handle_vrun_packet(connection, packet, packet_size);
3260 gdb_put_packet(connection, "", 0);
3265 /* if flash programming disabled - send a empty reply */
3267 if (gdb_flash_program == 0) {
3268 gdb_put_packet(connection, "", 0);
3272 if (strncmp(packet, "vFlashErase:", 12) == 0) {
3274 unsigned long length;
3276 char const *parse = packet + 12;
3277 if (*parse == '\0') {
3278 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3279 return ERROR_SERVER_REMOTE_CLOSED;
3282 addr = strtoul(parse, (char **)&parse, 16);
3284 if (*(parse++) != ',' || *parse == '\0') {
3285 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3286 return ERROR_SERVER_REMOTE_CLOSED;
3289 length = strtoul(parse, (char **)&parse, 16);
3291 if (*parse != '\0') {
3292 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3293 return ERROR_SERVER_REMOTE_CLOSED;
3296 /* assume all sectors need erasing - stops any problems
3297 * when flash_write is called multiple times */
3300 /* perform any target specific operations before the erase */
3301 target_call_event_callbacks(target,
3302 TARGET_EVENT_GDB_FLASH_ERASE_START);
3304 /* vFlashErase:addr,length messages require region start and
3305 * end to be "block" aligned ... if padding is ever needed,
3306 * GDB will have become dangerously confused.
3308 result = flash_erase_address_range(target, false, addr,
3311 /* perform any target specific operations after the erase */
3312 target_call_event_callbacks(target,
3313 TARGET_EVENT_GDB_FLASH_ERASE_END);
3316 if (result != ERROR_OK) {
3317 /* GDB doesn't evaluate the actual error number returned,
3318 * treat a failed erase as an I/O error
3320 gdb_send_error(connection, EIO);
3321 LOG_ERROR("flash_erase returned %i", result);
3323 gdb_put_packet(connection, "OK", 2);
3328 if (strncmp(packet, "vFlashWrite:", 12) == 0) {
3331 unsigned long length;
3332 char const *parse = packet + 12;
3334 if (*parse == '\0') {
3335 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3336 return ERROR_SERVER_REMOTE_CLOSED;
3338 addr = strtoul(parse, (char **)&parse, 16);
3339 if (*(parse++) != ':') {
3340 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3341 return ERROR_SERVER_REMOTE_CLOSED;
3343 length = packet_size - (parse - packet);
3345 /* create a new image if there isn't already one */
3346 if (!gdb_connection->vflash_image) {
3347 gdb_connection->vflash_image = malloc(sizeof(struct image));
3348 image_open(gdb_connection->vflash_image, "", "build");
3351 /* create new section with content from packet buffer */
3352 retval = image_add_section(gdb_connection->vflash_image,
3353 addr, length, 0x0, (uint8_t const *)parse);
3354 if (retval != ERROR_OK)
3357 gdb_put_packet(connection, "OK", 2);
3362 if (strncmp(packet, "vFlashDone", 10) == 0) {
3365 /* process the flashing buffer. No need to erase as GDB
3366 * always issues a vFlashErase first. */
3367 target_call_event_callbacks(target,
3368 TARGET_EVENT_GDB_FLASH_WRITE_START);
3369 result = flash_write(target, gdb_connection->vflash_image,
3371 target_call_event_callbacks(target,
3372 TARGET_EVENT_GDB_FLASH_WRITE_END);
3373 if (result != ERROR_OK) {
3374 if (result == ERROR_FLASH_DST_OUT_OF_BANK)
3375 gdb_put_packet(connection, "E.memtype", 9);
3377 gdb_send_error(connection, EIO);
3379 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
3380 gdb_put_packet(connection, "OK", 2);
3383 image_close(gdb_connection->vflash_image);
3384 free(gdb_connection->vflash_image);
3385 gdb_connection->vflash_image = NULL;
3390 gdb_put_packet(connection, "", 0);
3394 static int gdb_detach(struct connection *connection)
3397 * Only reply "OK" to GDB
3398 * it will close the connection and this will trigger a call to
3399 * gdb_connection_closed() that will in turn trigger the event
3400 * TARGET_EVENT_GDB_DETACH
3402 return gdb_put_packet(connection, "OK", 2);
3405 /* The format of 'F' response packet is
3406 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3408 static int gdb_fileio_response_packet(struct connection *connection,
3409 char const *packet, int packet_size)
3411 struct target *target = get_target_from_connection(connection);
3413 char *parsing_point;
3414 int fileio_retcode = strtoul(packet + 1, &separator, 16);
3415 int fileio_errno = 0;
3416 bool fileio_ctrl_c = false;
3421 if (*separator == ',') {
3422 parsing_point = separator + 1;
3423 fileio_errno = strtoul(parsing_point, &separator, 16);
3424 if (*separator == ',') {
3425 if (*(separator + 1) == 'C') {
3426 /* TODO: process ctrl-c */
3427 fileio_ctrl_c = true;
3432 LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
3433 fileio_retcode, fileio_errno, fileio_ctrl_c ? "true" : "false");
3435 retval = target_gdb_fileio_end(target, fileio_retcode, fileio_errno, fileio_ctrl_c);
3436 if (retval != ERROR_OK)
3439 /* After File-I/O ends, keep continue or step */
3440 if (gdb_running_type == 'c')
3441 retval = target_resume(target, 1, 0x0, 0, 0);
3442 else if (gdb_running_type == 's')
3443 retval = target_step(target, 1, 0x0, 0);
3445 retval = ERROR_FAIL;
3447 if (retval != ERROR_OK)
3453 static void gdb_log_callback(void *priv, const char *file, unsigned line,
3454 const char *function, const char *string)
3456 struct connection *connection = priv;
3457 struct gdb_connection *gdb_con = connection->priv;
3459 if (gdb_con->output_flag == GDB_OUTPUT_NO)
3460 /* No out allowed */
3463 if (gdb_con->busy) {
3464 /* do not reply this using the O packet */
3468 gdb_output_con(connection, string);
3471 static void gdb_sig_halted(struct connection *connection)
3474 snprintf(sig_reply, 4, "T%2.2x", 2);
3475 gdb_put_packet(connection, sig_reply, 3);
3478 static int gdb_input_inner(struct connection *connection)
3480 /* Do not allocate this on the stack */
3481 static char gdb_packet_buffer[GDB_BUFFER_SIZE + 1]; /* Extra byte for null-termination */
3483 struct target *target;
3484 char const *packet = gdb_packet_buffer;
3487 struct gdb_connection *gdb_con = connection->priv;
3488 static bool warn_use_ext;
3490 target = get_target_from_connection(connection);
3492 /* drain input buffer. If one of the packets fail, then an error
3493 * packet is replied, if applicable.
3495 * This loop will terminate and the error code is returned.
3497 * The calling fn will check if this error is something that
3498 * can be recovered from, or if the connection must be closed.
3500 * If the error is recoverable, this fn is called again to
3501 * drain the rest of the buffer.
3504 packet_size = GDB_BUFFER_SIZE;
3505 retval = gdb_get_packet(connection, gdb_packet_buffer, &packet_size);
3506 if (retval != ERROR_OK)
3509 /* terminate with zero */
3510 gdb_packet_buffer[packet_size] = '\0';
3512 if (packet_size > 0) {
3514 gdb_log_incoming_packet(connection, gdb_packet_buffer);
3517 switch (packet[0]) {
3518 case 'T': /* Is thread alive? */
3519 gdb_thread_packet(connection, packet, packet_size);
3521 case 'H': /* Set current thread ( 'c' for step and continue,
3522 * 'g' for all other operations ) */
3523 gdb_thread_packet(connection, packet, packet_size);
3527 retval = gdb_thread_packet(connection, packet, packet_size);
3528 if (retval == GDB_THREAD_PACKET_NOT_CONSUMED)
3529 retval = gdb_query_packet(connection, packet, packet_size);
3532 retval = gdb_get_registers_packet(connection, packet, packet_size);
3535 retval = gdb_set_registers_packet(connection, packet, packet_size);
3538 retval = gdb_get_register_packet(connection, packet, packet_size);
3541 retval = gdb_set_register_packet(connection, packet, packet_size);
3544 retval = gdb_read_memory_packet(connection, packet, packet_size);
3547 retval = gdb_write_memory_packet(connection, packet, packet_size);
3551 retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size);
3554 gdb_last_signal_packet(connection, packet, packet_size);
3555 /* '?' is sent after the eventual '!' */
3556 if (!warn_use_ext && !gdb_con->extended_protocol) {
3557 warn_use_ext = true;
3558 LOG_WARNING("Prefer GDB command \"target extended-remote :%s\" instead of \"target remote :%s\"",
3559 connection->service->port, connection->service->port);
3565 gdb_thread_packet(connection, packet, packet_size);
3566 gdb_con->output_flag = GDB_OUTPUT_ALL;
3568 if (gdb_con->mem_write_error) {
3569 LOG_ERROR("Memory write failure!");
3571 /* now that we have reported the memory write error,
3572 * we can clear the condition */
3573 gdb_con->mem_write_error = false;
3576 bool nostep = false;
3577 bool already_running = false;
3578 if (target->state == TARGET_RUNNING) {
3579 LOG_WARNING("WARNING! The target is already running. "
3580 "All changes GDB did to registers will be discarded! "
3581 "Waiting for target to halt.");
3582 already_running = true;
3583 } else if (target->state != TARGET_HALTED) {
3584 LOG_WARNING("The target is not in the halted nor running stated, "
3585 "stepi/continue ignored.");
3587 } else if ((packet[0] == 's') && gdb_con->sync) {
3588 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
3589 * sent by GDB first to OpenOCD, thus defeating the check to
3590 * make only the single stepping have the sync feature...
3593 LOG_DEBUG("stepi ignored. GDB will now fetch the register state "
3594 "from the target.");
3596 gdb_con->sync = false;
3598 if (!already_running && nostep) {
3599 /* Either the target isn't in the halted state, then we can't
3600 * step/continue. This might be early setup, etc.
3602 * Or we want to allow GDB to pick up a fresh set of
3603 * register values without modifying the target state.
3606 gdb_sig_halted(connection);
3608 /* stop forwarding log packets! */
3609 gdb_con->output_flag = GDB_OUTPUT_NO;
3611 /* We're running/stepping, in which case we can
3612 * forward log output until the target is halted
3614 gdb_con->frontend_state = TARGET_RUNNING;
3615 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
3617 if (!already_running) {
3618 /* Here we don't want packet processing to stop even if this fails,
3619 * so we use a local variable instead of retval. */
3620 retval = gdb_step_continue_packet(connection, packet, packet_size);
3621 if (retval != ERROR_OK) {
3622 /* we'll never receive a halted
3623 * condition... issue a false one..
3625 gdb_frontend_halted(target, connection);
3632 retval = gdb_v_packet(connection, packet, packet_size);
3635 retval = gdb_detach(connection);
3638 retval = gdb_write_memory_binary_packet(connection, packet, packet_size);
3639 if (retval != ERROR_OK)
3643 if (gdb_con->extended_protocol) {
3644 gdb_con->attached = false;
3647 gdb_put_packet(connection, "OK", 2);
3648 return ERROR_SERVER_REMOTE_CLOSED;
3650 /* handle extended remote protocol */
3651 gdb_con->extended_protocol = true;
3652 gdb_put_packet(connection, "OK", 2);
3655 /* handle extended restart packet */
3656 gdb_restart_inferior(connection, packet, packet_size);
3660 /* packet supported only by smp target i.e cortex_a.c*/
3661 /* handle smp packet replying coreid played to gbd */
3662 gdb_read_smp_packet(connection, packet, packet_size);
3666 /* packet supported only by smp target i.e cortex_a.c */
3667 /* handle smp packet setting coreid to be played at next
3669 gdb_write_smp_packet(connection, packet, packet_size);
3673 /* File-I/O extension */
3674 /* After gdb uses host-side syscall to complete target file
3675 * I/O, gdb sends host-side syscall return value to target
3677 * The format of 'F' response packet is
3678 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3680 gdb_con->frontend_state = TARGET_RUNNING;
3681 gdb_con->output_flag = GDB_OUTPUT_ALL;
3682 gdb_fileio_response_packet(connection, packet, packet_size);
3686 /* ignore unknown packets */
3687 LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
3688 gdb_put_packet(connection, "", 0);
3692 /* if a packet handler returned an error, exit input loop */
3693 if (retval != ERROR_OK)
3697 if (gdb_con->ctrl_c) {
3698 if (target->state == TARGET_RUNNING) {
3699 struct target *t = target;
3701 target->rtos->gdb_target_for_threadid(connection, target->rtos->current_threadid, &t);
3702 retval = target_halt(t);
3703 if (retval == ERROR_OK)
3704 retval = target_poll(t);
3705 if (retval != ERROR_OK)
3706 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3707 gdb_con->ctrl_c = false;
3709 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
3710 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3714 } while (gdb_con->buf_cnt > 0);
3719 static int gdb_input(struct connection *connection)
3721 int retval = gdb_input_inner(connection);
3722 struct gdb_connection *gdb_con = connection->priv;
3723 if (retval == ERROR_SERVER_REMOTE_CLOSED)
3726 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
3727 if (gdb_con->closed)
3728 return ERROR_SERVER_REMOTE_CLOSED;
3730 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
3734 static void gdb_keep_client_alive(struct connection *connection)
3736 struct gdb_connection *gdb_con = connection->priv;
3738 if (gdb_con->busy) {
3739 /* do not send packets, retry asap */
3743 switch (gdb_con->output_flag) {
3745 /* no need for keep-alive */
3747 case GDB_OUTPUT_ALL:
3748 /* send an empty O packet */
3749 gdb_output_con(connection, "");
3756 static const struct service_driver gdb_service_driver = {
3758 .new_connection_during_keep_alive_handler = NULL,
3759 .new_connection_handler = gdb_new_connection,
3760 .input_handler = gdb_input,
3761 .connection_closed_handler = gdb_connection_closed,
3762 .keep_client_alive_handler = gdb_keep_client_alive,
3765 static int gdb_target_start(struct target *target, const char *port)
3767 struct gdb_service *gdb_service;
3769 gdb_service = malloc(sizeof(struct gdb_service));
3774 LOG_INFO("starting gdb server for %s on %s", target_name(target), port);
3776 gdb_service->target = target;
3777 gdb_service->core[0] = -1;
3778 gdb_service->core[1] = -1;
3779 target->gdb_service = gdb_service;
3781 ret = add_service(&gdb_service_driver, port, target->gdb_max_connections, gdb_service);
3782 /* initialize all targets gdb service with the same pointer */
3784 struct target_list *head;
3785 foreach_smp_target(head, target->smp_targets) {
3786 struct target *curr = head->target;
3788 curr->gdb_service = gdb_service;
3794 static int gdb_target_add_one(struct target *target)
3796 /* one gdb instance per smp list */
3797 if ((target->smp) && (target->gdb_service))
3800 /* skip targets that cannot handle a gdb connections (e.g. mem_ap) */
3801 if (!target_supports_gdb_connection(target)) {
3802 LOG_DEBUG("skip gdb server for target %s", target_name(target));
3806 if (target->gdb_port_override) {
3807 if (strcmp(target->gdb_port_override, "disabled") == 0) {
3808 LOG_INFO("gdb port disabled");
3811 return gdb_target_start(target, target->gdb_port_override);
3814 if (strcmp(gdb_port, "disabled") == 0) {
3815 LOG_INFO("gdb port disabled");
3819 int retval = gdb_target_start(target, gdb_port_next);
3820 if (retval == ERROR_OK) {
3821 /* save the port number so can be queried with
3822 * $target_name cget -gdb-port
3824 target->gdb_port_override = strdup(gdb_port_next);
3827 /* If we can parse the port number
3828 * then we increment the port number for the next target.
3831 portnumber = strtol(gdb_port_next, &end, 0);
3833 if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) {
3834 free(gdb_port_next);
3836 gdb_port_next = alloc_printf("%ld", portnumber+1);
3838 /* Don't increment if gdb_port is 0, since we're just
3839 * trying to allocate an unused port. */
3840 gdb_port_next = strdup("0");
3848 int gdb_target_add_all(struct target *target)
3851 LOG_WARNING("gdb services need one or more targets defined");
3856 int retval = gdb_target_add_one(target);
3857 if (retval != ERROR_OK)
3860 target = target->next;
3866 COMMAND_HANDLER(handle_gdb_sync_command)
3869 return ERROR_COMMAND_SYNTAX_ERROR;
3871 if (!current_gdb_connection) {
3873 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
3877 current_gdb_connection->sync = true;
3882 /* daemon configuration command gdb_port */
3883 COMMAND_HANDLER(handle_gdb_port_command)
3885 int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
3886 if (retval == ERROR_OK) {
3887 free(gdb_port_next);
3888 gdb_port_next = strdup(gdb_port);
3893 COMMAND_HANDLER(handle_gdb_memory_map_command)
3896 return ERROR_COMMAND_SYNTAX_ERROR;
3898 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
3902 COMMAND_HANDLER(handle_gdb_flash_program_command)
3905 return ERROR_COMMAND_SYNTAX_ERROR;
3907 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
3911 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
3914 return ERROR_COMMAND_SYNTAX_ERROR;
3916 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
3920 COMMAND_HANDLER(handle_gdb_report_register_access_error)
3923 return ERROR_COMMAND_SYNTAX_ERROR;
3925 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_register_access_error);
3929 /* gdb_breakpoint_override */
3930 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
3932 if (CMD_ARGC == 0) {
3934 } else if (CMD_ARGC == 1) {
3935 gdb_breakpoint_override = 1;
3936 if (strcmp(CMD_ARGV[0], "hard") == 0)
3937 gdb_breakpoint_override_type = BKPT_HARD;
3938 else if (strcmp(CMD_ARGV[0], "soft") == 0)
3939 gdb_breakpoint_override_type = BKPT_SOFT;
3940 else if (strcmp(CMD_ARGV[0], "disable") == 0)
3941 gdb_breakpoint_override = 0;
3943 return ERROR_COMMAND_SYNTAX_ERROR;
3944 if (gdb_breakpoint_override)
3945 LOG_USER("force %s breakpoints",
3946 (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft");
3948 LOG_USER("breakpoint type is not overridden");
3953 COMMAND_HANDLER(handle_gdb_target_description_command)
3956 return ERROR_COMMAND_SYNTAX_ERROR;
3958 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_target_description);
3962 COMMAND_HANDLER(handle_gdb_save_tdesc_command)
3965 uint32_t tdesc_length;
3966 struct target *target = get_current_target(CMD_CTX);
3968 int retval = gdb_generate_target_description(target, &tdesc);
3969 if (retval != ERROR_OK) {
3970 LOG_ERROR("Unable to Generate Target Description");
3974 tdesc_length = strlen(tdesc);
3976 struct fileio *fileio;
3977 size_t size_written;
3979 char *tdesc_filename = alloc_printf("%s.xml", target_type_name(target));
3980 if (!tdesc_filename) {
3981 retval = ERROR_FAIL;
3985 retval = fileio_open(&fileio, tdesc_filename, FILEIO_WRITE, FILEIO_TEXT);
3987 if (retval != ERROR_OK) {
3988 LOG_ERROR("Can't open %s for writing", tdesc_filename);
3992 retval = fileio_write(fileio, tdesc_length, tdesc, &size_written);
3994 fileio_close(fileio);
3996 if (retval != ERROR_OK)
3997 LOG_ERROR("Error while writing the tdesc file");
4000 free(tdesc_filename);
4006 static const struct command_registration gdb_command_handlers[] = {
4009 .handler = handle_gdb_sync_command,
4010 .mode = COMMAND_ANY,
4011 .help = "next stepi will return immediately allowing "
4012 "GDB to fetch register state without affecting "
4018 .handler = handle_gdb_port_command,
4019 .mode = COMMAND_CONFIG,
4020 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
4021 "server listens for the next port number after the "
4022 "base port number specified. "
4023 "No arguments reports GDB port. \"pipe\" means listen to stdin "
4024 "output to stdout, an integer is base port number, \"disabled\" disables "
4025 "port. Any other string is are interpreted as named pipe to listen to. "
4026 "Output pipe is the same name as input pipe, but with 'o' appended.",
4027 .usage = "[port_num]",
4030 .name = "gdb_memory_map",
4031 .handler = handle_gdb_memory_map_command,
4032 .mode = COMMAND_CONFIG,
4033 .help = "enable or disable memory map",
4034 .usage = "('enable'|'disable')"
4037 .name = "gdb_flash_program",
4038 .handler = handle_gdb_flash_program_command,
4039 .mode = COMMAND_CONFIG,
4040 .help = "enable or disable flash program",
4041 .usage = "('enable'|'disable')"
4044 .name = "gdb_report_data_abort",
4045 .handler = handle_gdb_report_data_abort_command,
4046 .mode = COMMAND_CONFIG,
4047 .help = "enable or disable reporting data aborts",
4048 .usage = "('enable'|'disable')"
4051 .name = "gdb_report_register_access_error",
4052 .handler = handle_gdb_report_register_access_error,
4053 .mode = COMMAND_CONFIG,
4054 .help = "enable or disable reporting register access errors",
4055 .usage = "('enable'|'disable')"
4058 .name = "gdb_breakpoint_override",
4059 .handler = handle_gdb_breakpoint_override_command,
4060 .mode = COMMAND_ANY,
4061 .help = "Display or specify type of breakpoint "
4062 "to be used by gdb 'break' commands.",
4063 .usage = "('hard'|'soft'|'disable')"
4066 .name = "gdb_target_description",
4067 .handler = handle_gdb_target_description_command,
4068 .mode = COMMAND_CONFIG,
4069 .help = "enable or disable target description",
4070 .usage = "('enable'|'disable')"
4073 .name = "gdb_save_tdesc",
4074 .handler = handle_gdb_save_tdesc_command,
4075 .mode = COMMAND_EXEC,
4076 .help = "Save the target description file",
4079 COMMAND_REGISTRATION_DONE
4082 int gdb_register_commands(struct command_context *cmd_ctx)
4084 gdb_port = strdup("3333");
4085 gdb_port_next = strdup("3333");
4086 return register_commands(cmd_ctx, NULL, gdb_command_handlers);
4089 void gdb_service_free(void)
4092 free(gdb_port_next);