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>
45 #include <flash/nor/core.h>
46 #include "gdb_server.h"
47 #include <target/image.h>
48 #include <jtag/jtag.h>
49 #include "rtos/rtos.h"
50 #include "target/smp.h"
54 * GDB server implementation.
56 * This implements the GDB Remote Serial Protocol, over TCP connections,
57 * giving GDB access to the JTAG or other hardware debugging facilities
58 * found in most modern embedded processors.
61 struct target_desc_format {
63 uint32_t tdesc_length;
66 /* private connection data for GDB */
67 struct gdb_connection {
68 char buffer[GDB_BUFFER_SIZE];
72 enum target_state frontend_state;
73 struct image *vflash_image;
77 /* set flag to true if you want the next stepi to return immediately.
78 * allowing GDB to pick up a fresh set of register values from the target
79 * without modifying the target state. */
81 /* We delay reporting memory write errors until next step/continue or memory
82 * write. This improves performance of gdb load significantly as the GDB packet
83 * can be replied immediately and a new GDB packet will be ready without delay
84 * (ca. 10% or so...). */
86 /* with extended-remote it seems we need to better emulate attach/detach.
87 * what this means is we reply with a W stop reply after a kill packet,
88 * normally we reply with a S reply via gdb_last_signal_packet.
89 * as a side note this behaviour only effects gdb > 6.8 */
91 /* temporarily used for target description support */
92 struct target_desc_format target_desc;
93 /* temporarily used for thread list support */
98 #define _DEBUG_GDB_IO_
101 static struct gdb_connection *current_gdb_connection;
103 static int gdb_breakpoint_override;
104 static enum breakpoint_type gdb_breakpoint_override_type;
106 static int gdb_error(struct connection *connection, int retval);
107 static char *gdb_port;
108 static char *gdb_port_next;
110 static void gdb_log_callback(void *priv, const char *file, unsigned line,
111 const char *function, const char *string);
113 /* number of gdb connections, mainly to suppress gdb related debugging spam
114 * in helper/log.c when no gdb connections are actually active */
115 int gdb_actual_connections;
117 /* set if we are sending a memory map to gdb
118 * via qXfer:memory-map:read packet */
119 /* enabled by default*/
120 static int gdb_use_memory_map = 1;
121 /* enabled by default*/
122 static int gdb_flash_program = 1;
124 /* if set, data aborts cause an error to be reported in memory read packets
125 * see the code in gdb_read_memory_packet() for further explanations.
126 * Disabled by default.
128 static int gdb_report_data_abort;
130 /* set if we are sending target descriptions to gdb
131 * via qXfer:features:read packet */
132 /* enabled by default */
133 static int gdb_use_target_description = 1;
135 /* current processing free-run type, used by file-I/O */
136 static char gdb_running_type;
138 static int gdb_last_signal(struct target *target)
140 switch (target->debug_reason) {
141 case DBG_REASON_DBGRQ:
142 return 0x2; /* SIGINT */
143 case DBG_REASON_BREAKPOINT:
144 case DBG_REASON_WATCHPOINT:
145 case DBG_REASON_WPTANDBKPT:
146 return 0x05; /* SIGTRAP */
147 case DBG_REASON_SINGLESTEP:
148 return 0x05; /* SIGTRAP */
149 case DBG_REASON_NOTHALTED:
150 return 0x0; /* no signal... shouldn't happen */
152 LOG_USER("undefined debug reason %d - target needs reset",
153 target->debug_reason);
158 static int check_pending(struct connection *connection,
159 int timeout_s, int *got_data)
161 /* a non-blocking socket will block if there is 0 bytes available on the socket,
162 * but return with as many bytes as are available immediately
166 struct gdb_connection *gdb_con = connection->priv;
168 if (got_data == NULL)
172 if (gdb_con->buf_cnt > 0) {
178 FD_SET(connection->fd, &read_fds);
180 tv.tv_sec = timeout_s;
182 if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) {
183 /* This can typically be because a "monitor" command took too long
184 * before printing any progress messages
187 return ERROR_GDB_TIMEOUT;
191 *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
195 static int gdb_get_char_inner(struct connection *connection, int *next_char)
197 struct gdb_connection *gdb_con = connection->priv;
198 int retval = ERROR_OK;
200 #ifdef _DEBUG_GDB_IO_
204 if (connection->service->type != CONNECTION_TCP)
205 gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
207 retval = check_pending(connection, 1, NULL);
208 if (retval != ERROR_OK)
210 gdb_con->buf_cnt = read_socket(connection->fd,
215 if (gdb_con->buf_cnt > 0)
217 if (gdb_con->buf_cnt == 0) {
219 return ERROR_SERVER_REMOTE_CLOSED;
223 errno = WSAGetLastError();
229 case WSAECONNABORTED:
231 return ERROR_SERVER_REMOTE_CLOSED;
234 return ERROR_SERVER_REMOTE_CLOSED;
236 LOG_ERROR("read: %d", errno);
246 return ERROR_SERVER_REMOTE_CLOSED;
249 return ERROR_SERVER_REMOTE_CLOSED;
251 LOG_ERROR("read: %s", strerror(errno));
253 return ERROR_SERVER_REMOTE_CLOSED;
258 #ifdef _DEBUG_GDB_IO_
259 debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt);
260 LOG_DEBUG("received '%s'", debug_buffer);
264 gdb_con->buf_p = gdb_con->buffer;
266 *next_char = *(gdb_con->buf_p++);
267 if (gdb_con->buf_cnt > 0)
268 connection->input_pending = 1;
270 connection->input_pending = 0;
271 #ifdef _DEBUG_GDB_IO_
272 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
279 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
280 * held in registers in the inner loop.
282 * For small caches and embedded systems this is important!
284 static inline int gdb_get_char_fast(struct connection *connection,
285 int *next_char, char **buf_p, int *buf_cnt)
287 int retval = ERROR_OK;
289 if ((*buf_cnt)-- > 0) {
290 *next_char = **buf_p;
293 connection->input_pending = 1;
295 connection->input_pending = 0;
297 #ifdef _DEBUG_GDB_IO_
298 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
304 struct gdb_connection *gdb_con = connection->priv;
305 gdb_con->buf_p = *buf_p;
306 gdb_con->buf_cnt = *buf_cnt;
307 retval = gdb_get_char_inner(connection, next_char);
308 *buf_p = gdb_con->buf_p;
309 *buf_cnt = gdb_con->buf_cnt;
314 static int gdb_get_char(struct connection *connection, int *next_char)
316 struct gdb_connection *gdb_con = connection->priv;
317 return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
320 static int gdb_putback_char(struct connection *connection, int last_char)
322 struct gdb_connection *gdb_con = connection->priv;
324 if (gdb_con->buf_p > gdb_con->buffer) {
325 *(--gdb_con->buf_p) = last_char;
328 LOG_ERROR("BUG: couldn't put character back");
333 /* The only way we can detect that the socket is closed is the first time
334 * we write to it, we will fail. Subsequent write operations will
335 * succeed. Shudder! */
336 static int gdb_write(struct connection *connection, void *data, int len)
338 struct gdb_connection *gdb_con = connection->priv;
340 return ERROR_SERVER_REMOTE_CLOSED;
342 if (connection_write(connection, data, len) == len)
345 return ERROR_SERVER_REMOTE_CLOSED;
348 static int gdb_put_packet_inner(struct connection *connection,
349 char *buffer, int len)
352 unsigned char my_checksum = 0;
353 #ifdef _DEBUG_GDB_IO_
358 struct gdb_connection *gdb_con = connection->priv;
360 for (i = 0; i < len; i++)
361 my_checksum += buffer[i];
363 #ifdef _DEBUG_GDB_IO_
365 * At this point we should have nothing in the input queue from GDB,
366 * however sometimes '-' is sent even though we've already received
367 * an ACK (+) for everything we've sent off.
371 retval = check_pending(connection, 0, &gotdata);
372 if (retval != ERROR_OK)
376 retval = gdb_get_char(connection, &reply);
377 if (retval != ERROR_OK)
380 /* fix a problem with some IAR tools */
381 gdb_putback_char(connection, reply);
382 LOG_DEBUG("Unexpected start of new packet");
386 LOG_WARNING("Discard unexpected char %c", reply);
391 #ifdef _DEBUG_GDB_IO_
392 debug_buffer = strndup(buffer, len);
393 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
397 char local_buffer[1024];
398 local_buffer[0] = '$';
399 if ((size_t)len + 4 <= sizeof(local_buffer)) {
400 /* performance gain on smaller packets by only a single call to gdb_write() */
401 memcpy(local_buffer + 1, buffer, len++);
402 len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum);
403 retval = gdb_write(connection, local_buffer, len);
404 if (retval != ERROR_OK)
407 /* larger packets are transmitted directly from caller supplied buffer
408 * by several calls to gdb_write() to avoid dynamic allocation */
409 snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum);
410 retval = gdb_write(connection, local_buffer, 1);
411 if (retval != ERROR_OK)
413 retval = gdb_write(connection, buffer, len);
414 if (retval != ERROR_OK)
416 retval = gdb_write(connection, local_buffer + 1, 3);
417 if (retval != ERROR_OK)
421 if (gdb_con->noack_mode)
424 retval = gdb_get_char(connection, &reply);
425 if (retval != ERROR_OK)
430 else if (reply == '-') {
431 /* Stop sending output packets for now */
432 log_remove_callback(gdb_log_callback, connection);
433 LOG_WARNING("negative reply, retrying");
434 } else if (reply == 0x3) {
436 retval = gdb_get_char(connection, &reply);
437 if (retval != ERROR_OK)
441 else if (reply == '-') {
442 /* Stop sending output packets for now */
443 log_remove_callback(gdb_log_callback, connection);
444 LOG_WARNING("negative reply, retrying");
445 } else if (reply == '$') {
446 LOG_ERROR("GDB missing ack(1) - assumed good");
447 gdb_putback_char(connection, reply);
450 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
452 return ERROR_SERVER_REMOTE_CLOSED;
454 } else if (reply == '$') {
455 LOG_ERROR("GDB missing ack(2) - assumed good");
456 gdb_putback_char(connection, reply);
459 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
462 return ERROR_SERVER_REMOTE_CLOSED;
466 return ERROR_SERVER_REMOTE_CLOSED;
471 int gdb_put_packet(struct connection *connection, char *buffer, int len)
473 struct gdb_connection *gdb_con = connection->priv;
475 int retval = gdb_put_packet_inner(connection, buffer, len);
478 /* we sent some data, reset timer for keep alive messages */
484 static inline int fetch_packet(struct connection *connection,
485 int *checksum_ok, int noack, int *len, char *buffer)
487 unsigned char my_checksum = 0;
490 int retval = ERROR_OK;
492 struct gdb_connection *gdb_con = connection->priv;
497 /* move this over into local variables to use registers and give the
498 * more freedom to optimize */
499 char *buf_p = gdb_con->buf_p;
500 int buf_cnt = gdb_con->buf_cnt;
503 /* The common case is that we have an entire packet with no escape chars.
504 * We need to leave at least 2 bytes in the buffer to have
505 * gdb_get_char() update various bits and bobs correctly.
507 if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) {
508 /* The compiler will struggle a bit with constant propagation and
509 * aliasing, so we help it by showing that these values do not
510 * change inside the loop
514 int run = buf_cnt - 2;
520 if (character == '#') {
521 /* Danger! character can be '#' when esc is
522 * used so we need an explicit boolean for done here. */
527 if (character == '}') {
528 /* data transmitted in binary mode (X packet)
529 * uses 0x7d as escape character */
530 my_checksum += character & 0xff;
533 my_checksum += character & 0xff;
534 buffer[count++] = (character ^ 0x20) & 0xff;
536 my_checksum += character & 0xff;
537 buffer[count++] = character & 0xff;
546 LOG_ERROR("packet buffer too small");
547 retval = ERROR_GDB_BUFFER_TOO_SMALL;
551 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
552 if (retval != ERROR_OK)
555 if (character == '#')
558 if (character == '}') {
559 /* data transmitted in binary mode (X packet)
560 * uses 0x7d as escape character */
561 my_checksum += character & 0xff;
563 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
564 if (retval != ERROR_OK)
567 my_checksum += character & 0xff;
568 buffer[count++] = (character ^ 0x20) & 0xff;
570 my_checksum += character & 0xff;
571 buffer[count++] = character & 0xff;
575 gdb_con->buf_p = buf_p;
576 gdb_con->buf_cnt = buf_cnt;
578 if (retval != ERROR_OK)
583 retval = gdb_get_char(connection, &character);
584 if (retval != ERROR_OK)
586 checksum[0] = character;
587 retval = gdb_get_char(connection, &character);
588 if (retval != ERROR_OK)
590 checksum[1] = character;
594 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
599 static int gdb_get_packet_inner(struct connection *connection,
600 char *buffer, int *len)
604 struct gdb_connection *gdb_con = connection->priv;
608 retval = gdb_get_char(connection, &character);
609 if (retval != ERROR_OK)
612 #ifdef _DEBUG_GDB_IO_
613 LOG_DEBUG("character: '%c'", character);
620 /* According to the GDB documentation
621 * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html):
622 * "gdb sends a final `+` acknowledgment of the stub's `OK`
623 * response, which can be safely ignored by the stub."
624 * However OpenOCD server already is in noack mode at this
625 * point and instead of ignoring this it was emitting a
626 * warning. This code makes server ignore the first ACK
627 * that will be received after going into noack mode,
628 * warning only about subsequent ACK's. */
629 if (gdb_con->noack_mode > 1) {
630 LOG_WARNING("acknowledgment received, but no packet pending");
631 } else if (gdb_con->noack_mode) {
632 LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it.");
633 gdb_con->noack_mode = 2;
637 LOG_WARNING("negative acknowledgment, but no packet pending");
644 LOG_WARNING("ignoring character 0x%x", character);
647 } while (character != '$');
650 /* explicit code expansion here to get faster inlined code in -O3 by not
651 * calculating checksum */
652 if (gdb_con->noack_mode) {
653 retval = fetch_packet(connection, &checksum_ok, 1, len, buffer);
654 if (retval != ERROR_OK)
657 retval = fetch_packet(connection, &checksum_ok, 0, len, buffer);
658 if (retval != ERROR_OK)
662 if (gdb_con->noack_mode) {
663 /* checksum is not checked in noack mode */
667 retval = gdb_write(connection, "+", 1);
668 if (retval != ERROR_OK)
674 return ERROR_SERVER_REMOTE_CLOSED;
679 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
681 struct gdb_connection *gdb_con = connection->priv;
683 int retval = gdb_get_packet_inner(connection, buffer, len);
688 static int gdb_output_con(struct connection *connection, const char *line)
693 bin_size = strlen(line);
695 hex_buffer = malloc(bin_size * 2 + 2);
696 if (hex_buffer == NULL)
697 return ERROR_GDB_BUFFER_TOO_SMALL;
700 size_t pkt_len = hexify(hex_buffer + 1, (const uint8_t *)line, bin_size,
702 int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1);
708 static int gdb_output(struct command_context *context, const char *line)
710 /* this will be dumped to the log and also sent as an O packet if possible */
711 LOG_USER_N("%s", line);
715 static void gdb_signal_reply(struct target *target, struct connection *connection)
717 struct gdb_connection *gdb_connection = connection->priv;
719 char stop_reason[20];
720 char current_thread[25];
724 rtos_update_threads(target);
726 if (target->debug_reason == DBG_REASON_EXIT) {
727 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "W00");
729 if (gdb_connection->ctrl_c) {
731 gdb_connection->ctrl_c = 0;
733 signal_var = gdb_last_signal(target);
735 stop_reason[0] = '\0';
736 if (target->debug_reason == DBG_REASON_WATCHPOINT) {
737 enum watchpoint_rw hit_wp_type;
738 target_addr_t hit_wp_address;
740 if (watchpoint_hit(target, &hit_wp_type, &hit_wp_address) == ERROR_OK) {
742 switch (hit_wp_type) {
744 snprintf(stop_reason, sizeof(stop_reason),
745 "watch:%08" TARGET_PRIxADDR ";", hit_wp_address);
748 snprintf(stop_reason, sizeof(stop_reason),
749 "rwatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
752 snprintf(stop_reason, sizeof(stop_reason),
753 "awatch:%08" TARGET_PRIxADDR ";", hit_wp_address);
761 current_thread[0] = '\0';
762 if (target->rtos != NULL) {
763 snprintf(current_thread, sizeof(current_thread), "thread:%016" PRIx64 ";", target->rtos->current_thread);
764 target->rtos->current_threadid = target->rtos->current_thread;
767 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "T%2.2x%s%s",
768 signal_var, stop_reason, current_thread);
771 gdb_put_packet(connection, sig_reply, sig_reply_len);
772 gdb_connection->frontend_state = TARGET_HALTED;
775 static void gdb_fileio_reply(struct target *target, struct connection *connection)
777 struct gdb_connection *gdb_connection = connection->priv;
778 char fileio_command[256];
780 bool program_exited = false;
782 if (strcmp(target->fileio_info->identifier, "open") == 0)
783 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
784 target->fileio_info->param_1,
785 target->fileio_info->param_2,
786 target->fileio_info->param_3,
787 target->fileio_info->param_4);
788 else if (strcmp(target->fileio_info->identifier, "close") == 0)
789 sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier,
790 target->fileio_info->param_1);
791 else if (strcmp(target->fileio_info->identifier, "read") == 0)
792 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
793 target->fileio_info->param_1,
794 target->fileio_info->param_2,
795 target->fileio_info->param_3);
796 else if (strcmp(target->fileio_info->identifier, "write") == 0)
797 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
798 target->fileio_info->param_1,
799 target->fileio_info->param_2,
800 target->fileio_info->param_3);
801 else if (strcmp(target->fileio_info->identifier, "lseek") == 0)
802 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
803 target->fileio_info->param_1,
804 target->fileio_info->param_2,
805 target->fileio_info->param_3);
806 else if (strcmp(target->fileio_info->identifier, "rename") == 0)
807 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
808 target->fileio_info->param_1,
809 target->fileio_info->param_2,
810 target->fileio_info->param_3,
811 target->fileio_info->param_4);
812 else if (strcmp(target->fileio_info->identifier, "unlink") == 0)
813 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
814 target->fileio_info->param_1,
815 target->fileio_info->param_2);
816 else if (strcmp(target->fileio_info->identifier, "stat") == 0)
817 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32, 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, "fstat") == 0)
822 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
823 target->fileio_info->param_1,
824 target->fileio_info->param_2);
825 else if (strcmp(target->fileio_info->identifier, "gettimeofday") == 0)
826 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
827 target->fileio_info->param_1,
828 target->fileio_info->param_2);
829 else if (strcmp(target->fileio_info->identifier, "isatty") == 0)
830 sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier,
831 target->fileio_info->param_1);
832 else if (strcmp(target->fileio_info->identifier, "system") == 0)
833 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
834 target->fileio_info->param_1,
835 target->fileio_info->param_2);
836 else if (strcmp(target->fileio_info->identifier, "exit") == 0) {
837 /* If target hits exit syscall, report to GDB the program is terminated.
838 * In addition, let target run its own exit syscall handler. */
839 program_exited = true;
840 sprintf(fileio_command, "W%02" PRIx32, target->fileio_info->param_1);
842 LOG_DEBUG("Unknown syscall: %s", target->fileio_info->identifier);
844 /* encounter unknown syscall, continue */
845 gdb_connection->frontend_state = TARGET_RUNNING;
846 target_resume(target, 1, 0x0, 0, 0);
850 command_len = strlen(fileio_command);
851 gdb_put_packet(connection, fileio_command, command_len);
853 if (program_exited) {
854 /* Use target_resume() to let target run its own exit syscall handler. */
855 gdb_connection->frontend_state = TARGET_RUNNING;
856 target_resume(target, 1, 0x0, 0, 0);
858 gdb_connection->frontend_state = TARGET_HALTED;
859 rtos_update_threads(target);
863 static void gdb_frontend_halted(struct target *target, struct connection *connection)
865 struct gdb_connection *gdb_connection = connection->priv;
867 /* In the GDB protocol when we are stepping or continuing execution,
868 * we have a lingering reply. Upon receiving a halted event
869 * when we have that lingering packet, we reply to the original
870 * step or continue packet.
872 * Executing monitor commands can bring the target in and
873 * out of the running state so we'll see lots of TARGET_EVENT_XXX
874 * that are to be ignored.
876 if (gdb_connection->frontend_state == TARGET_RUNNING) {
877 /* stop forwarding log packets! */
878 log_remove_callback(gdb_log_callback, connection);
880 /* check fileio first */
881 if (target_get_gdb_fileio_info(target, target->fileio_info) == ERROR_OK)
882 gdb_fileio_reply(target, connection);
884 gdb_signal_reply(target, connection);
888 static int gdb_target_callback_event_handler(struct target *target,
889 enum target_event event, void *priv)
892 struct connection *connection = priv;
893 struct gdb_service *gdb_service = connection->service->priv;
895 if (gdb_service->target != target)
899 case TARGET_EVENT_GDB_HALT:
900 gdb_frontend_halted(target, connection);
902 case TARGET_EVENT_HALTED:
903 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
905 case TARGET_EVENT_GDB_FLASH_ERASE_START:
906 retval = jtag_execute_queue();
907 if (retval != ERROR_OK)
917 static int gdb_new_connection(struct connection *connection)
919 struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
920 struct target *target;
924 target = get_target_from_connection(connection);
925 connection->priv = gdb_connection;
927 /* initialize gdb connection information */
928 gdb_connection->buf_p = gdb_connection->buffer;
929 gdb_connection->buf_cnt = 0;
930 gdb_connection->ctrl_c = 0;
931 gdb_connection->frontend_state = TARGET_HALTED;
932 gdb_connection->vflash_image = NULL;
933 gdb_connection->closed = 0;
934 gdb_connection->busy = 0;
935 gdb_connection->noack_mode = 0;
936 gdb_connection->sync = false;
937 gdb_connection->mem_write_error = false;
938 gdb_connection->attached = true;
939 gdb_connection->target_desc.tdesc = NULL;
940 gdb_connection->target_desc.tdesc_length = 0;
941 gdb_connection->thread_list = NULL;
943 /* send ACK to GDB for debug request */
944 gdb_write(connection, "+", 1);
946 /* output goes through gdb connection */
947 command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
949 /* we must remove all breakpoints registered to the target as a previous
950 * GDB session could leave dangling breakpoints if e.g. communication
953 breakpoint_clear_target(target);
954 watchpoint_clear_target(target);
956 /* clean previous rtos session if supported*/
957 if ((target->rtos) && (target->rtos->type->clean))
958 target->rtos->type->clean(target);
960 /* remove the initial ACK from the incoming buffer */
961 retval = gdb_get_char(connection, &initial_ack);
962 if (retval != ERROR_OK)
965 /* FIX!!!??? would we actually ever receive a + here???
968 if (initial_ack != '+')
969 gdb_putback_char(connection, initial_ack);
970 target_call_event_callbacks(target, TARGET_EVENT_GDB_ATTACH);
972 if (gdb_use_memory_map) {
973 /* Connect must fail if the memory map can't be set up correctly.
975 * This will cause an auto_probe to be invoked, which is either
976 * a no-op or it will fail when the target isn't ready(e.g. not halted).
979 for (i = 0; i < flash_get_bank_count(); i++) {
980 struct flash_bank *p;
981 p = get_flash_bank_by_num_noprobe(i);
982 if (p->target != target)
984 retval = get_flash_bank_by_num(i, &p);
985 if (retval != ERROR_OK) {
986 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \
987 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
993 gdb_actual_connections++;
994 LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
995 gdb_actual_connections,
997 target_state_name(target));
999 /* DANGER! If we fail subsequently, we must remove this handler,
1000 * otherwise we occasionally see crashes as the timer can invoke the
1003 * register callback to be informed about target events */
1004 target_register_event_callback(gdb_target_callback_event_handler, connection);
1009 static int gdb_connection_closed(struct connection *connection)
1011 struct target *target;
1012 struct gdb_connection *gdb_connection = connection->priv;
1014 target = get_target_from_connection(connection);
1016 /* we're done forwarding messages. Tear down callback before
1017 * cleaning up connection.
1019 log_remove_callback(gdb_log_callback, connection);
1021 gdb_actual_connections--;
1022 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
1023 target_name(target),
1024 target_state_name(target),
1025 gdb_actual_connections);
1027 /* see if an image built with vFlash commands is left */
1028 if (gdb_connection->vflash_image) {
1029 image_close(gdb_connection->vflash_image);
1030 free(gdb_connection->vflash_image);
1031 gdb_connection->vflash_image = NULL;
1034 /* if this connection registered a debug-message receiver delete it */
1035 delete_debug_msg_receiver(connection->cmd_ctx, target);
1037 if (connection->priv) {
1038 free(connection->priv);
1039 connection->priv = NULL;
1041 LOG_ERROR("BUG: connection->priv == NULL");
1043 target_unregister_event_callback(gdb_target_callback_event_handler, connection);
1045 target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
1047 target_call_event_callbacks(target, TARGET_EVENT_GDB_DETACH);
1052 static void gdb_send_error(struct connection *connection, uint8_t the_error)
1055 snprintf(err, 4, "E%2.2X", the_error);
1056 gdb_put_packet(connection, err, 3);
1059 static int gdb_last_signal_packet(struct connection *connection,
1060 char const *packet, int packet_size)
1062 struct target *target = get_target_from_connection(connection);
1063 struct gdb_connection *gdb_con = connection->priv;
1067 if (!gdb_con->attached) {
1068 /* if we are here we have received a kill packet
1069 * reply W stop reply otherwise gdb gets very unhappy */
1070 gdb_put_packet(connection, "W00", 3);
1074 signal_var = gdb_last_signal(target);
1076 snprintf(sig_reply, 4, "S%2.2x", signal_var);
1077 gdb_put_packet(connection, sig_reply, 3);
1082 static inline int gdb_reg_pos(struct target *target, int pos, int len)
1084 if (target->endianness == TARGET_LITTLE_ENDIAN)
1087 return len - 1 - pos;
1090 /* Convert register to string of bytes. NB! The # of bits in the
1091 * register might be non-divisible by 8(a byte), in which
1092 * case an entire byte is shown.
1094 * NB! the format on the wire is the target endianness
1096 * The format of reg->value is little endian
1099 static void gdb_str_to_target(struct target *target,
1100 char *tstr, struct reg *reg)
1107 buf_len = DIV_ROUND_UP(reg->size, 8);
1109 for (i = 0; i < buf_len; i++) {
1110 int j = gdb_reg_pos(target, i, buf_len);
1111 tstr += sprintf(tstr, "%02x", buf[j]);
1115 /* copy over in register buffer */
1116 static void gdb_target_to_reg(struct target *target,
1117 char const *tstr, int str_len, uint8_t *bin)
1120 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1125 for (i = 0; i < str_len; i += 2) {
1127 if (sscanf(tstr + i, "%02x", &t) != 1) {
1128 LOG_ERROR("BUG: unable to convert register value");
1132 int j = gdb_reg_pos(target, i/2, str_len/2);
1137 static int gdb_get_registers_packet(struct connection *connection,
1138 char const *packet, int packet_size)
1140 struct target *target = get_target_from_connection(connection);
1141 struct reg **reg_list;
1144 int reg_packet_size = 0;
1149 #ifdef _DEBUG_GDB_IO_
1153 if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg_list(connection)))
1156 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1158 if (retval != ERROR_OK)
1159 return gdb_error(connection, retval);
1161 for (i = 0; i < reg_list_size; i++)
1162 reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1164 assert(reg_packet_size > 0);
1166 reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */
1167 if (reg_packet == NULL)
1170 reg_packet_p = reg_packet;
1172 for (i = 0; i < reg_list_size; i++) {
1173 if (!reg_list[i]->valid)
1174 reg_list[i]->type->get(reg_list[i]);
1175 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1176 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1179 #ifdef _DEBUG_GDB_IO_
1181 char *reg_packet_p_debug;
1182 reg_packet_p_debug = strndup(reg_packet, reg_packet_size);
1183 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug);
1184 free(reg_packet_p_debug);
1188 gdb_put_packet(connection, reg_packet, reg_packet_size);
1196 static int gdb_set_registers_packet(struct connection *connection,
1197 char const *packet, int packet_size)
1199 struct target *target = get_target_from_connection(connection);
1201 struct reg **reg_list;
1204 char const *packet_p;
1206 #ifdef _DEBUG_GDB_IO_
1210 /* skip command character */
1214 if (packet_size % 2) {
1215 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1216 return ERROR_SERVER_REMOTE_CLOSED;
1219 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1221 if (retval != ERROR_OK)
1222 return gdb_error(connection, retval);
1225 for (i = 0; i < reg_list_size; i++) {
1227 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1229 if (packet_p + chars > packet + packet_size)
1230 LOG_ERROR("BUG: register packet is too small for registers");
1232 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1233 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1235 reg_list[i]->type->set(reg_list[i], bin_buf);
1237 /* advance packet pointer */
1243 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1246 gdb_put_packet(connection, "OK", 2);
1251 static int gdb_get_register_packet(struct connection *connection,
1252 char const *packet, int packet_size)
1254 struct target *target = get_target_from_connection(connection);
1256 int reg_num = strtoul(packet + 1, NULL, 16);
1257 struct reg **reg_list;
1261 #ifdef _DEBUG_GDB_IO_
1265 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1267 if (retval != ERROR_OK)
1268 return gdb_error(connection, retval);
1270 if (reg_list_size <= reg_num) {
1271 LOG_ERROR("gdb requested a non-existing register");
1272 return ERROR_SERVER_REMOTE_CLOSED;
1275 if (!reg_list[reg_num]->valid)
1276 reg_list[reg_num]->type->get(reg_list[reg_num]);
1278 reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1); /* plus one for string termination null */
1280 gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1282 gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1290 static int gdb_set_register_packet(struct connection *connection,
1291 char const *packet, int packet_size)
1293 struct target *target = get_target_from_connection(connection);
1296 int reg_num = strtoul(packet + 1, &separator, 16);
1297 struct reg **reg_list;
1303 retval = target_get_gdb_reg_list(target, ®_list, ®_list_size,
1305 if (retval != ERROR_OK)
1306 return gdb_error(connection, retval);
1308 if (reg_list_size <= reg_num) {
1309 LOG_ERROR("gdb requested a non-existing register");
1310 return ERROR_SERVER_REMOTE_CLOSED;
1313 if (*separator != '=') {
1314 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1315 return ERROR_SERVER_REMOTE_CLOSED;
1318 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1319 bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
1320 int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1322 if ((unsigned int)chars != strlen(separator + 1)) {
1323 LOG_ERROR("gdb sent a packet with wrong register size");
1325 return ERROR_SERVER_REMOTE_CLOSED;
1328 gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1330 reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1332 gdb_put_packet(connection, "OK", 2);
1340 /* No attempt is made to translate the "retval" to
1341 * GDB speak. This has to be done at the calling
1342 * site as no mapping really exists.
1344 static int gdb_error(struct connection *connection, int retval)
1346 LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1347 gdb_send_error(connection, EFAULT);
1351 /* We don't have to worry about the default 2 second timeout for GDB packets,
1352 * because GDB breaks up large memory reads into smaller reads.
1354 * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1356 static int gdb_read_memory_packet(struct connection *connection,
1357 char const *packet, int packet_size)
1359 struct target *target = get_target_from_connection(connection);
1367 int retval = ERROR_OK;
1369 /* skip command character */
1372 addr = strtoull(packet, &separator, 16);
1374 if (*separator != ',') {
1375 LOG_ERROR("incomplete read memory packet received, dropping connection");
1376 return ERROR_SERVER_REMOTE_CLOSED;
1379 len = strtoul(separator + 1, NULL, 16);
1382 LOG_WARNING("invalid read memory packet received (len == 0)");
1383 gdb_put_packet(connection, NULL, 0);
1387 buffer = malloc(len);
1389 LOG_DEBUG("addr: 0x%16.16" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1391 retval = target_read_buffer(target, addr, len, buffer);
1393 if ((retval != ERROR_OK) && !gdb_report_data_abort) {
1394 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1395 * At some point this might be fixed in GDB, in which case this code can be removed.
1397 * OpenOCD developers are acutely aware of this problem, but there is nothing
1398 * gained by involving the user in this problem that hopefully will get resolved
1401 * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1402 * cmd = view%20audit-trail&database = gdb&pr = 2395
1404 * For now, the default is to fix up things to make current GDB versions work.
1405 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1407 memset(buffer, 0, len);
1411 if (retval == ERROR_OK) {
1412 hex_buffer = malloc(len * 2 + 1);
1414 size_t pkt_len = hexify(hex_buffer, buffer, len, len * 2 + 1);
1416 gdb_put_packet(connection, hex_buffer, pkt_len);
1420 retval = gdb_error(connection, retval);
1427 static int gdb_write_memory_packet(struct connection *connection,
1428 char const *packet, int packet_size)
1430 struct target *target = get_target_from_connection(connection);
1438 /* skip command character */
1441 addr = strtoull(packet, &separator, 16);
1443 if (*separator != ',') {
1444 LOG_ERROR("incomplete write memory packet received, dropping connection");
1445 return ERROR_SERVER_REMOTE_CLOSED;
1448 len = strtoul(separator + 1, &separator, 16);
1450 if (*(separator++) != ':') {
1451 LOG_ERROR("incomplete write memory packet received, dropping connection");
1452 return ERROR_SERVER_REMOTE_CLOSED;
1455 buffer = malloc(len);
1457 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1459 if (unhexify(buffer, separator, len) != len)
1460 LOG_ERROR("unable to decode memory packet");
1462 retval = target_write_buffer(target, addr, len, buffer);
1464 if (retval == ERROR_OK)
1465 gdb_put_packet(connection, "OK", 2);
1467 retval = gdb_error(connection, retval);
1474 static int gdb_write_memory_binary_packet(struct connection *connection,
1475 char const *packet, int packet_size)
1477 struct target *target = get_target_from_connection(connection);
1482 int retval = ERROR_OK;
1483 /* Packets larger than fast_limit bytes will be acknowledged instantly on
1484 * the assumption that we're in a download and it's important to go as fast
1486 uint32_t fast_limit = 8;
1488 /* skip command character */
1491 addr = strtoull(packet, &separator, 16);
1493 if (*separator != ',') {
1494 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1495 return ERROR_SERVER_REMOTE_CLOSED;
1498 len = strtoul(separator + 1, &separator, 16);
1500 if (*(separator++) != ':') {
1501 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1502 return ERROR_SERVER_REMOTE_CLOSED;
1505 struct gdb_connection *gdb_connection = connection->priv;
1507 if (gdb_connection->mem_write_error)
1508 retval = ERROR_FAIL;
1510 if (retval == ERROR_OK) {
1511 if (len >= fast_limit) {
1512 /* By replying the packet *immediately* GDB will send us a new packet
1513 * while we write the last one to the target.
1514 * We only do this for larger writes, so that users who do something like:
1515 * p *((int*)0xdeadbeef)=8675309
1516 * will get immediate feedback that that write failed.
1518 gdb_put_packet(connection, "OK", 2);
1521 retval = gdb_error(connection, retval);
1522 /* now that we have reported the memory write error, we can clear the condition */
1523 gdb_connection->mem_write_error = false;
1524 if (retval != ERROR_OK)
1529 LOG_DEBUG("addr: 0x%" PRIx64 ", len: 0x%8.8" PRIx32 "", addr, len);
1531 retval = target_write_buffer(target, addr, len, (uint8_t *)separator);
1532 if (retval != ERROR_OK)
1533 gdb_connection->mem_write_error = true;
1536 if (len < fast_limit) {
1537 if (retval != ERROR_OK) {
1538 gdb_error(connection, retval);
1539 gdb_connection->mem_write_error = false;
1541 gdb_put_packet(connection, "OK", 2);
1548 static int gdb_step_continue_packet(struct connection *connection,
1549 char const *packet, int packet_size)
1551 struct target *target = get_target_from_connection(connection);
1553 uint64_t address = 0x0;
1554 int retval = ERROR_OK;
1558 if (packet_size > 1)
1559 address = strtoull(packet + 1, NULL, 16);
1563 gdb_running_type = packet[0];
1564 if (packet[0] == 'c') {
1565 LOG_DEBUG("continue");
1566 /* resume at current address, don't handle breakpoints, not debugging */
1567 retval = target_resume(target, current, address, 0, 0);
1568 } else if (packet[0] == 's') {
1570 /* step at current or address, don't handle breakpoints */
1571 retval = target_step(target, current, address, 0);
1576 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1577 char const *packet, int packet_size)
1579 struct target *target = get_target_from_connection(connection);
1581 enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1582 enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1590 type = strtoul(packet + 1, &separator, 16);
1592 if (type == 0) /* memory breakpoint */
1593 bp_type = BKPT_SOFT;
1594 else if (type == 1) /* hardware breakpoint */
1595 bp_type = BKPT_HARD;
1596 else if (type == 2) /* write watchpoint */
1597 wp_type = WPT_WRITE;
1598 else if (type == 3) /* read watchpoint */
1600 else if (type == 4) /* access watchpoint */
1601 wp_type = WPT_ACCESS;
1603 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1604 return ERROR_SERVER_REMOTE_CLOSED;
1607 if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD)))
1608 bp_type = gdb_breakpoint_override_type;
1610 if (*separator != ',') {
1611 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1612 return ERROR_SERVER_REMOTE_CLOSED;
1615 address = strtoull(separator + 1, &separator, 16);
1617 if (*separator != ',') {
1618 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1619 return ERROR_SERVER_REMOTE_CLOSED;
1622 size = strtoul(separator + 1, &separator, 16);
1627 if (packet[0] == 'Z') {
1628 retval = breakpoint_add(target, address, size, bp_type);
1629 if (retval != ERROR_OK) {
1630 retval = gdb_error(connection, retval);
1631 if (retval != ERROR_OK)
1634 gdb_put_packet(connection, "OK", 2);
1636 breakpoint_remove(target, address);
1637 gdb_put_packet(connection, "OK", 2);
1644 if (packet[0] == 'Z') {
1645 retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu);
1646 if (retval != ERROR_OK) {
1647 retval = gdb_error(connection, retval);
1648 if (retval != ERROR_OK)
1651 gdb_put_packet(connection, "OK", 2);
1653 watchpoint_remove(target, address);
1654 gdb_put_packet(connection, "OK", 2);
1665 /* print out a string and allocate more space as needed,
1666 * mainly used for XML at this point
1668 static void xml_printf(int *retval, char **xml, int *pos, int *size,
1669 const char *fmt, ...)
1671 if (*retval != ERROR_OK)
1676 if ((*xml == NULL) || (!first)) {
1677 /* start by 0 to exercise all the code paths.
1678 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1680 *size = *size * 2 + 2;
1682 *xml = realloc(*xml, *size);
1686 *retval = ERROR_SERVER_REMOTE_CLOSED;
1694 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1696 if ((ret > 0) && ((ret + 1) < *size - *pos)) {
1700 /* there was just enough or not enough space, allocate more. */
1705 static int decode_xfer_read(char const *buf, char **annex, int *ofs, unsigned int *len)
1707 /* Locate the annex. */
1708 const char *annex_end = strchr(buf, ':');
1709 if (annex_end == NULL)
1712 /* After the read marker and annex, qXfer looks like a
1713 * traditional 'm' packet. */
1715 *ofs = strtoul(annex_end + 1, &separator, 16);
1717 if (*separator != ',')
1720 *len = strtoul(separator + 1, NULL, 16);
1722 /* Extract the annex if needed */
1723 if (annex != NULL) {
1724 *annex = strndup(buf, annex_end - buf);
1732 static int compare_bank(const void *a, const void *b)
1734 struct flash_bank *b1, *b2;
1735 b1 = *((struct flash_bank **)a);
1736 b2 = *((struct flash_bank **)b);
1738 if (b1->base == b2->base)
1740 else if (b1->base > b2->base)
1746 static int gdb_memory_map(struct connection *connection,
1747 char const *packet, int packet_size)
1749 /* We get away with only specifying flash here. Regions that are not
1750 * specified are treated as if we provided no memory map(if not we
1751 * could detect the holes and mark them as RAM).
1752 * Normally we only execute this code once, but no big deal if we
1753 * have to regenerate it a couple of times.
1756 struct target *target = get_target_from_connection(connection);
1757 struct flash_bank *p;
1761 int retval = ERROR_OK;
1762 struct flash_bank **banks;
1766 uint32_t ram_start = 0;
1768 int target_flash_banks = 0;
1770 /* skip command character */
1773 offset = strtoul(packet, &separator, 16);
1774 length = strtoul(separator + 1, &separator, 16);
1776 xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1778 /* Sort banks in ascending order. We need to report non-flash
1779 * memory as ram (or rather read/write) by default for GDB, since
1780 * it has no concept of non-cacheable read/write memory (i/o etc).
1782 * FIXME Most non-flash addresses are *NOT* RAM! Don't lie.
1783 * Current versions of GDB assume unlisted addresses are RAM...
1785 banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1787 for (i = 0; i < flash_get_bank_count(); i++) {
1788 p = get_flash_bank_by_num_noprobe(i);
1789 if (p->target != target)
1791 retval = get_flash_bank_by_num(i, &p);
1792 if (retval != ERROR_OK) {
1794 gdb_error(connection, retval);
1797 banks[target_flash_banks++] = p;
1800 qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1803 for (i = 0; i < target_flash_banks; i++) {
1805 unsigned sector_size = 0;
1811 if (ram_start < p->base)
1812 xml_printf(&retval, &xml, &pos, &size,
1813 "<memory type=\"ram\" start=\"0x%x\" "
1814 "length=\"0x%x\"/>\n",
1815 ram_start, p->base - ram_start);
1817 /* Report adjacent groups of same-size sectors. So for
1818 * example top boot CFI flash will list an initial region
1819 * with several large sectors (maybe 128KB) and several
1820 * smaller ones at the end (maybe 32KB). STR7 will have
1821 * regions with 8KB, 32KB, and 64KB sectors; etc.
1823 for (j = 0; j < p->num_sectors; j++) {
1826 /* Maybe start a new group of sectors. */
1827 if (sector_size == 0) {
1828 start = p->base + p->sectors[j].offset;
1829 xml_printf(&retval, &xml, &pos, &size,
1830 "<memory type=\"flash\" "
1833 sector_size = p->sectors[j].size;
1836 /* Does this finish a group of sectors?
1837 * If not, continue an already-started group.
1839 if (j == p->num_sectors - 1)
1840 group_len = (p->base + p->size) - start;
1841 else if (p->sectors[j + 1].size != sector_size)
1842 group_len = p->base + p->sectors[j + 1].offset
1847 xml_printf(&retval, &xml, &pos, &size,
1848 "length=\"0x%x\">\n"
1849 "<property name=\"blocksize\">"
1857 ram_start = p->base + p->size;
1861 xml_printf(&retval, &xml, &pos, &size,
1862 "<memory type=\"ram\" start=\"0x%x\" "
1863 "length=\"0x%x\"/>\n",
1864 ram_start, 0-ram_start);
1865 /* ELSE a flash chip could be at the very end of the 32 bit address
1866 * space, in which case ram_start will be precisely 0
1872 xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1874 if (retval != ERROR_OK) {
1875 gdb_error(connection, retval);
1879 if (offset + length > pos)
1880 length = pos - offset;
1882 char *t = malloc(length + 1);
1884 memcpy(t + 1, xml + offset, length);
1885 gdb_put_packet(connection, t, length + 1);
1892 static const char *gdb_get_reg_type_name(enum reg_type type)
1899 case REG_TYPE_INT16:
1901 case REG_TYPE_INT32:
1903 case REG_TYPE_INT64:
1905 case REG_TYPE_INT128:
1907 case REG_TYPE_UINT8:
1909 case REG_TYPE_UINT16:
1911 case REG_TYPE_UINT32:
1913 case REG_TYPE_UINT64:
1915 case REG_TYPE_UINT128:
1917 case REG_TYPE_CODE_PTR:
1919 case REG_TYPE_DATA_PTR:
1921 case REG_TYPE_FLOAT:
1923 case REG_TYPE_IEEE_SINGLE:
1924 return "ieee_single";
1925 case REG_TYPE_IEEE_DOUBLE:
1926 return "ieee_double";
1927 case REG_TYPE_ARCH_DEFINED:
1928 return "int"; /* return arbitrary string to avoid compile warning. */
1931 return "int"; /* "int" as default value */
1934 static int gdb_generate_reg_type_description(struct target *target,
1935 char **tdesc, int *pos, int *size, struct reg_data_type *type)
1937 int retval = ERROR_OK;
1939 if (type->type_class == REG_TYPE_CLASS_VECTOR) {
1940 /* <vector id="id" type="type" count="count"/> */
1941 xml_printf(&retval, tdesc, pos, size,
1942 "<vector id=\"%s\" type=\"%s\" count=\"%d\"/>\n",
1943 type->id, type->reg_type_vector->type->id,
1944 type->reg_type_vector->count);
1946 } else if (type->type_class == REG_TYPE_CLASS_UNION) {
1948 * <field name="name" type="type"/> ...
1950 xml_printf(&retval, tdesc, pos, size,
1951 "<union id=\"%s\">\n",
1954 struct reg_data_type_union_field *field;
1955 field = type->reg_type_union->fields;
1956 while (field != NULL) {
1957 xml_printf(&retval, tdesc, pos, size,
1958 "<field name=\"%s\" type=\"%s\"/>\n",
1959 field->name, field->type->id);
1961 field = field->next;
1964 xml_printf(&retval, tdesc, pos, size,
1967 } else if (type->type_class == REG_TYPE_CLASS_STRUCT) {
1968 struct reg_data_type_struct_field *field;
1969 field = type->reg_type_struct->fields;
1971 if (field->use_bitfields) {
1972 /* <struct id="id" size="size">
1973 * <field name="name" start="start" end="end"/> ...
1975 xml_printf(&retval, tdesc, pos, size,
1976 "<struct id=\"%s\" size=\"%d\">\n",
1977 type->id, type->reg_type_struct->size);
1978 while (field != NULL) {
1979 xml_printf(&retval, tdesc, pos, size,
1980 "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
1981 field->name, field->bitfield->start,
1982 field->bitfield->end);
1984 field = field->next;
1988 * <field name="name" type="type"/> ...
1990 xml_printf(&retval, tdesc, pos, size,
1991 "<struct id=\"%s\">\n",
1993 while (field != NULL) {
1994 xml_printf(&retval, tdesc, pos, size,
1995 "<field name=\"%s\" type=\"%s\"/>\n",
1996 field->name, field->type->id);
1998 field = field->next;
2002 xml_printf(&retval, tdesc, pos, size,
2005 } else if (type->type_class == REG_TYPE_CLASS_FLAGS) {
2006 /* <flags id="id" size="size">
2007 * <field name="name" start="start" end="end"/> ...
2009 xml_printf(&retval, tdesc, pos, size,
2010 "<flags id=\"%s\" size=\"%d\">\n",
2011 type->id, type->reg_type_flags->size);
2013 struct reg_data_type_flags_field *field;
2014 field = type->reg_type_flags->fields;
2015 while (field != NULL) {
2016 xml_printf(&retval, tdesc, pos, size,
2017 "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
2018 field->name, field->bitfield->start, field->bitfield->end);
2020 field = field->next;
2023 xml_printf(&retval, tdesc, pos, size,
2031 /* Get a list of available target registers features. feature_list must
2032 * be freed by caller.
2034 static int get_reg_features_list(struct target *target, char const **feature_list[], int *feature_list_size,
2035 struct reg **reg_list, int reg_list_size)
2039 /* Start with only one element */
2040 *feature_list = calloc(1, sizeof(char *));
2042 for (int i = 0; i < reg_list_size; i++) {
2043 if (reg_list[i]->exist == false)
2046 if (reg_list[i]->feature != NULL
2047 && reg_list[i]->feature->name != NULL
2048 && (strcmp(reg_list[i]->feature->name, ""))) {
2049 /* We found a feature, check if the feature is already in the
2050 * table. If not, allocate a new entry for the table and
2051 * put the new feature in it.
2053 for (int j = 0; j < (tbl_sz + 1); j++) {
2054 if (!((*feature_list)[j])) {
2055 (*feature_list)[tbl_sz++] = reg_list[i]->feature->name;
2056 *feature_list = realloc(*feature_list, sizeof(char *) * (tbl_sz + 1));
2057 (*feature_list)[tbl_sz] = NULL;
2060 if (!strcmp((*feature_list)[j], reg_list[i]->feature->name))
2067 if (feature_list_size)
2068 *feature_list_size = tbl_sz;
2073 static int gdb_generate_target_description(struct target *target, char **tdesc_out)
2075 int retval = ERROR_OK;
2076 struct reg **reg_list = NULL;
2078 char const **features = NULL;
2079 int feature_list_size = 0;
2084 retval = target_get_gdb_reg_list(target, ®_list,
2085 ®_list_size, REG_CLASS_ALL);
2087 if (retval != ERROR_OK) {
2088 LOG_ERROR("get register list failed");
2089 retval = ERROR_FAIL;
2093 if (reg_list_size <= 0) {
2094 LOG_ERROR("get register list failed");
2095 retval = ERROR_FAIL;
2099 /* Get a list of available target registers features */
2100 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2101 if (retval != ERROR_OK) {
2102 LOG_ERROR("Can't get the registers feature list");
2103 retval = ERROR_FAIL;
2107 /* If we found some features associated with registers, create sections */
2108 int current_feature = 0;
2110 xml_printf(&retval, &tdesc, &pos, &size,
2111 "<?xml version=\"1.0\"?>\n"
2112 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2113 "<target version=\"1.0\">\n");
2115 /* generate target description according to register list */
2116 if (features != NULL) {
2117 while (features[current_feature]) {
2119 xml_printf(&retval, &tdesc, &pos, &size,
2120 "<feature name=\"%s\">\n",
2121 features[current_feature]);
2124 for (i = 0; i < reg_list_size; i++) {
2126 if (reg_list[i]->exist == false)
2129 if (strcmp(reg_list[i]->feature->name, features[current_feature]))
2132 const char *type_str;
2133 if (reg_list[i]->reg_data_type != NULL) {
2134 if (reg_list[i]->reg_data_type->type == REG_TYPE_ARCH_DEFINED) {
2135 /* generate <type... first, if there are architecture-defined types. */
2136 gdb_generate_reg_type_description(target, &tdesc, &pos, &size,
2137 reg_list[i]->reg_data_type);
2139 type_str = reg_list[i]->reg_data_type->id;
2141 /* predefined type */
2142 type_str = gdb_get_reg_type_name(
2143 reg_list[i]->reg_data_type->type);
2146 /* Default type is "int" */
2150 xml_printf(&retval, &tdesc, &pos, &size,
2151 "<reg name=\"%s\"", reg_list[i]->name);
2152 xml_printf(&retval, &tdesc, &pos, &size,
2153 " bitsize=\"%d\"", reg_list[i]->size);
2154 xml_printf(&retval, &tdesc, &pos, &size,
2155 " regnum=\"%d\"", reg_list[i]->number);
2156 if (reg_list[i]->caller_save)
2157 xml_printf(&retval, &tdesc, &pos, &size,
2158 " save-restore=\"yes\"");
2160 xml_printf(&retval, &tdesc, &pos, &size,
2161 " save-restore=\"no\"");
2163 xml_printf(&retval, &tdesc, &pos, &size,
2164 " type=\"%s\"", type_str);
2166 if (reg_list[i]->group != NULL)
2167 xml_printf(&retval, &tdesc, &pos, &size,
2168 " group=\"%s\"", reg_list[i]->group);
2170 xml_printf(&retval, &tdesc, &pos, &size,
2174 xml_printf(&retval, &tdesc, &pos, &size,
2181 xml_printf(&retval, &tdesc, &pos, &size,
2188 if (retval == ERROR_OK)
2196 static int gdb_get_target_description_chunk(struct target *target, struct target_desc_format *target_desc,
2197 char **chunk, int32_t offset, uint32_t length)
2199 if (target_desc == NULL) {
2200 LOG_ERROR("Unable to Generate Target Description");
2204 char *tdesc = target_desc->tdesc;
2205 uint32_t tdesc_length = target_desc->tdesc_length;
2207 if (tdesc == NULL) {
2208 int retval = gdb_generate_target_description(target, &tdesc);
2209 if (retval != ERROR_OK) {
2210 LOG_ERROR("Unable to Generate Target Description");
2214 tdesc_length = strlen(tdesc);
2219 if (length < (tdesc_length - offset))
2220 transfer_type = 'm';
2222 transfer_type = 'l';
2224 *chunk = malloc(length + 2);
2225 if (*chunk == NULL) {
2226 LOG_ERROR("Unable to allocate memory");
2230 (*chunk)[0] = transfer_type;
2231 if (transfer_type == 'm') {
2232 strncpy((*chunk) + 1, tdesc + offset, length);
2233 (*chunk)[1 + length] = '\0';
2235 strncpy((*chunk) + 1, tdesc + offset, tdesc_length - offset);
2236 (*chunk)[1 + (tdesc_length - offset)] = '\0';
2238 /* After gdb-server sends out last chunk, invalidate tdesc. */
2244 target_desc->tdesc = tdesc;
2245 target_desc->tdesc_length = tdesc_length;
2250 static int gdb_target_description_supported(struct target *target, int *supported)
2252 int retval = ERROR_OK;
2253 struct reg **reg_list = NULL;
2254 int reg_list_size = 0;
2255 char const **features = NULL;
2256 int feature_list_size = 0;
2258 retval = target_get_gdb_reg_list(target, ®_list,
2259 ®_list_size, REG_CLASS_ALL);
2260 if (retval != ERROR_OK) {
2261 LOG_ERROR("get register list failed");
2265 if (reg_list_size <= 0) {
2266 LOG_ERROR("get register list failed");
2267 retval = ERROR_FAIL;
2271 /* Get a list of available target registers features */
2272 retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2273 if (retval != ERROR_OK) {
2274 LOG_ERROR("Can't get the registers feature list");
2279 if (feature_list_size)
2293 static int gdb_generate_thread_list(struct target *target, char **thread_list_out)
2295 struct rtos *rtos = target->rtos;
2296 int retval = ERROR_OK;
2297 char *thread_list = NULL;
2301 xml_printf(&retval, &thread_list, &pos, &size,
2302 "<?xml version=\"1.0\"?>\n"
2306 for (int i = 0; i < rtos->thread_count; i++) {
2307 struct thread_detail *thread_detail = &rtos->thread_details[i];
2309 if (!thread_detail->exists)
2312 xml_printf(&retval, &thread_list, &pos, &size,
2313 "<thread id=\"%" PRIx64 "\">", thread_detail->threadid);
2315 if (thread_detail->thread_name_str != NULL)
2316 xml_printf(&retval, &thread_list, &pos, &size,
2317 "Name: %s", thread_detail->thread_name_str);
2319 if (thread_detail->extra_info_str != NULL) {
2320 if (thread_detail->thread_name_str != NULL)
2321 xml_printf(&retval, &thread_list, &pos, &size,
2323 xml_printf(&retval, &thread_list, &pos, &size,
2324 thread_detail->extra_info_str);
2327 xml_printf(&retval, &thread_list, &pos, &size,
2332 xml_printf(&retval, &thread_list, &pos, &size,
2335 if (retval == ERROR_OK)
2336 *thread_list_out = thread_list;
2343 static int gdb_get_thread_list_chunk(struct target *target, char **thread_list,
2344 char **chunk, int32_t offset, uint32_t length)
2346 if (*thread_list == NULL) {
2347 int retval = gdb_generate_thread_list(target, thread_list);
2348 if (retval != ERROR_OK) {
2349 LOG_ERROR("Unable to Generate Thread List");
2354 size_t thread_list_length = strlen(*thread_list);
2357 length = MIN(length, thread_list_length - offset);
2358 if (length < (thread_list_length - offset))
2359 transfer_type = 'm';
2361 transfer_type = 'l';
2363 *chunk = malloc(length + 2);
2364 if (*chunk == NULL) {
2365 LOG_ERROR("Unable to allocate memory");
2369 (*chunk)[0] = transfer_type;
2370 strncpy((*chunk) + 1, (*thread_list) + offset, length);
2371 (*chunk)[1 + length] = '\0';
2373 /* After gdb-server sends out last chunk, invalidate thread list. */
2374 if (transfer_type == 'l') {
2376 *thread_list = NULL;
2382 static int gdb_query_packet(struct connection *connection,
2383 char const *packet, int packet_size)
2385 struct command_context *cmd_ctx = connection->cmd_ctx;
2386 struct gdb_connection *gdb_connection = connection->priv;
2387 struct target *target = get_target_from_connection(connection);
2389 if (strncmp(packet, "qRcmd,", 6) == 0) {
2390 if (packet_size > 6) {
2392 cmd = malloc((packet_size - 6) / 2 + 1);
2393 size_t len = unhexify((uint8_t *)cmd, packet + 6, (packet_size - 6) / 2);
2396 /* We want to print all debug output to GDB connection */
2397 log_add_callback(gdb_log_callback, connection);
2398 target_call_timer_callbacks_now();
2399 /* some commands need to know the GDB connection, make note of current
2400 * GDB connection. */
2401 current_gdb_connection = gdb_connection;
2402 command_run_line(cmd_ctx, cmd);
2403 current_gdb_connection = NULL;
2404 target_call_timer_callbacks_now();
2405 log_remove_callback(gdb_log_callback, connection);
2408 gdb_put_packet(connection, "OK", 2);
2410 } else if (strncmp(packet, "qCRC:", 5) == 0) {
2411 if (packet_size > 5) {
2419 /* skip command character */
2422 addr = strtoul(packet, &separator, 16);
2424 if (*separator != ',') {
2425 LOG_ERROR("incomplete read memory packet received, dropping connection");
2426 return ERROR_SERVER_REMOTE_CLOSED;
2429 len = strtoul(separator + 1, NULL, 16);
2431 retval = target_checksum_memory(target, addr, len, &checksum);
2433 if (retval == ERROR_OK) {
2434 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
2435 gdb_put_packet(connection, gdb_reply, 9);
2437 retval = gdb_error(connection, retval);
2438 if (retval != ERROR_OK)
2444 } else if (strncmp(packet, "qSupported", 10) == 0) {
2445 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2446 * qXfer:features:read is supported for some targets */
2447 int retval = ERROR_OK;
2448 char *buffer = NULL;
2451 int gdb_target_desc_supported = 0;
2453 /* we need to test that the target supports target descriptions */
2454 retval = gdb_target_description_supported(target, &gdb_target_desc_supported);
2455 if (retval != ERROR_OK) {
2456 LOG_INFO("Failed detecting Target Description Support, disabling");
2457 gdb_target_desc_supported = 0;
2460 /* support may be disabled globally */
2461 if (gdb_use_target_description == 0) {
2462 if (gdb_target_desc_supported)
2463 LOG_WARNING("Target Descriptions Supported, but disabled");
2464 gdb_target_desc_supported = 0;
2471 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;qXfer:threads:read+;QStartNoAckMode+",
2472 (GDB_BUFFER_SIZE - 1),
2473 ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2474 (gdb_target_desc_supported == 1) ? '+' : '-');
2476 if (retval != ERROR_OK) {
2477 gdb_send_error(connection, 01);
2481 gdb_put_packet(connection, buffer, strlen(buffer));
2485 } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0)
2486 && (flash_get_bank_count() > 0))
2487 return gdb_memory_map(connection, packet, packet_size);
2488 else if (strncmp(packet, "qXfer:features:read:", 20) == 0) {
2490 int retval = ERROR_OK;
2493 unsigned int length;
2495 /* skip command character */
2498 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2499 gdb_send_error(connection, 01);
2503 /* Target should prepare correct target description for annex.
2504 * The first character of returned xml is 'm' or 'l'. 'm' for
2505 * there are *more* chunks to transfer. 'l' for it is the *last*
2506 * chunk of target description.
2508 retval = gdb_get_target_description_chunk(target, &gdb_connection->target_desc,
2509 &xml, offset, length);
2510 if (retval != ERROR_OK) {
2511 gdb_error(connection, retval);
2515 gdb_put_packet(connection, xml, strlen(xml));
2519 } else if (strncmp(packet, "qXfer:threads:read:", 19) == 0) {
2521 int retval = ERROR_OK;
2524 unsigned int length;
2526 /* skip command character */
2529 if (decode_xfer_read(packet, NULL, &offset, &length) < 0) {
2530 gdb_send_error(connection, 01);
2534 /* Target should prepare correct thread list for annex.
2535 * The first character of returned xml is 'm' or 'l'. 'm' for
2536 * there are *more* chunks to transfer. 'l' for it is the *last*
2537 * chunk of target description.
2539 retval = gdb_get_thread_list_chunk(target, &gdb_connection->thread_list,
2540 &xml, offset, length);
2541 if (retval != ERROR_OK) {
2542 gdb_error(connection, retval);
2546 gdb_put_packet(connection, xml, strlen(xml));
2550 } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) {
2551 gdb_connection->noack_mode = 1;
2552 gdb_put_packet(connection, "OK", 2);
2556 gdb_put_packet(connection, "", 0);
2560 static int gdb_v_packet(struct connection *connection,
2561 char const *packet, int packet_size)
2563 struct gdb_connection *gdb_connection = connection->priv;
2564 struct target *target;
2567 target = get_target_from_connection(connection);
2569 /* if flash programming disabled - send a empty reply */
2571 if (gdb_flash_program == 0) {
2572 gdb_put_packet(connection, "", 0);
2576 if (strncmp(packet, "vFlashErase:", 12) == 0) {
2578 unsigned long length;
2580 char const *parse = packet + 12;
2581 if (*parse == '\0') {
2582 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2583 return ERROR_SERVER_REMOTE_CLOSED;
2586 addr = strtoul(parse, (char **)&parse, 16);
2588 if (*(parse++) != ',' || *parse == '\0') {
2589 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2590 return ERROR_SERVER_REMOTE_CLOSED;
2593 length = strtoul(parse, (char **)&parse, 16);
2595 if (*parse != '\0') {
2596 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2597 return ERROR_SERVER_REMOTE_CLOSED;
2600 /* assume all sectors need erasing - stops any problems
2601 * when flash_write is called multiple times */
2604 /* perform any target specific operations before the erase */
2605 target_call_event_callbacks(target,
2606 TARGET_EVENT_GDB_FLASH_ERASE_START);
2608 /* vFlashErase:addr,length messages require region start and
2609 * end to be "block" aligned ... if padding is ever needed,
2610 * GDB will have become dangerously confused.
2612 result = flash_erase_address_range(target, false, addr,
2615 /* perform any target specific operations after the erase */
2616 target_call_event_callbacks(target,
2617 TARGET_EVENT_GDB_FLASH_ERASE_END);
2620 if (result != ERROR_OK) {
2621 /* GDB doesn't evaluate the actual error number returned,
2622 * treat a failed erase as an I/O error
2624 gdb_send_error(connection, EIO);
2625 LOG_ERROR("flash_erase returned %i", result);
2627 gdb_put_packet(connection, "OK", 2);
2632 if (strncmp(packet, "vFlashWrite:", 12) == 0) {
2635 unsigned long length;
2636 char const *parse = packet + 12;
2638 if (*parse == '\0') {
2639 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2640 return ERROR_SERVER_REMOTE_CLOSED;
2642 addr = strtoul(parse, (char **)&parse, 16);
2643 if (*(parse++) != ':') {
2644 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2645 return ERROR_SERVER_REMOTE_CLOSED;
2647 length = packet_size - (parse - packet);
2649 /* create a new image if there isn't already one */
2650 if (gdb_connection->vflash_image == NULL) {
2651 gdb_connection->vflash_image = malloc(sizeof(struct image));
2652 image_open(gdb_connection->vflash_image, "", "build");
2655 /* create new section with content from packet buffer */
2656 retval = image_add_section(gdb_connection->vflash_image,
2657 addr, length, 0x0, (uint8_t const *)parse);
2658 if (retval != ERROR_OK)
2661 gdb_put_packet(connection, "OK", 2);
2666 if (strncmp(packet, "vFlashDone", 10) == 0) {
2669 /* process the flashing buffer. No need to erase as GDB
2670 * always issues a vFlashErase first. */
2671 target_call_event_callbacks(target,
2672 TARGET_EVENT_GDB_FLASH_WRITE_START);
2673 result = flash_write(target, gdb_connection->vflash_image,
2675 target_call_event_callbacks(target,
2676 TARGET_EVENT_GDB_FLASH_WRITE_END);
2677 if (result != ERROR_OK) {
2678 if (result == ERROR_FLASH_DST_OUT_OF_BANK)
2679 gdb_put_packet(connection, "E.memtype", 9);
2681 gdb_send_error(connection, EIO);
2683 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
2684 gdb_put_packet(connection, "OK", 2);
2687 image_close(gdb_connection->vflash_image);
2688 free(gdb_connection->vflash_image);
2689 gdb_connection->vflash_image = NULL;
2694 gdb_put_packet(connection, "", 0);
2698 static int gdb_detach(struct connection *connection)
2700 target_call_event_callbacks(get_target_from_connection(connection),
2701 TARGET_EVENT_GDB_DETACH);
2703 return gdb_put_packet(connection, "OK", 2);
2706 /* The format of 'F' response packet is
2707 * Fretcode,errno,Ctrl-C flag;call-specific attachment
2709 static int gdb_fileio_response_packet(struct connection *connection,
2710 char const *packet, int packet_size)
2712 struct target *target = get_target_from_connection(connection);
2714 char *parsing_point;
2715 int fileio_retcode = strtoul(packet + 1, &separator, 16);
2716 int fileio_errno = 0;
2717 bool fileio_ctrl_c = false;
2722 if (*separator == ',') {
2723 parsing_point = separator + 1;
2724 fileio_errno = strtoul(parsing_point, &separator, 16);
2725 if (*separator == ',') {
2726 if (*(separator + 1) == 'C') {
2727 /* TODO: process ctrl-c */
2728 fileio_ctrl_c = true;
2733 LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
2734 fileio_retcode, fileio_errno, fileio_ctrl_c ? "true" : "false");
2736 retval = target_gdb_fileio_end(target, fileio_retcode, fileio_errno, fileio_ctrl_c);
2737 if (retval != ERROR_OK)
2740 /* After File-I/O ends, keep continue or step */
2741 if (gdb_running_type == 'c')
2742 retval = target_resume(target, 1, 0x0, 0, 0);
2743 else if (gdb_running_type == 's')
2744 retval = target_step(target, 1, 0x0, 0);
2746 retval = ERROR_FAIL;
2748 if (retval != ERROR_OK)
2754 static void gdb_log_callback(void *priv, const char *file, unsigned line,
2755 const char *function, const char *string)
2757 struct connection *connection = priv;
2758 struct gdb_connection *gdb_con = connection->priv;
2760 if (gdb_con->busy) {
2761 /* do not reply this using the O packet */
2765 gdb_output_con(connection, string);
2768 static void gdb_sig_halted(struct connection *connection)
2771 snprintf(sig_reply, 4, "T%2.2x", 2);
2772 gdb_put_packet(connection, sig_reply, 3);
2775 static int gdb_input_inner(struct connection *connection)
2777 /* Do not allocate this on the stack */
2778 static char gdb_packet_buffer[GDB_BUFFER_SIZE];
2780 struct target *target;
2781 char const *packet = gdb_packet_buffer;
2784 struct gdb_connection *gdb_con = connection->priv;
2785 static int extended_protocol;
2787 target = get_target_from_connection(connection);
2789 /* drain input buffer. If one of the packets fail, then an error
2790 * packet is replied, if applicable.
2792 * This loop will terminate and the error code is returned.
2794 * The calling fn will check if this error is something that
2795 * can be recovered from, or if the connection must be closed.
2797 * If the error is recoverable, this fn is called again to
2798 * drain the rest of the buffer.
2801 packet_size = GDB_BUFFER_SIZE-1;
2802 retval = gdb_get_packet(connection, gdb_packet_buffer, &packet_size);
2803 if (retval != ERROR_OK)
2806 /* terminate with zero */
2807 gdb_packet_buffer[packet_size] = '\0';
2809 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
2810 if (packet[0] == 'X') {
2811 /* binary packets spew junk into the debug log stream */
2814 for (x = 0; (x < 49) && (packet[x] != ':'); x++)
2817 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
2819 LOG_DEBUG("received packet: '%s'", packet);
2822 if (packet_size > 0) {
2824 switch (packet[0]) {
2825 case 'T': /* Is thread alive? */
2826 gdb_thread_packet(connection, packet, packet_size);
2828 case 'H': /* Set current thread ( 'c' for step and continue,
2829 * 'g' for all other operations ) */
2830 gdb_thread_packet(connection, packet, packet_size);
2834 retval = gdb_thread_packet(connection, packet, packet_size);
2835 if (retval == GDB_THREAD_PACKET_NOT_CONSUMED)
2836 retval = gdb_query_packet(connection, packet, packet_size);
2839 retval = gdb_get_registers_packet(connection, packet, packet_size);
2842 retval = gdb_set_registers_packet(connection, packet, packet_size);
2845 retval = gdb_get_register_packet(connection, packet, packet_size);
2848 retval = gdb_set_register_packet(connection, packet, packet_size);
2851 retval = gdb_read_memory_packet(connection, packet, packet_size);
2854 retval = gdb_write_memory_packet(connection, packet, packet_size);
2858 retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size);
2861 gdb_last_signal_packet(connection, packet, packet_size);
2866 gdb_thread_packet(connection, packet, packet_size);
2867 log_add_callback(gdb_log_callback, connection);
2869 if (gdb_con->mem_write_error) {
2870 LOG_ERROR("Memory write failure!");
2872 /* now that we have reported the memory write error,
2873 * we can clear the condition */
2874 gdb_con->mem_write_error = false;
2877 bool nostep = false;
2878 bool already_running = false;
2879 if (target->state == TARGET_RUNNING) {
2880 LOG_WARNING("WARNING! The target is already running. "
2881 "All changes GDB did to registers will be discarded! "
2882 "Waiting for target to halt.");
2883 already_running = true;
2884 } else if (target->state != TARGET_HALTED) {
2885 LOG_WARNING("The target is not in the halted nor running stated, " \
2886 "stepi/continue ignored.");
2888 } else if ((packet[0] == 's') && gdb_con->sync) {
2889 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2890 * sent by GDB first to OpenOCD, thus defeating the check to
2891 * make only the single stepping have the sync feature...
2894 LOG_WARNING("stepi ignored. GDB will now fetch the register state " \
2895 "from the target.");
2897 gdb_con->sync = false;
2899 if (!already_running && nostep) {
2900 /* Either the target isn't in the halted state, then we can't
2901 * step/continue. This might be early setup, etc.
2903 * Or we want to allow GDB to pick up a fresh set of
2904 * register values without modifying the target state.
2907 gdb_sig_halted(connection);
2909 /* stop forwarding log packets! */
2910 log_remove_callback(gdb_log_callback, connection);
2912 /* We're running/stepping, in which case we can
2913 * forward log output until the target is halted
2915 gdb_con->frontend_state = TARGET_RUNNING;
2916 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2918 if (!already_running) {
2919 /* Here we don't want packet processing to stop even if this fails,
2920 * so we use a local variable instead of retval. */
2921 retval = gdb_step_continue_packet(connection, packet, packet_size);
2922 if (retval != ERROR_OK) {
2923 /* we'll never receive a halted
2924 * condition... issue a false one..
2926 gdb_frontend_halted(target, connection);
2933 retval = gdb_v_packet(connection, packet, packet_size);
2936 retval = gdb_detach(connection);
2937 extended_protocol = 0;
2940 retval = gdb_write_memory_binary_packet(connection, packet, packet_size);
2941 if (retval != ERROR_OK)
2945 if (extended_protocol != 0) {
2946 gdb_con->attached = false;
2949 gdb_put_packet(connection, "OK", 2);
2950 return ERROR_SERVER_REMOTE_CLOSED;
2952 /* handle extended remote protocol */
2953 extended_protocol = 1;
2954 gdb_put_packet(connection, "OK", 2);
2957 /* handle extended restart packet */
2958 breakpoint_clear_target(target);
2959 watchpoint_clear_target(target);
2960 command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s",
2961 target_name(target));
2962 /* set connection as attached after reset */
2963 gdb_con->attached = true;
2964 /* info rtos parts */
2965 gdb_thread_packet(connection, packet, packet_size);
2969 /* packet supported only by smp target i.e cortex_a.c*/
2970 /* handle smp packet replying coreid played to gbd */
2971 gdb_read_smp_packet(connection, packet, packet_size);
2975 /* packet supported only by smp target i.e cortex_a.c */
2976 /* handle smp packet setting coreid to be played at next
2978 gdb_write_smp_packet(connection, packet, packet_size);
2982 /* File-I/O extension */
2983 /* After gdb uses host-side syscall to complete target file
2984 * I/O, gdb sends host-side syscall return value to target
2986 * The format of 'F' response packet is
2987 * Fretcode,errno,Ctrl-C flag;call-specific attachment
2989 gdb_con->frontend_state = TARGET_RUNNING;
2990 log_add_callback(gdb_log_callback, connection);
2991 gdb_fileio_response_packet(connection, packet, packet_size);
2995 /* ignore unknown packets */
2996 LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
2997 gdb_put_packet(connection, NULL, 0);
3001 /* if a packet handler returned an error, exit input loop */
3002 if (retval != ERROR_OK)
3006 if (gdb_con->ctrl_c) {
3007 if (target->state == TARGET_RUNNING) {
3008 retval = target_halt(target);
3009 if (retval != ERROR_OK)
3010 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3011 gdb_con->ctrl_c = 0;
3013 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
3014 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
3018 } while (gdb_con->buf_cnt > 0);
3023 static int gdb_input(struct connection *connection)
3025 int retval = gdb_input_inner(connection);
3026 struct gdb_connection *gdb_con = connection->priv;
3027 if (retval == ERROR_SERVER_REMOTE_CLOSED)
3030 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
3031 if (gdb_con->closed)
3032 return ERROR_SERVER_REMOTE_CLOSED;
3034 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
3038 static int gdb_target_start(struct target *target, const char *port)
3040 struct gdb_service *gdb_service;
3042 gdb_service = malloc(sizeof(struct gdb_service));
3044 if (NULL == gdb_service)
3047 gdb_service->target = target;
3048 gdb_service->core[0] = -1;
3049 gdb_service->core[1] = -1;
3050 target->gdb_service = gdb_service;
3052 ret = add_service("gdb",
3053 port, 1, &gdb_new_connection, &gdb_input,
3054 &gdb_connection_closed, gdb_service);
3055 /* initialialize all targets gdb service with the same pointer */
3057 struct target_list *head;
3058 struct target *curr;
3059 head = target->head;
3060 while (head != (struct target_list *)NULL) {
3061 curr = head->target;
3063 curr->gdb_service = gdb_service;
3070 static int gdb_target_add_one(struct target *target)
3072 if (strcmp(gdb_port, "disabled") == 0) {
3073 LOG_INFO("gdb port disabled");
3077 /* one gdb instance per smp list */
3078 if ((target->smp) && (target->gdb_service))
3080 int retval = gdb_target_start(target, gdb_port_next);
3081 if (retval == ERROR_OK) {
3083 /* If we can parse the port number
3084 * then we increment the port number for the next target.
3087 portnumber = strtol(gdb_port_next, &end, 0);
3089 if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) {
3090 free(gdb_port_next);
3091 gdb_port_next = alloc_printf("%d", portnumber+1);
3098 int gdb_target_add_all(struct target *target)
3100 if (strcmp(gdb_port, "disabled") == 0) {
3101 LOG_INFO("gdb server disabled");
3105 if (NULL == target) {
3106 LOG_WARNING("gdb services need one or more targets defined");
3110 while (NULL != target) {
3111 int retval = gdb_target_add_one(target);
3112 if (ERROR_OK != retval)
3115 target = target->next;
3121 COMMAND_HANDLER(handle_gdb_sync_command)
3124 return ERROR_COMMAND_SYNTAX_ERROR;
3126 if (current_gdb_connection == NULL) {
3127 command_print(CMD_CTX,
3128 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
3132 current_gdb_connection->sync = true;
3137 /* daemon configuration command gdb_port */
3138 COMMAND_HANDLER(handle_gdb_port_command)
3140 int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
3141 if (ERROR_OK == retval) {
3142 free(gdb_port_next);
3143 gdb_port_next = strdup(gdb_port);
3148 COMMAND_HANDLER(handle_gdb_memory_map_command)
3151 return ERROR_COMMAND_SYNTAX_ERROR;
3153 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
3157 COMMAND_HANDLER(handle_gdb_flash_program_command)
3160 return ERROR_COMMAND_SYNTAX_ERROR;
3162 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
3166 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
3169 return ERROR_COMMAND_SYNTAX_ERROR;
3171 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
3175 /* gdb_breakpoint_override */
3176 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
3178 if (CMD_ARGC == 0) {
3180 } else if (CMD_ARGC == 1) {
3181 gdb_breakpoint_override = 1;
3182 if (strcmp(CMD_ARGV[0], "hard") == 0)
3183 gdb_breakpoint_override_type = BKPT_HARD;
3184 else if (strcmp(CMD_ARGV[0], "soft") == 0)
3185 gdb_breakpoint_override_type = BKPT_SOFT;
3186 else if (strcmp(CMD_ARGV[0], "disable") == 0)
3187 gdb_breakpoint_override = 0;
3189 return ERROR_COMMAND_SYNTAX_ERROR;
3190 if (gdb_breakpoint_override)
3191 LOG_USER("force %s breakpoints",
3192 (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft");
3194 LOG_USER("breakpoint type is not overridden");
3199 COMMAND_HANDLER(handle_gdb_target_description_command)
3202 return ERROR_COMMAND_SYNTAX_ERROR;
3204 COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_target_description);
3208 COMMAND_HANDLER(handle_gdb_save_tdesc_command)
3211 uint32_t tdesc_length;
3212 struct target *target = get_current_target(CMD_CTX);
3214 int retval = gdb_generate_target_description(target, &tdesc);
3215 if (retval != ERROR_OK) {
3216 LOG_ERROR("Unable to Generate Target Description");
3220 tdesc_length = strlen(tdesc);
3222 struct fileio *fileio;
3223 size_t size_written;
3225 char *tdesc_filename = alloc_printf("%s.xml", target_type_name(target));
3226 if (tdesc_filename == NULL) {
3227 retval = ERROR_FAIL;
3231 retval = fileio_open(&fileio, tdesc_filename, FILEIO_WRITE, FILEIO_TEXT);
3233 if (retval != ERROR_OK) {
3234 LOG_ERROR("Can't open %s for writing", tdesc_filename);
3238 retval = fileio_write(fileio, tdesc_length, tdesc, &size_written);
3240 fileio_close(fileio);
3242 if (retval != ERROR_OK)
3243 LOG_ERROR("Error while writing the tdesc file");
3246 free(tdesc_filename);
3252 static const struct command_registration gdb_command_handlers[] = {
3255 .handler = handle_gdb_sync_command,
3256 .mode = COMMAND_ANY,
3257 .help = "next stepi will return immediately allowing "
3258 "GDB to fetch register state without affecting "
3264 .handler = handle_gdb_port_command,
3265 .mode = COMMAND_ANY,
3266 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
3267 "server listens for the next port number after the "
3268 "base port number specified. "
3269 "No arguments reports GDB port. \"pipe\" means listen to stdin "
3270 "output to stdout, an integer is base port number, \"disabled\" disables "
3271 "port. Any other string is are interpreted as named pipe to listen to. "
3272 "Output pipe is the same name as input pipe, but with 'o' appended.",
3273 .usage = "[port_num]",
3276 .name = "gdb_memory_map",
3277 .handler = handle_gdb_memory_map_command,
3278 .mode = COMMAND_CONFIG,
3279 .help = "enable or disable memory map",
3280 .usage = "('enable'|'disable')"
3283 .name = "gdb_flash_program",
3284 .handler = handle_gdb_flash_program_command,
3285 .mode = COMMAND_CONFIG,
3286 .help = "enable or disable flash program",
3287 .usage = "('enable'|'disable')"
3290 .name = "gdb_report_data_abort",
3291 .handler = handle_gdb_report_data_abort_command,
3292 .mode = COMMAND_CONFIG,
3293 .help = "enable or disable reporting data aborts",
3294 .usage = "('enable'|'disable')"
3297 .name = "gdb_breakpoint_override",
3298 .handler = handle_gdb_breakpoint_override_command,
3299 .mode = COMMAND_ANY,
3300 .help = "Display or specify type of breakpoint "
3301 "to be used by gdb 'break' commands.",
3302 .usage = "('hard'|'soft'|'disable')"
3305 .name = "gdb_target_description",
3306 .handler = handle_gdb_target_description_command,
3307 .mode = COMMAND_CONFIG,
3308 .help = "enable or disable target description",
3309 .usage = "('enable'|'disable')"
3312 .name = "gdb_save_tdesc",
3313 .handler = handle_gdb_save_tdesc_command,
3314 .mode = COMMAND_EXEC,
3315 .help = "Save the target description file",
3317 COMMAND_REGISTRATION_DONE
3320 int gdb_register_commands(struct command_context *cmd_ctx)
3322 gdb_port = strdup("3333");
3323 gdb_port_next = strdup("3333");
3324 return register_commands(cmd_ctx, NULL, gdb_command_handlers);