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>
47 #include <flash/nor/core.h>
48 #include "gdb_server.h"
49 #include <target/image.h>
50 #include <jtag/jtag.h>
51 #include "rtos/rtos.h"
52 #include "target/smp.h"
56 * GDB server implementation.
58 * This implements the GDB Remote Serial Protocol, over TCP connections,
59 * giving GDB access to the JTAG or other hardware debugging facilities
60 * found in most modern embedded processors.
63 struct target_desc_format
{
65 uint32_t tdesc_length
;
68 /* private connection data for GDB */
69 struct gdb_connection
{
70 char buffer
[GDB_BUFFER_SIZE
+ 1]; /* Extra byte for nul-termination */
74 enum target_state frontend_state
;
75 struct image
*vflash_image
;
79 /* set flag to true if you want the next stepi to return immediately.
80 * allowing GDB to pick up a fresh set of register values from the target
81 * without modifying the target state. */
83 /* We delay reporting memory write errors until next step/continue or memory
84 * write. This improves performance of gdb load significantly as the GDB packet
85 * can be replied immediately and a new GDB packet will be ready without delay
86 * (ca. 10% or so...). */
88 /* with extended-remote it seems we need to better emulate attach/detach.
89 * what this means is we reply with a W stop reply after a kill packet,
90 * normally we reply with a S reply via gdb_last_signal_packet.
91 * as a side note this behaviour only effects gdb > 6.8 */
93 /* temporarily used for target description support */
94 struct target_desc_format target_desc
;
95 /* temporarily used for thread list support */
100 #define _DEBUG_GDB_IO_
103 static struct gdb_connection
*current_gdb_connection
;
105 static int gdb_breakpoint_override
;
106 static enum breakpoint_type gdb_breakpoint_override_type
;
108 static int gdb_error(struct connection
*connection
, int retval
);
109 static char *gdb_port
;
110 static char *gdb_port_next
;
112 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
113 const char *function
, const char *string
);
115 static void gdb_sig_halted(struct connection
*connection
);
117 /* number of gdb connections, mainly to suppress gdb related debugging spam
118 * in helper/log.c when no gdb connections are actually active */
119 int gdb_actual_connections
;
121 /* set if we are sending a memory map to gdb
122 * via qXfer:memory-map:read packet */
123 /* enabled by default*/
124 static int gdb_use_memory_map
= 1;
125 /* enabled by default*/
126 static int gdb_flash_program
= 1;
128 /* if set, data aborts cause an error to be reported in memory read packets
129 * see the code in gdb_read_memory_packet() for further explanations.
130 * Disabled by default.
132 static int gdb_report_data_abort
;
133 /* If set, errors when accessing registers are reported to gdb. Disabled by
135 static int gdb_report_register_access_error
;
137 /* set if we are sending target descriptions to gdb
138 * via qXfer:features:read packet */
139 /* enabled by default */
140 static int gdb_use_target_description
= 1;
142 /* current processing free-run type, used by file-I/O */
143 static char gdb_running_type
;
145 static int gdb_last_signal(struct target
*target
)
147 switch (target
->debug_reason
) {
148 case DBG_REASON_DBGRQ
:
149 return 0x2; /* SIGINT */
150 case DBG_REASON_BREAKPOINT
:
151 case DBG_REASON_WATCHPOINT
:
152 case DBG_REASON_WPTANDBKPT
:
153 return 0x05; /* SIGTRAP */
154 case DBG_REASON_SINGLESTEP
:
155 return 0x05; /* SIGTRAP */
156 case DBG_REASON_EXC_CATCH
:
158 case DBG_REASON_NOTHALTED
:
159 return 0x0; /* no signal... shouldn't happen */
161 LOG_USER("undefined debug reason %d - target needs reset",
162 target
->debug_reason
);
167 static int check_pending(struct connection
*connection
,
168 int timeout_s
, int *got_data
)
170 /* a non-blocking socket will block if there is 0 bytes available on the socket,
171 * but return with as many bytes as are available immediately
175 struct gdb_connection
*gdb_con
= connection
->priv
;
177 if (got_data
== NULL
)
181 if (gdb_con
->buf_cnt
> 0) {
187 FD_SET(connection
->fd
, &read_fds
);
189 tv
.tv_sec
= timeout_s
;
191 if (socket_select(connection
->fd
+ 1, &read_fds
, NULL
, NULL
, &tv
) == 0) {
192 /* This can typically be because a "monitor" command took too long
193 * before printing any progress messages
196 return ERROR_GDB_TIMEOUT
;
200 *got_data
= FD_ISSET(connection
->fd
, &read_fds
) != 0;
204 static int gdb_get_char_inner(struct connection
*connection
, int *next_char
)
206 struct gdb_connection
*gdb_con
= connection
->priv
;
207 int retval
= ERROR_OK
;
209 #ifdef _DEBUG_GDB_IO_
213 if (connection
->service
->type
!= CONNECTION_TCP
)
214 gdb_con
->buf_cnt
= read(connection
->fd
, gdb_con
->buffer
, GDB_BUFFER_SIZE
);
216 retval
= check_pending(connection
, 1, NULL
);
217 if (retval
!= ERROR_OK
)
219 gdb_con
->buf_cnt
= read_socket(connection
->fd
,
224 if (gdb_con
->buf_cnt
> 0)
226 if (gdb_con
->buf_cnt
== 0) {
227 gdb_con
->closed
= true;
228 return ERROR_SERVER_REMOTE_CLOSED
;
232 errno
= WSAGetLastError();
238 case WSAECONNABORTED
:
239 gdb_con
->closed
= true;
240 return ERROR_SERVER_REMOTE_CLOSED
;
242 gdb_con
->closed
= true;
243 return ERROR_SERVER_REMOTE_CLOSED
;
245 LOG_ERROR("read: %d", errno
);
254 gdb_con
->closed
= true;
255 return ERROR_SERVER_REMOTE_CLOSED
;
257 gdb_con
->closed
= true;
258 return ERROR_SERVER_REMOTE_CLOSED
;
260 LOG_ERROR("read: %s", strerror(errno
));
261 gdb_con
->closed
= true;
262 return ERROR_SERVER_REMOTE_CLOSED
;
267 #ifdef _DEBUG_GDB_IO_
268 debug_buffer
= strndup(gdb_con
->buffer
, gdb_con
->buf_cnt
);
269 LOG_DEBUG("received '%s'", debug_buffer
);
273 gdb_con
->buf_p
= gdb_con
->buffer
;
275 *next_char
= *(gdb_con
->buf_p
++);
276 if (gdb_con
->buf_cnt
> 0)
277 connection
->input_pending
= 1;
279 connection
->input_pending
= 0;
280 #ifdef _DEBUG_GDB_IO_
281 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
288 * The cool thing about this fn is that it allows buf_p and buf_cnt to be
289 * held in registers in the inner loop.
291 * For small caches and embedded systems this is important!
293 static inline int gdb_get_char_fast(struct connection
*connection
,
294 int *next_char
, char **buf_p
, int *buf_cnt
)
296 int retval
= ERROR_OK
;
298 if ((*buf_cnt
)-- > 0) {
299 *next_char
= **buf_p
;
302 connection
->input_pending
= 1;
304 connection
->input_pending
= 0;
306 #ifdef _DEBUG_GDB_IO_
307 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char
, *next_char
);
313 struct gdb_connection
*gdb_con
= connection
->priv
;
314 gdb_con
->buf_p
= *buf_p
;
315 gdb_con
->buf_cnt
= *buf_cnt
;
316 retval
= gdb_get_char_inner(connection
, next_char
);
317 *buf_p
= gdb_con
->buf_p
;
318 *buf_cnt
= gdb_con
->buf_cnt
;
323 static int gdb_get_char(struct connection
*connection
, int *next_char
)
325 struct gdb_connection
*gdb_con
= connection
->priv
;
326 return gdb_get_char_fast(connection
, next_char
, &gdb_con
->buf_p
, &gdb_con
->buf_cnt
);
329 static int gdb_putback_char(struct connection
*connection
, int last_char
)
331 struct gdb_connection
*gdb_con
= connection
->priv
;
333 if (gdb_con
->buf_p
> gdb_con
->buffer
) {
334 *(--gdb_con
->buf_p
) = last_char
;
337 LOG_ERROR("BUG: couldn't put character back");
342 /* The only way we can detect that the socket is closed is the first time
343 * we write to it, we will fail. Subsequent write operations will
344 * succeed. Shudder! */
345 static int gdb_write(struct connection
*connection
, void *data
, int len
)
347 struct gdb_connection
*gdb_con
= connection
->priv
;
349 return ERROR_SERVER_REMOTE_CLOSED
;
351 if (connection_write(connection
, data
, len
) == len
)
353 gdb_con
->closed
= true;
354 return ERROR_SERVER_REMOTE_CLOSED
;
357 static int gdb_put_packet_inner(struct connection
*connection
,
358 char *buffer
, int len
)
361 unsigned char my_checksum
= 0;
362 #ifdef _DEBUG_GDB_IO_
367 struct gdb_connection
*gdb_con
= connection
->priv
;
369 for (i
= 0; i
< len
; i
++)
370 my_checksum
+= buffer
[i
];
372 #ifdef _DEBUG_GDB_IO_
374 * At this point we should have nothing in the input queue from GDB,
375 * however sometimes '-' is sent even though we've already received
376 * an ACK (+) for everything we've sent off.
380 retval
= check_pending(connection
, 0, &gotdata
);
381 if (retval
!= ERROR_OK
)
385 retval
= gdb_get_char(connection
, &reply
);
386 if (retval
!= ERROR_OK
)
389 /* fix a problem with some IAR tools */
390 gdb_putback_char(connection
, reply
);
391 LOG_DEBUG("Unexpected start of new packet");
395 LOG_WARNING("Discard unexpected char %c", reply
);
400 #ifdef _DEBUG_GDB_IO_
401 debug_buffer
= strndup(buffer
, len
);
402 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer
, my_checksum
);
406 char local_buffer
[1024];
407 local_buffer
[0] = '$';
408 if ((size_t)len
+ 4 <= sizeof(local_buffer
)) {
409 /* performance gain on smaller packets by only a single call to gdb_write() */
410 memcpy(local_buffer
+ 1, buffer
, len
++);
411 len
+= snprintf(local_buffer
+ len
, sizeof(local_buffer
) - len
, "#%02x", my_checksum
);
412 retval
= gdb_write(connection
, local_buffer
, len
);
413 if (retval
!= ERROR_OK
)
416 /* larger packets are transmitted directly from caller supplied buffer
417 * by several calls to gdb_write() to avoid dynamic allocation */
418 snprintf(local_buffer
+ 1, sizeof(local_buffer
) - 1, "#%02x", my_checksum
);
419 retval
= gdb_write(connection
, local_buffer
, 1);
420 if (retval
!= ERROR_OK
)
422 retval
= gdb_write(connection
, buffer
, len
);
423 if (retval
!= ERROR_OK
)
425 retval
= gdb_write(connection
, local_buffer
+ 1, 3);
426 if (retval
!= ERROR_OK
)
430 if (gdb_con
->noack_mode
)
433 retval
= gdb_get_char(connection
, &reply
);
434 if (retval
!= ERROR_OK
)
439 else if (reply
== '-') {
440 /* Stop sending output packets for now */
441 log_remove_callback(gdb_log_callback
, connection
);
442 LOG_WARNING("negative reply, retrying");
443 } else if (reply
== 0x3) {
445 retval
= gdb_get_char(connection
, &reply
);
446 if (retval
!= ERROR_OK
)
450 else if (reply
== '-') {
451 /* Stop sending output packets for now */
452 log_remove_callback(gdb_log_callback
, connection
);
453 LOG_WARNING("negative reply, retrying");
454 } else if (reply
== '$') {
455 LOG_ERROR("GDB missing ack(1) - assumed good");
456 gdb_putback_char(connection
, reply
);
459 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply
);
460 gdb_con
->closed
= true;
461 return ERROR_SERVER_REMOTE_CLOSED
;
463 } else if (reply
== '$') {
464 LOG_ERROR("GDB missing ack(2) - assumed good");
465 gdb_putback_char(connection
, reply
);
468 LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
470 gdb_con
->closed
= true;
471 return ERROR_SERVER_REMOTE_CLOSED
;
475 return ERROR_SERVER_REMOTE_CLOSED
;
480 int gdb_put_packet(struct connection
*connection
, char *buffer
, int len
)
482 struct gdb_connection
*gdb_con
= connection
->priv
;
483 gdb_con
->busy
= true;
484 int retval
= gdb_put_packet_inner(connection
, buffer
, len
);
485 gdb_con
->busy
= false;
487 /* we sent some data, reset timer for keep alive messages */
493 static inline int fetch_packet(struct connection
*connection
,
494 int *checksum_ok
, int noack
, int *len
, char *buffer
)
496 unsigned char my_checksum
= 0;
499 int retval
= ERROR_OK
;
501 struct gdb_connection
*gdb_con
= connection
->priv
;
506 /* move this over into local variables to use registers and give the
507 * more freedom to optimize */
508 char *buf_p
= gdb_con
->buf_p
;
509 int buf_cnt
= gdb_con
->buf_cnt
;
512 /* The common case is that we have an entire packet with no escape chars.
513 * We need to leave at least 2 bytes in the buffer to have
514 * gdb_get_char() update various bits and bobs correctly.
516 if ((buf_cnt
> 2) && ((buf_cnt
+ count
) < *len
)) {
517 /* The compiler will struggle a bit with constant propagation and
518 * aliasing, so we help it by showing that these values do not
519 * change inside the loop
523 int run
= buf_cnt
- 2;
529 if (character
== '#') {
530 /* Danger! character can be '#' when esc is
531 * used so we need an explicit boolean for done here. */
536 if (character
== '}') {
537 /* data transmitted in binary mode (X packet)
538 * uses 0x7d as escape character */
539 my_checksum
+= character
& 0xff;
542 my_checksum
+= character
& 0xff;
543 buffer
[count
++] = (character
^ 0x20) & 0xff;
545 my_checksum
+= character
& 0xff;
546 buffer
[count
++] = character
& 0xff;
555 LOG_ERROR("packet buffer too small");
556 retval
= ERROR_GDB_BUFFER_TOO_SMALL
;
560 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
561 if (retval
!= ERROR_OK
)
564 if (character
== '#')
567 if (character
== '}') {
568 /* data transmitted in binary mode (X packet)
569 * uses 0x7d as escape character */
570 my_checksum
+= character
& 0xff;
572 retval
= gdb_get_char_fast(connection
, &character
, &buf_p
, &buf_cnt
);
573 if (retval
!= ERROR_OK
)
576 my_checksum
+= character
& 0xff;
577 buffer
[count
++] = (character
^ 0x20) & 0xff;
579 my_checksum
+= character
& 0xff;
580 buffer
[count
++] = character
& 0xff;
584 gdb_con
->buf_p
= buf_p
;
585 gdb_con
->buf_cnt
= buf_cnt
;
587 if (retval
!= ERROR_OK
)
592 retval
= gdb_get_char(connection
, &character
);
593 if (retval
!= ERROR_OK
)
595 checksum
[0] = character
;
596 retval
= gdb_get_char(connection
, &character
);
597 if (retval
!= ERROR_OK
)
599 checksum
[1] = character
;
603 *checksum_ok
= (my_checksum
== strtoul(checksum
, NULL
, 16));
608 static int gdb_get_packet_inner(struct connection
*connection
,
609 char *buffer
, int *len
)
613 struct gdb_connection
*gdb_con
= connection
->priv
;
617 retval
= gdb_get_char(connection
, &character
);
618 if (retval
!= ERROR_OK
)
621 #ifdef _DEBUG_GDB_IO_
622 LOG_DEBUG("character: '%c'", character
);
629 /* According to the GDB documentation
630 * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html):
631 * "gdb sends a final `+` acknowledgment of the stub's `OK`
632 * response, which can be safely ignored by the stub."
633 * However OpenOCD server already is in noack mode at this
634 * point and instead of ignoring this it was emitting a
635 * warning. This code makes server ignore the first ACK
636 * that will be received after going into noack mode,
637 * warning only about subsequent ACK's. */
638 if (gdb_con
->noack_mode
> 1) {
639 LOG_WARNING("acknowledgment received, but no packet pending");
640 } else if (gdb_con
->noack_mode
) {
641 LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it.");
642 gdb_con
->noack_mode
= 2;
646 LOG_WARNING("negative acknowledgment, but no packet pending");
653 LOG_WARNING("ignoring character 0x%x", character
);
656 } while (character
!= '$');
659 /* explicit code expansion here to get faster inlined code in -O3 by not
660 * calculating checksum */
661 if (gdb_con
->noack_mode
) {
662 retval
= fetch_packet(connection
, &checksum_ok
, 1, len
, buffer
);
663 if (retval
!= ERROR_OK
)
666 retval
= fetch_packet(connection
, &checksum_ok
, 0, len
, buffer
);
667 if (retval
!= ERROR_OK
)
671 if (gdb_con
->noack_mode
) {
672 /* checksum is not checked in noack mode */
676 retval
= gdb_write(connection
, "+", 1);
677 if (retval
!= ERROR_OK
)
683 return ERROR_SERVER_REMOTE_CLOSED
;
688 static int gdb_get_packet(struct connection
*connection
, char *buffer
, int *len
)
690 struct gdb_connection
*gdb_con
= connection
->priv
;
691 gdb_con
->busy
= true;
692 int retval
= gdb_get_packet_inner(connection
, buffer
, len
);
693 gdb_con
->busy
= false;
697 static int gdb_output_con(struct connection
*connection
, const char *line
)
702 bin_size
= strlen(line
);
704 hex_buffer
= malloc(bin_size
* 2 + 2);
705 if (hex_buffer
== NULL
)
706 return ERROR_GDB_BUFFER_TOO_SMALL
;
709 size_t pkt_len
= hexify(hex_buffer
+ 1, (const uint8_t *)line
, bin_size
,
711 int retval
= gdb_put_packet(connection
, hex_buffer
, pkt_len
+ 1);
717 static int gdb_output(struct command_context
*context
, const char *line
)
719 /* this will be dumped to the log and also sent as an O packet if possible */
720 LOG_USER_N("%s", line
);
724 static void gdb_signal_reply(struct target
*target
, struct connection
*connection
)
726 struct gdb_connection
*gdb_connection
= connection
->priv
;
728 char stop_reason
[20];
729 char current_thread
[25];
733 rtos_update_threads(target
);
735 if (target
->debug_reason
== DBG_REASON_EXIT
) {
736 sig_reply_len
= snprintf(sig_reply
, sizeof(sig_reply
), "W00");
738 if (gdb_connection
->ctrl_c
) {
741 signal_var
= gdb_last_signal(target
);
743 stop_reason
[0] = '\0';
744 if (target
->debug_reason
== DBG_REASON_WATCHPOINT
) {
745 enum watchpoint_rw hit_wp_type
;
746 target_addr_t hit_wp_address
;
748 if (watchpoint_hit(target
, &hit_wp_type
, &hit_wp_address
) == ERROR_OK
) {
750 switch (hit_wp_type
) {
752 snprintf(stop_reason
, sizeof(stop_reason
),
753 "watch:%08" TARGET_PRIxADDR
";", hit_wp_address
);
756 snprintf(stop_reason
, sizeof(stop_reason
),
757 "rwatch:%08" TARGET_PRIxADDR
";", hit_wp_address
);
760 snprintf(stop_reason
, sizeof(stop_reason
),
761 "awatch:%08" TARGET_PRIxADDR
";", hit_wp_address
);
769 current_thread
[0] = '\0';
770 if (target
->rtos
!= NULL
) {
772 snprintf(current_thread
, sizeof(current_thread
), "thread:%016" PRIx64
";",
773 target
->rtos
->current_thread
);
774 target
->rtos
->current_threadid
= target
->rtos
->current_thread
;
775 target
->rtos
->gdb_target_for_threadid(connection
, target
->rtos
->current_threadid
, &ct
);
776 if (!gdb_connection
->ctrl_c
)
777 signal_var
= gdb_last_signal(ct
);
780 sig_reply_len
= snprintf(sig_reply
, sizeof(sig_reply
), "T%2.2x%s%s",
781 signal_var
, stop_reason
, current_thread
);
783 gdb_connection
->ctrl_c
= 0;
786 gdb_put_packet(connection
, sig_reply
, sig_reply_len
);
787 gdb_connection
->frontend_state
= TARGET_HALTED
;
790 static void gdb_fileio_reply(struct target
*target
, struct connection
*connection
)
792 struct gdb_connection
*gdb_connection
= connection
->priv
;
793 char fileio_command
[256];
795 bool program_exited
= false;
797 if (strcmp(target
->fileio_info
->identifier
, "open") == 0)
798 sprintf(fileio_command
, "F%s,%" PRIx64
"/%" PRIx64
",%" PRIx64
",%" PRIx64
, target
->fileio_info
->identifier
,
799 target
->fileio_info
->param_1
,
800 target
->fileio_info
->param_2
,
801 target
->fileio_info
->param_3
,
802 target
->fileio_info
->param_4
);
803 else if (strcmp(target
->fileio_info
->identifier
, "close") == 0)
804 sprintf(fileio_command
, "F%s,%" PRIx64
, target
->fileio_info
->identifier
,
805 target
->fileio_info
->param_1
);
806 else if (strcmp(target
->fileio_info
->identifier
, "read") == 0)
807 sprintf(fileio_command
, "F%s,%" PRIx64
",%" PRIx64
",%" PRIx64
, target
->fileio_info
->identifier
,
808 target
->fileio_info
->param_1
,
809 target
->fileio_info
->param_2
,
810 target
->fileio_info
->param_3
);
811 else if (strcmp(target
->fileio_info
->identifier
, "write") == 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
, "lseek") == 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
, "rename") == 0)
822 sprintf(fileio_command
, "F%s,%" PRIx64
"/%" 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 target
->fileio_info
->param_4
);
827 else if (strcmp(target
->fileio_info
->identifier
, "unlink") == 0)
828 sprintf(fileio_command
, "F%s,%" PRIx64
"/%" PRIx64
, target
->fileio_info
->identifier
,
829 target
->fileio_info
->param_1
,
830 target
->fileio_info
->param_2
);
831 else if (strcmp(target
->fileio_info
->identifier
, "stat") == 0)
832 sprintf(fileio_command
, "F%s,%" PRIx64
"/%" PRIx64
",%" PRIx64
, target
->fileio_info
->identifier
,
833 target
->fileio_info
->param_1
,
834 target
->fileio_info
->param_2
,
835 target
->fileio_info
->param_3
);
836 else if (strcmp(target
->fileio_info
->identifier
, "fstat") == 0)
837 sprintf(fileio_command
, "F%s,%" PRIx64
",%" PRIx64
, target
->fileio_info
->identifier
,
838 target
->fileio_info
->param_1
,
839 target
->fileio_info
->param_2
);
840 else if (strcmp(target
->fileio_info
->identifier
, "gettimeofday") == 0)
841 sprintf(fileio_command
, "F%s,%" PRIx64
",%" PRIx64
, target
->fileio_info
->identifier
,
842 target
->fileio_info
->param_1
,
843 target
->fileio_info
->param_2
);
844 else if (strcmp(target
->fileio_info
->identifier
, "isatty") == 0)
845 sprintf(fileio_command
, "F%s,%" PRIx64
, target
->fileio_info
->identifier
,
846 target
->fileio_info
->param_1
);
847 else if (strcmp(target
->fileio_info
->identifier
, "system") == 0)
848 sprintf(fileio_command
, "F%s,%" PRIx64
"/%" PRIx64
, target
->fileio_info
->identifier
,
849 target
->fileio_info
->param_1
,
850 target
->fileio_info
->param_2
);
851 else if (strcmp(target
->fileio_info
->identifier
, "exit") == 0) {
852 /* If target hits exit syscall, report to GDB the program is terminated.
853 * In addition, let target run its own exit syscall handler. */
854 program_exited
= true;
855 sprintf(fileio_command
, "W%02" PRIx64
, target
->fileio_info
->param_1
);
857 LOG_DEBUG("Unknown syscall: %s", target
->fileio_info
->identifier
);
859 /* encounter unknown syscall, continue */
860 gdb_connection
->frontend_state
= TARGET_RUNNING
;
861 target_resume(target
, 1, 0x0, 0, 0);
865 command_len
= strlen(fileio_command
);
866 gdb_put_packet(connection
, fileio_command
, command_len
);
868 if (program_exited
) {
869 /* Use target_resume() to let target run its own exit syscall handler. */
870 gdb_connection
->frontend_state
= TARGET_RUNNING
;
871 target_resume(target
, 1, 0x0, 0, 0);
873 gdb_connection
->frontend_state
= TARGET_HALTED
;
874 rtos_update_threads(target
);
878 static void gdb_frontend_halted(struct target
*target
, struct connection
*connection
)
880 struct gdb_connection
*gdb_connection
= connection
->priv
;
882 /* In the GDB protocol when we are stepping or continuing execution,
883 * we have a lingering reply. Upon receiving a halted event
884 * when we have that lingering packet, we reply to the original
885 * step or continue packet.
887 * Executing monitor commands can bring the target in and
888 * out of the running state so we'll see lots of TARGET_EVENT_XXX
889 * that are to be ignored.
891 if (gdb_connection
->frontend_state
== TARGET_RUNNING
) {
892 /* stop forwarding log packets! */
893 log_remove_callback(gdb_log_callback
, connection
);
895 /* check fileio first */
896 if (target_get_gdb_fileio_info(target
, target
->fileio_info
) == ERROR_OK
)
897 gdb_fileio_reply(target
, connection
);
899 gdb_signal_reply(target
, connection
);
903 static int gdb_target_callback_event_handler(struct target
*target
,
904 enum target_event event
, void *priv
)
906 struct connection
*connection
= priv
;
907 struct gdb_service
*gdb_service
= connection
->service
->priv
;
909 if (gdb_service
->target
!= target
)
913 case TARGET_EVENT_GDB_HALT
:
914 gdb_frontend_halted(target
, connection
);
916 case TARGET_EVENT_HALTED
:
917 target_call_event_callbacks(target
, TARGET_EVENT_GDB_END
);
926 static int gdb_new_connection(struct connection
*connection
)
928 struct gdb_connection
*gdb_connection
= malloc(sizeof(struct gdb_connection
));
929 struct target
*target
;
933 target
= get_target_from_connection(connection
);
934 connection
->priv
= gdb_connection
;
935 connection
->cmd_ctx
->current_target
= target
;
937 /* initialize gdb connection information */
938 gdb_connection
->buf_p
= gdb_connection
->buffer
;
939 gdb_connection
->buf_cnt
= 0;
940 gdb_connection
->ctrl_c
= 0;
941 gdb_connection
->frontend_state
= TARGET_HALTED
;
942 gdb_connection
->vflash_image
= NULL
;
943 gdb_connection
->closed
= false;
944 gdb_connection
->busy
= false;
945 gdb_connection
->noack_mode
= 0;
946 gdb_connection
->sync
= false;
947 gdb_connection
->mem_write_error
= false;
948 gdb_connection
->attached
= true;
949 gdb_connection
->target_desc
.tdesc
= NULL
;
950 gdb_connection
->target_desc
.tdesc_length
= 0;
951 gdb_connection
->thread_list
= NULL
;
953 /* send ACK to GDB for debug request */
954 gdb_write(connection
, "+", 1);
956 /* output goes through gdb connection */
957 command_set_output_handler(connection
->cmd_ctx
, gdb_output
, connection
);
959 /* we must remove all breakpoints registered to the target as a previous
960 * GDB session could leave dangling breakpoints if e.g. communication
963 breakpoint_clear_target(target
);
964 watchpoint_clear_target(target
);
967 /* clean previous rtos session if supported*/
968 if (target
->rtos
->type
->clean
)
969 target
->rtos
->type
->clean(target
);
972 rtos_update_threads(target
);
975 /* remove the initial ACK from the incoming buffer */
976 retval
= gdb_get_char(connection
, &initial_ack
);
977 if (retval
!= ERROR_OK
)
980 /* FIX!!!??? would we actually ever receive a + here???
983 if (initial_ack
!= '+')
984 gdb_putback_char(connection
, initial_ack
);
985 target_call_event_callbacks(target
, TARGET_EVENT_GDB_ATTACH
);
987 if (gdb_use_memory_map
) {
988 /* Connect must fail if the memory map can't be set up correctly.
990 * This will cause an auto_probe to be invoked, which is either
991 * a no-op or it will fail when the target isn't ready(e.g. not halted).
994 for (i
= 0; i
< flash_get_bank_count(); i
++) {
995 struct flash_bank
*p
;
996 p
= get_flash_bank_by_num_noprobe(i
);
997 if (p
->target
!= target
)
999 retval
= get_flash_bank_by_num(i
, &p
);
1000 if (retval
!= ERROR_OK
) {
1001 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \
1002 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
1008 gdb_actual_connections
++;
1009 log_printf_lf(all_targets
->next
!= NULL
? LOG_LVL_INFO
: LOG_LVL_DEBUG
,
1010 __FILE__
, __LINE__
, __func__
,
1011 "New GDB Connection: %d, Target %s, state: %s",
1012 gdb_actual_connections
,
1013 target_name(target
),
1014 target_state_name(target
));
1016 /* DANGER! If we fail subsequently, we must remove this handler,
1017 * otherwise we occasionally see crashes as the timer can invoke the
1020 * register callback to be informed about target events */
1021 target_register_event_callback(gdb_target_callback_event_handler
, connection
);
1026 static int gdb_connection_closed(struct connection
*connection
)
1028 struct target
*target
;
1029 struct gdb_connection
*gdb_connection
= connection
->priv
;
1031 target
= get_target_from_connection(connection
);
1033 /* we're done forwarding messages. Tear down callback before
1034 * cleaning up connection.
1036 log_remove_callback(gdb_log_callback
, connection
);
1038 gdb_actual_connections
--;
1039 LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
1040 target_name(target
),
1041 target_state_name(target
),
1042 gdb_actual_connections
);
1044 /* see if an image built with vFlash commands is left */
1045 if (gdb_connection
->vflash_image
) {
1046 image_close(gdb_connection
->vflash_image
);
1047 free(gdb_connection
->vflash_image
);
1048 gdb_connection
->vflash_image
= NULL
;
1051 /* if this connection registered a debug-message receiver delete it */
1052 delete_debug_msg_receiver(connection
->cmd_ctx
, target
);
1054 if (connection
->priv
) {
1055 free(connection
->priv
);
1056 connection
->priv
= NULL
;
1058 LOG_ERROR("BUG: connection->priv == NULL");
1060 target_unregister_event_callback(gdb_target_callback_event_handler
, connection
);
1062 target_call_event_callbacks(target
, TARGET_EVENT_GDB_END
);
1064 target_call_event_callbacks(target
, TARGET_EVENT_GDB_DETACH
);
1069 static void gdb_send_error(struct connection
*connection
, uint8_t the_error
)
1072 snprintf(err
, 4, "E%2.2X", the_error
);
1073 gdb_put_packet(connection
, err
, 3);
1076 static int gdb_last_signal_packet(struct connection
*connection
,
1077 char const *packet
, int packet_size
)
1079 struct target
*target
= get_target_from_connection(connection
);
1080 struct gdb_connection
*gdb_con
= connection
->priv
;
1084 if (!gdb_con
->attached
) {
1085 /* if we are here we have received a kill packet
1086 * reply W stop reply otherwise gdb gets very unhappy */
1087 gdb_put_packet(connection
, "W00", 3);
1091 signal_var
= gdb_last_signal(target
);
1093 snprintf(sig_reply
, 4, "S%2.2x", signal_var
);
1094 gdb_put_packet(connection
, sig_reply
, 3);
1099 static inline int gdb_reg_pos(struct target
*target
, int pos
, int len
)
1101 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
1104 return len
- 1 - pos
;
1107 /* Convert register to string of bytes. NB! The # of bits in the
1108 * register might be non-divisible by 8(a byte), in which
1109 * case an entire byte is shown.
1111 * NB! the format on the wire is the target endianness
1113 * The format of reg->value is little endian
1116 static void gdb_str_to_target(struct target
*target
,
1117 char *tstr
, struct reg
*reg
)
1124 buf_len
= DIV_ROUND_UP(reg
->size
, 8);
1126 for (i
= 0; i
< buf_len
; i
++) {
1127 int j
= gdb_reg_pos(target
, i
, buf_len
);
1128 tstr
+= sprintf(tstr
, "%02x", buf
[j
]);
1132 /* copy over in register buffer */
1133 static void gdb_target_to_reg(struct target
*target
,
1134 char const *tstr
, int str_len
, uint8_t *bin
)
1137 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1142 for (i
= 0; i
< str_len
; i
+= 2) {
1144 if (sscanf(tstr
+ i
, "%02x", &t
) != 1) {
1145 LOG_ERROR("BUG: unable to convert register value");
1149 int j
= gdb_reg_pos(target
, i
/2, str_len
/2);
1154 static int gdb_get_registers_packet(struct connection
*connection
,
1155 char const *packet
, int packet_size
)
1157 struct target
*target
= get_target_from_connection(connection
);
1158 struct reg
**reg_list
;
1161 int reg_packet_size
= 0;
1166 #ifdef _DEBUG_GDB_IO_
1170 if ((target
->rtos
!= NULL
) && (ERROR_OK
== rtos_get_gdb_reg_list(connection
)))
1173 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1175 if (retval
!= ERROR_OK
)
1176 return gdb_error(connection
, retval
);
1178 for (i
= 0; i
< reg_list_size
; i
++) {
1179 if (reg_list
[i
] == NULL
|| reg_list
[i
]->exist
== false)
1181 reg_packet_size
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
1184 assert(reg_packet_size
> 0);
1186 reg_packet
= malloc(reg_packet_size
+ 1); /* plus one for string termination null */
1187 if (reg_packet
== NULL
)
1190 reg_packet_p
= reg_packet
;
1192 for (i
= 0; i
< reg_list_size
; i
++) {
1193 if (reg_list
[i
] == NULL
|| reg_list
[i
]->exist
== false)
1195 if (!reg_list
[i
]->valid
) {
1196 retval
= reg_list
[i
]->type
->get(reg_list
[i
]);
1197 if (retval
!= ERROR_OK
&& gdb_report_register_access_error
) {
1198 LOG_DEBUG("Couldn't get register %s.", reg_list
[i
]->name
);
1201 return gdb_error(connection
, retval
);
1204 gdb_str_to_target(target
, reg_packet_p
, reg_list
[i
]);
1205 reg_packet_p
+= DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2;
1208 #ifdef _DEBUG_GDB_IO_
1210 char *reg_packet_p_debug
;
1211 reg_packet_p_debug
= strndup(reg_packet
, reg_packet_size
);
1212 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug
);
1213 free(reg_packet_p_debug
);
1217 gdb_put_packet(connection
, reg_packet
, reg_packet_size
);
1225 static int gdb_set_registers_packet(struct connection
*connection
,
1226 char const *packet
, int packet_size
)
1228 struct target
*target
= get_target_from_connection(connection
);
1230 struct reg
**reg_list
;
1233 char const *packet_p
;
1235 #ifdef _DEBUG_GDB_IO_
1239 /* skip command character */
1243 if (packet_size
% 2) {
1244 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1245 return ERROR_SERVER_REMOTE_CLOSED
;
1248 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1250 if (retval
!= ERROR_OK
)
1251 return gdb_error(connection
, retval
);
1254 for (i
= 0; i
< reg_list_size
; i
++) {
1256 int chars
= (DIV_ROUND_UP(reg_list
[i
]->size
, 8) * 2);
1258 if (packet_p
+ chars
> packet
+ packet_size
)
1259 LOG_ERROR("BUG: register packet is too small for registers");
1261 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[i
]->size
, 8));
1262 gdb_target_to_reg(target
, packet_p
, chars
, bin_buf
);
1264 retval
= reg_list
[i
]->type
->set(reg_list
[i
], bin_buf
);
1265 if (retval
!= ERROR_OK
&& gdb_report_register_access_error
) {
1266 LOG_DEBUG("Couldn't set register %s.", reg_list
[i
]->name
);
1269 return gdb_error(connection
, retval
);
1272 /* advance packet pointer */
1278 /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1281 gdb_put_packet(connection
, "OK", 2);
1286 static int gdb_get_register_packet(struct connection
*connection
,
1287 char const *packet
, int packet_size
)
1289 struct target
*target
= get_target_from_connection(connection
);
1291 int reg_num
= strtoul(packet
+ 1, NULL
, 16);
1292 struct reg
**reg_list
;
1296 #ifdef _DEBUG_GDB_IO_
1300 if ((target
->rtos
!= NULL
) && (ERROR_OK
== rtos_get_gdb_reg(connection
, reg_num
)))
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 (!reg_list
[reg_num
]->valid
) {
1314 retval
= reg_list
[reg_num
]->type
->get(reg_list
[reg_num
]);
1315 if (retval
!= ERROR_OK
&& gdb_report_register_access_error
) {
1316 LOG_DEBUG("Couldn't get register %s.", reg_list
[reg_num
]->name
);
1318 return gdb_error(connection
, retval
);
1322 reg_packet
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2 + 1); /* plus one for string termination null */
1324 gdb_str_to_target(target
, reg_packet
, reg_list
[reg_num
]);
1326 gdb_put_packet(connection
, reg_packet
, DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1334 static int gdb_set_register_packet(struct connection
*connection
,
1335 char const *packet
, int packet_size
)
1337 struct target
*target
= get_target_from_connection(connection
);
1340 int reg_num
= strtoul(packet
+ 1, &separator
, 16);
1341 struct reg
**reg_list
;
1347 retval
= target_get_gdb_reg_list(target
, ®_list
, ®_list_size
,
1349 if (retval
!= ERROR_OK
)
1350 return gdb_error(connection
, retval
);
1352 if (reg_list_size
<= reg_num
) {
1353 LOG_ERROR("gdb requested a non-existing register");
1354 return ERROR_SERVER_REMOTE_CLOSED
;
1357 if (*separator
!= '=') {
1358 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1359 return ERROR_SERVER_REMOTE_CLOSED
;
1362 /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1363 bin_buf
= malloc(DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8));
1364 int chars
= (DIV_ROUND_UP(reg_list
[reg_num
]->size
, 8) * 2);
1366 if ((unsigned int)chars
!= strlen(separator
+ 1)) {
1367 LOG_ERROR("gdb sent %zu bits for a %d-bit register (%s)",
1368 strlen(separator
+ 1) * 4, chars
* 4, reg_list
[reg_num
]->name
);
1370 return ERROR_SERVER_REMOTE_CLOSED
;
1373 gdb_target_to_reg(target
, separator
+ 1, chars
, bin_buf
);
1375 retval
= reg_list
[reg_num
]->type
->set(reg_list
[reg_num
], bin_buf
);
1376 if (retval
!= ERROR_OK
&& gdb_report_register_access_error
) {
1377 LOG_DEBUG("Couldn't set register %s.", reg_list
[reg_num
]->name
);
1380 return gdb_error(connection
, retval
);
1383 gdb_put_packet(connection
, "OK", 2);
1391 /* No attempt is made to translate the "retval" to
1392 * GDB speak. This has to be done at the calling
1393 * site as no mapping really exists.
1395 static int gdb_error(struct connection
*connection
, int retval
)
1397 LOG_DEBUG("Reporting %i to GDB as generic error", retval
);
1398 gdb_send_error(connection
, EFAULT
);
1402 /* We don't have to worry about the default 2 second timeout for GDB packets,
1403 * because GDB breaks up large memory reads into smaller reads.
1405 static int gdb_read_memory_packet(struct connection
*connection
,
1406 char const *packet
, int packet_size
)
1408 struct target
*target
= get_target_from_connection(connection
);
1416 int retval
= ERROR_OK
;
1418 /* skip command character */
1421 addr
= strtoull(packet
, &separator
, 16);
1423 if (*separator
!= ',') {
1424 LOG_ERROR("incomplete read memory packet received, dropping connection");
1425 return ERROR_SERVER_REMOTE_CLOSED
;
1428 len
= strtoul(separator
+ 1, NULL
, 16);
1431 LOG_WARNING("invalid read memory packet received (len == 0)");
1432 gdb_put_packet(connection
, "", 0);
1436 buffer
= malloc(len
);
1438 LOG_DEBUG("addr: 0x%16.16" PRIx64
", len: 0x%8.8" PRIx32
"", addr
, len
);
1440 retval
= target_read_buffer(target
, addr
, len
, buffer
);
1442 if ((retval
!= ERROR_OK
) && !gdb_report_data_abort
) {
1443 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1444 * At some point this might be fixed in GDB, in which case this code can be removed.
1446 * OpenOCD developers are acutely aware of this problem, but there is nothing
1447 * gained by involving the user in this problem that hopefully will get resolved
1450 * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1451 * cmd = view%20audit-trail&database = gdb&pr = 2395
1453 * For now, the default is to fix up things to make current GDB versions work.
1454 * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1456 memset(buffer
, 0, len
);
1460 if (retval
== ERROR_OK
) {
1461 hex_buffer
= malloc(len
* 2 + 1);
1463 size_t pkt_len
= hexify(hex_buffer
, buffer
, len
, len
* 2 + 1);
1465 gdb_put_packet(connection
, hex_buffer
, pkt_len
);
1469 retval
= gdb_error(connection
, retval
);
1476 static int gdb_write_memory_packet(struct connection
*connection
,
1477 char const *packet
, int packet_size
)
1479 struct target
*target
= get_target_from_connection(connection
);
1487 /* skip command character */
1490 addr
= strtoull(packet
, &separator
, 16);
1492 if (*separator
!= ',') {
1493 LOG_ERROR("incomplete write memory packet received, dropping connection");
1494 return ERROR_SERVER_REMOTE_CLOSED
;
1497 len
= strtoul(separator
+ 1, &separator
, 16);
1499 if (*(separator
++) != ':') {
1500 LOG_ERROR("incomplete write memory packet received, dropping connection");
1501 return ERROR_SERVER_REMOTE_CLOSED
;
1504 buffer
= malloc(len
);
1506 LOG_DEBUG("addr: 0x%" PRIx64
", len: 0x%8.8" PRIx32
"", addr
, len
);
1508 if (unhexify(buffer
, separator
, len
) != len
)
1509 LOG_ERROR("unable to decode memory packet");
1511 retval
= target_write_buffer(target
, addr
, len
, buffer
);
1513 if (retval
== ERROR_OK
)
1514 gdb_put_packet(connection
, "OK", 2);
1516 retval
= gdb_error(connection
, retval
);
1523 static int gdb_write_memory_binary_packet(struct connection
*connection
,
1524 char const *packet
, int packet_size
)
1526 struct target
*target
= get_target_from_connection(connection
);
1531 int retval
= ERROR_OK
;
1532 /* Packets larger than fast_limit bytes will be acknowledged instantly on
1533 * the assumption that we're in a download and it's important to go as fast
1535 uint32_t fast_limit
= 8;
1537 /* skip command character */
1540 addr
= strtoull(packet
, &separator
, 16);
1542 if (*separator
!= ',') {
1543 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1544 return ERROR_SERVER_REMOTE_CLOSED
;
1547 len
= strtoul(separator
+ 1, &separator
, 16);
1549 if (*(separator
++) != ':') {
1550 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1551 return ERROR_SERVER_REMOTE_CLOSED
;
1554 struct gdb_connection
*gdb_connection
= connection
->priv
;
1556 if (gdb_connection
->mem_write_error
)
1557 retval
= ERROR_FAIL
;
1559 if (retval
== ERROR_OK
) {
1560 if (len
>= fast_limit
) {
1561 /* By replying the packet *immediately* GDB will send us a new packet
1562 * while we write the last one to the target.
1563 * We only do this for larger writes, so that users who do something like:
1564 * p *((int*)0xdeadbeef)=8675309
1565 * will get immediate feedback that that write failed.
1567 gdb_put_packet(connection
, "OK", 2);
1570 retval
= gdb_error(connection
, retval
);
1571 /* now that we have reported the memory write error, we can clear the condition */
1572 gdb_connection
->mem_write_error
= false;
1573 if (retval
!= ERROR_OK
)
1578 LOG_DEBUG("addr: 0x%" PRIx64
", len: 0x%8.8" PRIx32
"", addr
, len
);
1580 retval
= target_write_buffer(target
, addr
, len
, (uint8_t *)separator
);
1581 if (retval
!= ERROR_OK
)
1582 gdb_connection
->mem_write_error
= true;
1585 if (len
< fast_limit
) {
1586 if (retval
!= ERROR_OK
) {
1587 gdb_error(connection
, retval
);
1588 gdb_connection
->mem_write_error
= false;
1590 gdb_put_packet(connection
, "OK", 2);
1597 static int gdb_step_continue_packet(struct connection
*connection
,
1598 char const *packet
, int packet_size
)
1600 struct target
*target
= get_target_from_connection(connection
);
1602 uint64_t address
= 0x0;
1603 int retval
= ERROR_OK
;
1607 if (packet_size
> 1)
1608 address
= strtoull(packet
+ 1, NULL
, 16);
1612 gdb_running_type
= packet
[0];
1613 if (packet
[0] == 'c') {
1614 LOG_DEBUG("continue");
1615 /* resume at current address, don't handle breakpoints, not debugging */
1616 retval
= target_resume(target
, current
, address
, 0, 0);
1617 } else if (packet
[0] == 's') {
1619 /* step at current or address, don't handle breakpoints */
1620 retval
= target_step(target
, current
, address
, 0);
1625 static int gdb_breakpoint_watchpoint_packet(struct connection
*connection
,
1626 char const *packet
, int packet_size
)
1628 struct target
*target
= get_target_from_connection(connection
);
1630 enum breakpoint_type bp_type
= BKPT_SOFT
/* dummy init to avoid warning */;
1631 enum watchpoint_rw wp_type
= WPT_READ
/* dummy init to avoid warning */;
1639 type
= strtoul(packet
+ 1, &separator
, 16);
1641 if (type
== 0) /* memory breakpoint */
1642 bp_type
= BKPT_SOFT
;
1643 else if (type
== 1) /* hardware breakpoint */
1644 bp_type
= BKPT_HARD
;
1645 else if (type
== 2) /* write watchpoint */
1646 wp_type
= WPT_WRITE
;
1647 else if (type
== 3) /* read watchpoint */
1649 else if (type
== 4) /* access watchpoint */
1650 wp_type
= WPT_ACCESS
;
1652 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type
);
1653 return ERROR_SERVER_REMOTE_CLOSED
;
1656 if (gdb_breakpoint_override
&& ((bp_type
== BKPT_SOFT
) || (bp_type
== BKPT_HARD
)))
1657 bp_type
= gdb_breakpoint_override_type
;
1659 if (*separator
!= ',') {
1660 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1661 return ERROR_SERVER_REMOTE_CLOSED
;
1664 address
= strtoull(separator
+ 1, &separator
, 16);
1666 if (*separator
!= ',') {
1667 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1668 return ERROR_SERVER_REMOTE_CLOSED
;
1671 size
= strtoul(separator
+ 1, &separator
, 16);
1676 if (packet
[0] == 'Z') {
1677 retval
= breakpoint_add(target
, address
, size
, bp_type
);
1678 if (retval
!= ERROR_OK
) {
1679 retval
= gdb_error(connection
, retval
);
1680 if (retval
!= ERROR_OK
)
1683 gdb_put_packet(connection
, "OK", 2);
1685 breakpoint_remove(target
, address
);
1686 gdb_put_packet(connection
, "OK", 2);
1693 if (packet
[0] == 'Z') {
1694 retval
= watchpoint_add(target
, address
, size
, wp_type
, 0, 0xffffffffu
);
1695 if (retval
!= ERROR_OK
) {
1696 retval
= gdb_error(connection
, retval
);
1697 if (retval
!= ERROR_OK
)
1700 gdb_put_packet(connection
, "OK", 2);
1702 watchpoint_remove(target
, address
);
1703 gdb_put_packet(connection
, "OK", 2);
1714 /* print out a string and allocate more space as needed,
1715 * mainly used for XML at this point
1717 static void xml_printf(int *retval
, char **xml
, int *pos
, int *size
,
1718 const char *fmt
, ...)
1720 if (*retval
!= ERROR_OK
)
1725 if ((*xml
== NULL
) || (!first
)) {
1726 /* start by 0 to exercise all the code paths.
1727 * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1729 *size
= *size
* 2 + 2;
1731 *xml
= realloc(*xml
, *size
);
1735 *retval
= ERROR_SERVER_REMOTE_CLOSED
;
1743 ret
= vsnprintf(*xml
+ *pos
, *size
- *pos
, fmt
, ap
);
1745 if ((ret
> 0) && ((ret
+ 1) < *size
- *pos
)) {
1749 /* there was just enough or not enough space, allocate more. */
1754 static int decode_xfer_read(char const *buf
, char **annex
, int *ofs
, unsigned int *len
)
1756 /* Locate the annex. */
1757 const char *annex_end
= strchr(buf
, ':');
1758 if (annex_end
== NULL
)
1761 /* After the read marker and annex, qXfer looks like a
1762 * traditional 'm' packet. */
1764 *ofs
= strtoul(annex_end
+ 1, &separator
, 16);
1766 if (*separator
!= ',')
1769 *len
= strtoul(separator
+ 1, NULL
, 16);
1771 /* Extract the annex if needed */
1772 if (annex
!= NULL
) {
1773 *annex
= strndup(buf
, annex_end
- buf
);
1781 static int compare_bank(const void *a
, const void *b
)
1783 struct flash_bank
*b1
, *b2
;
1784 b1
= *((struct flash_bank
**)a
);
1785 b2
= *((struct flash_bank
**)b
);
1787 if (b1
->base
== b2
->base
)
1789 else if (b1
->base
> b2
->base
)
1795 static int gdb_memory_map(struct connection
*connection
,
1796 char const *packet
, int packet_size
)
1798 /* We get away with only specifying flash here. Regions that are not
1799 * specified are treated as if we provided no memory map(if not we
1800 * could detect the holes and mark them as RAM).
1801 * Normally we only execute this code once, but no big deal if we
1802 * have to regenerate it a couple of times.
1805 struct target
*target
= get_target_from_connection(connection
);
1806 struct flash_bank
*p
;
1810 int retval
= ERROR_OK
;
1811 struct flash_bank
**banks
;
1815 target_addr_t ram_start
= 0;
1817 int target_flash_banks
= 0;
1819 /* skip command character */
1822 offset
= strtoul(packet
, &separator
, 16);
1823 length
= strtoul(separator
+ 1, &separator
, 16);
1825 xml_printf(&retval
, &xml
, &pos
, &size
, "<memory-map>\n");
1827 /* Sort banks in ascending order. We need to report non-flash
1828 * memory as ram (or rather read/write) by default for GDB, since
1829 * it has no concept of non-cacheable read/write memory (i/o etc).
1831 banks
= malloc(sizeof(struct flash_bank
*)*flash_get_bank_count());
1833 for (i
= 0; i
< flash_get_bank_count(); i
++) {
1834 p
= get_flash_bank_by_num_noprobe(i
);
1835 if (p
->target
!= target
)
1837 retval
= get_flash_bank_by_num(i
, &p
);
1838 if (retval
!= ERROR_OK
) {
1840 gdb_error(connection
, retval
);
1843 banks
[target_flash_banks
++] = p
;
1846 qsort(banks
, target_flash_banks
, sizeof(struct flash_bank
*),
1849 for (i
= 0; i
< target_flash_banks
; i
++) {
1851 unsigned sector_size
= 0;
1852 unsigned group_len
= 0;
1856 if (ram_start
< p
->base
)
1857 xml_printf(&retval
, &xml
, &pos
, &size
,
1858 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT
"\" "
1859 "length=\"0x%x\"/>\n",
1860 ram_start
, p
->base
- ram_start
);
1862 /* Report adjacent groups of same-size sectors. So for
1863 * example top boot CFI flash will list an initial region
1864 * with several large sectors (maybe 128KB) and several
1865 * smaller ones at the end (maybe 32KB). STR7 will have
1866 * regions with 8KB, 32KB, and 64KB sectors; etc.
1868 for (j
= 0; j
< p
->num_sectors
; j
++) {
1870 /* Maybe start a new group of sectors. */
1871 if (sector_size
== 0) {
1872 if (p
->sectors
[j
].offset
+ p
->sectors
[j
].size
> p
->size
) {
1873 LOG_WARNING("The flash sector at offset 0x%08" PRIx32
1874 " overflows the end of %s bank.",
1875 p
->sectors
[j
].offset
, p
->name
);
1876 LOG_WARNING("The rest of bank will not show in gdb memory map.");
1879 target_addr_t start
;
1880 start
= p
->base
+ p
->sectors
[j
].offset
;
1881 xml_printf(&retval
, &xml
, &pos
, &size
,
1882 "<memory type=\"flash\" "
1883 "start=\"" TARGET_ADDR_FMT
"\" ",
1885 sector_size
= p
->sectors
[j
].size
;
1886 group_len
= sector_size
;
1888 group_len
+= sector_size
; /* equal to p->sectors[j].size */
1891 /* Does this finish a group of sectors?
1892 * If not, continue an already-started group.
1894 if (j
< p
->num_sectors
- 1
1895 && p
->sectors
[j
+ 1].size
== sector_size
1896 && p
->sectors
[j
+ 1].offset
== p
->sectors
[j
].offset
+ sector_size
1897 && p
->sectors
[j
+ 1].offset
+ p
->sectors
[j
+ 1].size
<= p
->size
)
1900 xml_printf(&retval
, &xml
, &pos
, &size
,
1901 "length=\"0x%x\">\n"
1902 "<property name=\"blocksize\">"
1910 ram_start
= p
->base
+ p
->size
;
1914 xml_printf(&retval
, &xml
, &pos
, &size
,
1915 "<memory type=\"ram\" start=\"" TARGET_ADDR_FMT
"\" "
1916 "length=\"" TARGET_ADDR_FMT
"\"/>\n",
1917 ram_start
, target_address_max(target
) - ram_start
+ 1);
1918 /* ELSE a flash chip could be at the very end of the address space, in
1919 * which case ram_start will be precisely 0 */
1923 xml_printf(&retval
, &xml
, &pos
, &size
, "</memory-map>\n");
1925 if (retval
!= ERROR_OK
) {
1927 gdb_error(connection
, retval
);
1931 if (offset
+ length
> pos
)
1932 length
= pos
- offset
;
1934 char *t
= malloc(length
+ 1);
1936 memcpy(t
+ 1, xml
+ offset
, length
);
1937 gdb_put_packet(connection
, t
, length
+ 1);
1944 static const char *gdb_get_reg_type_name(enum reg_type type
)
1953 case REG_TYPE_INT16
:
1955 case REG_TYPE_INT32
:
1957 case REG_TYPE_INT64
:
1959 case REG_TYPE_INT128
:
1963 case REG_TYPE_UINT8
:
1965 case REG_TYPE_UINT16
:
1967 case REG_TYPE_UINT32
:
1969 case REG_TYPE_UINT64
:
1971 case REG_TYPE_UINT128
:
1973 case REG_TYPE_CODE_PTR
:
1975 case REG_TYPE_DATA_PTR
:
1977 case REG_TYPE_FLOAT
:
1979 case REG_TYPE_IEEE_SINGLE
:
1980 return "ieee_single";
1981 case REG_TYPE_IEEE_DOUBLE
:
1982 return "ieee_double";
1983 case REG_TYPE_ARCH_DEFINED
:
1984 return "int"; /* return arbitrary string to avoid compile warning. */
1987 return "int"; /* "int" as default value */
1990 static int lookup_add_arch_defined_types(char const **arch_defined_types_list
[], const char *type_id
,
1991 int *num_arch_defined_types
)
1993 int tbl_sz
= *num_arch_defined_types
;
1995 if (type_id
!= NULL
&& (strcmp(type_id
, ""))) {
1996 for (int j
= 0; j
< (tbl_sz
+ 1); j
++) {
1997 if (!((*arch_defined_types_list
)[j
])) {
1998 (*arch_defined_types_list
)[tbl_sz
++] = type_id
;
1999 *arch_defined_types_list
= realloc(*arch_defined_types_list
,
2000 sizeof(char *) * (tbl_sz
+ 1));
2001 (*arch_defined_types_list
)[tbl_sz
] = NULL
;
2002 *num_arch_defined_types
= tbl_sz
;
2005 if (!strcmp((*arch_defined_types_list
)[j
], type_id
))
2014 static int gdb_generate_reg_type_description(struct target
*target
,
2015 char **tdesc
, int *pos
, int *size
, struct reg_data_type
*type
,
2016 char const **arch_defined_types_list
[], int * num_arch_defined_types
)
2018 int retval
= ERROR_OK
;
2020 if (type
->type_class
== REG_TYPE_CLASS_VECTOR
) {
2021 struct reg_data_type
*data_type
= type
->reg_type_vector
->type
;
2022 if (data_type
->type
== REG_TYPE_ARCH_DEFINED
) {
2023 if (lookup_add_arch_defined_types(arch_defined_types_list
, data_type
->id
,
2024 num_arch_defined_types
))
2025 gdb_generate_reg_type_description(target
, tdesc
, pos
, size
, data_type
,
2026 arch_defined_types_list
,
2027 num_arch_defined_types
);
2029 /* <vector id="id" type="type" count="count"/> */
2030 xml_printf(&retval
, tdesc
, pos
, size
,
2031 "<vector id=\"%s\" type=\"%s\" count=\"%d\"/>\n",
2032 type
->id
, type
->reg_type_vector
->type
->id
,
2033 type
->reg_type_vector
->count
);
2035 } else if (type
->type_class
== REG_TYPE_CLASS_UNION
) {
2036 struct reg_data_type_union_field
*field
;
2037 field
= type
->reg_type_union
->fields
;
2038 while (field
!= NULL
) {
2039 struct reg_data_type
*data_type
= field
->type
;
2040 if (data_type
->type
== REG_TYPE_ARCH_DEFINED
) {
2041 if (lookup_add_arch_defined_types(arch_defined_types_list
, data_type
->id
,
2042 num_arch_defined_types
))
2043 gdb_generate_reg_type_description(target
, tdesc
, pos
, size
, data_type
,
2044 arch_defined_types_list
,
2045 num_arch_defined_types
);
2048 field
= field
->next
;
2051 * <field name="name" type="type"/> ...
2053 xml_printf(&retval
, tdesc
, pos
, size
,
2054 "<union id=\"%s\">\n",
2057 field
= type
->reg_type_union
->fields
;
2058 while (field
!= NULL
) {
2059 xml_printf(&retval
, tdesc
, pos
, size
,
2060 "<field name=\"%s\" type=\"%s\"/>\n",
2061 field
->name
, field
->type
->id
);
2063 field
= field
->next
;
2066 xml_printf(&retval
, tdesc
, pos
, size
,
2069 } else if (type
->type_class
== REG_TYPE_CLASS_STRUCT
) {
2070 struct reg_data_type_struct_field
*field
;
2071 field
= type
->reg_type_struct
->fields
;
2073 if (field
->use_bitfields
) {
2074 /* <struct id="id" size="size">
2075 * <field name="name" start="start" end="end"/> ...
2077 xml_printf(&retval
, tdesc
, pos
, size
,
2078 "<struct id=\"%s\" size=\"%d\">\n",
2079 type
->id
, type
->reg_type_struct
->size
);
2080 while (field
!= NULL
) {
2081 xml_printf(&retval
, tdesc
, pos
, size
,
2082 "<field name=\"%s\" start=\"%d\" end=\"%d\" type=\"%s\" />\n",
2083 field
->name
, field
->bitfield
->start
, field
->bitfield
->end
,
2084 gdb_get_reg_type_name(field
->bitfield
->type
));
2086 field
= field
->next
;
2089 while (field
!= NULL
) {
2090 struct reg_data_type
*data_type
= field
->type
;
2091 if (data_type
->type
== REG_TYPE_ARCH_DEFINED
) {
2092 if (lookup_add_arch_defined_types(arch_defined_types_list
, data_type
->id
,
2093 num_arch_defined_types
))
2094 gdb_generate_reg_type_description(target
, tdesc
, pos
, size
, data_type
,
2095 arch_defined_types_list
,
2096 num_arch_defined_types
);
2101 * <field name="name" type="type"/> ...
2103 xml_printf(&retval
, tdesc
, pos
, size
,
2104 "<struct id=\"%s\">\n",
2106 while (field
!= NULL
) {
2107 xml_printf(&retval
, tdesc
, pos
, size
,
2108 "<field name=\"%s\" type=\"%s\"/>\n",
2109 field
->name
, field
->type
->id
);
2111 field
= field
->next
;
2115 xml_printf(&retval
, tdesc
, pos
, size
,
2118 } else if (type
->type_class
== REG_TYPE_CLASS_FLAGS
) {
2119 /* <flags id="id" size="size">
2120 * <field name="name" start="start" end="end"/> ...
2122 xml_printf(&retval
, tdesc
, pos
, size
,
2123 "<flags id=\"%s\" size=\"%d\">\n",
2124 type
->id
, type
->reg_type_flags
->size
);
2126 struct reg_data_type_flags_field
*field
;
2127 field
= type
->reg_type_flags
->fields
;
2128 while (field
!= NULL
) {
2129 xml_printf(&retval
, tdesc
, pos
, size
,
2130 "<field name=\"%s\" start=\"%d\" end=\"%d\" type=\"%s\" />\n",
2131 field
->name
, field
->bitfield
->start
, field
->bitfield
->end
,
2132 gdb_get_reg_type_name(field
->bitfield
->type
));
2134 field
= field
->next
;
2137 xml_printf(&retval
, tdesc
, pos
, size
,
2145 /* Get a list of available target registers features. feature_list must
2146 * be freed by caller.
2148 static int get_reg_features_list(struct target
*target
, char const **feature_list
[], int *feature_list_size
,
2149 struct reg
**reg_list
, int reg_list_size
)
2153 /* Start with only one element */
2154 *feature_list
= calloc(1, sizeof(char *));
2156 for (int i
= 0; i
< reg_list_size
; i
++) {
2157 if (reg_list
[i
]->exist
== false)
2160 if (reg_list
[i
]->feature
!= NULL
2161 && reg_list
[i
]->feature
->name
!= NULL
2162 && (strcmp(reg_list
[i
]->feature
->name
, ""))) {
2163 /* We found a feature, check if the feature is already in the
2164 * table. If not, allocate a new entry for the table and
2165 * put the new feature in it.
2167 for (int j
= 0; j
< (tbl_sz
+ 1); j
++) {
2168 if (!((*feature_list
)[j
])) {
2169 (*feature_list
)[tbl_sz
++] = reg_list
[i
]->feature
->name
;
2170 *feature_list
= realloc(*feature_list
, sizeof(char *) * (tbl_sz
+ 1));
2171 (*feature_list
)[tbl_sz
] = NULL
;
2174 if (!strcmp((*feature_list
)[j
], reg_list
[i
]->feature
->name
))
2181 if (feature_list_size
)
2182 *feature_list_size
= tbl_sz
;
2187 static int gdb_generate_target_description(struct target
*target
, char **tdesc_out
)
2189 int retval
= ERROR_OK
;
2190 struct reg
**reg_list
= NULL
;
2192 char const *architecture
;
2193 char const **features
= NULL
;
2194 char const **arch_defined_types
= NULL
;
2195 int feature_list_size
= 0;
2196 int num_arch_defined_types
= 0;
2201 arch_defined_types
= calloc(1, sizeof(char *));
2203 retval
= target_get_gdb_reg_list(target
, ®_list
,
2204 ®_list_size
, REG_CLASS_ALL
);
2206 if (retval
!= ERROR_OK
) {
2207 LOG_ERROR("get register list failed");
2208 retval
= ERROR_FAIL
;
2212 if (reg_list_size
<= 0) {
2213 LOG_ERROR("get register list failed");
2214 retval
= ERROR_FAIL
;
2218 /* Get a list of available target registers features */
2219 retval
= get_reg_features_list(target
, &features
, &feature_list_size
, reg_list
, reg_list_size
);
2220 if (retval
!= ERROR_OK
) {
2221 LOG_ERROR("Can't get the registers feature list");
2222 retval
= ERROR_FAIL
;
2226 /* If we found some features associated with registers, create sections */
2227 int current_feature
= 0;
2229 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2230 "<?xml version=\"1.0\"?>\n"
2231 "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2232 "<target version=\"1.0\">\n");
2234 /* generate architecture element if supported by target */
2235 architecture
= target_get_gdb_arch(target
);
2236 if (architecture
!= NULL
)
2237 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2238 "<architecture>%s</architecture>\n", architecture
);
2240 /* generate target description according to register list */
2241 if (features
!= NULL
) {
2242 while (features
[current_feature
]) {
2244 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2245 "<feature name=\"%s\">\n",
2246 features
[current_feature
]);
2249 for (i
= 0; i
< reg_list_size
; i
++) {
2251 if (reg_list
[i
]->exist
== false)
2254 if (strcmp(reg_list
[i
]->feature
->name
, features
[current_feature
]))
2257 const char *type_str
;
2258 if (reg_list
[i
]->reg_data_type
!= NULL
) {
2259 if (reg_list
[i
]->reg_data_type
->type
== REG_TYPE_ARCH_DEFINED
) {
2260 /* generate <type... first, if there are architecture-defined types. */
2261 if (lookup_add_arch_defined_types(&arch_defined_types
,
2262 reg_list
[i
]->reg_data_type
->id
,
2263 &num_arch_defined_types
))
2264 gdb_generate_reg_type_description(target
, &tdesc
, &pos
, &size
,
2265 reg_list
[i
]->reg_data_type
,
2266 &arch_defined_types
,
2267 &num_arch_defined_types
);
2269 type_str
= reg_list
[i
]->reg_data_type
->id
;
2271 /* predefined type */
2272 type_str
= gdb_get_reg_type_name(
2273 reg_list
[i
]->reg_data_type
->type
);
2276 /* Default type is "int" */
2280 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2281 "<reg name=\"%s\"", reg_list
[i
]->name
);
2282 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2283 " bitsize=\"%d\"", reg_list
[i
]->size
);
2284 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2285 " regnum=\"%d\"", reg_list
[i
]->number
);
2286 if (reg_list
[i
]->caller_save
)
2287 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2288 " save-restore=\"yes\"");
2290 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2291 " save-restore=\"no\"");
2293 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2294 " type=\"%s\"", type_str
);
2296 if (reg_list
[i
]->group
!= NULL
)
2297 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2298 " group=\"%s\"", reg_list
[i
]->group
);
2300 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2304 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2311 xml_printf(&retval
, &tdesc
, &pos
, &size
,
2317 free(arch_defined_types
);
2319 if (retval
== ERROR_OK
)
2327 static int gdb_get_target_description_chunk(struct target
*target
, struct target_desc_format
*target_desc
,
2328 char **chunk
, int32_t offset
, uint32_t length
)
2330 if (target_desc
== NULL
) {
2331 LOG_ERROR("Unable to Generate Target Description");
2335 char *tdesc
= target_desc
->tdesc
;
2336 uint32_t tdesc_length
= target_desc
->tdesc_length
;
2338 if (tdesc
== NULL
) {
2339 int retval
= gdb_generate_target_description(target
, &tdesc
);
2340 if (retval
!= ERROR_OK
) {
2341 LOG_ERROR("Unable to Generate Target Description");
2345 tdesc_length
= strlen(tdesc
);
2350 if (length
< (tdesc_length
- offset
))
2351 transfer_type
= 'm';
2353 transfer_type
= 'l';
2355 *chunk
= malloc(length
+ 2);
2356 if (*chunk
== NULL
) {
2357 LOG_ERROR("Unable to allocate memory");
2361 (*chunk
)[0] = transfer_type
;
2362 if (transfer_type
== 'm') {
2363 strncpy((*chunk
) + 1, tdesc
+ offset
, length
);
2364 (*chunk
)[1 + length
] = '\0';
2366 strncpy((*chunk
) + 1, tdesc
+ offset
, tdesc_length
- offset
);
2367 (*chunk
)[1 + (tdesc_length
- offset
)] = '\0';
2369 /* After gdb-server sends out last chunk, invalidate tdesc. */
2375 target_desc
->tdesc
= tdesc
;
2376 target_desc
->tdesc_length
= tdesc_length
;
2381 static int gdb_target_description_supported(struct target
*target
, int *supported
)
2383 int retval
= ERROR_OK
;
2384 struct reg
**reg_list
= NULL
;
2385 int reg_list_size
= 0;
2386 char const **features
= NULL
;
2387 int feature_list_size
= 0;
2389 char const *architecture
= target_get_gdb_arch(target
);
2391 retval
= target_get_gdb_reg_list(target
, ®_list
,
2392 ®_list_size
, REG_CLASS_ALL
);
2393 if (retval
!= ERROR_OK
) {
2394 LOG_ERROR("get register list failed");
2398 if (reg_list_size
<= 0) {
2399 LOG_ERROR("get register list failed");
2400 retval
= ERROR_FAIL
;
2404 /* Get a list of available target registers features */
2405 retval
= get_reg_features_list(target
, &features
, &feature_list_size
, reg_list
, reg_list_size
);
2406 if (retval
!= ERROR_OK
) {
2407 LOG_ERROR("Can't get the registers feature list");
2412 if (architecture
|| feature_list_size
)
2426 static int gdb_generate_thread_list(struct target
*target
, char **thread_list_out
)
2428 struct rtos
*rtos
= target
->rtos
;
2429 int retval
= ERROR_OK
;
2430 char *thread_list
= NULL
;
2434 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2435 "<?xml version=\"1.0\"?>\n"
2439 for (int i
= 0; i
< rtos
->thread_count
; i
++) {
2440 struct thread_detail
*thread_detail
= &rtos
->thread_details
[i
];
2442 if (!thread_detail
->exists
)
2445 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2446 "<thread id=\"%" PRIx64
"\">", thread_detail
->threadid
);
2448 if (thread_detail
->thread_name_str
!= NULL
)
2449 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2450 "Name: %s", thread_detail
->thread_name_str
);
2452 if (thread_detail
->extra_info_str
!= NULL
) {
2453 if (thread_detail
->thread_name_str
!= NULL
)
2454 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2456 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2457 thread_detail
->extra_info_str
);
2460 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2465 xml_printf(&retval
, &thread_list
, &pos
, &size
,
2468 if (retval
== ERROR_OK
)
2469 *thread_list_out
= thread_list
;
2476 static int gdb_get_thread_list_chunk(struct target
*target
, char **thread_list
,
2477 char **chunk
, int32_t offset
, uint32_t length
)
2479 if (*thread_list
== NULL
) {
2480 int retval
= gdb_generate_thread_list(target
, thread_list
);
2481 if (retval
!= ERROR_OK
) {
2482 LOG_ERROR("Unable to Generate Thread List");
2487 size_t thread_list_length
= strlen(*thread_list
);
2490 length
= MIN(length
, thread_list_length
- offset
);
2491 if (length
< (thread_list_length
- offset
))
2492 transfer_type
= 'm';
2494 transfer_type
= 'l';
2496 *chunk
= malloc(length
+ 2 + 3);
2497 /* Allocating extra 3 bytes prevents false positive valgrind report
2498 * of strlen(chunk) word access:
2499 * Invalid read of size 4
2500 * Address 0x4479934 is 44 bytes inside a block of size 45 alloc'd */
2501 if (*chunk
== NULL
) {
2502 LOG_ERROR("Unable to allocate memory");
2506 (*chunk
)[0] = transfer_type
;
2507 strncpy((*chunk
) + 1, (*thread_list
) + offset
, length
);
2508 (*chunk
)[1 + length
] = '\0';
2510 /* After gdb-server sends out last chunk, invalidate thread list. */
2511 if (transfer_type
== 'l') {
2513 *thread_list
= NULL
;
2519 static int gdb_query_packet(struct connection
*connection
,
2520 char const *packet
, int packet_size
)
2522 struct command_context
*cmd_ctx
= connection
->cmd_ctx
;
2523 struct gdb_connection
*gdb_connection
= connection
->priv
;
2524 struct target
*target
= get_target_from_connection(connection
);
2526 if (strncmp(packet
, "qRcmd,", 6) == 0) {
2527 if (packet_size
> 6) {
2529 cmd
= malloc((packet_size
- 6) / 2 + 1);
2530 size_t len
= unhexify((uint8_t *)cmd
, packet
+ 6, (packet_size
- 6) / 2);
2533 /* We want to print all debug output to GDB connection */
2534 log_add_callback(gdb_log_callback
, connection
);
2535 target_call_timer_callbacks_now();
2536 /* some commands need to know the GDB connection, make note of current
2537 * GDB connection. */
2538 current_gdb_connection
= gdb_connection
;
2539 command_run_line(cmd_ctx
, cmd
);
2540 current_gdb_connection
= NULL
;
2541 target_call_timer_callbacks_now();
2542 log_remove_callback(gdb_log_callback
, connection
);
2545 gdb_put_packet(connection
, "OK", 2);
2547 } else if (strncmp(packet
, "qCRC:", 5) == 0) {
2548 if (packet_size
> 5) {
2553 target_addr_t addr
= 0;
2556 /* skip command character */
2559 addr
= strtoull(packet
, &separator
, 16);
2561 if (*separator
!= ',') {
2562 LOG_ERROR("incomplete read memory packet received, dropping connection");
2563 return ERROR_SERVER_REMOTE_CLOSED
;
2566 len
= strtoul(separator
+ 1, NULL
, 16);
2568 retval
= target_checksum_memory(target
, addr
, len
, &checksum
);
2570 if (retval
== ERROR_OK
) {
2571 snprintf(gdb_reply
, 10, "C%8.8" PRIx32
"", checksum
);
2572 gdb_put_packet(connection
, gdb_reply
, 9);
2574 retval
= gdb_error(connection
, retval
);
2575 if (retval
!= ERROR_OK
)
2581 } else if (strncmp(packet
, "qSupported", 10) == 0) {
2582 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2583 * qXfer:features:read is supported for some targets */
2584 int retval
= ERROR_OK
;
2585 char *buffer
= NULL
;
2588 int gdb_target_desc_supported
= 0;
2590 /* we need to test that the target supports target descriptions */
2591 retval
= gdb_target_description_supported(target
, &gdb_target_desc_supported
);
2592 if (retval
!= ERROR_OK
) {
2593 LOG_INFO("Failed detecting Target Description Support, disabling");
2594 gdb_target_desc_supported
= 0;
2597 /* support may be disabled globally */
2598 if (gdb_use_target_description
== 0) {
2599 if (gdb_target_desc_supported
)
2600 LOG_WARNING("Target Descriptions Supported, but disabled");
2601 gdb_target_desc_supported
= 0;
2608 "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;qXfer:threads:read+;QStartNoAckMode+;vContSupported+",
2610 ((gdb_use_memory_map
== 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2611 (gdb_target_desc_supported
== 1) ? '+' : '-');
2613 if (retval
!= ERROR_OK
) {
2614 gdb_send_error(connection
, 01);
2618 gdb_put_packet(connection
, buffer
, strlen(buffer
));
2622 } else if ((strncmp(packet
, "qXfer:memory-map:read::", 23) == 0)
2623 && (flash_get_bank_count() > 0))
2624 return gdb_memory_map(connection
, packet
, packet_size
);
2625 else if (strncmp(packet
, "qXfer:features:read:", 20) == 0) {
2627 int retval
= ERROR_OK
;
2630 unsigned int length
;
2632 /* skip command character */
2635 if (decode_xfer_read(packet
, NULL
, &offset
, &length
) < 0) {
2636 gdb_send_error(connection
, 01);
2640 /* Target should prepare correct target description for annex.
2641 * The first character of returned xml is 'm' or 'l'. 'm' for
2642 * there are *more* chunks to transfer. 'l' for it is the *last*
2643 * chunk of target description.
2645 retval
= gdb_get_target_description_chunk(target
, &gdb_connection
->target_desc
,
2646 &xml
, offset
, length
);
2647 if (retval
!= ERROR_OK
) {
2648 gdb_error(connection
, retval
);
2652 gdb_put_packet(connection
, xml
, strlen(xml
));
2656 } else if (strncmp(packet
, "qXfer:threads:read:", 19) == 0) {
2658 int retval
= ERROR_OK
;
2661 unsigned int length
;
2663 /* skip command character */
2666 if (decode_xfer_read(packet
, NULL
, &offset
, &length
) < 0) {
2667 gdb_send_error(connection
, 01);
2671 /* Target should prepare correct thread list for annex.
2672 * The first character of returned xml is 'm' or 'l'. 'm' for
2673 * there are *more* chunks to transfer. 'l' for it is the *last*
2674 * chunk of target description.
2676 retval
= gdb_get_thread_list_chunk(target
, &gdb_connection
->thread_list
,
2677 &xml
, offset
, length
);
2678 if (retval
!= ERROR_OK
) {
2679 gdb_error(connection
, retval
);
2683 gdb_put_packet(connection
, xml
, strlen(xml
));
2687 } else if (strncmp(packet
, "QStartNoAckMode", 15) == 0) {
2688 gdb_connection
->noack_mode
= 1;
2689 gdb_put_packet(connection
, "OK", 2);
2693 gdb_put_packet(connection
, "", 0);
2697 static bool gdb_handle_vcont_packet(struct connection
*connection
, const char *packet
, int packet_size
)
2699 struct gdb_connection
*gdb_connection
= connection
->priv
;
2700 struct target
*target
= get_target_from_connection(connection
);
2701 const char *parse
= packet
;
2704 /* query for vCont supported */
2705 if (parse
[0] == '?') {
2706 if (target
->type
->step
!= NULL
) {
2707 /* gdb doesn't accept c without C and s without S */
2708 gdb_put_packet(connection
, "vCont;c;C;s;S", 13);
2714 if (parse
[0] == ';') {
2719 /* simple case, a continue packet */
2720 if (parse
[0] == 'c') {
2721 gdb_running_type
= 'c';
2722 LOG_DEBUG("target %s continue", target_name(target
));
2723 log_add_callback(gdb_log_callback
, connection
);
2724 retval
= target_resume(target
, 1, 0, 0, 0);
2725 if (retval
== ERROR_TARGET_NOT_HALTED
)
2726 LOG_INFO("target %s was not halted when resume was requested", target_name(target
));
2728 /* poll target in an attempt to make its internal state consistent */
2729 if (retval
!= ERROR_OK
) {
2730 retval
= target_poll(target
);
2731 if (retval
!= ERROR_OK
)
2732 LOG_DEBUG("error polling target %s after failed resume", target_name(target
));
2736 * We don't report errors to gdb here, move frontend_state to
2737 * TARGET_RUNNING to stay in sync with gdb's expectation of the
2740 gdb_connection
->frontend_state
= TARGET_RUNNING
;
2741 target_call_event_callbacks(target
, TARGET_EVENT_GDB_START
);
2746 /* single-step or step-over-breakpoint */
2747 if (parse
[0] == 's') {
2748 gdb_running_type
= 's';
2749 bool fake_step
= false;
2751 if (strncmp(parse
, "s:", 2) == 0) {
2752 struct target
*ct
= target
;
2760 thread_id
= strtoll(parse
, &endp
, 16);
2762 packet_size
-= endp
- parse
;
2766 if (target
->rtos
!= NULL
) {
2767 /* FIXME: why is this necessary? rtos state should be up-to-date here already! */
2768 rtos_update_threads(target
);
2770 target
->rtos
->gdb_target_for_threadid(connection
, thread_id
, &ct
);
2773 * check if the thread to be stepped is the current rtos thread
2774 * if not, we must fake the step
2776 if (target
->rtos
->current_thread
!= thread_id
)
2780 if (parse
[0] == ';') {
2784 if (parse
[0] == 'c') {
2788 /* check if thread-id follows */
2789 if (parse
[0] == ':') {
2794 tid
= strtoll(parse
, &endp
, 16);
2795 if (tid
== thread_id
) {
2797 * Special case: only step a single thread (core),
2798 * keep the other threads halted. Currently, only
2799 * aarch64 target understands it. Other target types don't
2800 * care (nobody checks the actual value of 'current')
2801 * and it doesn't really matter. This deserves
2802 * a symbolic constant and a formal interface documentation
2805 LOG_DEBUG("request to step current core only");
2806 /* uncomment after checking that indeed other targets are safe */
2813 LOG_DEBUG("target %s single-step thread %"PRIx64
, target_name(ct
), thread_id
);
2814 log_add_callback(gdb_log_callback
, connection
);
2815 target_call_event_callbacks(ct
, TARGET_EVENT_GDB_START
);
2818 * work around an annoying gdb behaviour: when the current thread
2819 * is changed in gdb, it assumes that the target can follow and also
2820 * make the thread current. This is an assumption that cannot hold
2821 * for a real target running a multi-threading OS. We just fake
2822 * the step to not trigger an internal error in gdb. See
2823 * https://sourceware.org/bugzilla/show_bug.cgi?id=22925 for details
2827 char sig_reply
[128];
2829 LOG_DEBUG("fake step thread %"PRIx64
, thread_id
);
2831 sig_reply_len
= snprintf(sig_reply
, sizeof(sig_reply
),
2832 "T05thread:%016"PRIx64
";", thread_id
);
2834 gdb_put_packet(connection
, sig_reply
, sig_reply_len
);
2835 log_remove_callback(gdb_log_callback
, connection
);
2840 /* support for gdb_sync command */
2841 if (gdb_connection
->sync
) {
2842 gdb_connection
->sync
= false;
2843 if (ct
->state
== TARGET_HALTED
) {
2844 LOG_DEBUG("stepi ignored. GDB will now fetch the register state " \
2845 "from the target.");
2846 gdb_sig_halted(connection
);
2847 log_remove_callback(gdb_log_callback
, connection
);
2849 gdb_connection
->frontend_state
= TARGET_RUNNING
;
2853 retval
= target_step(ct
, current_pc
, 0, 0);
2854 if (retval
== ERROR_TARGET_NOT_HALTED
)
2855 LOG_INFO("target %s was not halted when step was requested", target_name(ct
));
2857 /* if step was successful send a reply back to gdb */
2858 if (retval
== ERROR_OK
) {
2859 retval
= target_poll(ct
);
2860 if (retval
!= ERROR_OK
)
2861 LOG_DEBUG("error polling target %s after successful step", target_name(ct
));
2862 /* send back signal information */
2863 gdb_signal_reply(ct
, connection
);
2864 /* stop forwarding log packets! */
2865 log_remove_callback(gdb_log_callback
, connection
);
2867 gdb_connection
->frontend_state
= TARGET_RUNNING
;
2869 LOG_ERROR("Unknown vCont packet");
2878 static int gdb_v_packet(struct connection
*connection
,
2879 char const *packet
, int packet_size
)
2881 struct gdb_connection
*gdb_connection
= connection
->priv
;
2882 struct target
*target
;
2885 target
= get_target_from_connection(connection
);
2887 if (strncmp(packet
, "vCont", 5) == 0) {
2893 handled
= gdb_handle_vcont_packet(connection
, packet
, packet_size
);
2895 gdb_put_packet(connection
, "", 0);
2900 /* if flash programming disabled - send a empty reply */
2902 if (gdb_flash_program
== 0) {
2903 gdb_put_packet(connection
, "", 0);
2907 if (strncmp(packet
, "vFlashErase:", 12) == 0) {
2909 unsigned long length
;
2911 char const *parse
= packet
+ 12;
2912 if (*parse
== '\0') {
2913 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2914 return ERROR_SERVER_REMOTE_CLOSED
;
2917 addr
= strtoul(parse
, (char **)&parse
, 16);
2919 if (*(parse
++) != ',' || *parse
== '\0') {
2920 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2921 return ERROR_SERVER_REMOTE_CLOSED
;
2924 length
= strtoul(parse
, (char **)&parse
, 16);
2926 if (*parse
!= '\0') {
2927 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2928 return ERROR_SERVER_REMOTE_CLOSED
;
2931 /* assume all sectors need erasing - stops any problems
2932 * when flash_write is called multiple times */
2935 /* perform any target specific operations before the erase */
2936 target_call_event_callbacks(target
,
2937 TARGET_EVENT_GDB_FLASH_ERASE_START
);
2939 /* vFlashErase:addr,length messages require region start and
2940 * end to be "block" aligned ... if padding is ever needed,
2941 * GDB will have become dangerously confused.
2943 result
= flash_erase_address_range(target
, false, addr
,
2946 /* perform any target specific operations after the erase */
2947 target_call_event_callbacks(target
,
2948 TARGET_EVENT_GDB_FLASH_ERASE_END
);
2951 if (result
!= ERROR_OK
) {
2952 /* GDB doesn't evaluate the actual error number returned,
2953 * treat a failed erase as an I/O error
2955 gdb_send_error(connection
, EIO
);
2956 LOG_ERROR("flash_erase returned %i", result
);
2958 gdb_put_packet(connection
, "OK", 2);
2963 if (strncmp(packet
, "vFlashWrite:", 12) == 0) {
2966 unsigned long length
;
2967 char const *parse
= packet
+ 12;
2969 if (*parse
== '\0') {
2970 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2971 return ERROR_SERVER_REMOTE_CLOSED
;
2973 addr
= strtoul(parse
, (char **)&parse
, 16);
2974 if (*(parse
++) != ':') {
2975 LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2976 return ERROR_SERVER_REMOTE_CLOSED
;
2978 length
= packet_size
- (parse
- packet
);
2980 /* create a new image if there isn't already one */
2981 if (gdb_connection
->vflash_image
== NULL
) {
2982 gdb_connection
->vflash_image
= malloc(sizeof(struct image
));
2983 image_open(gdb_connection
->vflash_image
, "", "build");
2986 /* create new section with content from packet buffer */
2987 retval
= image_add_section(gdb_connection
->vflash_image
,
2988 addr
, length
, 0x0, (uint8_t const *)parse
);
2989 if (retval
!= ERROR_OK
)
2992 gdb_put_packet(connection
, "OK", 2);
2997 if (strncmp(packet
, "vFlashDone", 10) == 0) {
3000 /* process the flashing buffer. No need to erase as GDB
3001 * always issues a vFlashErase first. */
3002 target_call_event_callbacks(target
,
3003 TARGET_EVENT_GDB_FLASH_WRITE_START
);
3004 result
= flash_write(target
, gdb_connection
->vflash_image
,
3006 target_call_event_callbacks(target
,
3007 TARGET_EVENT_GDB_FLASH_WRITE_END
);
3008 if (result
!= ERROR_OK
) {
3009 if (result
== ERROR_FLASH_DST_OUT_OF_BANK
)
3010 gdb_put_packet(connection
, "E.memtype", 9);
3012 gdb_send_error(connection
, EIO
);
3014 LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written
);
3015 gdb_put_packet(connection
, "OK", 2);
3018 image_close(gdb_connection
->vflash_image
);
3019 free(gdb_connection
->vflash_image
);
3020 gdb_connection
->vflash_image
= NULL
;
3025 gdb_put_packet(connection
, "", 0);
3029 static int gdb_detach(struct connection
*connection
)
3032 * Only reply "OK" to GDB
3033 * it will close the connection and this will trigger a call to
3034 * gdb_connection_closed() that will in turn trigger the event
3035 * TARGET_EVENT_GDB_DETACH
3037 return gdb_put_packet(connection
, "OK", 2);
3040 /* The format of 'F' response packet is
3041 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3043 static int gdb_fileio_response_packet(struct connection
*connection
,
3044 char const *packet
, int packet_size
)
3046 struct target
*target
= get_target_from_connection(connection
);
3048 char *parsing_point
;
3049 int fileio_retcode
= strtoul(packet
+ 1, &separator
, 16);
3050 int fileio_errno
= 0;
3051 bool fileio_ctrl_c
= false;
3056 if (*separator
== ',') {
3057 parsing_point
= separator
+ 1;
3058 fileio_errno
= strtoul(parsing_point
, &separator
, 16);
3059 if (*separator
== ',') {
3060 if (*(separator
+ 1) == 'C') {
3061 /* TODO: process ctrl-c */
3062 fileio_ctrl_c
= true;
3067 LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
3068 fileio_retcode
, fileio_errno
, fileio_ctrl_c
? "true" : "false");
3070 retval
= target_gdb_fileio_end(target
, fileio_retcode
, fileio_errno
, fileio_ctrl_c
);
3071 if (retval
!= ERROR_OK
)
3074 /* After File-I/O ends, keep continue or step */
3075 if (gdb_running_type
== 'c')
3076 retval
= target_resume(target
, 1, 0x0, 0, 0);
3077 else if (gdb_running_type
== 's')
3078 retval
= target_step(target
, 1, 0x0, 0);
3080 retval
= ERROR_FAIL
;
3082 if (retval
!= ERROR_OK
)
3088 static void gdb_log_callback(void *priv
, const char *file
, unsigned line
,
3089 const char *function
, const char *string
)
3091 struct connection
*connection
= priv
;
3092 struct gdb_connection
*gdb_con
= connection
->priv
;
3094 if (gdb_con
->busy
) {
3095 /* do not reply this using the O packet */
3099 gdb_output_con(connection
, string
);
3102 static void gdb_sig_halted(struct connection
*connection
)
3105 snprintf(sig_reply
, 4, "T%2.2x", 2);
3106 gdb_put_packet(connection
, sig_reply
, 3);
3109 static int gdb_input_inner(struct connection
*connection
)
3111 /* Do not allocate this on the stack */
3112 static char gdb_packet_buffer
[GDB_BUFFER_SIZE
+ 1]; /* Extra byte for nul-termination */
3114 struct target
*target
;
3115 char const *packet
= gdb_packet_buffer
;
3118 struct gdb_connection
*gdb_con
= connection
->priv
;
3119 static int extended_protocol
;
3121 target
= get_target_from_connection(connection
);
3123 /* drain input buffer. If one of the packets fail, then an error
3124 * packet is replied, if applicable.
3126 * This loop will terminate and the error code is returned.
3128 * The calling fn will check if this error is something that
3129 * can be recovered from, or if the connection must be closed.
3131 * If the error is recoverable, this fn is called again to
3132 * drain the rest of the buffer.
3135 packet_size
= GDB_BUFFER_SIZE
;
3136 retval
= gdb_get_packet(connection
, gdb_packet_buffer
, &packet_size
);
3137 if (retval
!= ERROR_OK
)
3140 /* terminate with zero */
3141 gdb_packet_buffer
[packet_size
] = '\0';
3143 if (LOG_LEVEL_IS(LOG_LVL_DEBUG
)) {
3144 if (packet
[0] == 'X') {
3145 /* binary packets spew junk into the debug log stream */
3148 for (x
= 0; (x
< 49) && (packet
[x
] != ':'); x
++)
3151 LOG_DEBUG("received packet: '%s:<binary-data>'", buf
);
3153 LOG_DEBUG("received packet: '%s'", packet
);
3156 if (packet_size
> 0) {
3158 switch (packet
[0]) {
3159 case 'T': /* Is thread alive? */
3160 gdb_thread_packet(connection
, packet
, packet_size
);
3162 case 'H': /* Set current thread ( 'c' for step and continue,
3163 * 'g' for all other operations ) */
3164 gdb_thread_packet(connection
, packet
, packet_size
);
3168 retval
= gdb_thread_packet(connection
, packet
, packet_size
);
3169 if (retval
== GDB_THREAD_PACKET_NOT_CONSUMED
)
3170 retval
= gdb_query_packet(connection
, packet
, packet_size
);
3173 retval
= gdb_get_registers_packet(connection
, packet
, packet_size
);
3176 retval
= gdb_set_registers_packet(connection
, packet
, packet_size
);
3179 retval
= gdb_get_register_packet(connection
, packet
, packet_size
);
3182 retval
= gdb_set_register_packet(connection
, packet
, packet_size
);
3185 retval
= gdb_read_memory_packet(connection
, packet
, packet_size
);
3188 retval
= gdb_write_memory_packet(connection
, packet
, packet_size
);
3192 retval
= gdb_breakpoint_watchpoint_packet(connection
, packet
, packet_size
);
3195 gdb_last_signal_packet(connection
, packet
, packet_size
);
3200 gdb_thread_packet(connection
, packet
, packet_size
);
3201 log_add_callback(gdb_log_callback
, connection
);
3203 if (gdb_con
->mem_write_error
) {
3204 LOG_ERROR("Memory write failure!");
3206 /* now that we have reported the memory write error,
3207 * we can clear the condition */
3208 gdb_con
->mem_write_error
= false;
3211 bool nostep
= false;
3212 bool already_running
= false;
3213 if (target
->state
== TARGET_RUNNING
) {
3214 LOG_WARNING("WARNING! The target is already running. "
3215 "All changes GDB did to registers will be discarded! "
3216 "Waiting for target to halt.");
3217 already_running
= true;
3218 } else if (target
->state
!= TARGET_HALTED
) {
3219 LOG_WARNING("The target is not in the halted nor running stated, " \
3220 "stepi/continue ignored.");
3222 } else if ((packet
[0] == 's') && gdb_con
->sync
) {
3223 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
3224 * sent by GDB first to OpenOCD, thus defeating the check to
3225 * make only the single stepping have the sync feature...
3228 LOG_DEBUG("stepi ignored. GDB will now fetch the register state " \
3229 "from the target.");
3231 gdb_con
->sync
= false;
3233 if (!already_running
&& nostep
) {
3234 /* Either the target isn't in the halted state, then we can't
3235 * step/continue. This might be early setup, etc.
3237 * Or we want to allow GDB to pick up a fresh set of
3238 * register values without modifying the target state.
3241 gdb_sig_halted(connection
);
3243 /* stop forwarding log packets! */
3244 log_remove_callback(gdb_log_callback
, connection
);
3246 /* We're running/stepping, in which case we can
3247 * forward log output until the target is halted
3249 gdb_con
->frontend_state
= TARGET_RUNNING
;
3250 target_call_event_callbacks(target
, TARGET_EVENT_GDB_START
);
3252 if (!already_running
) {
3253 /* Here we don't want packet processing to stop even if this fails,
3254 * so we use a local variable instead of retval. */
3255 retval
= gdb_step_continue_packet(connection
, packet
, packet_size
);
3256 if (retval
!= ERROR_OK
) {
3257 /* we'll never receive a halted
3258 * condition... issue a false one..
3260 gdb_frontend_halted(target
, connection
);
3267 retval
= gdb_v_packet(connection
, packet
, packet_size
);
3270 retval
= gdb_detach(connection
);
3271 extended_protocol
= 0;
3274 retval
= gdb_write_memory_binary_packet(connection
, packet
, packet_size
);
3275 if (retval
!= ERROR_OK
)
3279 if (extended_protocol
!= 0) {
3280 gdb_con
->attached
= false;
3283 gdb_put_packet(connection
, "OK", 2);
3284 return ERROR_SERVER_REMOTE_CLOSED
;
3286 /* handle extended remote protocol */
3287 extended_protocol
= 1;
3288 gdb_put_packet(connection
, "OK", 2);
3291 /* handle extended restart packet */
3292 breakpoint_clear_target(target
);
3293 watchpoint_clear_target(target
);
3294 command_run_linef(connection
->cmd_ctx
, "ocd_gdb_restart %s",
3295 target_name(target
));
3296 /* set connection as attached after reset */
3297 gdb_con
->attached
= true;
3298 /* info rtos parts */
3299 gdb_thread_packet(connection
, packet
, packet_size
);
3303 /* packet supported only by smp target i.e cortex_a.c*/
3304 /* handle smp packet replying coreid played to gbd */
3305 gdb_read_smp_packet(connection
, packet
, packet_size
);
3309 /* packet supported only by smp target i.e cortex_a.c */
3310 /* handle smp packet setting coreid to be played at next
3312 gdb_write_smp_packet(connection
, packet
, packet_size
);
3316 /* File-I/O extension */
3317 /* After gdb uses host-side syscall to complete target file
3318 * I/O, gdb sends host-side syscall return value to target
3320 * The format of 'F' response packet is
3321 * Fretcode,errno,Ctrl-C flag;call-specific attachment
3323 gdb_con
->frontend_state
= TARGET_RUNNING
;
3324 log_add_callback(gdb_log_callback
, connection
);
3325 gdb_fileio_response_packet(connection
, packet
, packet_size
);
3329 /* ignore unknown packets */
3330 LOG_DEBUG("ignoring 0x%2.2x packet", packet
[0]);
3331 gdb_put_packet(connection
, "", 0);
3335 /* if a packet handler returned an error, exit input loop */
3336 if (retval
!= ERROR_OK
)
3340 if (gdb_con
->ctrl_c
) {
3341 if (target
->state
== TARGET_RUNNING
) {
3342 struct target
*t
= target
;
3344 target
->rtos
->gdb_target_for_threadid(connection
, target
->rtos
->current_threadid
, &t
);
3345 retval
= target_halt(t
);
3346 if (retval
== ERROR_OK
)
3347 retval
= target_poll(t
);
3348 if (retval
!= ERROR_OK
)
3349 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
3350 gdb_con
->ctrl_c
= 0;
3352 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
3353 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
3357 } while (gdb_con
->buf_cnt
> 0);
3362 static int gdb_input(struct connection
*connection
)
3364 int retval
= gdb_input_inner(connection
);
3365 struct gdb_connection
*gdb_con
= connection
->priv
;
3366 if (retval
== ERROR_SERVER_REMOTE_CLOSED
)
3369 /* logging does not propagate the error, yet can set the gdb_con->closed flag */
3370 if (gdb_con
->closed
)
3371 return ERROR_SERVER_REMOTE_CLOSED
;
3373 /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
3377 static int gdb_target_start(struct target
*target
, const char *port
)
3379 struct gdb_service
*gdb_service
;
3381 gdb_service
= malloc(sizeof(struct gdb_service
));
3383 if (NULL
== gdb_service
)
3386 LOG_DEBUG("starting gdb server for %s on %s", target_name(target
), port
);
3388 gdb_service
->target
= target
;
3389 gdb_service
->core
[0] = -1;
3390 gdb_service
->core
[1] = -1;
3391 target
->gdb_service
= gdb_service
;
3393 ret
= add_service("gdb",
3394 port
, 1, &gdb_new_connection
, &gdb_input
,
3395 &gdb_connection_closed
, gdb_service
);
3396 /* initialialize all targets gdb service with the same pointer */
3398 struct target_list
*head
;
3399 struct target
*curr
;
3400 head
= target
->head
;
3401 while (head
!= (struct target_list
*)NULL
) {
3402 curr
= head
->target
;
3404 curr
->gdb_service
= gdb_service
;
3411 static int gdb_target_add_one(struct target
*target
)
3413 /* one gdb instance per smp list */
3414 if ((target
->smp
) && (target
->gdb_service
))
3417 /* skip targets that cannot handle a gdb connections (e.g. mem_ap) */
3418 if (!target_supports_gdb_connection(target
)) {
3419 LOG_DEBUG("skip gdb server for target %s", target_name(target
));
3423 if (target
->gdb_port_override
) {
3424 if (strcmp(target
->gdb_port_override
, "disabled") == 0) {
3425 LOG_INFO("gdb port disabled");
3428 return gdb_target_start(target
, target
->gdb_port_override
);
3431 if (strcmp(gdb_port
, "disabled") == 0) {
3432 LOG_INFO("gdb port disabled");
3436 int retval
= gdb_target_start(target
, gdb_port_next
);
3437 if (retval
== ERROR_OK
) {
3438 /* save the port number so can be queried with
3439 * $target_name cget -gdb-port
3441 target
->gdb_port_override
= strdup(gdb_port_next
);
3444 /* If we can parse the port number
3445 * then we increment the port number for the next target.
3448 portnumber
= strtol(gdb_port_next
, &end
, 0);
3450 if (parse_long(gdb_port_next
, &portnumber
) == ERROR_OK
) {
3451 free(gdb_port_next
);
3453 gdb_port_next
= alloc_printf("%d", portnumber
+1);
3455 /* Don't increment if gdb_port is 0, since we're just
3456 * trying to allocate an unused port. */
3457 gdb_port_next
= strdup("0");
3465 int gdb_target_add_all(struct target
*target
)
3467 if (NULL
== target
) {
3468 LOG_WARNING("gdb services need one or more targets defined");
3472 while (NULL
!= target
) {
3473 int retval
= gdb_target_add_one(target
);
3474 if (ERROR_OK
!= retval
)
3477 target
= target
->next
;
3483 COMMAND_HANDLER(handle_gdb_sync_command
)
3486 return ERROR_COMMAND_SYNTAX_ERROR
;
3488 if (current_gdb_connection
== NULL
) {
3490 "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
3494 current_gdb_connection
->sync
= true;
3499 /* daemon configuration command gdb_port */
3500 COMMAND_HANDLER(handle_gdb_port_command
)
3502 int retval
= CALL_COMMAND_HANDLER(server_pipe_command
, &gdb_port
);
3503 if (ERROR_OK
== retval
) {
3504 free(gdb_port_next
);
3505 gdb_port_next
= strdup(gdb_port
);
3510 COMMAND_HANDLER(handle_gdb_memory_map_command
)
3513 return ERROR_COMMAND_SYNTAX_ERROR
;
3515 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_use_memory_map
);
3519 COMMAND_HANDLER(handle_gdb_flash_program_command
)
3522 return ERROR_COMMAND_SYNTAX_ERROR
;
3524 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_flash_program
);
3528 COMMAND_HANDLER(handle_gdb_report_data_abort_command
)
3531 return ERROR_COMMAND_SYNTAX_ERROR
;
3533 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_report_data_abort
);
3537 COMMAND_HANDLER(handle_gdb_report_register_access_error
)
3540 return ERROR_COMMAND_SYNTAX_ERROR
;
3542 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_report_register_access_error
);
3546 /* gdb_breakpoint_override */
3547 COMMAND_HANDLER(handle_gdb_breakpoint_override_command
)
3549 if (CMD_ARGC
== 0) {
3551 } else if (CMD_ARGC
== 1) {
3552 gdb_breakpoint_override
= 1;
3553 if (strcmp(CMD_ARGV
[0], "hard") == 0)
3554 gdb_breakpoint_override_type
= BKPT_HARD
;
3555 else if (strcmp(CMD_ARGV
[0], "soft") == 0)
3556 gdb_breakpoint_override_type
= BKPT_SOFT
;
3557 else if (strcmp(CMD_ARGV
[0], "disable") == 0)
3558 gdb_breakpoint_override
= 0;
3560 return ERROR_COMMAND_SYNTAX_ERROR
;
3561 if (gdb_breakpoint_override
)
3562 LOG_USER("force %s breakpoints",
3563 (gdb_breakpoint_override_type
== BKPT_HARD
) ? "hard" : "soft");
3565 LOG_USER("breakpoint type is not overridden");
3570 COMMAND_HANDLER(handle_gdb_target_description_command
)
3573 return ERROR_COMMAND_SYNTAX_ERROR
;
3575 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], gdb_use_target_description
);
3579 COMMAND_HANDLER(handle_gdb_save_tdesc_command
)
3582 uint32_t tdesc_length
;
3583 struct target
*target
= get_current_target(CMD_CTX
);
3585 int retval
= gdb_generate_target_description(target
, &tdesc
);
3586 if (retval
!= ERROR_OK
) {
3587 LOG_ERROR("Unable to Generate Target Description");
3591 tdesc_length
= strlen(tdesc
);
3593 struct fileio
*fileio
;
3594 size_t size_written
;
3596 char *tdesc_filename
= alloc_printf("%s.xml", target_type_name(target
));
3597 if (tdesc_filename
== NULL
) {
3598 retval
= ERROR_FAIL
;
3602 retval
= fileio_open(&fileio
, tdesc_filename
, FILEIO_WRITE
, FILEIO_TEXT
);
3604 if (retval
!= ERROR_OK
) {
3605 LOG_ERROR("Can't open %s for writing", tdesc_filename
);
3609 retval
= fileio_write(fileio
, tdesc_length
, tdesc
, &size_written
);
3611 fileio_close(fileio
);
3613 if (retval
!= ERROR_OK
)
3614 LOG_ERROR("Error while writing the tdesc file");
3617 free(tdesc_filename
);
3623 static const struct command_registration gdb_command_handlers
[] = {
3626 .handler
= handle_gdb_sync_command
,
3627 .mode
= COMMAND_ANY
,
3628 .help
= "next stepi will return immediately allowing "
3629 "GDB to fetch register state without affecting "
3635 .handler
= handle_gdb_port_command
,
3636 .mode
= COMMAND_ANY
,
3637 .help
= "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
3638 "server listens for the next port number after the "
3639 "base port number specified. "
3640 "No arguments reports GDB port. \"pipe\" means listen to stdin "
3641 "output to stdout, an integer is base port number, \"disabled\" disables "
3642 "port. Any other string is are interpreted as named pipe to listen to. "
3643 "Output pipe is the same name as input pipe, but with 'o' appended.",
3644 .usage
= "[port_num]",
3647 .name
= "gdb_memory_map",
3648 .handler
= handle_gdb_memory_map_command
,
3649 .mode
= COMMAND_CONFIG
,
3650 .help
= "enable or disable memory map",
3651 .usage
= "('enable'|'disable')"
3654 .name
= "gdb_flash_program",
3655 .handler
= handle_gdb_flash_program_command
,
3656 .mode
= COMMAND_CONFIG
,
3657 .help
= "enable or disable flash program",
3658 .usage
= "('enable'|'disable')"
3661 .name
= "gdb_report_data_abort",
3662 .handler
= handle_gdb_report_data_abort_command
,
3663 .mode
= COMMAND_CONFIG
,
3664 .help
= "enable or disable reporting data aborts",
3665 .usage
= "('enable'|'disable')"
3668 .name
= "gdb_report_register_access_error",
3669 .handler
= handle_gdb_report_register_access_error
,
3670 .mode
= COMMAND_CONFIG
,
3671 .help
= "enable or disable reporting register access errors",
3672 .usage
= "('enable'|'disable')"
3675 .name
= "gdb_breakpoint_override",
3676 .handler
= handle_gdb_breakpoint_override_command
,
3677 .mode
= COMMAND_ANY
,
3678 .help
= "Display or specify type of breakpoint "
3679 "to be used by gdb 'break' commands.",
3680 .usage
= "('hard'|'soft'|'disable')"
3683 .name
= "gdb_target_description",
3684 .handler
= handle_gdb_target_description_command
,
3685 .mode
= COMMAND_CONFIG
,
3686 .help
= "enable or disable target description",
3687 .usage
= "('enable'|'disable')"
3690 .name
= "gdb_save_tdesc",
3691 .handler
= handle_gdb_save_tdesc_command
,
3692 .mode
= COMMAND_EXEC
,
3693 .help
= "Save the target description file",
3696 COMMAND_REGISTRATION_DONE
3699 int gdb_register_commands(struct command_context
*cmd_ctx
)
3701 gdb_port
= strdup("3333");
3702 gdb_port_next
= strdup("3333");
3703 return register_commands(cmd_ctx
, NULL
, gdb_command_handlers
);
3706 void gdb_service_free(void)
3709 free(gdb_port_next
);