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 struct target_desc_format {
66 uint32_t tdesc_length;
69 /* private connection data for GDB */
70 struct gdb_connection {
71 char buffer[GDB_BUFFER_SIZE + 1]; /* Extra byte for null-termination */
75 enum target_state frontend_state;
76 struct image *vflash_image;
80 /* set flag to true if you want the next stepi to return immediately.
81 * allowing GDB to pick up a fresh set of register values from the target
82 * without modifying the target state. */
84 /* We delay reporting memory write errors until next step/continue or memory
85 * write. This improves performance of gdb load significantly as the GDB packet
86 * can be replied immediately and a new GDB packet will be ready without delay
87 * (ca. 10% or so...). */
89 /* with extended-remote it seems we need to better emulate attach/detach.
90 * what this means is we reply with a W stop reply after a kill packet,
91 * normally we reply with a S reply via gdb_last_signal_packet.
92 * as a side note this behaviour only effects gdb > 6.8 */
94 /* set when extended protocol is used */
95 bool extended_protocol;
96 /* temporarily used for target description support */
97 struct target_desc_format target_desc;
98 /* temporarily used for thread list support */
103 #define _DEBUG_GDB_IO_
106 static struct gdb_connection *current_gdb_connection;
108 static int gdb_breakpoint_override;
109 static enum breakpoint_type gdb_breakpoint_override_type;
111 static int gdb_error(struct connection *connection, int retval);
112 static char *gdb_port;
113 static char *gdb_port_next;
115 static void gdb_log_callback(void *priv, const char *file, unsigned line,
116 const char *function, const char *string);
118 static void gdb_sig_halted(struct connection *connection);
120 /* number of gdb connections, mainly to suppress gdb related debugging spam
121 * in helper/log.c when no gdb connections are actually active */
122 int gdb_actual_connections;
124 /* set if we are sending a memory map to gdb
125 * via qXfer:memory-map:read packet */
126 /* enabled by default*/
127 static int gdb_use_memory_map = 1;
128 /* enabled by default*/
129 static int gdb_flash_program = 1;
131 /* if set, data aborts cause an error to be reported in memory read packets
132 * see the code in gdb_read_memory_packet() for further explanations.
133 * Disabled by default.
135 static int gdb_report_data_abort;
136 /* If set, errors when accessing registers are reported to gdb. Disabled by
138 static int gdb_report_register_access_error;
140 /* set if we are sending target descriptions to gdb
141 * via qXfer:features:read packet */
142 /* enabled by default */
143 static int gdb_use_target_description = 1;
145 /* current processing free-run type, used by file-I/O */
146 static char gdb_running_type;
148 static int gdb_last_signal(struct target *target)
150 switch (target->debug_reason) {
151 case DBG_REASON_DBGRQ:
152 return 0x2; /* SIGINT */
153 case DBG_REASON_BREAKPOINT:
154 case DBG_REASON_WATCHPOINT:
155 case DBG_REASON_WPTANDBKPT:
156 return 0x05; /* SIGTRAP */
157 case DBG_REASON_SINGLESTEP:
158 return 0x05; /* SIGTRAP */
159 case DBG_REASON_EXC_CATCH:
161 case DBG_REASON_NOTHALTED:
162 return 0x0; /* no signal... shouldn't happen */
164 LOG_USER("undefined debug reason %d - target needs reset",
165 target->debug_reason);
170 static int check_pending(struct connection *connection,
171 int timeout_s, int *got_data)
173 /* a non-blocking socket will block if there is 0 bytes available on the socket,
174 * but return with as many bytes as are available immediately
178 struct gdb_connection *gdb_con = connection->priv;
180 if (got_data == NULL)
184 if (gdb_con->buf_cnt > 0) {
190 FD_SET(connection->fd, &read_fds);
192 tv.tv_sec = timeout_s;
194 if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) {
195 /* This can typically be because a "monitor" command took too long
196 * before printing any progress messages
199 return ERROR_GDB_TIMEOUT;
203 *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
207 static int gdb_get_char_inner(struct connection *connection, int *next_char)
209 struct gdb_connection *gdb_con = connection->priv;
210 int retval = ERROR_OK;
212 #ifdef _DEBUG_GDB_IO_
216 if (connection->service->type != CONNECTION_TCP)
217 gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
219 retval = check_pending(connection, 1, NULL);
220 if (retval != ERROR_OK)
222 gdb_con->buf_cnt = read_socket(connection->fd,
227 if (gdb_con->buf_cnt > 0)
229 if (gdb_con->buf_cnt == 0) {
230 gdb_con->closed = true;
231 return ERROR_SERVER_REMOTE_CLOSED;
235 errno = WSAGetLastError();
241 case WSAECONNABORTED:
242 gdb_con->closed = true;
243 return ERROR_SERVER_REMOTE_CLOSED;
245 gdb_con->closed = true;
246 return ERROR_SERVER_REMOTE_CLOSED;
248 LOG_ERROR("read: %d", errno);
257 gdb_con->closed = true;
258 return ERROR_SERVER_REMOTE_CLOSED;
260 gdb_con->closed = true;
261 return ERROR_SERVER_REMOTE_CLOSED;
263 LOG_ERROR("read: %s", strerror(errno));
264 gdb_con->closed = true;
265 return ERROR_SERVER_REMOTE_CLOSED;
270 #ifdef _DEBUG_GDB_IO_
271 debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt);
272 LOG_DEBUG("received '%s'", debug_buffer);
276 gdb_con->buf_p = gdb_con->buffer;
278 *next_char = *(gdb_con->buf_p++);
279 if (gdb_con->buf_cnt > 0)
280 connection->input_pending = true;
282 connection->input_pending = false;
283 #ifdef _DEBUG_GDB_IO_
284 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
291 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
292 * held in registers in the inner loop.
294 * For small caches and embedded systems this is important!
296 static inline int gdb_get_char_fast(struct connection *connection,
297 int *next_char, char **buf_p, int *buf_cnt)
299 int retval = ERROR_OK;
301 if ((*buf_cnt)-- > 0) {
302 *next_char = **buf_p;
305 connection->input_pending = true;
307 connection->input_pending = false;
309 #ifdef _DEBUG_GDB_IO_
310 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
316 struct gdb_connection *gdb_con = connection->priv;
317 gdb_con->buf_p = *buf_p;
318 gdb_con->buf_cnt = *buf_cnt;
319 retval = gdb_get_char_inner(connection, next_char);
320 *buf_p = gdb_con->buf_p;
321 *buf_cnt = gdb_con->buf_cnt;
326 static int gdb_get_char(struct connection *connection, int *next_char)
328 struct gdb_connection *gdb_con = connection->priv;
329 return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
332 static int gdb_putback_char(struct connection *connection, int last_char)
334 struct gdb_connection *gdb_con = connection->priv;
336 if (gdb_con->buf_p > gdb_con->buffer) {
337 *(--gdb_con->buf_p) = last_char;
340 LOG_ERROR("BUG: couldn't put character back");
345 /* The only way we can detect that the socket is closed is the first time
346 * we write to it, we will fail. Subsequent write operations will
347 * succeed. Shudder! */
348 static int gdb_write(struct connection *connection, void *data, int len)
350 struct gdb_connection *gdb_con = connection->priv;
352 return ERROR_SERVER_REMOTE_CLOSED;
354 if (connection_write(connection, data, len) == len)
356 gdb_con->closed = true;
357 return ERROR_SERVER_REMOTE_CLOSED;
360 static int gdb_put_packet_inner(struct connection *connection,
361 char *buffer, int len)
364 unsigned char my_checksum = 0;
365 #ifdef _DEBUG_GDB_IO_
370 struct gdb_connection *gdb_con = connection->priv;
372 for (i = 0; i < len; i++)
373 my_checksum += buffer[i];
375 #ifdef _DEBUG_GDB_IO_
377 * At this point we should have nothing in the input queue from GDB,
378 * however sometimes '-' is sent even though we've already received
379 * an ACK (+) for everything we've sent off.
383 retval = check_pending(connection, 0, &gotdata);
384 if (retval != ERROR_OK)
388 retval = gdb_get_char(connection, &reply);
389 if (retval != ERROR_OK)
392 /* fix a problem with some IAR tools */
393 gdb_putback_char(connection, reply);
394 LOG_DEBUG("Unexpected start of new packet");
398 LOG_WARNING("Discard unexpected char %c", reply);
403 #ifdef _DEBUG_GDB_IO_
404 debug_buffer = strndup(buffer, len);
405 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
409 char local_buffer[1024];
410 local_buffer[0] = '$';
411 if ((size_t)len + 4 <= sizeof(local_buffer)) {
412 /* performance gain on smaller packets by only a single call to gdb_write() */
413 memcpy(local_buffer + 1, buffer, len++);
414 len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum);
415 retval = gdb_write(connection, local_buffer, len);
416 if (retval != ERROR_OK)
419 /* larger packets are transmitted directly from caller supplied buffer
420 * by several calls to gdb_write() to avoid dynamic allocation */
421 snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum);
422 retval = gdb_write(connection, local_buffer, 1);
423 if (retval != ERROR_OK)
425 retval = gdb_write(connection, buffer, len);
426 if (retval != ERROR_OK)
428 retval = gdb_write(connection, local_buffer + 1, 3);
429 if (retval != ERROR_OK)
433 if (gdb_con->noack_mode)
436 retval = gdb_get_char(connection, &reply);
437 if (retval != ERROR_OK)
442 else if (reply == '-') {
443 /* Stop sending output packets for now */
444 log_remove_callback(gdb_log_callback, connection);
445 LOG_WARNING("negative reply, retrying");
446 } else if (reply == 0x3) {
447 gdb_con->ctrl_c = true;
448 retval = gdb_get_char(connection, &reply);
449 if (retval != ERROR_OK)
453 else if (reply == '-') {
454 /* Stop sending output packets for now */
455 log_remove_callback(gdb_log_callback, connection);
456 LOG_WARNING("negative reply, retrying");
457 } else if (reply == '$') {
458 LOG_ERROR("GDB missing ack(1) - assumed good");
459 gdb_putback_char(connection, reply);
462 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
463 gdb_con->closed = true;
464 return ERROR_SERVER_REMOTE_CLOSED;
466 } else if (reply == '$') {
467 LOG_ERROR("GDB missing ack(2) - assumed good");
468 gdb_putback_char(connection, reply);
471 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
473 gdb_con->closed = true;
474 return ERROR_SERVER_REMOTE_CLOSED;
478 return ERROR_SERVER_REMOTE_CLOSED;
483 int gdb_put_packet(struct connection *connection, char *buffer, int len)
485 struct gdb_connection *gdb_con = connection->priv;
486 gdb_con->busy = true;
487 int retval = gdb_put_packet_inner(connection, buffer, len);
488 gdb_con->busy = false;
490 /* we sent some data, reset timer for keep alive messages */
496 static inline int fetch_packet(struct connection *connection,
497 int *checksum_ok, int noack, int *len, char *buffer)
499 unsigned char my_checksum = 0;
502 int retval = ERROR_OK;
504 struct gdb_connection *gdb_con = connection->priv;
509 /* move this over into local variables to use registers and give the
510 * more freedom to optimize */
511 char *buf_p = gdb_con->buf_p;
512 int buf_cnt = gdb_con->buf_cnt;
515 /* The common case is that we have an entire packet with no escape chars.
516 * We need to leave at least 2 bytes in the buffer to have
517 * gdb_get_char() update various bits and bobs correctly.
519 if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) {
520 /* The compiler will struggle a bit with constant propagation and
521 * aliasing, so we help it by showing that these values do not
522 * change inside the loop
526 int run = buf_cnt - 2;
532 if (character == '#') {
533 /* Danger! character can be '#' when esc is
534 * used so we need an explicit boolean for done here. */
539 if (character == '}') {
540 /* data transmitted in binary mode (X packet)
541 * uses 0x7d as escape character */
542 my_checksum += character & 0xff;
545 my_checksum += character & 0xff;
546 buffer[count++] = (character ^ 0x20) & 0xff;
548 my_checksum += character & 0xff;
549 buffer[count++] = character & 0xff;
558 LOG_ERROR("packet buffer too small");
559 retval = ERROR_GDB_BUFFER_TOO_SMALL;
563 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
564 if (retval != ERROR_OK)
567 if (character == '#')
570 if (character == '}') {
571 /* data transmitted in binary mode (X packet)
572 * uses 0x7d as escape character */
573 my_checksum += character & 0xff;
575 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
576 if (retval != ERROR_OK)
579 my_checksum += character & 0xff;
580 buffer[count++] = (character ^ 0x20) & 0xff;
582 my_checksum += character & 0xff;
583 buffer[count++] = character & 0xff;
587 gdb_con->buf_p = buf_p;
588 gdb_con->buf_cnt = buf_cnt;
590 if (retval != ERROR_OK)
595 retval = gdb_get_char(connection, &character);
596 if (retval != ERROR_OK)
598 checksum[0] = character;
599 retval = gdb_get_char(connection, &character);
600 if (retval != ERROR_OK)
602 checksum[1] = character;
606 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
611 static int gdb_get_packet_inner(struct connection *connection,
612 char *buffer, int *len)
616 struct gdb_connection *gdb_con = connection->priv;
620 retval = gdb_get_char(connection, &character);
621 if (retval != ERROR_OK)
624 #ifdef _DEBUG_GDB_IO_
625 LOG_DEBUG("character: '%c'", character);
632 /* According to the GDB documentation
633 * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html):
634 * "gdb sends a final `+` acknowledgment of the stub's `OK`
635 * response, which can be safely ignored by the stub."
636 * However OpenOCD server already is in noack mode at this
637 * point and instead of ignoring this it was emitting a
638 * warning. This code makes server ignore the first ACK
639 * that will be received after going into noack mode,
640 * warning only about subsequent ACK's. */
641 if (gdb_con->noack_mode > 1) {
642 LOG_WARNING("acknowledgment received, but no packet pending");
643 } else if (gdb_con->noack_mode) {
644 LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it.");
645 gdb_con->noack_mode = 2;
649 LOG_WARNING("negative acknowledgment, but no packet pending");
652 gdb_con->ctrl_c = true;
656 LOG_WARNING("ignoring character 0x%x", character);
659 } while (character != '$');
662 /* explicit code expansion here to get faster inlined code in -O3 by not
663 * calculating checksum */
664 if (gdb_con->noack_mode) {
665 retval = fetch_packet(connection, &checksum_ok, 1, len, buffer);
666 if (retval != ERROR_OK)
669 retval = fetch_packet(connection, &checksum_ok, 0, len, buffer);
670 if (retval != ERROR_OK)
674 if (gdb_con->noack_mode) {
675 /* checksum is not checked in noack mode */
679 retval = gdb_write(connection, "+", 1);
680 if (retval != ERROR_OK)
686 return ERROR_SERVER_REMOTE_CLOSED;
691 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
693 struct gdb_connection *gdb_con = connection->priv;
694 gdb_con->busy = true;
695 int retval = gdb_get_packet_inner(connection, buffer, len);
696 gdb_con->busy = false;
700 static int gdb_output_con(struct connection *connection, const char *line)
705 bin_size = strlen(line);
707 hex_buffer = malloc(bin_size * 2 + 2);
708 if (hex_buffer == NULL)
709 return ERROR_GDB_BUFFER_TOO_SMALL;
712 size_t pkt_len = hexify(hex_buffer + 1, (const uint8_t *)line, bin_size,
714 int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1);
720 static int gdb_output(struct command_context *context, const char *line)
722 /* this will be dumped to the log and also sent as an O packet if possible */
723 LOG_USER_N("%s", line);
727 static void gdb_signal_reply(struct target *target, struct connection *connection)
729 struct gdb_connection *gdb_connection = connection->priv;
731 char stop_reason[20];
732 char current_thread[25];
736 rtos_update_threads(target);
738 if (target->debug_reason == DBG_REASON_EXIT) {
739 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "W00");
742 if (target->rtos != NULL) {
743 target->rtos->current_threadid = target->rtos->current_thread;
744 target->rtos->gdb_target_for_threadid(connection, target->rtos->current_threadid, &ct);
749 if (gdb_connection->ctrl_c) {
752 signal_var = gdb_last_signal(ct);
754 stop_reason[0] = '\0';
755 if (ct->debug_reason == DBG_REASON_WATCHPOINT) {
756 enum watchpoint_rw hit_wp_type;
757 target_addr_t hit_wp_address;
759 if (watchpoint_hit(ct, &hit_wp_type, &hit_wp_address) == ERROR_OK) {
761 switch (hit_wp_type) {
763 snprintf(stop_reason, sizeof(stop_reason),
764 "watch:%08" TARGET_PRIxADDR ";", hit_wp_address);
767 snprintf(stop_reason, sizeof(stop_reason),
768 "rwatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
771 snprintf(stop_reason, sizeof(stop_reason),
772 "awatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
780 current_thread[0] = '\0';
781 if (target->rtos != NULL)
782 snprintf(current_thread, sizeof(current_thread), "thread:%" PRIx64 ";",
783 target->rtos->current_thread);
785 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "T%2.2x%s%s",
786 signal_var, stop_reason, current_thread);
788 gdb_connection->ctrl_c = false;
791 gdb_put_packet(connection, sig_reply, sig_reply_len);
792 gdb_connection->frontend_state = TARGET_HALTED;
795 static void gdb_fileio_reply(struct target *target, struct connection *connection)
797 struct gdb_connection *gdb_connection = connection->priv;
798 char fileio_command[256];
800 bool program_exited = false;
802 if (strcmp(target->fileio_info->identifier, "open") == 0)
803 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
804 target->fileio_info->param_1,
805 target->fileio_info->param_2 + 1, /* len + trailing zero */
806 target->fileio_info->param_3,
807 target->fileio_info->param_4);
808 else if (strcmp(target->fileio_info->identifier, "close") == 0)
809 sprintf(fileio_command, "F%s,%" PRIx64, target->fileio_info->identifier,
810 target->fileio_info->param_1);
811 else if (strcmp(target->fileio_info->identifier, "read") == 0)
812 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
813 target->fileio_info->param_1,
814 target->fileio_info->param_2,
815 target->fileio_info->param_3);
816 else if (strcmp(target->fileio_info->identifier, "write") == 0)
817 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
818 target->fileio_info->param_1,
819 target->fileio_info->param_2,
820 target->fileio_info->param_3);
821 else if (strcmp(target->fileio_info->identifier, "lseek") == 0)
822 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
823 target->fileio_info->param_1,
824 target->fileio_info->param_2,
825 target->fileio_info->param_3);
826 else if (strcmp(target->fileio_info->identifier, "rename") == 0)
827 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
828 target->fileio_info->param_1,
829 target->fileio_info->param_2 + 1, /* len + trailing zero */
830 target->fileio_info->param_3,
831 target->fileio_info->param_4 + 1); /* len + trailing zero */
832 else if (strcmp(target->fileio_info->identifier, "unlink") == 0)
833 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
834 target->fileio_info->param_1,
835 target->fileio_info->param_2 + 1); /* len + trailing zero */
836 else if (strcmp(target->fileio_info->identifier, "stat") == 0)
837 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
838 target->fileio_info->param_1,
839 target->fileio_info->param_2,
840 target->fileio_info->param_3);
841 else if (strcmp(target->fileio_info->identifier, "fstat") == 0)
842 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
843 target->fileio_info->param_1,
844 target->fileio_info->param_2);
845 else if (strcmp(target->fileio_info->identifier, "gettimeofday") == 0)
846 sprintf(fileio_command, "F%s,%" PRIx64 ",%" PRIx64, target->fileio_info->identifier,
847 target->fileio_info->param_1,
848 target->fileio_info->param_2);
849 else if (strcmp(target->fileio_info->identifier, "isatty") == 0)
850 sprintf(fileio_command, "F%s,%" PRIx64, target->fileio_info->identifier,
851 target->fileio_info->param_1);
852 else if (strcmp(target->fileio_info->identifier, "system") == 0)
853 sprintf(fileio_command, "F%s,%" PRIx64 "/%" PRIx64, target->fileio_info->identifier,
854 target->fileio_info->param_1,
855 target->fileio_info->param_2 + 1); /* len + trailing zero */
856 else if (strcmp(target->fileio_info->identifier, "exit") == 0) {
857 /* If target hits exit syscall, report to GDB the program is terminated.
858 * In addition, let target run its own exit syscall handler. */
859 program_exited = true;
860 sprintf(fileio_command, "W%02" PRIx64, target->fileio_info->param_1);
862 LOG_DEBUG("Unknown syscall: %s", target->fileio_info->identifier);
864 /* encounter unknown syscall, continue */
865 gdb_connection->frontend_state = TARGET_RUNNING;
866 target_resume(target, 1, 0x0, 0, 0);
870 command_len = strlen(fileio_command);
871 gdb_put_packet(connection, fileio_command, command_len);
873 if (program_exited) {
874 /* Use target_resume() to let target run its own exit syscall handler. */
875 gdb_connection->frontend_state = TARGET_RUNNING;
876 target_resume(target, 1, 0x0, 0, 0);
878 gdb_connection->frontend_state = TARGET_HALTED;
879 rtos_update_threads(target);
883 static void gdb_frontend_halted(struct target *target, struct connection *connection)
885 struct gdb_connection *gdb_connection = connection->priv;
887 /* In the GDB protocol when we are stepping or continuing execution,
888 * we have a lingering reply. Upon receiving a halted event
889 * when we have that lingering packet, we reply to the original
890 * step or continue packet.
892 * Executing monitor commands can bring the target in and
893 * out of the running state so we'll see lots of TARGET_EVENT_XXX
894 * that are to be ignored.
896 if (gdb_connection->frontend_state == TARGET_RUNNING) {
897 /* stop forwarding log packets! */
898 log_remove_callback(gdb_log_callback, connection);
900 /* check fileio first */
901 if (target_get_gdb_fileio_info(target, target->fileio_info) == ERROR_OK)
902 gdb_fileio_reply(target, connection);
904 gdb_signal_reply(target, connection);
908 static int gdb_target_callback_event_handler(struct target *target,
909 enum target_event event, void *priv)
911 struct connection *connection = priv;
912 struct gdb_service *gdb_service = connection->service->priv;
914 if (gdb_service->target != target)
918 case TARGET_EVENT_GDB_HALT:
919 gdb_frontend_halted(target, connection);
921 case TARGET_EVENT_HALTED:
922 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
931 static int gdb_new_connection(struct connection *connection)
933 struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
934 struct target *target;
938 target = get_target_from_connection(connection);
939 connection->priv = gdb_connection;
940 connection->cmd_ctx->current_target = target;
942 /* initialize gdb connection information */
943 gdb_connection->buf_p = gdb_connection->buffer;
944 gdb_connection->buf_cnt = 0;
945 gdb_connection->ctrl_c = false;
946 gdb_connection->frontend_state = TARGET_HALTED;
947 gdb_connection->vflash_image = NULL;
948 gdb_connection->closed = false;
949 gdb_connection->busy = false;
950 gdb_connection->noack_mode = 0;
951 gdb_connection->sync = false;
952 gdb_connection->mem_write_error = false;
953 gdb_connection->attached = true;
954 gdb_connection->extended_protocol = false;
955 gdb_connection->target_desc.tdesc = NULL;
956 gdb_connection->target_desc.tdesc_length = 0;
957 gdb_connection->thread_list = NULL;
959 /* send ACK to GDB for debug request */
960 gdb_write(connection, "+", 1);
962 /* output goes through gdb connection */
963 command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
965 /* we must remove all breakpoints registered to the target as a previous
966 * GDB session could leave dangling breakpoints if e.g. communication
969 breakpoint_clear_target(target);
970 watchpoint_clear_target(target);
973 /* clean previous rtos session if supported*/
974 if (target->rtos->type->clean)
975 target->rtos->type->clean(target);
978 rtos_update_threads(target);
981 /* remove the initial ACK from the incoming buffer */
982 retval = gdb_get_char(connection, &initial_ack);
983 if (retval != ERROR_OK)
986 /* FIX!!!??? would we actually ever receive a + here???
989 if (initial_ack != '+')
990 gdb_putback_char(connection, initial_ack);
991 target_call_event_callbacks(target, TARGET_EVENT_GDB_ATTACH);
993 if (gdb_use_memory_map) {
994 /* Connect must fail if the memory map can't be set up correctly.
996 * This will cause an auto_probe to be invoked, which is either
997 * a no-op or it will fail when the target isn't ready(e.g. not halted).
999 for (unsigned int i = 0; i < flash_get_bank_count(); i++) {
1000 struct flash_bank *p;
1001 p = get_flash_bank_by_num_noprobe(i);
1002 if (p->target != target)
1004 retval = get_flash_bank_by_num(i, &p);
1005 if (retval != ERROR_OK) {
1006 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target "
1007 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
1013 gdb_actual_connections++;
1014 log_printf_lf(all_targets->next != NULL ? LOG_LVL_INFO : LOG_LVL_DEBUG,
1015 __FILE__, __LINE__, __func__,
1016 "New GDB Connection: %d, Target %s, state: %s",
1017 gdb_actual_connections,
1018 target_name(target),
1019 target_state_name(target));
1021 if (!target_was_examined(target)) {
1022 LOG_ERROR("Target %s not examined yet, refuse gdb connection %d!",
1023 target_name(target), gdb_actual_connections);
1024 gdb_actual_connections--;
1025 return ERROR_TARGET_NOT_EXAMINED;
1028 if (target->state != TARGET_HALTED)
1029 LOG_WARNING("GDB connection %d on target %s not halted",
1030 gdb_actual_connections, target_name(target));
1032 /* DANGER! If we fail subsequently, we must remove this handler,
1033 * otherwise we occasionally see crashes as the timer can invoke the
1036 * register callback to be informed about target events */
1037 target_register_event_callback(gdb_target_callback_event_handler, connection);
1042 static int gdb_connection_closed(struct connection *connection)
1044 struct target *target;
1045 struct gdb_connection *gdb_connection = connection->priv;
1047 target = get_target_from_connection(connection);
1049 /* we're done forwarding messages. Tear down callback before
1050 * cleaning up connection.
1052 log_remove_callback(gdb_log_callback, connection);
1054 gdb_actual_connections--;
1055 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
1056 target_name(target),
1057 target_state_name(target),
1058 gdb_actual_connections);
1060 /* see if an image built with vFlash commands is left */
1061 if (gdb_connection->vflash_image) {
1062 image_close(gdb_connection->vflash_image);
1063 free(gdb_connection->vflash_image);
1064 gdb_connection->vflash_image = NULL;
1067 /* if this connection registered a debug-message receiver delete it */
1068 delete_debug_msg_receiver(connection->cmd_ctx, target);
1070 free(connection->priv);
1071 connection->priv = NULL;
1073 target_unregister_event_callback(gdb_target_callback_event_handler, connection);
1075 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
1077 target_call_event_callbacks(target, TARGET_EVENT_GDB_DETACH);
1082 static void gdb_send_error(struct connection *connection, uint8_t the_error)
1085 snprintf(err, 4, "E%2.2X", the_error);
1086 gdb_put_packet(connection, err, 3);
1089 static int gdb_last_signal_packet(struct connection *connection,
1090 char const *packet, int packet_size)
1092 struct target *target = get_target_from_connection(connection);
1093 struct gdb_connection *gdb_con = connection->priv;
1097 if (!gdb_con->attached) {
1098 /* if we are here we have received a kill packet
1099 * reply W stop reply otherwise gdb gets very unhappy */
1100 gdb_put_packet(connection, "W00", 3);
1104 signal_var = gdb_last_signal(target);
1106 snprintf(sig_reply, 4, "S%2.2x", signal_var);
1107 gdb_put_packet(connection, sig_reply, 3);
1112 static inline int gdb_reg_pos(struct target *target, int pos, int len)
1114 if (target->endianness == TARGET_LITTLE_ENDIAN)
1117 return len - 1 - pos;
1120 /* Convert register to string of bytes. NB! The # of bits in the
1121 * register might be non-divisible by 8(a byte), in which
1122 * case an entire byte is shown.
1124 * NB! the format on the wire is the target endianness
1126 * The format of reg->value is little endian
1129 static void gdb_str_to_target(struct target *target,
1130 char *tstr, struct reg *reg)
1137 buf_len = DIV_ROUND_UP(reg->size, 8);
1139 for (i = 0; i < buf_len; i++) {
1140 int j = gdb_reg_pos(target, i, buf_len);
1141 tstr += sprintf(tstr, "%02x", buf[j]);
1145 /* copy over in register buffer */
1146 static void gdb_target_to_reg(struct target *target,
1147 char const *tstr, int str_len, uint8_t *bin)
1150 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1155 for (i = 0; i < str_len; i += 2) {
1157 if (sscanf(tstr + i, "%02x", &t) != 1) {
1158 LOG_ERROR("BUG: unable to convert register value");
1162 int j = gdb_reg_pos(target, i/2, str_len/2);
1167 static int gdb_get_registers_packet(struct connection *connection,
1168 char const *packet, int packet_size)
1170 struct target *target = get_target_from_connection(connection);
1171 struct reg **reg_list;
1174 int reg_packet_size = 0;
1179 #ifdef _DEBUG_GDB_IO_
1183 if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg_list(connection)))
1186 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1188 if (retval != ERROR_OK)
1189 return gdb_error(connection, retval);
1191 for (i = 0; i < reg_list_size; i++) {
1192 if (reg_list[i] == NULL || reg_list[i]->exist == false)
1194 reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1197 assert(reg_packet_size > 0);
1199 reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */
1200 if (reg_packet == NULL)
1203 reg_packet_p = reg_packet;
1205 for (i = 0; i < reg_list_size; i++) {
1206 if (reg_list[i] == NULL || reg_list[i]->exist == false)
1208 if (!reg_list[i]->valid) {
1209 retval = reg_list[i]->type->get(reg_list[i]);
1210 if (retval != ERROR_OK && gdb_report_register_access_error) {
1211 LOG_DEBUG("Couldn't get register %s.", reg_list[i]->name);
1214 return gdb_error(connection, retval);
1217 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1218 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1221 #ifdef _DEBUG_GDB_IO_
1223 char *reg_packet_p_debug;
1224 reg_packet_p_debug = strndup(reg_packet, reg_packet_size);
1225 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug);
1226 free(reg_packet_p_debug);
1230 gdb_put_packet(connection, reg_packet, reg_packet_size);
1238 static int gdb_set_registers_packet(struct connection *connection,
1239 char const *packet, int packet_size)
1241 struct target *target = get_target_from_connection(connection);
1243 struct reg **reg_list;
1246 char const *packet_p;
1248 #ifdef _DEBUG_GDB_IO_
1252 /* skip command character */
1256 if (packet_size % 2) {
1257 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1258 return ERROR_SERVER_REMOTE_CLOSED;
1261 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1263 if (retval != ERROR_OK)
1264 return gdb_error(connection, retval);
1267 for (i = 0; i < reg_list_size; i++) {
1269 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1271 if (packet_p + chars > packet + packet_size)
1272 LOG_ERROR("BUG: register packet is too small for registers");
1274 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1275 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1277 retval = reg_list[i]->type->set(reg_list[i], bin_buf);
1278 if (retval != ERROR_OK && gdb_report_register_access_error) {
1279 LOG_DEBUG("Couldn't set register %s.", reg_list[i]->name);
1282 return gdb_error(connection, retval);
1285 /* advance packet pointer */
1291 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1294 gdb_put_packet(connection, "OK", 2);
1299 static int gdb_get_register_packet(struct connection *connection,
1300 char const *packet, int packet_size)
1302 struct target *target = get_target_from_connection(connection);
1304 int reg_num = strtoul(packet + 1, NULL, 16);
1305 struct reg **reg_list;
1309 #ifdef _DEBUG_GDB_IO_
1313 if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg(connection, reg_num)))
1316 retval = target_get_gdb_reg_list_noread(target, ®_list, ®_list_size,
1318 if (retval != ERROR_OK)
1319 return gdb_error(connection, retval);
1321 if (reg_list_size <= reg_num) {
1322 LOG_ERROR("gdb requested a non-existing register");
1323 return ERROR_SERVER_REMOTE_CLOSED;
1326 if (!reg_list[reg_num]->valid) {
1327 retval = reg_list[reg_num]->type->get(reg_list[reg_num]);
1328 if (retval != ERROR_OK && gdb_report_register_access_error) {
1329 LOG_DEBUG("Couldn't get register %s.", reg_list[reg_num]->name);
1331 return gdb_error(connection, retval);
1335 reg_packet = calloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1, 1); /* plus one for string termination null */
1337 gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1339 gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1347 static int gdb_set_register_packet(struct connection *connection,
1348 char const *packet, int packet_size)
1350 struct target *target = get_target_from_connection(connection);
1352 int reg_num = strtoul(packet + 1, &separator, 16);
1353 struct reg **reg_list;
1357 #ifdef _DEBUG_GDB_IO_
1361 if (*separator != '=') {
1362 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1363 return ERROR_SERVER_REMOTE_CLOSED;
1365 size_t chars = strlen(separator + 1);
1366 uint8_t *bin_buf = malloc(chars / 2);
1367 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1369 if ((target->rtos != NULL) &&
1370 (ERROR_OK == rtos_set_reg(connection, reg_num, bin_buf))) {
1372 gdb_put_packet(connection, "OK", 2);
1376 retval = target_get_gdb_reg_list_noread(target, ®_list, ®_list_size,
1378 if (retval != ERROR_OK) {
1380 return gdb_error(connection, retval);
1383 if (reg_list_size <= reg_num) {
1384 LOG_ERROR("gdb requested a non-existing register");
1387 return ERROR_SERVER_REMOTE_CLOSED;
1390 if (chars != (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2)) {
1391 LOG_ERROR("gdb sent %zu bits for a %" PRIu32 "-bit register (%s)",
1392 chars * 4, reg_list[reg_num]->size, reg_list[reg_num]->name);
1395 return ERROR_SERVER_REMOTE_CLOSED;
1398 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1400 retval = reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1401 if (retval != ERROR_OK && gdb_report_register_access_error) {
1402 LOG_DEBUG("Couldn't set register %s.", reg_list[reg_num]->name);
1405 return gdb_error(connection, retval);
1408 gdb_put_packet(connection, "OK", 2);
1416 /* No attempt is made to translate the "retval" to
1417 * GDB speak. This has to be done at the calling
1418 * site as no mapping really exists.
1420 static int gdb_error(struct connection *connection, int retval)
1422 LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1423 gdb_send_error(connection, EFAULT);
1427 /* We don't have to worry about the default 2 second timeout for GDB packets,
1428 * because GDB breaks up large memory reads into smaller reads.
1430 static int gdb_read_memory_packet(struct connection *connection,
1431 char const *packet, int packet_size)
1433 struct target *target = get_target_from_connection(connection);
1441 int retval = ERROR_OK;
1443 /* skip command character */
1446 addr = strtoull(packet, &separator, 16);
1448 if (*separator != ',') {
1449 LOG_ERROR("incomplete read memory packet received, dropping connection");
1450 return ERROR_SERVER_REMOTE_CLOSED;
1453 len = strtoul(separator + 1, NULL, 16);
1456 LOG_WARNING("invalid read memory packet received (len == 0)");
1457 gdb_put_packet(connection, "", 0);
1461 buffer = malloc(len);
1463 LOG_DEBUG("addr: 0x%16.16" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1465 retval = target_read_buffer(target, addr, len, buffer);
1467 if ((retval != ERROR_OK) && !gdb_report_data_abort) {
1468 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1469 * At some point this might be fixed in GDB, in which case this code can be removed.
1471 * OpenOCD developers are acutely aware of this problem, but there is nothing
1472 * gained by involving the user in this problem that hopefully will get resolved
1475 * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1476 * cmd = view%20audit-trail&database = gdb&pr = 2395
1478 * For now, the default is to fix up things to make current GDB versions work.
1479 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1481 memset(buffer, 0, len);
1485 if (retval == ERROR_OK) {
1486 hex_buffer = malloc(len * 2 + 1);
1488 size_t pkt_len = hexify(hex_buffer, buffer, len, len * 2 + 1);
1490 gdb_put_packet(connection, hex_buffer, pkt_len);
1494 retval = gdb_error(connection, retval);
1501 static int gdb_write_memory_packet(struct connection *connection,
1502 char const *packet, int packet_size)
1504 struct target *target = get_target_from_connection(connection);
1512 /* skip command character */
1515 addr = strtoull(packet, &separator, 16);
1517 if (*separator != ',') {
1518 LOG_ERROR("incomplete write memory packet received, dropping connection");
1519 return ERROR_SERVER_REMOTE_CLOSED;
1522 len = strtoul(separator + 1, &separator, 16);
1524 if (*(separator++) != ':') {
1525 LOG_ERROR("incomplete write memory packet received, dropping connection");
1526 return ERROR_SERVER_REMOTE_CLOSED;
1529 buffer = malloc(len);
1531 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1533 if (unhexify(buffer, separator, len) != len)
1534 LOG_ERROR("unable to decode memory packet");
1536 retval = target_write_buffer(target, addr, len, buffer);
1538 if (retval == ERROR_OK)
1539 gdb_put_packet(connection, "OK", 2);
1541 retval = gdb_error(connection, retval);
1548 static int gdb_write_memory_binary_packet(struct connection *connection,
1549 char const *packet, int packet_size)
1551 struct target *target = get_target_from_connection(connection);
1556 int retval = ERROR_OK;
1557 /* Packets larger than fast_limit bytes will be acknowledged instantly on
1558 * the assumption that we're in a download and it's important to go as fast
1560 uint32_t fast_limit = 8;
1562 /* skip command character */
1565 addr = strtoull(packet, &separator, 16);
1567 if (*separator != ',') {
1568 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1569 return ERROR_SERVER_REMOTE_CLOSED;
1572 len = strtoul(separator + 1, &separator, 16);
1574 if (*(separator++) != ':') {
1575 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1576 return ERROR_SERVER_REMOTE_CLOSED;
1579 struct gdb_connection *gdb_connection = connection->priv;
1581 if (gdb_connection->mem_write_error)
1582 retval = ERROR_FAIL;
1584 if (retval == ERROR_OK) {
1585 if (len >= fast_limit) {
1586 /* By replying the packet *immediately* GDB will send us a new packet
1587 * while we write the last one to the target.
1588 * We only do this for larger writes, so that users who do something like:
1589 * p *((int*)0xdeadbeef)=8675309
1590 * will get immediate feedback that that write failed.
1592 gdb_put_packet(connection, "OK", 2);
1595 retval = gdb_error(connection, retval);
1596 /* now that we have reported the memory write error, we can clear the condition */
1597 gdb_connection->mem_write_error = false;
1598 if (retval != ERROR_OK)
1603 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1605 retval = target_write_buffer(target, addr, len, (uint8_t *)separator);
1606 if (retval != ERROR_OK)
1607 gdb_connection->mem_write_error = true;
1610 if (len < fast_limit) {
1611 if (retval != ERROR_OK) {
1612 gdb_error(connection, retval);
1613 gdb_connection->mem_write_error = false;
1615 gdb_put_packet(connection, "OK", 2);
1622 static int gdb_step_continue_packet(struct connection *connection,
1623 char const *packet, int packet_size)
1625 struct target *target = get_target_from_connection(connection);
1627 uint64_t address = 0x0;
1628 int retval = ERROR_OK;
1632 if (packet_size > 1)
1633 address = strtoull(packet + 1, NULL, 16);
1637 gdb_running_type = packet[0];
1638 if (packet[0] == 'c') {
1639 LOG_DEBUG("continue");
1640 /* resume at current address, don't handle breakpoints, not debugging */
1641 retval = target_resume(target, current, address, 0, 0);
1642 } else if (packet[0] == 's') {
1644 /* step at current or address, don't handle breakpoints */
1645 retval = target_step(target, current, address, 0);
1650 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1651 char const *packet, int packet_size)
1653 struct target *target = get_target_from_connection(connection);
1655 enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1656 enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1662 LOG_DEBUG("[%s]", target_name(target));
1664 type = strtoul(packet + 1, &separator, 16);
1666 if (type == 0) /* memory breakpoint */
1667 bp_type = BKPT_SOFT;
1668 else if (type == 1) /* hardware breakpoint */
1669 bp_type = BKPT_HARD;
1670 else if (type == 2) /* write watchpoint */
1671 wp_type = WPT_WRITE;
1672 else if (type == 3) /* read watchpoint */
1674 else if (type == 4) /* access watchpoint */
1675 wp_type = WPT_ACCESS;
1677 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1678 return ERROR_SERVER_REMOTE_CLOSED;
1681 if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD)))
1682 bp_type = gdb_breakpoint_override_type;
1684 if (*separator != ',') {
1685 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1686 return ERROR_SERVER_REMOTE_CLOSED;
1689 address = strtoull(separator + 1, &separator, 16);
1691 if (*separator != ',') {
1692 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1693 return ERROR_SERVER_REMOTE_CLOSED;
1696 size = strtoul(separator + 1, &separator, 16);
1701 if (packet[0] == 'Z') {
1702 retval = breakpoint_add(target, address, size, bp_type);
1703 if (retval != ERROR_OK) {
1704 retval = gdb_error(connection, retval);
1705 if (retval != ERROR_OK)
1708 gdb_put_packet(connection, "OK", 2);
1710 breakpoint_remove(target, address);
1711 gdb_put_packet(connection, "OK", 2);
1718 if (packet[0] == 'Z') {
1719 retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu);
1720 if (retval != ERROR_OK) {
1721 retval = gdb_error(connection, retval);
1722 if (retval != ERROR_OK)
1725 gdb_put_packet(connection, "OK", 2);
1727 watchpoint_remove(target, address);
1728 gdb_put_packet(connection, "OK", 2);
1739 /* print out a string and allocate more space as needed,
1740 * mainly used for XML at this point
1742 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))) void xml_printf(int *retval,
1743 char **xml, int *pos, int *size, const char *fmt, ...)
1745 if (*retval != ERROR_OK)
1750 if ((*xml == NULL) || (!first)) {
1751 /* start by 0 to exercise all the code paths.
1752 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1754 *size = *size * 2 + 2;
1756 *xml = realloc(*xml, *size);
1759 *retval = ERROR_SERVER_REMOTE_CLOSED;
1767 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1769 if ((ret > 0) && ((ret + 1) < *size - *pos)) {
1773 /* there was just enough or not enough space, allocate more. */
1778 static int decode_xfer_read(char const *buf, char **annex, int *ofs, unsigned int *len)
1780 /* Locate the annex. */
1781 const char *annex_end = strchr(buf, ':');
1782 if (annex_end == NULL)
1785 /* After the read marker and annex, qXfer looks like a
1786 * traditional 'm' packet. */
1788 *ofs = strtoul(annex_end + 1, &separator, 16);
1790 if (*separator != ',')
1793 *len = strtoul(separator + 1, NULL, 16);
1795 /* Extract the annex if needed */
1796 if (annex != NULL) {
1797 *annex = strndup(buf, annex_end - buf);
1805 static int compare_bank(const void *a, const void *b)
1807 struct flash_bank *b1, *b2;
1808 b1 = *((struct flash_bank **)a);
1809 b2 = *((struct flash_bank **)b);
1811 if (b1->base == b2->base)
1813 else if (b1->base > b2->base)
1819 static int gdb_memory_map(struct connection *connection,
1820 char const *packet, int packet_size)
1822 /* We get away with only specifying flash here. Regions that are not
1823 * specified are treated as if we provided no memory map(if not we
1824 * could detect the holes and mark them as RAM).
1825 * Normally we only execute this code once, but no big deal if we
1826 * have to regenerate it a couple of times.
1829 struct target *target = get_target_from_connection(connection);
1830 struct flash_bank *p;
1834 int retval = ERROR_OK;
1835 struct flash_bank **banks;
1839 target_addr_t ram_start = 0;
1840 unsigned int target_flash_banks = 0;
1842 /* skip command character */
1845 offset = strtoul(packet, &separator, 16);
1846 length = strtoul(separator + 1, &separator, 16);
1848 xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1850 /* Sort banks in ascending order. We need to report non-flash
1851 * memory as ram (or rather read/write) by default for GDB, since
1852 * it has no concept of non-cacheable read/write memory (i/o etc).
1854 banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1856 for (unsigned int i = 0; i < flash_get_bank_count(); i++) {
1857 p = get_flash_bank_by_num_noprobe(i);
1858 if (p->target != target)
1860 retval = get_flash_bank_by_num(i, &p);
1861 if (retval != ERROR_OK) {
1863 gdb_error(connection, retval);
1866 banks[target_flash_banks++] = p;
1869 qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1872 for (unsigned int i = 0; i < target_flash_banks; i++) {
1873 unsigned sector_size = 0;
1874 unsigned group_len = 0;
1878 if (ram_start < p->base)
1879 xml_printf(&retval, &xml, &pos, &size,
1880 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT "\" "
1881 "length=\"" TARGET_ADDR_FMT "\"/>\n",
1882 ram_start, p->base - ram_start);
1884 /* Report adjacent groups of same-size sectors. So for
1885 * example top boot CFI flash will list an initial region
1886 * with several large sectors (maybe 128KB) and several
1887 * smaller ones at the end (maybe 32KB). STR7 will have
1888 * regions with 8KB, 32KB, and 64KB sectors; etc.
1890 for (unsigned int j = 0; j < p->num_sectors; j++) {
1892 /* Maybe start a new group of sectors. */
1893 if (sector_size == 0) {
1894 if (p->sectors[j].offset + p->sectors[j].size > p->size) {
1895 LOG_WARNING("The flash sector at offset 0x%08" PRIx32
1896 " overflows the end of %s bank.",
1897 p->sectors[j].offset, p->name);
1898 LOG_WARNING("The rest of bank will not show in gdb memory map.");
1901 target_addr_t start;
1902 start = p->base + p->sectors[j].offset;
1903 xml_printf(&retval, &xml, &pos, &size,
1904 "<memory type=\"flash\" "
1905 "start=\"" TARGET_ADDR_FMT "\" ",
1907 sector_size = p->sectors[j].size;
1908 group_len = sector_size;
1910 group_len += sector_size; /* equal to p->sectors[j].size */
1913 /* Does this finish a group of sectors?
1914 * If not, continue an already-started group.
1916 if (j < p->num_sectors - 1
1917 && p->sectors[j + 1].size == sector_size
1918 && p->sectors[j + 1].offset == p->sectors[j].offset + sector_size
1919 && p->sectors[j + 1].offset + p->sectors[j + 1].size <= p->size)
1922 xml_printf(&retval, &xml, &pos, &size,
1923 "length=\"0x%x\">\n"
1924 "<property name=\"blocksize\">"
1932 ram_start = p->base + p->size;
1936 xml_printf(&retval, &xml, &pos, &size,
1937 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT "\" "
1938 "length=\"" TARGET_ADDR_FMT "\"/>\n",
1939 ram_start, target_address_max(target) - ram_start + 1);
1940 /* ELSE a flash chip could be at the very end of the address space, in
1941 * which case ram_start will be precisely 0 */
1945 xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1947 if (retval != ERROR_OK) {
1949 gdb_error(connection, retval);
1953 if (offset + length > pos)
1954 length = pos - offset;
1956 char *t = malloc(length + 1);
1958 memcpy(t + 1, xml + offset, length);
1959 gdb_put_packet(connection, t, length + 1);
1966 static const char *gdb_get_reg_type_name(enum reg_type type)
1975 case REG_TYPE_INT16:
1977 case REG_TYPE_INT32:
1979 case REG_TYPE_INT64:
1981 case REG_TYPE_INT128:
1985 case REG_TYPE_UINT8:
1987 case REG_TYPE_UINT16:
1989 case REG_TYPE_UINT32:
1991 case REG_TYPE_UINT64:
1993 case REG_TYPE_UINT128:
1995 case REG_TYPE_CODE_PTR:
1997 case REG_TYPE_DATA_PTR:
1999 case REG_TYPE_FLOAT:
2001 case REG_TYPE_IEEE_SINGLE:
2002 return "ieee_single";
2003 case REG_TYPE_IEEE_DOUBLE:
2004 return "ieee_double";
2005 case REG_TYPE_ARCH_DEFINED:
2006 return "int"; /* return arbitrary string to avoid compile warning. */
2009 return "int"; /* "int" as default value */
2012 static int lookup_add_arch_defined_types(char const **arch_defined_types_list[], const char *type_id,
2013 int *num_arch_defined_types)
2015 int tbl_sz = *num_arch_defined_types;
2017 if (type_id != NULL && (strcmp(type_id, ""))) {
2018 for (int j = 0; j < (tbl_sz + 1); j++) {
2019 if (!((*arch_defined_types_list)[j])) {
2020 (*arch_defined_types_list)[tbl_sz++] = type_id;
2021 *arch_defined_types_list = realloc(*arch_defined_types_list,
2022 sizeof(char *) * (tbl_sz + 1));
2023 (*arch_defined_types_list)[tbl_sz] = NULL;
2024 *num_arch_defined_types = tbl_sz;
2027 if (!strcmp((*arch_defined_types_list)[j], type_id))
2036 static int gdb_generate_reg_type_description(struct target *target,
2037 char **tdesc, int *pos, int *size, struct reg_data_type *type,
2038 char const **arch_defined_types_list[], int *num_arch_defined_types)
2040 int retval = ERROR_OK;
2042 if (type->type_class == REG_TYPE_CLASS_VECTOR) {
2043 struct reg_data_type *data_type = type->reg_type_vector->type;
2044 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2045 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2046 num_arch_defined_types))
2047 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2048 arch_defined_types_list,
2049 num_arch_defined_types);
2051 /* <vector id="id" type="type" count="count"/> */
2052 xml_printf(&retval, tdesc, pos, size,
2053 "<vector id=\"%s\" type=\"%s\" count=\"%" PRIu32 "\"/>\n",
2054 type->id, type->reg_type_vector->type->id,
2055 type->reg_type_vector->count);
2057 } else if (type->type_class == REG_TYPE_CLASS_UNION) {
2058 struct reg_data_type_union_field *field;
2059 field = type->reg_type_union->fields;
2060 while (field != NULL) {
2061 struct reg_data_type *data_type = field->type;
2062 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2063 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2064 num_arch_defined_types))
2065 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2066 arch_defined_types_list,
2067 num_arch_defined_types);
2070 field = field->next;
2073 * <field name="name" type="type"/> ...
2075 xml_printf(&retval, tdesc, pos, size,
2076 "<union id=\"%s\">\n",
2079 field = type->reg_type_union->fields;
2080 while (field != NULL) {
2081 xml_printf(&retval, tdesc, pos, size,
2082 "<field name=\"%s\" type=\"%s\"/>\n",
2083 field->name, field->type->id);
2085 field = field->next;
2088 xml_printf(&retval, tdesc, pos, size,
2091 } else if (type->type_class == REG_TYPE_CLASS_STRUCT) {
2092 struct reg_data_type_struct_field *field;
2093 field = type->reg_type_struct->fields;
2095 if (field->use_bitfields) {
2096 /* <struct id="id" size="size">
2097 * <field name="name" start="start" end="end"/> ...
2099 xml_printf(&retval, tdesc, pos, size,
2100 "<struct id=\"%s\" size=\"%" PRIu32 "\">\n",
2101 type->id, type->reg_type_struct->size);
2102 while (field != NULL) {
2103 xml_printf(&retval, tdesc, pos, size,
2104 "<field name=\"%s\" start=\"%" PRIu32 "\" end=\"%" PRIu32 "\" type=\"%s\" />\n",
2105 field->name, field->bitfield->start, field->bitfield->end,
2106 gdb_get_reg_type_name(field->bitfield->type));
2108 field = field->next;
2111 while (field != NULL) {
2112 struct reg_data_type *data_type = field->type;
2113 if (data_type->type == REG_TYPE_ARCH_DEFINED) {
2114 if (lookup_add_arch_defined_types(arch_defined_types_list, data_type->id,
2115 num_arch_defined_types))
2116 gdb_generate_reg_type_description(target, tdesc, pos, size, data_type,
2117 arch_defined_types_list,
2118 num_arch_defined_types);
2123 * <field name="name" type="type"/> ...
2125 xml_printf(&retval, tdesc, pos, size,
2126 "<struct id=\"%s\">\n",
2128 while (field != NULL) {
2129 xml_printf(&retval, tdesc, pos, size,
2130 "<field name=\"%s\" type=\"%s\"/>\n",
2131 field->name, field->type->id);
2133 field = field->next;
2137 xml_printf(&retval, tdesc, pos, size,
2140 } else if (type->type_class == REG_TYPE_CLASS_FLAGS) {
2141 /* <flags id="id" size="size">
2142 * <field name="name" start="start" end="end"/> ...
2144 xml_printf(&retval, tdesc, pos, size,
2145 "<flags id=\"%s\" size=\"%" PRIu32 "\">\n",
2146 type->id, type->reg_type_flags->size);
2148 struct reg_data_type_flags_field *field;
2149 field = type->reg_type_flags->fields;
2150 while (field != NULL) {
2151 xml_printf(&retval, tdesc, pos, size,
2152 "<field name=\"%s\" start=\"%" PRIu32 "\" end=\"%" PRIu32 "\" type=\"%s\" />\n",
2153 field->name, field->bitfield->start, field->bitfield->end,
2154 gdb_get_reg_type_name(field->bitfield->type));
2156 field = field->next;
2159 xml_printf(&retval, tdesc, pos, size,
2167 /* Get a list of available target registers features. feature_list must
2168 * be freed by caller.
2170 static int get_reg_features_list(struct target *target, char const **feature_list[], int *feature_list_size,
2171 struct reg **reg_list, int reg_list_size)
2175 /* Start with only one element */
2176 *feature_list = calloc(1, sizeof(char *));
2178 for (int i = 0; i < reg_list_size; i++) {
2179 if (reg_list[i]->exist == false)
2182 if (reg_list[i]->feature != NULL
2183 && reg_list[i]->feature->name != NULL
2184 && (strcmp(reg_list[i]->feature->name, ""))) {
2185 /* We found a feature, check if the feature is already in the
2186 * table. If not, allocate a new entry for the table and
2187 * put the new feature in it.
2189 for (int j = 0; j < (tbl_sz + 1); j++) {
2190 if (!((*feature_list)[j])) {
2191 (*feature_list)[tbl_sz++] = reg_list[i]->feature->name;
2192 *feature_list = realloc(*feature_list, sizeof(char *) * (tbl_sz + 1));
2193 (*feature_list)[tbl_sz] = NULL;
2196 if (!strcmp((*feature_list)[j], reg_list[i]->feature->name))
2203 if (feature_list_size)
2204 *feature_list_size = tbl_sz;
2209 static int gdb_generate_target_description(struct target *target, char **tdesc_out)
2211 int retval = ERROR_OK;
2212 struct reg **reg_list = NULL;
2214 char const *architecture;
2215 char const **features = NULL;
2216 int feature_list_size = 0;
2222 retval = target_get_gdb_reg_list_noread(target, ®_list,
2223 ®_list_size, REG_CLASS_ALL);
2225 if (retval != ERROR_OK) {
2226 LOG_ERROR("get register list failed");
2227 retval = ERROR_FAIL;
2231 if (reg_list_size <= 0) {
2232 LOG_ERROR("get register list failed");
2233 retval = ERROR_FAIL;
2237 /* Get a list of available target registers features */
2238 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2239 if (retval != ERROR_OK) {
2240 LOG_ERROR("Can't get the registers feature list");
2241 retval = ERROR_FAIL;
2245 /* If we found some features associated with registers, create sections */
2246 int current_feature = 0;
2248 xml_printf(&retval, &tdesc, &pos, &size,
2249 "<?xml version=\"1.0\"?>\n"
2250 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2251 "<target version=\"1.0\">\n");
2253 /* generate architecture element if supported by target */
2254 architecture = target_get_gdb_arch(target);
2255 if (architecture != NULL)
2256 xml_printf(&retval, &tdesc, &pos, &size,
2257 "<architecture>%s</architecture>\n", architecture);
2259 /* generate target description according to register list */
2260 if (features != NULL) {
2261 while (features[current_feature]) {
2262 char const **arch_defined_types = NULL;
2263 int num_arch_defined_types = 0;
2265 arch_defined_types = calloc(1, sizeof(char *));
2266 xml_printf(&retval, &tdesc, &pos, &size,
2267 "<feature name=\"%s\">\n",
2268 features[current_feature]);
2271 for (i = 0; i < reg_list_size; i++) {
2273 if (reg_list[i]->exist == false)
2276 if (strcmp(reg_list[i]->feature->name, features[current_feature]))
2279 const char *type_str;
2280 if (reg_list[i]->reg_data_type != NULL) {
2281 if (reg_list[i]->reg_data_type->type == REG_TYPE_ARCH_DEFINED) {
2282 /* generate <type... first, if there are architecture-defined types. */
2283 if (lookup_add_arch_defined_types(&arch_defined_types,
2284 reg_list[i]->reg_data_type->id,
2285 &num_arch_defined_types))
2286 gdb_generate_reg_type_description(target, &tdesc, &pos, &size,
2287 reg_list[i]->reg_data_type,
2288 &arch_defined_types,
2289 &num_arch_defined_types);
2291 type_str = reg_list[i]->reg_data_type->id;
2293 /* predefined type */
2294 type_str = gdb_get_reg_type_name(
2295 reg_list[i]->reg_data_type->type);
2298 /* Default type is "int" */
2302 xml_printf(&retval, &tdesc, &pos, &size,
2303 "<reg name=\"%s\"", reg_list[i]->name);
2304 xml_printf(&retval, &tdesc, &pos, &size,
2305 " bitsize=\"%" PRIu32 "\"", reg_list[i]->size);
2306 xml_printf(&retval, &tdesc, &pos, &size,
2307 " regnum=\"%" PRIu32 "\"", reg_list[i]->number);
2308 if (reg_list[i]->caller_save)
2309 xml_printf(&retval, &tdesc, &pos, &size,
2310 " save-restore=\"yes\"");
2312 xml_printf(&retval, &tdesc, &pos, &size,
2313 " save-restore=\"no\"");
2315 xml_printf(&retval, &tdesc, &pos, &size,
2316 " type=\"%s\"", type_str);
2318 if (reg_list[i]->group != NULL)
2319 xml_printf(&retval, &tdesc, &pos, &size,
2320 " group=\"%s\"", reg_list[i]->group);
2322 xml_printf(&retval, &tdesc, &pos, &size,
2326 xml_printf(&retval, &tdesc, &pos, &size,
2330 free(arch_defined_types);
2334 xml_printf(&retval, &tdesc, &pos, &size,
2341 if (retval == ERROR_OK)
2349 static int gdb_get_target_description_chunk(struct target *target, struct target_desc_format *target_desc,
2350 char **chunk, int32_t offset, uint32_t length)
2352 if (target_desc == NULL) {
2353 LOG_ERROR("Unable to Generate Target Description");
2357 char *tdesc = target_desc->tdesc;
2358 uint32_t tdesc_length = target_desc->tdesc_length;
2360 if (tdesc == NULL) {
2361 int retval = gdb_generate_target_description(target, &tdesc);
2362 if (retval != ERROR_OK) {
2363 LOG_ERROR("Unable to Generate Target Description");
2367 tdesc_length = strlen(tdesc);
2372 if (length < (tdesc_length - offset))
2373 transfer_type = 'm';
2375 transfer_type = 'l';
2377 *chunk = malloc(length + 2);
2378 if (*chunk == NULL) {
2379 LOG_ERROR("Unable to allocate memory");
2383 (*chunk)[0] = transfer_type;
2384 if (transfer_type == 'm') {
2385 strncpy((*chunk) + 1, tdesc + offset, length);
2386 (*chunk)[1 + length] = '\0';
2388 strncpy((*chunk) + 1, tdesc + offset, tdesc_length - offset);
2389 (*chunk)[1 + (tdesc_length - offset)] = '\0';
2391 /* After gdb-server sends out last chunk, invalidate tdesc. */
2397 target_desc->tdesc = tdesc;
2398 target_desc->tdesc_length = tdesc_length;
2403 static int gdb_target_description_supported(struct target *target, int *supported)
2405 int retval = ERROR_OK;
2406 struct reg **reg_list = NULL;
2407 int reg_list_size = 0;
2408 char const **features = NULL;
2409 int feature_list_size = 0;
2411 char const *architecture = target_get_gdb_arch(target);
2413 retval = target_get_gdb_reg_list_noread(target, ®_list,
2414 ®_list_size, REG_CLASS_ALL);
2415 if (retval != ERROR_OK) {
2416 LOG_ERROR("get register list failed");
2420 if (reg_list_size <= 0) {
2421 LOG_ERROR("get register list failed");
2422 retval = ERROR_FAIL;
2426 /* Get a list of available target registers features */
2427 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2428 if (retval != ERROR_OK) {
2429 LOG_ERROR("Can't get the registers feature list");
2434 if (architecture || feature_list_size)
2448 static int gdb_generate_thread_list(struct target *target, char **thread_list_out)
2450 struct rtos *rtos = target->rtos;
2451 int retval = ERROR_OK;
2452 char *thread_list = NULL;
2456 xml_printf(&retval, &thread_list, &pos, &size,
2457 "<?xml version=\"1.0\"?>\n"
2461 for (int i = 0; i < rtos->thread_count; i++) {
2462 struct thread_detail *thread_detail = &rtos->thread_details[i];
2464 if (!thread_detail->exists)
2467 xml_printf(&retval, &thread_list, &pos, &size,
2468 "<thread id=\"%" PRIx64 "\">", thread_detail->threadid);
2470 if (thread_detail->thread_name_str != NULL)
2471 xml_printf(&retval, &thread_list, &pos, &size,
2472 "Name: %s", thread_detail->thread_name_str);
2474 if (thread_detail->extra_info_str != NULL) {
2475 if (thread_detail->thread_name_str != NULL)
2476 xml_printf(&retval, &thread_list, &pos, &size,
2478 xml_printf(&retval, &thread_list, &pos, &size,
2479 "%s", thread_detail->extra_info_str);
2482 xml_printf(&retval, &thread_list, &pos, &size,
2487 xml_printf(&retval, &thread_list, &pos, &size,
2490 if (retval == ERROR_OK)
2491 *thread_list_out = thread_list;
2498 static int gdb_get_thread_list_chunk(struct target *target, char **thread_list,
2499 char **chunk, int32_t offset, uint32_t length)
2501 if (*thread_list == NULL) {
2502 int retval = gdb_generate_thread_list(target, thread_list);
2503 if (retval != ERROR_OK) {
2504 LOG_ERROR("Unable to Generate Thread List");
2509 size_t thread_list_length = strlen(*thread_list);
2512 length = MIN(length, thread_list_length - offset);
2513 if (length < (thread_list_length - offset))
2514 transfer_type = 'm';
2516 transfer_type = 'l';
2518 *chunk = malloc(length + 2 + 3);
2519 /* Allocating extra 3 bytes prevents false positive valgrind report
2520 * of strlen(chunk) word access:
2521 * Invalid read of size 4
2522 * Address 0x4479934 is 44 bytes inside a block of size 45 alloc'd */
2523 if (*chunk == NULL) {
2524 LOG_ERROR("Unable to allocate memory");
2528 (*chunk)[0] = transfer_type;
2529 strncpy((*chunk) + 1, (*thread_list) + offset, length);
2530 (*chunk)[1 + length] = '\0';
2532 /* After gdb-server sends out last chunk, invalidate thread list. */
2533 if (transfer_type == 'l') {
2535 *thread_list = NULL;
2541 static int gdb_query_packet(struct connection *connection,
2542 char const *packet, int packet_size)
2544 struct command_context *cmd_ctx = connection->cmd_ctx;
2545 struct gdb_connection *gdb_connection = connection->priv;
2546 struct target *target = get_target_from_connection(connection);
2548 if (strncmp(packet, "qRcmd,", 6) == 0) {
2549 if (packet_size > 6) {
2551 cmd = malloc((packet_size - 6) / 2 + 1);
2552 size_t len = unhexify((uint8_t *)cmd, packet + 6, (packet_size - 6) / 2);
2555 /* We want to print all debug output to GDB connection */
2556 log_add_callback(gdb_log_callback, connection);
2557 target_call_timer_callbacks_now();
2558 /* some commands need to know the GDB connection, make note of current
2559 * GDB connection. */
2560 current_gdb_connection = gdb_connection;
2561 command_run_line(cmd_ctx, cmd);
2562 current_gdb_connection = NULL;
2563 target_call_timer_callbacks_now();
2564 log_remove_callback(gdb_log_callback, connection);
2567 gdb_put_packet(connection, "OK", 2);
2569 } else if (strncmp(packet, "qCRC:", 5) == 0) {
2570 if (packet_size > 5) {
2575 target_addr_t addr = 0;
2578 /* skip command character */
2581 addr = strtoull(packet, &separator, 16);
2583 if (*separator != ',') {
2584 LOG_ERROR("incomplete read memory packet received, dropping connection");
2585 return ERROR_SERVER_REMOTE_CLOSED;
2588 len = strtoul(separator + 1, NULL, 16);
2590 retval = target_checksum_memory(target, addr, len, &checksum);
2592 if (retval == ERROR_OK) {
2593 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
2594 gdb_put_packet(connection, gdb_reply, 9);
2596 retval = gdb_error(connection, retval);
2597 if (retval != ERROR_OK)
2603 } else if (strncmp(packet, "qSupported", 10) == 0) {
2604 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2605 * qXfer:features:read is supported for some targets */
2606 int retval = ERROR_OK;
2607 char *buffer = NULL;
2610 int gdb_target_desc_supported = 0;
2612 /* we need to test that the target supports target descriptions */
2613 retval = gdb_target_description_supported(target, &gdb_target_desc_supported);
2614 if (retval != ERROR_OK) {
2615 LOG_INFO("Failed detecting Target Description Support, disabling");
2616 gdb_target_desc_supported = 0;
2619 /* support may be disabled globally */
2620 if (gdb_use_target_description == 0) {
2621 if (gdb_target_desc_supported)
2622 LOG_WARNING("Target Descriptions Supported, but disabled");
2623 gdb_target_desc_supported = 0;
2630 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;qXfer:threads:read+;QStartNoAckMode+;vContSupported+",
2632 ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2633 (gdb_target_desc_supported == 1) ? '+' : '-');
2635 if (retval != ERROR_OK) {
2636 gdb_send_error(connection, 01);
2640 gdb_put_packet(connection, buffer, strlen(buffer));
2644 } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0)
2645 && (flash_get_bank_count() > 0))
2646 return gdb_memory_map(connection, packet, packet_size);
2647 else if (strncmp(packet, "qXfer:features:read:", 20) == 0) {
2649 int retval = ERROR_OK;
2652 unsigned int length;
2654 /* skip command character */
2657 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2658 gdb_send_error(connection, 01);
2662 /* Target should prepare correct target description for annex.
2663 * The first character of returned xml is 'm' or 'l'. 'm' for
2664 * there are *more* chunks to transfer. 'l' for it is the *last*
2665 * chunk of target description.
2667 retval = gdb_get_target_description_chunk(target, &gdb_connection->target_desc,
2668 &xml, offset, length);
2669 if (retval != ERROR_OK) {
2670 gdb_error(connection, retval);
2674 gdb_put_packet(connection, xml, strlen(xml));
2678 } else if (strncmp(packet, "qXfer:threads:read:", 19) == 0) {
2680 int retval = ERROR_OK;
2683 unsigned int length;
2685 /* skip command character */
2688 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2689 gdb_send_error(connection, 01);
2693 /* Target should prepare correct thread list for annex.
2694 * The first character of returned xml is 'm' or 'l'. 'm' for
2695 * there are *more* chunks to transfer. 'l' for it is the *last*
2696 * chunk of target description.
2698 retval = gdb_get_thread_list_chunk(target, &gdb_connection->thread_list,
2699 &xml, offset, length);
2700 if (retval != ERROR_OK) {
2701 gdb_error(connection, retval);
2705 gdb_put_packet(connection, xml, strlen(xml));
2709 } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) {
2710 gdb_connection->noack_mode = 1;
2711 gdb_put_packet(connection, "OK", 2);
2715 gdb_put_packet(connection, "", 0);
2719 static bool gdb_handle_vcont_packet(struct connection *connection, const char *packet, int packet_size)
2721 struct gdb_connection *gdb_connection = connection->priv;
2722 struct target *target = get_target_from_connection(connection);
2723 const char *parse = packet;
2726 /* query for vCont supported */
2727 if (parse[0] == '?') {
2728 if (target->type->step != NULL) {
2729 /* gdb doesn't accept c without C and s without S */
2730 gdb_put_packet(connection, "vCont;c;C;s;S", 13);
2736 if (parse[0] == ';') {
2741 /* simple case, a continue packet */
2742 if (parse[0] == 'c') {
2743 gdb_running_type = 'c';
2744 LOG_DEBUG("target %s continue", target_name(target));
2745 log_add_callback(gdb_log_callback, connection);
2746 retval = target_resume(target, 1, 0, 0, 0);
2747 if (retval == ERROR_TARGET_NOT_HALTED)
2748 LOG_INFO("target %s was not halted when resume was requested", target_name(target));
2750 /* poll target in an attempt to make its internal state consistent */
2751 if (retval != ERROR_OK) {
2752 retval = target_poll(target);
2753 if (retval != ERROR_OK)
2754 LOG_DEBUG("error polling target %s after failed resume", target_name(target));
2758 * We don't report errors to gdb here, move frontend_state to
2759 * TARGET_RUNNING to stay in sync with gdb's expectation of the
2762 gdb_connection->frontend_state = TARGET_RUNNING;
2763 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2768 /* single-step or step-over-breakpoint */
2769 if (parse[0] == 's') {
2770 gdb_running_type = 's';
2771 bool fake_step = false;
2773 if (strncmp(parse, "s:", 2) == 0) {
2774 struct target *ct = target;
2782 thread_id = strtoll(parse, &endp, 16);
2784 packet_size -= endp - parse;
2788 if (target->rtos != NULL) {
2789 /* FIXME: why is this necessary? rtos state should be up-to-date here already! */
2790 rtos_update_threads(target);
2792 target->rtos->gdb_target_for_threadid(connection, thread_id, &ct);
2795 * check if the thread to be stepped is the current rtos thread
2796 * if not, we must fake the step
2798 if (target->rtos->current_thread != thread_id)
2802 if (parse[0] == ';') {
2806 if (parse[0] == 'c') {
2809 /* check if thread-id follows */
2810 if (parse[0] == ':') {
2814 tid = strtoll(parse, &endp, 16);
2815 if (tid == thread_id) {
2817 * Special case: only step a single thread (core),
2818 * keep the other threads halted. Currently, only
2819 * aarch64 target understands it. Other target types don't
2820 * care (nobody checks the actual value of 'current')
2821 * and it doesn't really matter. This deserves
2822 * a symbolic constant and a formal interface documentation
2825 LOG_DEBUG("request to step current core only");
2826 /* uncomment after checking that indeed other targets are safe */
2833 LOG_DEBUG("target %s single-step thread %"PRIx64, target_name(ct), thread_id);
2834 log_add_callback(gdb_log_callback, connection);
2835 target_call_event_callbacks(ct, TARGET_EVENT_GDB_START);
2838 * work around an annoying gdb behaviour: when the current thread
2839 * is changed in gdb, it assumes that the target can follow and also
2840 * make the thread current. This is an assumption that cannot hold
2841 * for a real target running a multi-threading OS. We just fake
2842 * the step to not trigger an internal error in gdb. See
2843 * https://sourceware.org/bugzilla/show_bug.cgi?id=22925 for details
2847 char sig_reply[128];
2849 LOG_DEBUG("fake step thread %"PRIx64, thread_id);
2851 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply),
2852 "T05thread:%016"PRIx64";", thread_id);
2854 gdb_put_packet(connection, sig_reply, sig_reply_len);
2855 log_remove_callback(gdb_log_callback, connection);
2860 /* support for gdb_sync command */
2861 if (gdb_connection->sync) {
2862 gdb_connection->sync = false;
2863 if (ct->state == TARGET_HALTED) {
2864 LOG_DEBUG("stepi ignored. GDB will now fetch the register state "
2865 "from the target.");
2866 gdb_sig_halted(connection);
2867 log_remove_callback(gdb_log_callback, connection);
2869 gdb_connection->frontend_state = TARGET_RUNNING;
2873 retval = target_step(ct, current_pc, 0, 0);
2874 if (retval == ERROR_TARGET_NOT_HALTED)
2875 LOG_INFO("target %s was not halted when step was requested", target_name(ct));
2877 /* if step was successful send a reply back to gdb */
2878 if (retval == ERROR_OK) {
2879 retval = target_poll(ct);
2880 if (retval != ERROR_OK)
2881 LOG_DEBUG("error polling target %s after successful step", target_name(ct));
2882 /* send back signal information */
2883 gdb_signal_reply(ct, connection);
2884 /* stop forwarding log packets! */
2885 log_remove_callback(gdb_log_callback, connection);
2887 gdb_connection->frontend_state = TARGET_RUNNING;
2889 LOG_ERROR("Unknown vCont packet");
2898 static char *next_hex_encoded_field(const char **str, char sep)
2901 const char *hex = *str;
2905 const char *end = strchr(hex, sep);
2907 hexlen = strlen(hex);
2910 *str = hex + hexlen + 1;
2912 if (hexlen % 2 != 0) {
2913 /* Malformed hex data */
2917 size_t count = hexlen / 2;
2918 char *decoded = malloc(count + 1);
2919 if (decoded == NULL)
2922 size_t converted = unhexify((void *)decoded, hex, count);
2923 if (converted != count) {
2928 decoded[count] = '\0';
2932 /* handle extended restart packet */
2933 static void gdb_restart_inferior(struct connection *connection, const char *packet, int packet_size)
2935 struct gdb_connection *gdb_con = connection->priv;
2936 struct target *target = get_target_from_connection(connection);
2938 breakpoint_clear_target(target);
2939 watchpoint_clear_target(target);
2940 command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s",
2941 target_name(target));
2942 /* set connection as attached after reset */
2943 gdb_con->attached = true;
2944 /* info rtos parts */
2945 gdb_thread_packet(connection, packet, packet_size);
2948 static bool gdb_handle_vrun_packet(struct connection *connection, const char *packet, int packet_size)
2950 struct target *target = get_target_from_connection(connection);
2951 const char *parse = packet;
2956 if (parse[0] != ';')
2960 /* Skip first field "filename"; don't know what to do with it. */
2961 free(next_hex_encoded_field(&parse, ';'));
2963 char *cmdline = next_hex_encoded_field(&parse, ';');
2965 while (cmdline != NULL && (arg = next_hex_encoded_field(&parse, ';')) != NULL) {
2966 char *new_cmdline = alloc_printf("%s %s", cmdline, arg);
2969 cmdline = new_cmdline;
2972 if (cmdline != NULL) {
2973 if (target->semihosting != NULL) {
2974 LOG_INFO("GDB set inferior command line to '%s'", cmdline);
2975 free(target->semihosting->cmdline);
2976 target->semihosting->cmdline = cmdline;
2978 LOG_INFO("GDB set inferior command line to '%s' but semihosting is unavailable", cmdline);
2983 gdb_restart_inferior(connection, packet, packet_size);
2984 gdb_put_packet(connection, "S00", 3);
2988 static int gdb_v_packet(struct connection *connection,
2989 char const *packet, int packet_size)
2991 struct gdb_connection *gdb_connection = connection->priv;
2994 struct target *target = get_target_from_connection(connection);
2996 if (strncmp(packet, "vCont", 5) == 0) {
3002 handled = gdb_handle_vcont_packet(connection, packet, packet_size);
3004 gdb_put_packet(connection, "", 0);
3009 if (strncmp(packet, "vRun", 4) == 0) {
3012 handled = gdb_handle_vrun_packet(connection, packet, packet_size);
3014 gdb_put_packet(connection, "", 0);
3019 /* if flash programming disabled - send a empty reply */
3021 if (gdb_flash_program == 0) {
3022 gdb_put_packet(connection, "", 0);
3026 if (strncmp(packet, "vFlashErase:", 12) == 0) {
3028 unsigned long length;
3030 char const *parse = packet + 12;
3031 if (*parse == '\0') {
3032 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3033 return ERROR_SERVER_REMOTE_CLOSED;
3036 addr = strtoul(parse, (char **)&parse, 16);
3038 if (*(parse++) != ',' || *parse == '\0') {
3039 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3040 return ERROR_SERVER_REMOTE_CLOSED;
3043 length = strtoul(parse, (char **)&parse, 16);
3045 if (*parse != '\0') {
3046 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3047 return ERROR_SERVER_REMOTE_CLOSED;
3050 /* assume all sectors need erasing - stops any problems
3051 * when flash_write is called multiple times */
3054 /* perform any target specific operations before the erase */
3055 target_call_event_callbacks(target,
3056 TARGET_EVENT_GDB_FLASH_ERASE_START);
3058 /* vFlashErase:addr,length messages require region start and
3059 * end to be "block" aligned ... if padding is ever needed,
3060 * GDB will have become dangerously confused.
3062 result = flash_erase_address_range(target, false, addr,
3065 /* perform any target specific operations after the erase */
3066 target_call_event_callbacks(target,
3067 TARGET_EVENT_GDB_FLASH_ERASE_END);
3070 if (result != ERROR_OK) {
3071 /* GDB doesn't evaluate the actual error number returned,
3072 * treat a failed erase as an I/O error
3074 gdb_send_error(connection, EIO);
3075 LOG_ERROR("flash_erase returned %i", result);
3077 gdb_put_packet(connection, "OK", 2);
3082 if (strncmp(packet, "vFlashWrite:", 12) == 0) {
3085 unsigned long length;
3086 char const *parse = packet + 12;
3088 if (*parse == '\0') {
3089 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3090 return ERROR_SERVER_REMOTE_CLOSED;
3092 addr = strtoul(parse, (char **)&parse, 16);
3093 if (*(parse++) != ':') {
3094 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
3095 return ERROR_SERVER_REMOTE_CLOSED;
3097 length = packet_size - (parse - packet);
3099 /* create a new image if there isn't already one */
3100 if (gdb_connection->vflash_image == NULL) {
3101 gdb_connection->vflash_image = malloc(sizeof(struct image));
3102 image_open(gdb_connection->vflash_image, "", "build");
3105 /* create new section with content from packet buffer */
3106 retval = image_add_section(gdb_connection->vflash_image,
3107 addr, length, 0x0, (uint8_t const *)parse);
3108 if (retval != ERROR_OK)
3111 gdb_put_packet(connection, "OK", 2);
3116 if (strncmp(packet, "vFlashDone", 10) == 0) {
3119 /* process the flashing buffer. No need to erase as GDB
3120 * always issues a vFlashErase first. */
3121 target_call_event_callbacks(target,
3122 TARGET_EVENT_GDB_FLASH_WRITE_START);
3123 result = flash_write(target, gdb_connection->vflash_image,
3125 target_call_event_callbacks(target,
3126 TARGET_EVENT_GDB_FLASH_WRITE_END);
3127 if (result != ERROR_OK) {
3128 if (result == ERROR_FLASH_DST_OUT_OF_BANK)
3129 gdb_put_packet(connection, "E.memtype", 9);
3131 gdb_send_error(connection, EIO);
3133 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
3134 gdb_put_packet(connection, "OK", 2);
3137 image_close(gdb_connection->vflash_image);
3138 free(gdb_connection->vflash_image);
3139 gdb_connection->vflash_image = NULL;
3144 gdb_put_packet(connection, "", 0);
3148 static int gdb_detach(struct connection *connection)
3151 * Only reply "OK" to GDB
3152 * it will close the connection and this will trigger a call to
3153 * gdb_connection_closed() that will in turn trigger the event
3154 * TARGET_EVENT_GDB_DETACH
3156 return gdb_put_packet(connection, "OK", 2);
3159 /* The format of 'F' response packet is
3160 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3162 static int gdb_fileio_response_packet(struct connection *connection,
3163 char const *packet, int packet_size)
3165 struct target *target = get_target_from_connection(connection);
3167 char *parsing_point;
3168 int fileio_retcode = strtoul(packet + 1, &separator, 16);
3169 int fileio_errno = 0;
3170 bool fileio_ctrl_c = false;
3175 if (*separator == ',') {
3176 parsing_point = separator + 1;
3177 fileio_errno = strtoul(parsing_point, &separator, 16);
3178 if (*separator == ',') {
3179 if (*(separator + 1) == 'C') {
3180 /* TODO: process ctrl-c */
3181 fileio_ctrl_c = true;
3186 LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
3187 fileio_retcode, fileio_errno, fileio_ctrl_c ? "true" : "false");
3189 retval = target_gdb_fileio_end(target, fileio_retcode, fileio_errno, fileio_ctrl_c);
3190 if (retval != ERROR_OK)
3193 /* After File-I/O ends, keep continue or step */
3194 if (gdb_running_type == 'c')
3195 retval = target_resume(target, 1, 0x0, 0, 0);
3196 else if (gdb_running_type == 's')
3197 retval = target_step(target, 1, 0x0, 0);
3199 retval = ERROR_FAIL;
3201 if (retval != ERROR_OK)
3207 static void gdb_log_callback(void *priv, const char *file, unsigned line,
3208 const char *function, const char *string)
3210 struct connection *connection = priv;
3211 struct gdb_connection *gdb_con = connection->priv;
3213 if (gdb_con->busy) {
3214 /* do not reply this using the O packet */
3218 gdb_output_con(connection, string);
3221 static void gdb_sig_halted(struct connection *connection)
3224 snprintf(sig_reply, 4, "T%2.2x", 2);
3225 gdb_put_packet(connection, sig_reply, 3);
3228 static int gdb_input_inner(struct connection *connection)
3230 /* Do not allocate this on the stack */
3231 static char gdb_packet_buffer[GDB_BUFFER_SIZE + 1]; /* Extra byte for null-termination */
3233 struct target *target;
3234 char const *packet = gdb_packet_buffer;
3237 struct gdb_connection *gdb_con = connection->priv;
3238 static bool warn_use_ext;
3240 target = get_target_from_connection(connection);
3242 /* drain input buffer. If one of the packets fail, then an error
3243 * packet is replied, if applicable.
3245 * This loop will terminate and the error code is returned.
3247 * The calling fn will check if this error is something that
3248 * can be recovered from, or if the connection must be closed.
3250 * If the error is recoverable, this fn is called again to
3251 * drain the rest of the buffer.
3254 packet_size = GDB_BUFFER_SIZE;
3255 retval = gdb_get_packet(connection, gdb_packet_buffer, &packet_size);
3256 if (retval != ERROR_OK)
3259 /* terminate with zero */
3260 gdb_packet_buffer[packet_size] = '\0';
3262 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
3263 if (packet[0] == 'X') {
3264 /* binary packets spew junk into the debug log stream */
3267 for (x = 0; (x < 49) && (packet[x] != ':'); x++)
3270 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
3272 LOG_DEBUG("received packet: '%s'", packet);
3275 if (packet_size > 0) {
3277 switch (packet[0]) {
3278 case 'T': /* Is thread alive? */
3279 gdb_thread_packet(connection, packet, packet_size);
3281 case 'H': /* Set current thread ( 'c' for step and continue,
3282 * 'g' for all other operations ) */
3283 gdb_thread_packet(connection, packet, packet_size);
3287 retval = gdb_thread_packet(connection, packet, packet_size);
3288 if (retval == GDB_THREAD_PACKET_NOT_CONSUMED)
3289 retval = gdb_query_packet(connection, packet, packet_size);
3292 retval = gdb_get_registers_packet(connection, packet, packet_size);
3295 retval = gdb_set_registers_packet(connection, packet, packet_size);
3298 retval = gdb_get_register_packet(connection, packet, packet_size);
3301 retval = gdb_set_register_packet(connection, packet, packet_size);
3304 retval = gdb_read_memory_packet(connection, packet, packet_size);
3307 retval = gdb_write_memory_packet(connection, packet, packet_size);
3311 retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size);
3314 gdb_last_signal_packet(connection, packet, packet_size);
3315 /* '?' is sent after the eventual '!' */
3316 if (!warn_use_ext && !gdb_con->extended_protocol) {
3317 warn_use_ext = true;
3318 LOG_WARNING("Prefer GDB command \"target extended-remote %s\" instead of \"target remote %s\"",
3319 connection->service->port, connection->service->port);
3325 gdb_thread_packet(connection, packet, packet_size);
3326 log_add_callback(gdb_log_callback, connection);
3328 if (gdb_con->mem_write_error) {
3329 LOG_ERROR("Memory write failure!");
3331 /* now that we have reported the memory write error,
3332 * we can clear the condition */
3333 gdb_con->mem_write_error = false;
3336 bool nostep = false;
3337 bool already_running = false;
3338 if (target->state == TARGET_RUNNING) {
3339 LOG_WARNING("WARNING! The target is already running. "
3340 "All changes GDB did to registers will be discarded! "
3341 "Waiting for target to halt.");
3342 already_running = true;
3343 } else if (target->state != TARGET_HALTED) {
3344 LOG_WARNING("The target is not in the halted nor running stated, "
3345 "stepi/continue ignored.");
3347 } else if ((packet[0] == 's') && gdb_con->sync) {
3348 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
3349 * sent by GDB first to OpenOCD, thus defeating the check to
3350 * make only the single stepping have the sync feature...
3353 LOG_DEBUG("stepi ignored. GDB will now fetch the register state "
3354 "from the target.");
3356 gdb_con->sync = false;
3358 if (!already_running && nostep) {
3359 /* Either the target isn't in the halted state, then we can't
3360 * step/continue. This might be early setup, etc.
3362 * Or we want to allow GDB to pick up a fresh set of
3363 * register values without modifying the target state.
3366 gdb_sig_halted(connection);
3368 /* stop forwarding log packets! */
3369 log_remove_callback(gdb_log_callback, connection);
3371 /* We're running/stepping, in which case we can
3372 * forward log output until the target is halted
3374 gdb_con->frontend_state = TARGET_RUNNING;
3375 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
3377 if (!already_running) {
3378 /* Here we don't want packet processing to stop even if this fails,
3379 * so we use a local variable instead of retval. */
3380 retval = gdb_step_continue_packet(connection, packet, packet_size);
3381 if (retval != ERROR_OK) {
3382 /* we'll never receive a halted
3383 * condition... issue a false one..
3385 gdb_frontend_halted(target, connection);
3392 retval = gdb_v_packet(connection, packet, packet_size);
3395 retval = gdb_detach(connection);
3398 retval = gdb_write_memory_binary_packet(connection, packet, packet_size);
3399 if (retval != ERROR_OK)
3403 if (gdb_con->extended_protocol) {
3404 gdb_con->attached = false;
3407 gdb_put_packet(connection, "OK", 2);
3408 return ERROR_SERVER_REMOTE_CLOSED;
3410 /* handle extended remote protocol */
3411 gdb_con->extended_protocol = true;
3412 gdb_put_packet(connection, "OK", 2);
3415 /* handle extended restart packet */
3416 gdb_restart_inferior(connection, packet, packet_size);
3420 /* packet supported only by smp target i.e cortex_a.c*/
3421 /* handle smp packet replying coreid played to gbd */
3422 gdb_read_smp_packet(connection, packet, packet_size);
3426 /* packet supported only by smp target i.e cortex_a.c */
3427 /* handle smp packet setting coreid to be played at next
3429 gdb_write_smp_packet(connection, packet, packet_size);
3433 /* File-I/O extension */
3434 /* After gdb uses host-side syscall to complete target file
3435 * I/O, gdb sends host-side syscall return value to target
3437 * The format of 'F' response packet is
3438 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3440 gdb_con->frontend_state = TARGET_RUNNING;
3441 log_add_callback(gdb_log_callback, connection);
3442 gdb_fileio_response_packet(connection, packet, packet_size);
3446 /* ignore unknown packets */
3447 LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
3448 gdb_put_packet(connection, "", 0);
3452 /* if a packet handler returned an error, exit input loop */
3453 if (retval != ERROR_OK)
3457 if (gdb_con->ctrl_c) {
3458 if (target->state == TARGET_RUNNING) {
3459 struct target *t = target;
3461 target->rtos->gdb_target_for_threadid(connection, target->rtos->current_threadid, &t);
3462 retval = target_halt(t);
3463 if (retval == ERROR_OK)
3464 retval = target_poll(t);
3465 if (retval != ERROR_OK)
3466 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3467 gdb_con->ctrl_c = false;
3469 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
3470 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3474 } while (gdb_con->buf_cnt > 0);
3479 static int gdb_input(struct connection *connection)
3481 int retval = gdb_input_inner(connection);
3482 struct gdb_connection *gdb_con = connection->priv;
3483 if (retval == ERROR_SERVER_REMOTE_CLOSED)
3486 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
3487 if (gdb_con->closed)
3488 return ERROR_SERVER_REMOTE_CLOSED;
3490 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
3494 static int gdb_target_start(struct target *target, const char *port)
3496 struct gdb_service *gdb_service;
3498 gdb_service = malloc(sizeof(struct gdb_service));
3500 if (NULL == gdb_service)
3503 LOG_INFO("starting gdb server for %s on %s", target_name(target), port);
3505 gdb_service->target = target;
3506 gdb_service->core[0] = -1;
3507 gdb_service->core[1] = -1;
3508 target->gdb_service = gdb_service;
3510 ret = add_service("gdb",
3511 port, 1, &gdb_new_connection, &gdb_input,
3512 &gdb_connection_closed, gdb_service);
3513 /* initialize all targets gdb service with the same pointer */
3515 struct target_list *head;
3516 struct target *curr;
3517 head = target->head;
3518 while (head != (struct target_list *)NULL) {
3519 curr = head->target;
3521 curr->gdb_service = gdb_service;
3528 static int gdb_target_add_one(struct target *target)
3530 /* one gdb instance per smp list */
3531 if ((target->smp) && (target->gdb_service))
3534 /* skip targets that cannot handle a gdb connections (e.g. mem_ap) */
3535 if (!target_supports_gdb_connection(target)) {
3536 LOG_DEBUG("skip gdb server for target %s", target_name(target));
3540 if (target->gdb_port_override) {
3541 if (strcmp(target->gdb_port_override, "disabled") == 0) {
3542 LOG_INFO("gdb port disabled");
3545 return gdb_target_start(target, target->gdb_port_override);
3548 if (strcmp(gdb_port, "disabled") == 0) {
3549 LOG_INFO("gdb port disabled");
3553 int retval = gdb_target_start(target, gdb_port_next);
3554 if (retval == ERROR_OK) {
3555 /* save the port number so can be queried with
3556 * $target_name cget -gdb-port
3558 target->gdb_port_override = strdup(gdb_port_next);
3561 /* If we can parse the port number
3562 * then we increment the port number for the next target.
3565 portnumber = strtol(gdb_port_next, &end, 0);
3567 if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) {
3568 free(gdb_port_next);
3570 gdb_port_next = alloc_printf("%ld", portnumber+1);
3572 /* Don't increment if gdb_port is 0, since we're just
3573 * trying to allocate an unused port. */
3574 gdb_port_next = strdup("0");
3582 int gdb_target_add_all(struct target *target)
3584 if (NULL == target) {
3585 LOG_WARNING("gdb services need one or more targets defined");
3589 while (NULL != target) {
3590 int retval = gdb_target_add_one(target);
3591 if (ERROR_OK != retval)
3594 target = target->next;
3600 COMMAND_HANDLER(handle_gdb_sync_command)
3603 return ERROR_COMMAND_SYNTAX_ERROR;
3605 if (current_gdb_connection == NULL) {
3607 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
3611 current_gdb_connection->sync = true;
3616 /* daemon configuration command gdb_port */
3617 COMMAND_HANDLER(handle_gdb_port_command)
3619 int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
3620 if (ERROR_OK == retval) {
3621 free(gdb_port_next);
3622 gdb_port_next = strdup(gdb_port);
3627 COMMAND_HANDLER(handle_gdb_memory_map_command)
3630 return ERROR_COMMAND_SYNTAX_ERROR;
3632 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
3636 COMMAND_HANDLER(handle_gdb_flash_program_command)
3639 return ERROR_COMMAND_SYNTAX_ERROR;
3641 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
3645 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
3648 return ERROR_COMMAND_SYNTAX_ERROR;
3650 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
3654 COMMAND_HANDLER(handle_gdb_report_register_access_error)
3657 return ERROR_COMMAND_SYNTAX_ERROR;
3659 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_register_access_error);
3663 /* gdb_breakpoint_override */
3664 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
3666 if (CMD_ARGC == 0) {
3668 } else if (CMD_ARGC == 1) {
3669 gdb_breakpoint_override = 1;
3670 if (strcmp(CMD_ARGV[0], "hard") == 0)
3671 gdb_breakpoint_override_type = BKPT_HARD;
3672 else if (strcmp(CMD_ARGV[0], "soft") == 0)
3673 gdb_breakpoint_override_type = BKPT_SOFT;
3674 else if (strcmp(CMD_ARGV[0], "disable") == 0)
3675 gdb_breakpoint_override = 0;
3677 return ERROR_COMMAND_SYNTAX_ERROR;
3678 if (gdb_breakpoint_override)
3679 LOG_USER("force %s breakpoints",
3680 (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft");
3682 LOG_USER("breakpoint type is not overridden");
3687 COMMAND_HANDLER(handle_gdb_target_description_command)
3690 return ERROR_COMMAND_SYNTAX_ERROR;
3692 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_target_description);
3696 COMMAND_HANDLER(handle_gdb_save_tdesc_command)
3699 uint32_t tdesc_length;
3700 struct target *target = get_current_target(CMD_CTX);
3702 int retval = gdb_generate_target_description(target, &tdesc);
3703 if (retval != ERROR_OK) {
3704 LOG_ERROR("Unable to Generate Target Description");
3708 tdesc_length = strlen(tdesc);
3710 struct fileio *fileio;
3711 size_t size_written;
3713 char *tdesc_filename = alloc_printf("%s.xml", target_type_name(target));
3714 if (tdesc_filename == NULL) {
3715 retval = ERROR_FAIL;
3719 retval = fileio_open(&fileio, tdesc_filename, FILEIO_WRITE, FILEIO_TEXT);
3721 if (retval != ERROR_OK) {
3722 LOG_ERROR("Can't open %s for writing", tdesc_filename);
3726 retval = fileio_write(fileio, tdesc_length, tdesc, &size_written);
3728 fileio_close(fileio);
3730 if (retval != ERROR_OK)
3731 LOG_ERROR("Error while writing the tdesc file");
3734 free(tdesc_filename);
3740 static const struct command_registration gdb_command_handlers[] = {
3743 .handler = handle_gdb_sync_command,
3744 .mode = COMMAND_ANY,
3745 .help = "next stepi will return immediately allowing "
3746 "GDB to fetch register state without affecting "
3752 .handler = handle_gdb_port_command,
3753 .mode = COMMAND_CONFIG,
3754 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
3755 "server listens for the next port number after the "
3756 "base port number specified. "
3757 "No arguments reports GDB port. \"pipe\" means listen to stdin "
3758 "output to stdout, an integer is base port number, \"disabled\" disables "
3759 "port. Any other string is are interpreted as named pipe to listen to. "
3760 "Output pipe is the same name as input pipe, but with 'o' appended.",
3761 .usage = "[port_num]",
3764 .name = "gdb_memory_map",
3765 .handler = handle_gdb_memory_map_command,
3766 .mode = COMMAND_CONFIG,
3767 .help = "enable or disable memory map",
3768 .usage = "('enable'|'disable')"
3771 .name = "gdb_flash_program",
3772 .handler = handle_gdb_flash_program_command,
3773 .mode = COMMAND_CONFIG,
3774 .help = "enable or disable flash program",
3775 .usage = "('enable'|'disable')"
3778 .name = "gdb_report_data_abort",
3779 .handler = handle_gdb_report_data_abort_command,
3780 .mode = COMMAND_CONFIG,
3781 .help = "enable or disable reporting data aborts",
3782 .usage = "('enable'|'disable')"
3785 .name = "gdb_report_register_access_error",
3786 .handler = handle_gdb_report_register_access_error,
3787 .mode = COMMAND_CONFIG,
3788 .help = "enable or disable reporting register access errors",
3789 .usage = "('enable'|'disable')"
3792 .name = "gdb_breakpoint_override",
3793 .handler = handle_gdb_breakpoint_override_command,
3794 .mode = COMMAND_ANY,
3795 .help = "Display or specify type of breakpoint "
3796 "to be used by gdb 'break' commands.",
3797 .usage = "('hard'|'soft'|'disable')"
3800 .name = "gdb_target_description",
3801 .handler = handle_gdb_target_description_command,
3802 .mode = COMMAND_CONFIG,
3803 .help = "enable or disable target description",
3804 .usage = "('enable'|'disable')"
3807 .name = "gdb_save_tdesc",
3808 .handler = handle_gdb_save_tdesc_command,
3809 .mode = COMMAND_EXEC,
3810 .help = "Save the target description file",
3813 COMMAND_REGISTRATION_DONE
3816 int gdb_register_commands(struct command_context *cmd_ctx)
3818 gdb_port = strdup("3333");
3819 gdb_port_next = strdup("3333");
3820 return register_commands(cmd_ctx, NULL, gdb_command_handlers);
3823 void gdb_service_free(void)
3826 free(gdb_port_next);