diff options
Diffstat (limited to 'src/server')
| -rw-r--r-- | src/server/Makefile.am | 23 | ||||
| -rw-r--r-- | src/server/gdb_server.c | 3197 | ||||
| -rw-r--r-- | src/server/gdb_server.h | 51 | ||||
| -rw-r--r-- | src/server/server.c | 751 | ||||
| -rw-r--r-- | src/server/server.h | 112 | ||||
| -rw-r--r-- | src/server/server_stubs.c | 30 | ||||
| -rw-r--r-- | src/server/startup.tcl | 10 | ||||
| -rw-r--r-- | src/server/tcl_server.c | 361 | ||||
| -rw-r--r-- | src/server/tcl_server.h | 26 | ||||
| -rw-r--r-- | src/server/telnet_server.c | 682 | ||||
| -rw-r--r-- | src/server/telnet_server.h | 70 |
11 files changed, 0 insertions, 5313 deletions
diff --git a/src/server/Makefile.am b/src/server/Makefile.am deleted file mode 100644 index 04d3035..0000000 --- a/src/server/Makefile.am +++ /dev/null @@ -1,23 +0,0 @@ -include $(top_srcdir)/common.mk - -METASOURCES = AUTO -noinst_LTLIBRARIES = libserver.la -noinst_HEADERS = server.h telnet_server.h gdb_server.h -libserver_la_SOURCES = server.c telnet_server.c gdb_server.c - -libserver_la_SOURCES += server_stubs.c - -libserver_la_CFLAGS = -if IS_MINGW -# FD_* macros are sloppy with their signs on MinGW32 platform -libserver_la_CFLAGS += -Wno-sign-compare -endif - -# tcl server addons -noinst_HEADERS += tcl_server.h -libserver_la_SOURCES += tcl_server.c - -EXTRA_DIST = \ - startup.tcl - -MAINTAINERCLEANFILES = $(srcdir)/Makefile.in diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c deleted file mode 100644 index 2387496..0000000 --- a/src/server/gdb_server.c +++ /dev/null @@ -1,3197 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007-2010 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * Copyright (C) 2011 by Broadcom Corporation * - * Evan Hunter - ehunter@broadcom.com * - * * - * Copyright (C) ST-Ericsson SA 2011 * - * michel.jaouen@stericsson.com : smp minimum support * - * * - * Copyright (C) 2013 Andes Technology * - * Hsiangkai Wang <hkwang@andestech.com> * - * * - * Copyright (C) 2013 Franck Jullien * - * elec4fun@gmail.com * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include <target/breakpoints.h> -#include <target/target_request.h> -#include <target/register.h> -#include "server.h" -#include <flash/nor/core.h> -#include "gdb_server.h" -#include <target/image.h> -#include <jtag/jtag.h> -#include "rtos/rtos.h" -#include "target/smp.h" - -/** - * @file - * GDB server implementation. - * - * This implements the GDB Remote Serial Protocol, over TCP connections, - * giving GDB access to the JTAG or other hardware debugging facilities - * found in most modern embedded processors. - */ - -struct target_desc_format { - char *tdesc; - uint32_t tdesc_length; -}; - -/* private connection data for GDB */ -struct gdb_connection { - char buffer[GDB_BUFFER_SIZE]; - char *buf_p; - int buf_cnt; - int ctrl_c; - enum target_state frontend_state; - struct image *vflash_image; - int closed; - int busy; - int noack_mode; - /* set flag to true if you want the next stepi to return immediately. - * allowing GDB to pick up a fresh set of register values from the target - * without modifying the target state. */ - bool sync; - /* We delay reporting memory write errors until next step/continue or memory - * write. This improves performance of gdb load significantly as the GDB packet - * can be replied immediately and a new GDB packet will be ready without delay - * (ca. 10% or so...). */ - bool mem_write_error; - /* with extended-remote it seems we need to better emulate attach/detach. - * what this means is we reply with a W stop reply after a kill packet, - * normally we reply with a S reply via gdb_last_signal_packet. - * as a side note this behaviour only effects gdb > 6.8 */ - bool attached; - /* temporarily used for target description support */ - struct target_desc_format target_desc; -}; - -#if 0 -#define _DEBUG_GDB_IO_ -#endif - -static struct gdb_connection *current_gdb_connection; - -static int gdb_breakpoint_override; -static enum breakpoint_type gdb_breakpoint_override_type; - -static int gdb_error(struct connection *connection, int retval); -static char *gdb_port; -static char *gdb_port_next; - -static void gdb_log_callback(void *priv, const char *file, unsigned line, - const char *function, const char *string); - -/* number of gdb connections, mainly to suppress gdb related debugging spam - * in helper/log.c when no gdb connections are actually active */ -int gdb_actual_connections; - -/* set if we are sending a memory map to gdb - * via qXfer:memory-map:read packet */ -/* enabled by default*/ -static int gdb_use_memory_map = 1; -/* enabled by default*/ -static int gdb_flash_program = 1; - -/* if set, data aborts cause an error to be reported in memory read packets - * see the code in gdb_read_memory_packet() for further explanations. - * Disabled by default. - */ -static int gdb_report_data_abort; - -/* set if we are sending target descriptions to gdb - * via qXfer:features:read packet */ -/* enabled by default */ -static int gdb_use_target_description = 1; - -/* current processing free-run type, used by file-I/O */ -static char gdb_running_type; - -static int gdb_last_signal(struct target *target) -{ - switch (target->debug_reason) { - case DBG_REASON_DBGRQ: - return 0x2; /* SIGINT */ - case DBG_REASON_BREAKPOINT: - case DBG_REASON_WATCHPOINT: - case DBG_REASON_WPTANDBKPT: - return 0x05; /* SIGTRAP */ - case DBG_REASON_SINGLESTEP: - return 0x05; /* SIGTRAP */ - case DBG_REASON_NOTHALTED: - return 0x0; /* no signal... shouldn't happen */ - default: - LOG_USER("undefined debug reason %d - target needs reset", - target->debug_reason); - return 0x0; - } -} - -static int check_pending(struct connection *connection, - int timeout_s, int *got_data) -{ - /* a non-blocking socket will block if there is 0 bytes available on the socket, - * but return with as many bytes as are available immediately - */ - struct timeval tv; - fd_set read_fds; - struct gdb_connection *gdb_con = connection->priv; - int t; - if (got_data == NULL) - got_data = &t; - *got_data = 0; - - if (gdb_con->buf_cnt > 0) { - *got_data = 1; - return ERROR_OK; - } - - FD_ZERO(&read_fds); - FD_SET(connection->fd, &read_fds); - - tv.tv_sec = timeout_s; - tv.tv_usec = 0; - if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) { - /* This can typically be because a "monitor" command took too long - * before printing any progress messages - */ - if (timeout_s > 0) - return ERROR_GDB_TIMEOUT; - else - return ERROR_OK; - } - *got_data = FD_ISSET(connection->fd, &read_fds) != 0; - return ERROR_OK; -} - -static int gdb_get_char_inner(struct connection *connection, int *next_char) -{ - struct gdb_connection *gdb_con = connection->priv; - int retval = ERROR_OK; - -#ifdef _DEBUG_GDB_IO_ - char *debug_buffer; -#endif - for (;; ) { - if (connection->service->type != CONNECTION_TCP) - gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE); - else { - retval = check_pending(connection, 1, NULL); - if (retval != ERROR_OK) - return retval; - gdb_con->buf_cnt = read_socket(connection->fd, - gdb_con->buffer, - GDB_BUFFER_SIZE); - } - - if (gdb_con->buf_cnt > 0) - break; - if (gdb_con->buf_cnt == 0) { - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - } - -#ifdef _WIN32 - errno = WSAGetLastError(); - - switch (errno) { - case WSAEWOULDBLOCK: - usleep(1000); - break; - case WSAECONNABORTED: - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - case WSAECONNRESET: - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - default: - LOG_ERROR("read: %d", errno); - exit(-1); - } -#else - switch (errno) { - case EAGAIN: - usleep(1000); - break; - case ECONNABORTED: - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - case ECONNRESET: - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - default: - LOG_ERROR("read: %s", strerror(errno)); - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - } -#endif - } - -#ifdef _DEBUG_GDB_IO_ - debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt); - LOG_DEBUG("received '%s'", debug_buffer); - free(debug_buffer); -#endif - - gdb_con->buf_p = gdb_con->buffer; - gdb_con->buf_cnt--; - *next_char = *(gdb_con->buf_p++); - if (gdb_con->buf_cnt > 0) - connection->input_pending = 1; - else - connection->input_pending = 0; -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char); -#endif - - return retval; -} - -/** - * The cool thing about this fn is that it allows buf_p and buf_cnt to be - * held in registers in the inner loop. - * - * For small caches and embedded systems this is important! - */ -static inline int gdb_get_char_fast(struct connection *connection, - int *next_char, char **buf_p, int *buf_cnt) -{ - int retval = ERROR_OK; - - if ((*buf_cnt)-- > 0) { - *next_char = **buf_p; - (*buf_p)++; - if (*buf_cnt > 0) - connection->input_pending = 1; - else - connection->input_pending = 0; - -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char); -#endif - - return ERROR_OK; - } - - struct gdb_connection *gdb_con = connection->priv; - gdb_con->buf_p = *buf_p; - gdb_con->buf_cnt = *buf_cnt; - retval = gdb_get_char_inner(connection, next_char); - *buf_p = gdb_con->buf_p; - *buf_cnt = gdb_con->buf_cnt; - - return retval; -} - -static int gdb_get_char(struct connection *connection, int *next_char) -{ - struct gdb_connection *gdb_con = connection->priv; - return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt); -} - -static int gdb_putback_char(struct connection *connection, int last_char) -{ - struct gdb_connection *gdb_con = connection->priv; - - if (gdb_con->buf_p > gdb_con->buffer) { - *(--gdb_con->buf_p) = last_char; - gdb_con->buf_cnt++; - } else - LOG_ERROR("BUG: couldn't put character back"); - - return ERROR_OK; -} - -/* The only way we can detect that the socket is closed is the first time - * we write to it, we will fail. Subsequent write operations will - * succeed. Shudder! */ -static int gdb_write(struct connection *connection, void *data, int len) -{ - struct gdb_connection *gdb_con = connection->priv; - if (gdb_con->closed) - return ERROR_SERVER_REMOTE_CLOSED; - - if (connection_write(connection, data, len) == len) - return ERROR_OK; - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; -} - -static int gdb_put_packet_inner(struct connection *connection, - char *buffer, int len) -{ - int i; - unsigned char my_checksum = 0; -#ifdef _DEBUG_GDB_IO_ - char *debug_buffer; -#endif - int reply; - int retval; - struct gdb_connection *gdb_con = connection->priv; - - for (i = 0; i < len; i++) - my_checksum += buffer[i]; - -#ifdef _DEBUG_GDB_IO_ - /* - * At this point we should have nothing in the input queue from GDB, - * however sometimes '-' is sent even though we've already received - * an ACK (+) for everything we've sent off. - */ - int gotdata; - for (;; ) { - retval = check_pending(connection, 0, &gotdata); - if (retval != ERROR_OK) - return retval; - if (!gotdata) - break; - retval = gdb_get_char(connection, &reply); - if (retval != ERROR_OK) - return retval; - if (reply == '$') { - /* fix a problem with some IAR tools */ - gdb_putback_char(connection, reply); - LOG_DEBUG("Unexpected start of new packet"); - break; - } - - LOG_WARNING("Discard unexpected char %c", reply); - } -#endif - - while (1) { -#ifdef _DEBUG_GDB_IO_ - debug_buffer = strndup(buffer, len); - LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum); - free(debug_buffer); -#endif - - char local_buffer[1024]; - local_buffer[0] = '$'; - if ((size_t)len + 4 <= sizeof(local_buffer)) { - /* performance gain on smaller packets by only a single call to gdb_write() */ - memcpy(local_buffer + 1, buffer, len++); - len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum); - retval = gdb_write(connection, local_buffer, len); - if (retval != ERROR_OK) - return retval; - } else { - /* larger packets are transmitted directly from caller supplied buffer - * by several calls to gdb_write() to avoid dynamic allocation */ - snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum); - retval = gdb_write(connection, local_buffer, 1); - if (retval != ERROR_OK) - return retval; - retval = gdb_write(connection, buffer, len); - if (retval != ERROR_OK) - return retval; - retval = gdb_write(connection, local_buffer + 1, 3); - if (retval != ERROR_OK) - return retval; - } - - if (gdb_con->noack_mode) - break; - - retval = gdb_get_char(connection, &reply); - if (retval != ERROR_OK) - return retval; - - if (reply == '+') - break; - else if (reply == '-') { - /* Stop sending output packets for now */ - log_remove_callback(gdb_log_callback, connection); - LOG_WARNING("negative reply, retrying"); - } else if (reply == 0x3) { - gdb_con->ctrl_c = 1; - retval = gdb_get_char(connection, &reply); - if (retval != ERROR_OK) - return retval; - if (reply == '+') - break; - else if (reply == '-') { - /* Stop sending output packets for now */ - log_remove_callback(gdb_log_callback, connection); - LOG_WARNING("negative reply, retrying"); - } else if (reply == '$') { - LOG_ERROR("GDB missing ack(1) - assumed good"); - gdb_putback_char(connection, reply); - return ERROR_OK; - } else { - LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply); - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - } - } else if (reply == '$') { - LOG_ERROR("GDB missing ack(2) - assumed good"); - gdb_putback_char(connection, reply); - return ERROR_OK; - } else { - LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection", - reply); - gdb_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; - } - } - if (gdb_con->closed) - return ERROR_SERVER_REMOTE_CLOSED; - - return ERROR_OK; -} - -int gdb_put_packet(struct connection *connection, char *buffer, int len) -{ - struct gdb_connection *gdb_con = connection->priv; - gdb_con->busy = 1; - int retval = gdb_put_packet_inner(connection, buffer, len); - gdb_con->busy = 0; - - /* we sent some data, reset timer for keep alive messages */ - kept_alive(); - - return retval; -} - -static inline int fetch_packet(struct connection *connection, - int *checksum_ok, int noack, int *len, char *buffer) -{ - unsigned char my_checksum = 0; - char checksum[3]; - int character; - int retval = ERROR_OK; - - struct gdb_connection *gdb_con = connection->priv; - my_checksum = 0; - int count = 0; - count = 0; - - /* move this over into local variables to use registers and give the - * more freedom to optimize */ - char *buf_p = gdb_con->buf_p; - int buf_cnt = gdb_con->buf_cnt; - - for (;; ) { - /* The common case is that we have an entire packet with no escape chars. - * We need to leave at least 2 bytes in the buffer to have - * gdb_get_char() update various bits and bobs correctly. - */ - if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) { - /* The compiler will struggle a bit with constant propagation and - * aliasing, so we help it by showing that these values do not - * change inside the loop - */ - int i; - char *buf = buf_p; - int run = buf_cnt - 2; - i = 0; - int done = 0; - while (i < run) { - character = *buf++; - i++; - if (character == '#') { - /* Danger! character can be '#' when esc is - * used so we need an explicit boolean for done here. */ - done = 1; - break; - } - - if (character == '}') { - /* data transmitted in binary mode (X packet) - * uses 0x7d as escape character */ - my_checksum += character & 0xff; - character = *buf++; - i++; - my_checksum += character & 0xff; - buffer[count++] = (character ^ 0x20) & 0xff; - } else { - my_checksum += character & 0xff; - buffer[count++] = character & 0xff; - } - } - buf_p += i; - buf_cnt -= i; - if (done) - break; - } - if (count > *len) { - LOG_ERROR("packet buffer too small"); - retval = ERROR_GDB_BUFFER_TOO_SMALL; - break; - } - - retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt); - if (retval != ERROR_OK) - break; - - if (character == '#') - break; - - if (character == '}') { - /* data transmitted in binary mode (X packet) - * uses 0x7d as escape character */ - my_checksum += character & 0xff; - - retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt); - if (retval != ERROR_OK) - break; - - my_checksum += character & 0xff; - buffer[count++] = (character ^ 0x20) & 0xff; - } else { - my_checksum += character & 0xff; - buffer[count++] = character & 0xff; - } - } - - gdb_con->buf_p = buf_p; - gdb_con->buf_cnt = buf_cnt; - - if (retval != ERROR_OK) - return retval; - - *len = count; - - retval = gdb_get_char(connection, &character); - if (retval != ERROR_OK) - return retval; - checksum[0] = character; - retval = gdb_get_char(connection, &character); - if (retval != ERROR_OK) - return retval; - checksum[1] = character; - checksum[2] = 0; - - if (!noack) - *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16)); - - return ERROR_OK; -} - -static int gdb_get_packet_inner(struct connection *connection, - char *buffer, int *len) -{ - int character; - int retval; - struct gdb_connection *gdb_con = connection->priv; - - while (1) { - do { - retval = gdb_get_char(connection, &character); - if (retval != ERROR_OK) - return retval; - -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("character: '%c'", character); -#endif - - switch (character) { - case '$': - break; - case '+': - /* According to the GDB documentation - * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html): - * "gdb sends a final `+` acknowledgment of the stub's `OK` - * response, which can be safely ignored by the stub." - * However OpenOCD server already is in noack mode at this - * point and instead of ignoring this it was emitting a - * warning. This code makes server ignore the first ACK - * that will be received after going into noack mode, - * warning only about subsequent ACK's. */ - if (gdb_con->noack_mode > 1) { - LOG_WARNING("acknowledgment received, but no packet pending"); - } else if (gdb_con->noack_mode) { - LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it."); - gdb_con->noack_mode = 2; - } - break; - case '-': - LOG_WARNING("negative acknowledgment, but no packet pending"); - break; - case 0x3: - gdb_con->ctrl_c = 1; - *len = 0; - return ERROR_OK; - default: - LOG_WARNING("ignoring character 0x%x", character); - break; - } - } while (character != '$'); - - int checksum_ok = 0; - /* explicit code expansion here to get faster inlined code in -O3 by not - * calculating checksum */ - if (gdb_con->noack_mode) { - retval = fetch_packet(connection, &checksum_ok, 1, len, buffer); - if (retval != ERROR_OK) - return retval; - } else { - retval = fetch_packet(connection, &checksum_ok, 0, len, buffer); - if (retval != ERROR_OK) - return retval; - } - - if (gdb_con->noack_mode) { - /* checksum is not checked in noack mode */ - break; - } - if (checksum_ok) { - retval = gdb_write(connection, "+", 1); - if (retval != ERROR_OK) - return retval; - break; - } - } - if (gdb_con->closed) - return ERROR_SERVER_REMOTE_CLOSED; - - return ERROR_OK; -} - -static int gdb_get_packet(struct connection *connection, char *buffer, int *len) -{ - struct gdb_connection *gdb_con = connection->priv; - gdb_con->busy = 1; - int retval = gdb_get_packet_inner(connection, buffer, len); - gdb_con->busy = 0; - return retval; -} - -static int gdb_output_con(struct connection *connection, const char *line) -{ - char *hex_buffer; - int bin_size; - - bin_size = strlen(line); - - hex_buffer = malloc(bin_size * 2 + 2); - if (hex_buffer == NULL) - return ERROR_GDB_BUFFER_TOO_SMALL; - - hex_buffer[0] = 'O'; - int pkt_len = hexify(hex_buffer + 1, line, bin_size, bin_size * 2 + 1); - int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1); - - free(hex_buffer); - return retval; -} - -static int gdb_output(struct command_context *context, const char *line) -{ - /* this will be dumped to the log and also sent as an O packet if possible */ - LOG_USER_N("%s", line); - return ERROR_OK; -} - -static void gdb_signal_reply(struct target *target, struct connection *connection) -{ - struct gdb_connection *gdb_connection = connection->priv; - char sig_reply[45]; - char stop_reason[20]; - char current_thread[25]; - int sig_reply_len; - int signal_var; - - rtos_update_threads(target); - - if (target->debug_reason == DBG_REASON_EXIT) { - sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "W00"); - } else { - if (gdb_connection->ctrl_c) { - signal_var = 0x2; - gdb_connection->ctrl_c = 0; - } else - signal_var = gdb_last_signal(target); - - stop_reason[0] = '\0'; - if (target->debug_reason == DBG_REASON_WATCHPOINT) { - enum watchpoint_rw hit_wp_type; - uint32_t hit_wp_address; - - if (watchpoint_hit(target, &hit_wp_type, &hit_wp_address) == ERROR_OK) { - - switch (hit_wp_type) { - case WPT_WRITE: - snprintf(stop_reason, sizeof(stop_reason), - "watch:%08" PRIx32 ";", hit_wp_address); - break; - case WPT_READ: - snprintf(stop_reason, sizeof(stop_reason), - "rwatch:%08" PRIx32 ";", hit_wp_address); - break; - case WPT_ACCESS: - snprintf(stop_reason, sizeof(stop_reason), - "awatch:%08" PRIx32 ";", hit_wp_address); - break; - default: - break; - } - } - } - - current_thread[0] = '\0'; - if (target->rtos != NULL) { - snprintf(current_thread, sizeof(current_thread), "thread:%016" PRIx64 ";", target->rtos->current_thread); - target->rtos->current_threadid = target->rtos->current_thread; - } - - sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "T%2.2x%s%s", - signal_var, stop_reason, current_thread); - } - - gdb_put_packet(connection, sig_reply, sig_reply_len); - gdb_connection->frontend_state = TARGET_HALTED; -} - -static void gdb_fileio_reply(struct target *target, struct connection *connection) -{ - struct gdb_connection *gdb_connection = connection->priv; - char fileio_command[256]; - int command_len; - bool program_exited = false; - - if (strcmp(target->fileio_info->identifier, "open") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3, - target->fileio_info->param_4); - else if (strcmp(target->fileio_info->identifier, "close") == 0) - sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1); - else if (strcmp(target->fileio_info->identifier, "read") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3); - else if (strcmp(target->fileio_info->identifier, "write") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3); - else if (strcmp(target->fileio_info->identifier, "lseek") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3); - else if (strcmp(target->fileio_info->identifier, "rename") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 "/%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3, - target->fileio_info->param_4); - else if (strcmp(target->fileio_info->identifier, "unlink") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2); - else if (strcmp(target->fileio_info->identifier, "stat") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2, - target->fileio_info->param_3); - else if (strcmp(target->fileio_info->identifier, "fstat") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2); - else if (strcmp(target->fileio_info->identifier, "gettimeofday") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2); - else if (strcmp(target->fileio_info->identifier, "isatty") == 0) - sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1); - else if (strcmp(target->fileio_info->identifier, "system") == 0) - sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier, - target->fileio_info->param_1, - target->fileio_info->param_2); - else if (strcmp(target->fileio_info->identifier, "exit") == 0) { - /* If target hits exit syscall, report to GDB the program is terminated. - * In addition, let target run its own exit syscall handler. */ - program_exited = true; - sprintf(fileio_command, "W%02" PRIx32, target->fileio_info->param_1); - } else { - LOG_DEBUG("Unknown syscall: %s", target->fileio_info->identifier); - - /* encounter unknown syscall, continue */ - gdb_connection->frontend_state = TARGET_RUNNING; - target_resume(target, 1, 0x0, 0, 0); - return; - } - - command_len = strlen(fileio_command); - gdb_put_packet(connection, fileio_command, command_len); - - if (program_exited) { - /* Use target_resume() to let target run its own exit syscall handler. */ - gdb_connection->frontend_state = TARGET_RUNNING; - target_resume(target, 1, 0x0, 0, 0); - } else { - gdb_connection->frontend_state = TARGET_HALTED; - rtos_update_threads(target); - } -} - -static void gdb_frontend_halted(struct target *target, struct connection *connection) -{ - struct gdb_connection *gdb_connection = connection->priv; - - /* In the GDB protocol when we are stepping or continuing execution, - * we have a lingering reply. Upon receiving a halted event - * when we have that lingering packet, we reply to the original - * step or continue packet. - * - * Executing monitor commands can bring the target in and - * out of the running state so we'll see lots of TARGET_EVENT_XXX - * that are to be ignored. - */ - if (gdb_connection->frontend_state == TARGET_RUNNING) { - /* stop forwarding log packets! */ - log_remove_callback(gdb_log_callback, connection); - - /* check fileio first */ - if (target_get_gdb_fileio_info(target, target->fileio_info) == ERROR_OK) - gdb_fileio_reply(target, connection); - else - gdb_signal_reply(target, connection); - } -} - -static int gdb_target_callback_event_handler(struct target *target, - enum target_event event, void *priv) -{ - int retval; - struct connection *connection = priv; - struct gdb_service *gdb_service = connection->service->priv; - - if (gdb_service->target != target) - return ERROR_OK; - - switch (event) { - case TARGET_EVENT_GDB_HALT: - gdb_frontend_halted(target, connection); - break; - case TARGET_EVENT_HALTED: - target_call_event_callbacks(target, TARGET_EVENT_GDB_END); - break; - case TARGET_EVENT_GDB_FLASH_ERASE_START: - retval = jtag_execute_queue(); - if (retval != ERROR_OK) - return retval; - break; - default: - break; - } - - return ERROR_OK; -} - -static int gdb_new_connection(struct connection *connection) -{ - struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection)); - struct gdb_service *gdb_service = connection->service->priv; - int retval; - int initial_ack; - - connection->priv = gdb_connection; - - /* initialize gdb connection information */ - gdb_connection->buf_p = gdb_connection->buffer; - gdb_connection->buf_cnt = 0; - gdb_connection->ctrl_c = 0; - gdb_connection->frontend_state = TARGET_HALTED; - gdb_connection->vflash_image = NULL; - gdb_connection->closed = 0; - gdb_connection->busy = 0; - gdb_connection->noack_mode = 0; - gdb_connection->sync = false; - gdb_connection->mem_write_error = false; - gdb_connection->attached = true; - gdb_connection->target_desc.tdesc = NULL; - gdb_connection->target_desc.tdesc_length = 0; - - /* send ACK to GDB for debug request */ - gdb_write(connection, "+", 1); - - /* output goes through gdb connection */ - command_set_output_handler(connection->cmd_ctx, gdb_output, connection); - - /* we must remove all breakpoints registered to the target as a previous - * GDB session could leave dangling breakpoints if e.g. communication - * timed out. - */ - breakpoint_clear_target(gdb_service->target); - watchpoint_clear_target(gdb_service->target); - - /* clean previous rtos session if supported*/ - if ((gdb_service->target->rtos) && (gdb_service->target->rtos->type->clean)) - gdb_service->target->rtos->type->clean(gdb_service->target); - - /* remove the initial ACK from the incoming buffer */ - retval = gdb_get_char(connection, &initial_ack); - if (retval != ERROR_OK) - return retval; - - /* FIX!!!??? would we actually ever receive a + here??? - * Not observed. - */ - if (initial_ack != '+') - gdb_putback_char(connection, initial_ack); - target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH); - - if (gdb_use_memory_map) { - /* Connect must fail if the memory map can't be set up correctly. - * - * This will cause an auto_probe to be invoked, which is either - * a no-op or it will fail when the target isn't ready(e.g. not halted). - */ - int i; - for (i = 0; i < flash_get_bank_count(); i++) { - struct flash_bank *p; - p = get_flash_bank_by_num_noprobe(i); - if (p->target != gdb_service->target) - continue; - retval = get_flash_bank_by_num(i, &p); - if (retval != ERROR_OK) { - LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \ - "to prepare target for GDB connect, or use 'gdb_memory_map disable'."); - return retval; - } - } - } - - gdb_actual_connections++; - LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s", - gdb_actual_connections, - target_name(gdb_service->target), - target_state_name(gdb_service->target)); - - /* DANGER! If we fail subsequently, we must remove this handler, - * otherwise we occasionally see crashes as the timer can invoke the - * callback fn. - * - * register callback to be informed about target events */ - target_register_event_callback(gdb_target_callback_event_handler, connection); - - return ERROR_OK; -} - -static int gdb_connection_closed(struct connection *connection) -{ - struct gdb_service *gdb_service = connection->service->priv; - struct gdb_connection *gdb_connection = connection->priv; - - /* we're done forwarding messages. Tear down callback before - * cleaning up connection. - */ - log_remove_callback(gdb_log_callback, connection); - - gdb_actual_connections--; - LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d", - target_name(gdb_service->target), - target_state_name(gdb_service->target), - gdb_actual_connections); - - /* see if an image built with vFlash commands is left */ - if (gdb_connection->vflash_image) { - image_close(gdb_connection->vflash_image); - free(gdb_connection->vflash_image); - gdb_connection->vflash_image = NULL; - } - - /* if this connection registered a debug-message receiver delete it */ - delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target); - - if (connection->priv) { - free(connection->priv); - connection->priv = NULL; - } else - LOG_ERROR("BUG: connection->priv == NULL"); - - target_unregister_event_callback(gdb_target_callback_event_handler, connection); - - target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_END); - - target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH); - - return ERROR_OK; -} - -static void gdb_send_error(struct connection *connection, uint8_t the_error) -{ - char err[4]; - snprintf(err, 4, "E%2.2X", the_error); - gdb_put_packet(connection, err, 3); -} - -static int gdb_last_signal_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - struct gdb_connection *gdb_con = connection->priv; - char sig_reply[4]; - int signal_var; - - if (!gdb_con->attached) { - /* if we are here we have received a kill packet - * reply W stop reply otherwise gdb gets very unhappy */ - gdb_put_packet(connection, "W00", 3); - return ERROR_OK; - } - - signal_var = gdb_last_signal(target); - - snprintf(sig_reply, 4, "S%2.2x", signal_var); - gdb_put_packet(connection, sig_reply, 3); - - return ERROR_OK; -} - -static inline int gdb_reg_pos(struct target *target, int pos, int len) -{ - if (target->endianness == TARGET_LITTLE_ENDIAN) - return pos; - else - return len - 1 - pos; -} - -/* Convert register to string of bytes. NB! The # of bits in the - * register might be non-divisible by 8(a byte), in which - * case an entire byte is shown. - * - * NB! the format on the wire is the target endianness - * - * The format of reg->value is little endian - * - */ -static void gdb_str_to_target(struct target *target, - char *tstr, struct reg *reg) -{ - int i; - - uint8_t *buf; - int buf_len; - buf = reg->value; - buf_len = DIV_ROUND_UP(reg->size, 8); - - for (i = 0; i < buf_len; i++) { - int j = gdb_reg_pos(target, i, buf_len); - tstr += sprintf(tstr, "%02x", buf[j]); - } -} - -/* copy over in register buffer */ -static void gdb_target_to_reg(struct target *target, - char const *tstr, int str_len, uint8_t *bin) -{ - if (str_len % 2) { - LOG_ERROR("BUG: gdb value with uneven number of characters encountered"); - exit(-1); - } - - int i; - for (i = 0; i < str_len; i += 2) { - unsigned t; - if (sscanf(tstr + i, "%02x", &t) != 1) { - LOG_ERROR("BUG: unable to convert register value"); - exit(-1); - } - - int j = gdb_reg_pos(target, i/2, str_len/2); - bin[j] = t; - } -} - -static int gdb_get_registers_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - struct reg **reg_list; - int reg_list_size; - int retval; - int reg_packet_size = 0; - char *reg_packet; - char *reg_packet_p; - int i; - -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("-"); -#endif - - if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg_list(connection))) - return ERROR_OK; - - retval = target_get_gdb_reg_list(target, ®_list, ®_list_size, - REG_CLASS_GENERAL); - if (retval != ERROR_OK) - return gdb_error(connection, retval); - - for (i = 0; i < reg_list_size; i++) - reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2; - - assert(reg_packet_size > 0); - - reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */ - if (reg_packet == NULL) - return ERROR_FAIL; - - reg_packet_p = reg_packet; - - for (i = 0; i < reg_list_size; i++) { - if (!reg_list[i]->valid) { - retval = reg_list[i]->type->get(reg_list[i]); - if (retval != ERROR_OK) { - LOG_DEBUG("Couldn't get register %s.", reg_list[i]->name); - free(reg_packet); - free(reg_list); - return gdb_error(connection, retval); - } - } - gdb_str_to_target(target, reg_packet_p, reg_list[i]); - reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2; - } - -#ifdef _DEBUG_GDB_IO_ - { - char *reg_packet_p_debug; - reg_packet_p_debug = strndup(reg_packet, reg_packet_size); - LOG_DEBUG("reg_packet: %s", reg_packet_p_debug); - free(reg_packet_p_debug); - } -#endif - - gdb_put_packet(connection, reg_packet, reg_packet_size); - free(reg_packet); - - free(reg_list); - - return ERROR_OK; -} - -static int gdb_set_registers_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - int i; - struct reg **reg_list; - int reg_list_size; - int retval; - char const *packet_p; - -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("-"); -#endif - - /* skip command character */ - packet++; - packet_size--; - - if (packet_size % 2) { - LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - retval = target_get_gdb_reg_list(target, ®_list, ®_list_size, - REG_CLASS_GENERAL); - if (retval != ERROR_OK) - return gdb_error(connection, retval); - - packet_p = packet; - for (i = 0; i < reg_list_size; i++) { - uint8_t *bin_buf; - int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2); - - if (packet_p + chars > packet + packet_size) - LOG_ERROR("BUG: register packet is too small for registers"); - - bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8)); - gdb_target_to_reg(target, packet_p, chars, bin_buf); - - retval = reg_list[i]->type->set(reg_list[i], bin_buf); - if (retval != ERROR_OK) { - LOG_DEBUG("Couldn't set register %s.", reg_list[i]->name); - free(reg_list); - free(bin_buf); - return gdb_error(connection, retval); - } - - /* advance packet pointer */ - packet_p += chars; - - free(bin_buf); - } - - /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */ - free(reg_list); - - gdb_put_packet(connection, "OK", 2); - - return ERROR_OK; -} - -static int gdb_get_register_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *reg_packet; - int reg_num = strtoul(packet + 1, NULL, 16); - struct reg **reg_list; - int reg_list_size; - int retval; - -#ifdef _DEBUG_GDB_IO_ - LOG_DEBUG("-"); -#endif - - retval = target_get_gdb_reg_list(target, ®_list, ®_list_size, - REG_CLASS_ALL); - if (retval != ERROR_OK) - return gdb_error(connection, retval); - - if (reg_list_size <= reg_num) { - LOG_ERROR("gdb requested a non-existing register"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - if (!reg_list[reg_num]->valid) { - retval = reg_list[reg_num]->type->get(reg_list[reg_num]); - if (retval != ERROR_OK) { - LOG_DEBUG("Couldn't get register %s.", reg_list[reg_num]->name); - free (reg_list); - return gdb_error(connection, retval); - } - } - - reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1); /* plus one for string termination null */ - - gdb_str_to_target(target, reg_packet, reg_list[reg_num]); - - gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2); - - free(reg_list); - free(reg_packet); - - return ERROR_OK; -} - -static int gdb_set_register_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *separator; - uint8_t *bin_buf; - int reg_num = strtoul(packet + 1, &separator, 16); - struct reg **reg_list; - int reg_list_size; - int retval; - - LOG_DEBUG("-"); - - retval = target_get_gdb_reg_list(target, ®_list, ®_list_size, - REG_CLASS_ALL); - if (retval != ERROR_OK) - return gdb_error(connection, retval); - - if (reg_list_size <= reg_num) { - LOG_ERROR("gdb requested a non-existing register"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - if (*separator != '=') { - LOG_ERROR("GDB 'set register packet', but no '=' following the register number"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - /* convert from GDB-string (target-endian) to hex-string (big-endian) */ - bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8)); - int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2); - - if ((unsigned int)chars != strlen(separator + 1)) { - LOG_ERROR("gdb sent a packet with wrong register size"); - free(bin_buf); - return ERROR_SERVER_REMOTE_CLOSED; - } - - gdb_target_to_reg(target, separator + 1, chars, bin_buf); - - retval = reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf); - if (retval != ERROR_OK){ - LOG_DEBUG("Couldn't set register %s.", reg_list[reg_num]->name); - free(bin_buf); - free(reg_list); - return gdb_error(connection, retval); - } - - gdb_put_packet(connection, "OK", 2); - - free(bin_buf); - free(reg_list); - - return ERROR_OK; -} - -/* No attempt is made to translate the "retval" to - * GDB speak. This has to be done at the calling - * site as no mapping really exists. - */ -static int gdb_error(struct connection *connection, int retval) -{ - LOG_DEBUG("Reporting %i to GDB as generic error", retval); - gdb_send_error(connection, EFAULT); - return ERROR_OK; -} - -/* We don't have to worry about the default 2 second timeout for GDB packets, - * because GDB breaks up large memory reads into smaller reads. - * - * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192????? - */ -static int gdb_read_memory_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *separator; - uint32_t addr = 0; - uint32_t len = 0; - - uint8_t *buffer; - char *hex_buffer; - - int retval = ERROR_OK; - - /* skip command character */ - packet++; - - addr = strtoul(packet, &separator, 16); - - if (*separator != ',') { - LOG_ERROR("incomplete read memory packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - len = strtoul(separator + 1, NULL, 16); - - if (!len) { - LOG_WARNING("invalid read memory packet received (len == 0)"); - gdb_put_packet(connection, NULL, 0); - return ERROR_OK; - } - - buffer = malloc(len); - - LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len); - - retval = target_read_buffer(target, addr, len, buffer); - - if ((retval != ERROR_OK) && !gdb_report_data_abort) { - /* TODO : Here we have to lie and send back all zero's lest stack traces won't work. - * At some point this might be fixed in GDB, in which case this code can be removed. - * - * OpenOCD developers are acutely aware of this problem, but there is nothing - * gained by involving the user in this problem that hopefully will get resolved - * eventually - * - * http://sourceware.org/cgi-bin/gnatsweb.pl? \ - * cmd = view%20audit-trail&database = gdb&pr = 2395 - * - * For now, the default is to fix up things to make current GDB versions work. - * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command. - */ - memset(buffer, 0, len); - retval = ERROR_OK; - } - - if (retval == ERROR_OK) { - hex_buffer = malloc(len * 2 + 1); - - int pkt_len = hexify(hex_buffer, (char *)buffer, len, len * 2 + 1); - - gdb_put_packet(connection, hex_buffer, pkt_len); - - free(hex_buffer); - } else - retval = gdb_error(connection, retval); - - free(buffer); - - return retval; -} - -static int gdb_write_memory_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *separator; - uint32_t addr = 0; - uint32_t len = 0; - - uint8_t *buffer; - int retval; - - /* skip command character */ - packet++; - - addr = strtoul(packet, &separator, 16); - - if (*separator != ',') { - LOG_ERROR("incomplete write memory packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - len = strtoul(separator + 1, &separator, 16); - - if (*(separator++) != ':') { - LOG_ERROR("incomplete write memory packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - buffer = malloc(len); - - LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len); - - if (unhexify((char *)buffer, separator, len) != (int)len) - LOG_ERROR("unable to decode memory packet"); - - retval = target_write_buffer(target, addr, len, buffer); - - if (retval == ERROR_OK) - gdb_put_packet(connection, "OK", 2); - else - retval = gdb_error(connection, retval); - - free(buffer); - - return retval; -} - -static int gdb_write_memory_binary_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *separator; - uint32_t addr = 0; - uint32_t len = 0; - - int retval = ERROR_OK; - - /* skip command character */ - packet++; - - addr = strtoul(packet, &separator, 16); - - if (*separator != ',') { - LOG_ERROR("incomplete write memory binary packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - len = strtoul(separator + 1, &separator, 16); - - if (*(separator++) != ':') { - LOG_ERROR("incomplete write memory binary packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - struct gdb_connection *gdb_connection = connection->priv; - - if (gdb_connection->mem_write_error) { - retval = ERROR_FAIL; - /* now that we have reported the memory write error, we can clear the condition */ - gdb_connection->mem_write_error = false; - } - - /* By replying the packet *immediately* GDB will send us a new packet - * while we write the last one to the target. - */ - if (retval == ERROR_OK) - gdb_put_packet(connection, "OK", 2); - else { - retval = gdb_error(connection, retval); - if (retval != ERROR_OK) - return retval; - } - - if (len) { - LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len); - - retval = target_write_buffer(target, addr, len, (uint8_t *)separator); - if (retval != ERROR_OK) - gdb_connection->mem_write_error = true; - } - - return ERROR_OK; -} - -static int gdb_step_continue_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - int current = 0; - uint32_t address = 0x0; - int retval = ERROR_OK; - - LOG_DEBUG("-"); - - if (packet_size > 1) - address = strtoul(packet + 1, NULL, 16); - else - current = 1; - - gdb_running_type = packet[0]; - if (packet[0] == 'c') { - LOG_DEBUG("continue"); - /* resume at current address, don't handle breakpoints, not debugging */ - retval = target_resume(target, current, address, 0, 0); - } else if (packet[0] == 's') { - LOG_DEBUG("step"); - /* step at current or address, don't handle breakpoints */ - retval = target_step(target, current, address, 0); - } - return retval; -} - -static int gdb_breakpoint_watchpoint_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - int type; - enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */; - enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */; - uint32_t address; - uint32_t size; - char *separator; - int retval; - - LOG_DEBUG("-"); - - type = strtoul(packet + 1, &separator, 16); - - if (type == 0) /* memory breakpoint */ - bp_type = BKPT_SOFT; - else if (type == 1) /* hardware breakpoint */ - bp_type = BKPT_HARD; - else if (type == 2) /* write watchpoint */ - wp_type = WPT_WRITE; - else if (type == 3) /* read watchpoint */ - wp_type = WPT_READ; - else if (type == 4) /* access watchpoint */ - wp_type = WPT_ACCESS; - else { - LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type); - return ERROR_SERVER_REMOTE_CLOSED; - } - - if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD))) - bp_type = gdb_breakpoint_override_type; - - if (*separator != ',') { - LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - address = strtoul(separator + 1, &separator, 16); - - if (*separator != ',') { - LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - size = strtoul(separator + 1, &separator, 16); - - switch (type) { - case 0: - case 1: - if (packet[0] == 'Z') { - retval = breakpoint_add(target, address, size, bp_type); - if (retval != ERROR_OK) { - retval = gdb_error(connection, retval); - if (retval != ERROR_OK) - return retval; - } else - gdb_put_packet(connection, "OK", 2); - } else { - breakpoint_remove(target, address); - gdb_put_packet(connection, "OK", 2); - } - break; - case 2: - case 3: - case 4: - { - if (packet[0] == 'Z') { - retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu); - if (retval != ERROR_OK) { - retval = gdb_error(connection, retval); - if (retval != ERROR_OK) - return retval; - } else - gdb_put_packet(connection, "OK", 2); - } else { - watchpoint_remove(target, address); - gdb_put_packet(connection, "OK", 2); - } - break; - } - default: - break; - } - - return ERROR_OK; -} - -/* print out a string and allocate more space as needed, - * mainly used for XML at this point - */ -static void xml_printf(int *retval, char **xml, int *pos, int *size, - const char *fmt, ...) -{ - if (*retval != ERROR_OK) - return; - int first = 1; - - for (;; ) { - if ((*xml == NULL) || (!first)) { - /* start by 0 to exercise all the code paths. - * Need minimum 2 bytes to fit 1 char and 0 terminator. */ - - *size = *size * 2 + 2; - char *t = *xml; - *xml = realloc(*xml, *size); - if (*xml == NULL) { - if (t) - free(t); - *retval = ERROR_SERVER_REMOTE_CLOSED; - return; - } - } - - va_list ap; - int ret; - va_start(ap, fmt); - ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap); - va_end(ap); - if ((ret > 0) && ((ret + 1) < *size - *pos)) { - *pos += ret; - return; - } - /* there was just enough or not enough space, allocate more. */ - first = 0; - } -} - -static int decode_xfer_read(char const *buf, char **annex, int *ofs, unsigned int *len) -{ - /* Locate the annex. */ - const char *annex_end = strchr(buf, ':'); - if (annex_end == NULL) - return ERROR_FAIL; - - /* After the read marker and annex, qXfer looks like a - * traditional 'm' packet. */ - char *separator; - *ofs = strtoul(annex_end + 1, &separator, 16); - - if (*separator != ',') - return ERROR_FAIL; - - *len = strtoul(separator + 1, NULL, 16); - - /* Extract the annex if needed */ - if (annex != NULL) { - *annex = strndup(buf, annex_end - buf); - if (*annex == NULL) - return ERROR_FAIL; - } - - return ERROR_OK; -} - -static int compare_bank(const void *a, const void *b) -{ - struct flash_bank *b1, *b2; - b1 = *((struct flash_bank **)a); - b2 = *((struct flash_bank **)b); - - if (b1->base == b2->base) - return 0; - else if (b1->base > b2->base) - return 1; - else - return -1; -} - -static int gdb_memory_map(struct connection *connection, - char const *packet, int packet_size) -{ - /* We get away with only specifying flash here. Regions that are not - * specified are treated as if we provided no memory map(if not we - * could detect the holes and mark them as RAM). - * Normally we only execute this code once, but no big deal if we - * have to regenerate it a couple of times. - */ - - struct target *target = get_target_from_connection(connection); - struct flash_bank *p; - char *xml = NULL; - int size = 0; - int pos = 0; - int retval = ERROR_OK; - struct flash_bank **banks; - int offset; - int length; - char *separator; - uint32_t ram_start = 0; - int i; - int target_flash_banks = 0; - - /* skip command character */ - packet += 23; - - offset = strtoul(packet, &separator, 16); - length = strtoul(separator + 1, &separator, 16); - - xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n"); - - /* Sort banks in ascending order. We need to report non-flash - * memory as ram (or rather read/write) by default for GDB, since - * it has no concept of non-cacheable read/write memory (i/o etc). - * - * FIXME Most non-flash addresses are *NOT* RAM! Don't lie. - * Current versions of GDB assume unlisted addresses are RAM... - */ - banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count()); - - for (i = 0; i < flash_get_bank_count(); i++) { - p = get_flash_bank_by_num_noprobe(i); - if (p->target != target) - continue; - retval = get_flash_bank_by_num(i, &p); - if (retval != ERROR_OK) { - free(banks); - gdb_error(connection, retval); - return retval; - } - banks[target_flash_banks++] = p; - } - - qsort(banks, target_flash_banks, sizeof(struct flash_bank *), - compare_bank); - - for (i = 0; i < target_flash_banks; i++) { - int j; - unsigned sector_size = 0; - uint32_t start; - - p = banks[i]; - start = p->base; - - if (ram_start < p->base) - xml_printf(&retval, &xml, &pos, &size, - "<memory type=\"ram\" start=\"0x%x\" " - "length=\"0x%x\"/>\n", - ram_start, p->base - ram_start); - - /* Report adjacent groups of same-size sectors. So for - * example top boot CFI flash will list an initial region - * with several large sectors (maybe 128KB) and several - * smaller ones at the end (maybe 32KB). STR7 will have - * regions with 8KB, 32KB, and 64KB sectors; etc. - */ - for (j = 0; j < p->num_sectors; j++) { - unsigned group_len; - - /* Maybe start a new group of sectors. */ - if (sector_size == 0) { - start = p->base + p->sectors[j].offset; - xml_printf(&retval, &xml, &pos, &size, - "<memory type=\"flash\" " - "start=\"0x%x\" ", - start); - sector_size = p->sectors[j].size; - } - - /* Does this finish a group of sectors? - * If not, continue an already-started group. - */ - if (j == p->num_sectors - 1) - group_len = (p->base + p->size) - start; - else if (p->sectors[j + 1].size != sector_size) - group_len = p->base + p->sectors[j + 1].offset - - start; - else - continue; - - xml_printf(&retval, &xml, &pos, &size, - "length=\"0x%x\">\n" - "<property name=\"blocksize\">" - "0x%x</property>\n" - "</memory>\n", - group_len, - sector_size); - sector_size = 0; - } - - ram_start = p->base + p->size; - } - - if (ram_start != 0) - xml_printf(&retval, &xml, &pos, &size, - "<memory type=\"ram\" start=\"0x%x\" " - "length=\"0x%x\"/>\n", - ram_start, 0-ram_start); - /* ELSE a flash chip could be at the very end of the 32 bit address - * space, in which case ram_start will be precisely 0 - */ - - free(banks); - banks = NULL; - - xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n"); - - if (retval != ERROR_OK) { - gdb_error(connection, retval); - return retval; - } - - if (offset + length > pos) - length = pos - offset; - - char *t = malloc(length + 1); - t[0] = 'l'; - memcpy(t + 1, xml + offset, length); - gdb_put_packet(connection, t, length + 1); - - free(t); - free(xml); - return ERROR_OK; -} - -static const char *gdb_get_reg_type_name(enum reg_type type) -{ - switch (type) { - case REG_TYPE_INT: - return "int"; - case REG_TYPE_INT8: - return "int8"; - case REG_TYPE_INT16: - return "int16"; - case REG_TYPE_INT32: - return "int32"; - case REG_TYPE_INT64: - return "int64"; - case REG_TYPE_INT128: - return "int128"; - case REG_TYPE_UINT8: - return "uint8"; - case REG_TYPE_UINT16: - return "uint16"; - case REG_TYPE_UINT32: - return "uint32"; - case REG_TYPE_UINT64: - return "uint64"; - case REG_TYPE_UINT128: - return "uint128"; - case REG_TYPE_CODE_PTR: - return "code_ptr"; - case REG_TYPE_DATA_PTR: - return "data_ptr"; - case REG_TYPE_FLOAT: - return "float"; - case REG_TYPE_IEEE_SINGLE: - return "ieee_single"; - case REG_TYPE_IEEE_DOUBLE: - return "ieee_double"; - case REG_TYPE_ARCH_DEFINED: - return "int"; /* return arbitrary string to avoid compile warning. */ - } - - return "int"; /* "int" as default value */ -} - -static int gdb_generate_reg_type_description(struct target *target, - char **tdesc, int *pos, int *size, struct reg_data_type *type) -{ - int retval = ERROR_OK; - - if (type->type_class == REG_TYPE_CLASS_VECTOR) { - /* <vector id="id" type="type" count="count"/> */ - xml_printf(&retval, tdesc, pos, size, - "<vector id=\"%s\" type=\"%s\" count=\"%d\"/>\n", - type->id, type->reg_type_vector->type->id, - type->reg_type_vector->count); - - } else if (type->type_class == REG_TYPE_CLASS_UNION) { - /* <union id="id"> - * <field name="name" type="type"/> ... - * </union> */ - xml_printf(&retval, tdesc, pos, size, - "<union id=\"%s\">\n", - type->id); - - struct reg_data_type_union_field *field; - field = type->reg_type_union->fields; - while (field != NULL) { - xml_printf(&retval, tdesc, pos, size, - "<field name=\"%s\" type=\"%s\"/>\n", - field->name, field->type->id); - - field = field->next; - } - - xml_printf(&retval, tdesc, pos, size, - "</union>\n"); - - } else if (type->type_class == REG_TYPE_CLASS_STRUCT) { - struct reg_data_type_struct_field *field; - field = type->reg_type_struct->fields; - - if (field->use_bitfields) { - /* <struct id="id" size="size"> - * <field name="name" start="start" end="end"/> ... - * </struct> */ - xml_printf(&retval, tdesc, pos, size, - "<struct id=\"%s\" size=\"%d\">\n", - type->id, type->reg_type_struct->size); - while (field != NULL) { - xml_printf(&retval, tdesc, pos, size, - "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n", - field->name, field->bitfield->start, - field->bitfield->end); - - field = field->next; - } - } else { - /* <struct id="id"> - * <field name="name" type="type"/> ... - * </struct> */ - xml_printf(&retval, tdesc, pos, size, - "<struct id=\"%s\">\n", - type->id); - while (field != NULL) { - xml_printf(&retval, tdesc, pos, size, - "<field name=\"%s\" type=\"%s\"/>\n", - field->name, field->type->id); - - field = field->next; - } - } - - xml_printf(&retval, tdesc, pos, size, - "</struct>\n"); - - } else if (type->type_class == REG_TYPE_CLASS_FLAGS) { - /* <flags id="id" size="size"> - * <field name="name" start="start" end="end"/> ... - * </flags> */ - xml_printf(&retval, tdesc, pos, size, - "<flags id=\"%s\" size=\"%d\">\n", - type->id, type->reg_type_flags->size); - - struct reg_data_type_flags_field *field; - field = type->reg_type_flags->fields; - while (field != NULL) { - xml_printf(&retval, tdesc, pos, size, - "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n", - field->name, field->bitfield->start, field->bitfield->end); - - field = field->next; - } - - xml_printf(&retval, tdesc, pos, size, - "</flags>\n"); - - } - - return ERROR_OK; -} - -/* Get a list of available target registers features. feature_list must - * be freed by caller. - */ -static int get_reg_features_list(struct target *target, char const **feature_list[], int *feature_list_size, - struct reg **reg_list, int reg_list_size) -{ - int tbl_sz = 0; - - /* Start with only one element */ - *feature_list = calloc(1, sizeof(char *)); - - for (int i = 0; i < reg_list_size; i++) { - if (reg_list[i]->exist == false) - continue; - - if (reg_list[i]->feature != NULL - && reg_list[i]->feature->name != NULL - && (strcmp(reg_list[i]->feature->name, ""))) { - /* We found a feature, check if the feature is already in the - * table. If not, allocate a new entry for the table and - * put the new feature in it. - */ - for (int j = 0; j < (tbl_sz + 1); j++) { - if (!((*feature_list)[j])) { - (*feature_list)[tbl_sz++] = reg_list[i]->feature->name; - *feature_list = realloc(*feature_list, sizeof(char *) * (tbl_sz + 1)); - (*feature_list)[tbl_sz] = NULL; - break; - } else { - if (!strcmp((*feature_list)[j], reg_list[i]->feature->name)) - break; - } - } - } - } - - if (feature_list_size) - *feature_list_size = tbl_sz; - - return ERROR_OK; -} - -static int gdb_generate_target_description(struct target *target, char **tdesc_out) -{ - int retval = ERROR_OK; - struct reg **reg_list = NULL; - int reg_list_size; - char const **features = NULL; - int feature_list_size = 0; - char *tdesc = NULL; - int pos = 0; - int size = 0; - - retval = target_get_gdb_reg_list(target, ®_list, - ®_list_size, REG_CLASS_ALL); - - if (retval != ERROR_OK) { - LOG_ERROR("get register list failed"); - retval = ERROR_FAIL; - goto error; - } - - if (reg_list_size <= 0) { - LOG_ERROR("get register list failed"); - retval = ERROR_FAIL; - goto error; - } - - /* Get a list of available target registers features */ - retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size); - if (retval != ERROR_OK) { - LOG_ERROR("Can't get the registers feature list"); - retval = ERROR_FAIL; - goto error; - } - - /* If we found some features associated with registers, create sections */ - int current_feature = 0; - - xml_printf(&retval, &tdesc, &pos, &size, - "<?xml version=\"1.0\"?>\n" - "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n" - "<target version=\"1.0\">\n"); - - /* generate target description according to register list */ - if (features != NULL) { - while (features[current_feature]) { - - xml_printf(&retval, &tdesc, &pos, &size, - "<feature name=\"%s\">\n", - features[current_feature]); - - int i; - for (i = 0; i < reg_list_size; i++) { - - if (reg_list[i]->exist == false) - continue; - - if (strcmp(reg_list[i]->feature->name, features[current_feature])) - continue; - - const char *type_str; - if (reg_list[i]->reg_data_type != NULL) { - if (reg_list[i]->reg_data_type->type == REG_TYPE_ARCH_DEFINED) { - /* generate <type... first, if there are architecture-defined types. */ - gdb_generate_reg_type_description(target, &tdesc, &pos, &size, - reg_list[i]->reg_data_type); - - type_str = reg_list[i]->reg_data_type->id; - } else { - /* predefined type */ - type_str = gdb_get_reg_type_name( - reg_list[i]->reg_data_type->type); - } - } else { - /* Default type is "int" */ - type_str = "int"; - } - - xml_printf(&retval, &tdesc, &pos, &size, - "<reg name=\"%s\"", reg_list[i]->name); - xml_printf(&retval, &tdesc, &pos, &size, - " bitsize=\"%d\"", reg_list[i]->size); - xml_printf(&retval, &tdesc, &pos, &size, - " regnum=\"%d\"", reg_list[i]->number); - if (reg_list[i]->caller_save) - xml_printf(&retval, &tdesc, &pos, &size, - " save-restore=\"yes\""); - else - xml_printf(&retval, &tdesc, &pos, &size, - " save-restore=\"no\""); - - xml_printf(&retval, &tdesc, &pos, &size, - " type=\"%s\"", type_str); - - if (reg_list[i]->group != NULL) - xml_printf(&retval, &tdesc, &pos, &size, - " group=\"%s\"", reg_list[i]->group); - - xml_printf(&retval, &tdesc, &pos, &size, - "/>\n"); - } - - xml_printf(&retval, &tdesc, &pos, &size, - "</feature>\n"); - - current_feature++; - } - } - - xml_printf(&retval, &tdesc, &pos, &size, - "</target>\n"); - -error: - free(features); - free(reg_list); - - if (retval == ERROR_OK) - *tdesc_out = tdesc; - else - free(tdesc); - - return retval; -} - -static int gdb_get_target_description_chunk(struct target *target, struct target_desc_format *target_desc, - char **chunk, int32_t offset, uint32_t length) -{ - if (target_desc == NULL) { - LOG_ERROR("Unable to Generate Target Description"); - return ERROR_FAIL; - } - - char *tdesc = target_desc->tdesc; - uint32_t tdesc_length = target_desc->tdesc_length; - - if (tdesc == NULL) { - int retval = gdb_generate_target_description(target, &tdesc); - if (retval != ERROR_OK) { - LOG_ERROR("Unable to Generate Target Description"); - return ERROR_FAIL; - } - - tdesc_length = strlen(tdesc); - } - - char transfer_type; - - if (length < (tdesc_length - offset)) - transfer_type = 'm'; - else - transfer_type = 'l'; - - *chunk = malloc(length + 2); - if (*chunk == NULL) { - LOG_ERROR("Unable to allocate memory"); - return ERROR_FAIL; - } - - (*chunk)[0] = transfer_type; - if (transfer_type == 'm') { - strncpy((*chunk) + 1, tdesc + offset, length); - (*chunk)[1 + length] = '\0'; - } else { - strncpy((*chunk) + 1, tdesc + offset, tdesc_length - offset); - (*chunk)[1 + (tdesc_length - offset)] = '\0'; - - /* After gdb-server sends out last chunk, invalidate tdesc. */ - free(tdesc); - tdesc = NULL; - tdesc_length = 0; - } - - target_desc->tdesc = tdesc; - target_desc->tdesc_length = tdesc_length; - - return ERROR_OK; -} - -static int gdb_target_description_supported(struct target *target, int *supported) -{ - int retval = ERROR_OK; - struct reg **reg_list = NULL; - int reg_list_size = 0; - char const **features = NULL; - int feature_list_size = 0; - - retval = target_get_gdb_reg_list(target, ®_list, - ®_list_size, REG_CLASS_ALL); - if (retval != ERROR_OK) { - LOG_ERROR("get register list failed"); - goto error; - } - - if (reg_list_size <= 0) { - LOG_ERROR("get register list failed"); - retval = ERROR_FAIL; - goto error; - } - - /* Get a list of available target registers features */ - retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size); - if (retval != ERROR_OK) { - LOG_ERROR("Can't get the registers feature list"); - goto error; - } - - if (supported) { - if (feature_list_size) - *supported = 1; - else - *supported = 0; - } - -error: - free(features); - - free(reg_list); - - return retval; -} - -static int gdb_query_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct command_context *cmd_ctx = connection->cmd_ctx; - struct gdb_connection *gdb_connection = connection->priv; - struct target *target = get_target_from_connection(connection); - - if (strncmp(packet, "qRcmd,", 6) == 0) { - if (packet_size > 6) { - char *cmd; - cmd = malloc((packet_size - 6) / 2 + 1); - int len = unhexify(cmd, packet + 6, (packet_size - 6) / 2); - cmd[len] = 0; - - /* We want to print all debug output to GDB connection */ - log_add_callback(gdb_log_callback, connection); - target_call_timer_callbacks_now(); - /* some commands need to know the GDB connection, make note of current - * GDB connection. */ - current_gdb_connection = gdb_connection; - command_run_line(cmd_ctx, cmd); - current_gdb_connection = NULL; - target_call_timer_callbacks_now(); - log_remove_callback(gdb_log_callback, connection); - free(cmd); - } - gdb_put_packet(connection, "OK", 2); - return ERROR_OK; - } else if (strncmp(packet, "qCRC:", 5) == 0) { - if (packet_size > 5) { - int retval; - char gdb_reply[10]; - char *separator; - uint32_t checksum; - uint32_t addr = 0; - uint32_t len = 0; - - /* skip command character */ - packet += 5; - - addr = strtoul(packet, &separator, 16); - - if (*separator != ',') { - LOG_ERROR("incomplete read memory packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - len = strtoul(separator + 1, NULL, 16); - - retval = target_checksum_memory(target, addr, len, &checksum); - - if (retval == ERROR_OK) { - snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum); - gdb_put_packet(connection, gdb_reply, 9); - } else { - retval = gdb_error(connection, retval); - if (retval != ERROR_OK) - return retval; - } - - return ERROR_OK; - } - } else if (strncmp(packet, "qSupported", 10) == 0) { - /* we currently support packet size and qXfer:memory-map:read (if enabled) - * qXfer:features:read is supported for some targets */ - int retval = ERROR_OK; - char *buffer = NULL; - int pos = 0; - int size = 0; - int gdb_target_desc_supported = 0; - - /* we need to test that the target supports target descriptions */ - retval = gdb_target_description_supported(target, &gdb_target_desc_supported); - if (retval != ERROR_OK) { - LOG_INFO("Failed detecting Target Description Support, disabling"); - gdb_target_desc_supported = 0; - } - - /* support may be disabled globally */ - if (gdb_use_target_description == 0) { - if (gdb_target_desc_supported) - LOG_WARNING("Target Descriptions Supported, but disabled"); - gdb_target_desc_supported = 0; - } - - xml_printf(&retval, - &buffer, - &pos, - &size, - "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;QStartNoAckMode+", - (GDB_BUFFER_SIZE - 1), - ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-', - (gdb_target_desc_supported == 1) ? '+' : '-'); - - if (retval != ERROR_OK) { - gdb_send_error(connection, 01); - return ERROR_OK; - } - - gdb_put_packet(connection, buffer, strlen(buffer)); - free(buffer); - - return ERROR_OK; - } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0) - && (flash_get_bank_count() > 0)) - return gdb_memory_map(connection, packet, packet_size); - else if (strncmp(packet, "qXfer:features:read:", 20) == 0) { - char *xml = NULL; - int retval = ERROR_OK; - - int offset; - unsigned int length; - - /* skip command character */ - packet += 20; - - if (decode_xfer_read(packet, NULL, &offset, &length) < 0) { - gdb_send_error(connection, 01); - return ERROR_OK; - } - - /* Target should prepare correct target description for annex. - * The first character of returned xml is 'm' or 'l'. 'm' for - * there are *more* chunks to transfer. 'l' for it is the *last* - * chunk of target description. - */ - retval = gdb_get_target_description_chunk(target, &gdb_connection->target_desc, - &xml, offset, length); - if (retval != ERROR_OK) { - gdb_error(connection, retval); - return retval; - } - - gdb_put_packet(connection, xml, strlen(xml)); - - free(xml); - return ERROR_OK; - } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) { - gdb_connection->noack_mode = 1; - gdb_put_packet(connection, "OK", 2); - return ERROR_OK; - } - - gdb_put_packet(connection, "", 0); - return ERROR_OK; -} - -static int gdb_v_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct gdb_connection *gdb_connection = connection->priv; - struct gdb_service *gdb_service = connection->service->priv; - int result; - - /* if flash programming disabled - send a empty reply */ - - if (gdb_flash_program == 0) { - gdb_put_packet(connection, "", 0); - return ERROR_OK; - } - - if (strncmp(packet, "vFlashErase:", 12) == 0) { - unsigned long addr; - unsigned long length; - - char const *parse = packet + 12; - if (*parse == '\0') { - LOG_ERROR("incomplete vFlashErase packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - addr = strtoul(parse, (char **)&parse, 16); - - if (*(parse++) != ',' || *parse == '\0') { - LOG_ERROR("incomplete vFlashErase packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - length = strtoul(parse, (char **)&parse, 16); - - if (*parse != '\0') { - LOG_ERROR("incomplete vFlashErase packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - - /* assume all sectors need erasing - stops any problems - * when flash_write is called multiple times */ - flash_set_dirty(); - - /* perform any target specific operations before the erase */ - target_call_event_callbacks(gdb_service->target, - TARGET_EVENT_GDB_FLASH_ERASE_START); - - /* vFlashErase:addr,length messages require region start and - * end to be "block" aligned ... if padding is ever needed, - * GDB will have become dangerously confused. - */ - result = flash_erase_address_range(gdb_service->target, - false, addr, length); - - /* perform any target specific operations after the erase */ - target_call_event_callbacks(gdb_service->target, - TARGET_EVENT_GDB_FLASH_ERASE_END); - - /* perform erase */ - if (result != ERROR_OK) { - /* GDB doesn't evaluate the actual error number returned, - * treat a failed erase as an I/O error - */ - gdb_send_error(connection, EIO); - LOG_ERROR("flash_erase returned %i", result); - } else - gdb_put_packet(connection, "OK", 2); - - return ERROR_OK; - } - - if (strncmp(packet, "vFlashWrite:", 12) == 0) { - int retval; - unsigned long addr; - unsigned long length; - char const *parse = packet + 12; - - if (*parse == '\0') { - LOG_ERROR("incomplete vFlashErase packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - addr = strtoul(parse, (char **)&parse, 16); - if (*(parse++) != ':') { - LOG_ERROR("incomplete vFlashErase packet received, dropping connection"); - return ERROR_SERVER_REMOTE_CLOSED; - } - length = packet_size - (parse - packet); - - /* create a new image if there isn't already one */ - if (gdb_connection->vflash_image == NULL) { - gdb_connection->vflash_image = malloc(sizeof(struct image)); - image_open(gdb_connection->vflash_image, "", "build"); - } - - /* create new section with content from packet buffer */ - retval = image_add_section(gdb_connection->vflash_image, - addr, length, 0x0, (uint8_t const *)parse); - if (retval != ERROR_OK) - return retval; - - gdb_put_packet(connection, "OK", 2); - - return ERROR_OK; - } - - if (strncmp(packet, "vFlashDone", 10) == 0) { - uint32_t written; - - /* process the flashing buffer. No need to erase as GDB - * always issues a vFlashErase first. */ - target_call_event_callbacks(gdb_service->target, - TARGET_EVENT_GDB_FLASH_WRITE_START); - result = flash_write(gdb_service->target, gdb_connection->vflash_image, &written, 0); - target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_END); - if (result != ERROR_OK) { - if (result == ERROR_FLASH_DST_OUT_OF_BANK) - gdb_put_packet(connection, "E.memtype", 9); - else - gdb_send_error(connection, EIO); - } else { - LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written); - gdb_put_packet(connection, "OK", 2); - } - - image_close(gdb_connection->vflash_image); - free(gdb_connection->vflash_image); - gdb_connection->vflash_image = NULL; - - return ERROR_OK; - } - - gdb_put_packet(connection, "", 0); - return ERROR_OK; -} - -static int gdb_detach(struct connection *connection) -{ - struct gdb_service *gdb_service = connection->service->priv; - - target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH); - - return gdb_put_packet(connection, "OK", 2); -} - -/* The format of 'F' response packet is - * Fretcode,errno,Ctrl-C flag;call-specific attachment - */ -static int gdb_fileio_response_packet(struct connection *connection, - char const *packet, int packet_size) -{ - struct target *target = get_target_from_connection(connection); - char *separator; - char *parsing_point; - int fileio_retcode = strtoul(packet + 1, &separator, 16); - int fileio_errno = 0; - bool fileio_ctrl_c = false; - int retval; - - LOG_DEBUG("-"); - - if (*separator == ',') { - parsing_point = separator + 1; - fileio_errno = strtoul(parsing_point, &separator, 16); - if (*separator == ',') { - if (*(separator + 1) == 'C') { - /* TODO: process ctrl-c */ - fileio_ctrl_c = true; - } - } - } - - LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s", - fileio_retcode, fileio_errno, fileio_ctrl_c ? "true" : "false"); - - retval = target_gdb_fileio_end(target, fileio_retcode, fileio_errno, fileio_ctrl_c); - if (retval != ERROR_OK) - return ERROR_FAIL; - - /* After File-I/O ends, keep continue or step */ - if (gdb_running_type == 'c') - retval = target_resume(target, 1, 0x0, 0, 0); - else if (gdb_running_type == 's') - retval = target_step(target, 1, 0x0, 0); - else - retval = ERROR_FAIL; - - if (retval != ERROR_OK) - return ERROR_FAIL; - - return ERROR_OK; -} - -static void gdb_log_callback(void *priv, const char *file, unsigned line, - const char *function, const char *string) -{ - struct connection *connection = priv; - struct gdb_connection *gdb_con = connection->priv; - - if (gdb_con->busy) { - /* do not reply this using the O packet */ - return; - } - - gdb_output_con(connection, string); -} - -static void gdb_sig_halted(struct connection *connection) -{ - char sig_reply[4]; - snprintf(sig_reply, 4, "T%2.2x", 2); - gdb_put_packet(connection, sig_reply, 3); -} - -static int gdb_input_inner(struct connection *connection) -{ - /* Do not allocate this on the stack */ - static char gdb_packet_buffer[GDB_BUFFER_SIZE]; - - struct gdb_service *gdb_service = connection->service->priv; - struct target *target = gdb_service->target; - char const *packet = gdb_packet_buffer; - int packet_size; - int retval; - struct gdb_connection *gdb_con = connection->priv; - static int extended_protocol; - - /* drain input buffer. If one of the packets fail, then an error - * packet is replied, if applicable. - * - * This loop will terminate and the error code is returned. - * - * The calling fn will check if this error is something that - * can be recovered from, or if the connection must be closed. - * - * If the error is recoverable, this fn is called again to - * drain the rest of the buffer. - */ - do { - packet_size = GDB_BUFFER_SIZE-1; - retval = gdb_get_packet(connection, gdb_packet_buffer, &packet_size); - if (retval != ERROR_OK) - return retval; - - /* terminate with zero */ - gdb_packet_buffer[packet_size] = '\0'; - - if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) { - if (packet[0] == 'X') { - /* binary packets spew junk into the debug log stream */ - char buf[50]; - int x; - for (x = 0; (x < 49) && (packet[x] != ':'); x++) - buf[x] = packet[x]; - buf[x] = 0; - LOG_DEBUG("received packet: '%s:<binary-data>'", buf); - } else - LOG_DEBUG("received packet: '%s'", packet); - } - - if (packet_size > 0) { - retval = ERROR_OK; - switch (packet[0]) { - case 'T': /* Is thread alive? */ - gdb_thread_packet(connection, packet, packet_size); - break; - case 'H': /* Set current thread ( 'c' for step and continue, - * 'g' for all other operations ) */ - gdb_thread_packet(connection, packet, packet_size); - break; - case 'q': - case 'Q': - retval = gdb_thread_packet(connection, packet, packet_size); - if (retval == GDB_THREAD_PACKET_NOT_CONSUMED) - retval = gdb_query_packet(connection, packet, packet_size); - break; - case 'g': - retval = gdb_get_registers_packet(connection, packet, packet_size); - break; - case 'G': - retval = gdb_set_registers_packet(connection, packet, packet_size); - break; - case 'p': - retval = gdb_get_register_packet(connection, packet, packet_size); - break; - case 'P': - retval = gdb_set_register_packet(connection, packet, packet_size); - break; - case 'm': - retval = gdb_read_memory_packet(connection, packet, packet_size); - break; - case 'M': - retval = gdb_write_memory_packet(connection, packet, packet_size); - break; - case 'z': - case 'Z': - retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size); - break; - case '?': - gdb_last_signal_packet(connection, packet, packet_size); - break; - case 'c': - case 's': - { - gdb_thread_packet(connection, packet, packet_size); - log_add_callback(gdb_log_callback, connection); - - if (gdb_con->mem_write_error) { - LOG_ERROR("Memory write failure!"); - - /* now that we have reported the memory write error, - * we can clear the condition */ - gdb_con->mem_write_error = false; - } - - bool nostep = false; - bool already_running = false; - if (target->state == TARGET_RUNNING) { - LOG_WARNING("WARNING! The target is already running. " - "All changes GDB did to registers will be discarded! " - "Waiting for target to halt."); - already_running = true; - } else if (target->state != TARGET_HALTED) { - LOG_WARNING("The target is not in the halted nor running stated, " \ - "stepi/continue ignored."); - nostep = true; - } else if ((packet[0] == 's') && gdb_con->sync) { - /* Hmm..... when you issue a continue in GDB, then a "stepi" is - * sent by GDB first to OpenOCD, thus defeating the check to - * make only the single stepping have the sync feature... - */ - nostep = true; - LOG_WARNING("stepi ignored. GDB will now fetch the register state " \ - "from the target."); - } - gdb_con->sync = false; - - if (!already_running && nostep) { - /* Either the target isn't in the halted state, then we can't - * step/continue. This might be early setup, etc. - * - * Or we want to allow GDB to pick up a fresh set of - * register values without modifying the target state. - * - */ - gdb_sig_halted(connection); - - /* stop forwarding log packets! */ - log_remove_callback(gdb_log_callback, connection); - } else { - /* We're running/stepping, in which case we can - * forward log output until the target is halted - */ - gdb_con->frontend_state = TARGET_RUNNING; - target_call_event_callbacks(target, TARGET_EVENT_GDB_START); - - if (!already_running) { - /* Here we don't want packet processing to stop even if this fails, - * so we use a local variable instead of retval. */ - retval = gdb_step_continue_packet(connection, packet, packet_size); - if (retval != ERROR_OK) { - /* we'll never receive a halted - * condition... issue a false one.. - */ - gdb_frontend_halted(target, connection); - } - } - } - } - break; - case 'v': - retval = gdb_v_packet(connection, packet, packet_size); - break; - case 'D': - retval = gdb_detach(connection); - extended_protocol = 0; - break; - case 'X': - retval = gdb_write_memory_binary_packet(connection, packet, packet_size); - if (retval != ERROR_OK) - return retval; - break; - case 'k': - if (extended_protocol != 0) { - gdb_con->attached = false; - break; - } - gdb_put_packet(connection, "OK", 2); - return ERROR_SERVER_REMOTE_CLOSED; - case '!': - /* handle extended remote protocol */ - extended_protocol = 1; - gdb_put_packet(connection, "OK", 2); - break; - case 'R': - /* handle extended restart packet */ - breakpoint_clear_target(gdb_service->target); - watchpoint_clear_target(gdb_service->target); - command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s", - target_name(target)); - /* set connection as attached after reset */ - gdb_con->attached = true; - /* info rtos parts */ - gdb_thread_packet(connection, packet, packet_size); - break; - - case 'j': - /* packet supported only by smp target i.e cortex_a.c*/ - /* handle smp packet replying coreid played to gbd */ - gdb_read_smp_packet(connection, packet, packet_size); - break; - - case 'J': - /* packet supported only by smp target i.e cortex_a.c */ - /* handle smp packet setting coreid to be played at next - * resume to gdb */ - gdb_write_smp_packet(connection, packet, packet_size); - break; - - case 'F': - /* File-I/O extension */ - /* After gdb uses host-side syscall to complete target file - * I/O, gdb sends host-side syscall return value to target - * by 'F' packet. - * The format of 'F' response packet is - * Fretcode,errno,Ctrl-C flag;call-specific attachment - */ - gdb_con->frontend_state = TARGET_RUNNING; - log_add_callback(gdb_log_callback, connection); - gdb_fileio_response_packet(connection, packet, packet_size); - break; - - default: - /* ignore unknown packets */ - LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]); - gdb_put_packet(connection, NULL, 0); - break; - } - - /* if a packet handler returned an error, exit input loop */ - if (retval != ERROR_OK) - return retval; - } - - if (gdb_con->ctrl_c) { - if (target->state == TARGET_RUNNING) { - retval = target_halt(target); - if (retval != ERROR_OK) - target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT); - gdb_con->ctrl_c = 0; - } else { - LOG_INFO("The target is not running when halt was requested, stopping GDB."); - target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT); - } - } - - } while (gdb_con->buf_cnt > 0); - - return ERROR_OK; -} - -static int gdb_input(struct connection *connection) -{ - int retval = gdb_input_inner(connection); - struct gdb_connection *gdb_con = connection->priv; - if (retval == ERROR_SERVER_REMOTE_CLOSED) - return retval; - - /* logging does not propagate the error, yet can set the gdb_con->closed flag */ - if (gdb_con->closed) - return ERROR_SERVER_REMOTE_CLOSED; - - /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */ - return ERROR_OK; -} - -static int gdb_target_start(struct target *target, const char *port) -{ - struct gdb_service *gdb_service; - int ret; - gdb_service = malloc(sizeof(struct gdb_service)); - - if (NULL == gdb_service) - return -ENOMEM; - - gdb_service->target = target; - gdb_service->core[0] = -1; - gdb_service->core[1] = -1; - target->gdb_service = gdb_service; - - ret = add_service("gdb", - port, 1, &gdb_new_connection, &gdb_input, - &gdb_connection_closed, gdb_service); - /* initialialize all targets gdb service with the same pointer */ - { - struct target_list *head; - struct target *curr; - head = target->head; - while (head != (struct target_list *)NULL) { - curr = head->target; - if (curr != target) - curr->gdb_service = gdb_service; - head = head->next; - } - } - return ret; -} - -static int gdb_target_add_one(struct target *target) -{ - /* one gdb instance per smp list */ - if ((target->smp) && (target->gdb_service)) - return ERROR_OK; - int retval = gdb_target_start(target, gdb_port_next); - if (retval == ERROR_OK) { - long portnumber; - /* If we can parse the port number - * then we increment the port number for the next target. - */ - char *end; - portnumber = strtol(gdb_port_next, &end, 0); - if (!*end) { - if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) { - free(gdb_port_next); - gdb_port_next = alloc_printf("%d", portnumber+1); - } - } - } - return retval; -} - -int gdb_target_add_all(struct target *target) -{ - if (strcmp(gdb_port, "disabled") == 0) { - LOG_INFO("gdb server disabled"); - return ERROR_OK; - } - - if (NULL == target) { - LOG_WARNING("gdb services need one or more targets defined"); - return ERROR_OK; - } - - while (NULL != target) { - int retval = gdb_target_add_one(target); - if (ERROR_OK != retval) - return retval; - - target = target->next; - } - - return ERROR_OK; -} - -COMMAND_HANDLER(handle_gdb_sync_command) -{ - if (CMD_ARGC != 0) - return ERROR_COMMAND_SYNTAX_ERROR; - - if (current_gdb_connection == NULL) { - command_print(CMD_CTX, - "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\""); - return ERROR_FAIL; - } - - current_gdb_connection->sync = true; - - return ERROR_OK; -} - -/* daemon configuration command gdb_port */ -COMMAND_HANDLER(handle_gdb_port_command) -{ - int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port); - if (ERROR_OK == retval) { - free(gdb_port_next); - gdb_port_next = strdup(gdb_port); - } - return retval; -} - -COMMAND_HANDLER(handle_gdb_memory_map_command) -{ - if (CMD_ARGC != 1) - return ERROR_COMMAND_SYNTAX_ERROR; - - COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map); - return ERROR_OK; -} - -COMMAND_HANDLER(handle_gdb_flash_program_command) -{ - if (CMD_ARGC != 1) - return ERROR_COMMAND_SYNTAX_ERROR; - - COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program); - return ERROR_OK; -} - -COMMAND_HANDLER(handle_gdb_report_data_abort_command) -{ - if (CMD_ARGC != 1) - return ERROR_COMMAND_SYNTAX_ERROR; - - COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort); - return ERROR_OK; -} - -/* gdb_breakpoint_override */ -COMMAND_HANDLER(handle_gdb_breakpoint_override_command) -{ - if (CMD_ARGC == 0) { - /* nothing */ - } else if (CMD_ARGC == 1) { - gdb_breakpoint_override = 1; - if (strcmp(CMD_ARGV[0], "hard") == 0) - gdb_breakpoint_override_type = BKPT_HARD; - else if (strcmp(CMD_ARGV[0], "soft") == 0) - gdb_breakpoint_override_type = BKPT_SOFT; - else if (strcmp(CMD_ARGV[0], "disable") == 0) - gdb_breakpoint_override = 0; - } else - return ERROR_COMMAND_SYNTAX_ERROR; - if (gdb_breakpoint_override) - LOG_USER("force %s breakpoints", - (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft"); - else - LOG_USER("breakpoint type is not overridden"); - - return ERROR_OK; -} - -COMMAND_HANDLER(handle_gdb_target_description_command) -{ - if (CMD_ARGC != 1) - return ERROR_COMMAND_SYNTAX_ERROR; - - COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_target_description); - return ERROR_OK; -} - -COMMAND_HANDLER(handle_gdb_save_tdesc_command) -{ - char *tdesc; - uint32_t tdesc_length; - struct target *target = get_current_target(CMD_CTX); - - int retval = gdb_generate_target_description(target, &tdesc); - if (retval != ERROR_OK) { - LOG_ERROR("Unable to Generate Target Description"); - return ERROR_FAIL; - } - - tdesc_length = strlen(tdesc); - - struct fileio *fileio; - size_t size_written; - - char *tdesc_filename = alloc_printf("%s.xml", target_type_name(target)); - if (tdesc_filename == NULL) { - retval = ERROR_FAIL; - goto out; - } - - retval = fileio_open(&fileio, tdesc_filename, FILEIO_WRITE, FILEIO_TEXT); - - if (retval != ERROR_OK) { - LOG_ERROR("Can't open %s for writing", tdesc_filename); - goto out; - } - - retval = fileio_write(fileio, tdesc_length, tdesc, &size_written); - - fileio_close(fileio); - - if (retval != ERROR_OK) - LOG_ERROR("Error while writing the tdesc file"); - -out: - free(tdesc_filename); - free(tdesc); - - return retval; -} - -static const struct command_registration gdb_command_handlers[] = { - { - .name = "gdb_sync", - .handler = handle_gdb_sync_command, - .mode = COMMAND_ANY, - .help = "next stepi will return immediately allowing " - "GDB to fetch register state without affecting " - "target state", - .usage = "" - }, - { - .name = "gdb_port", - .handler = handle_gdb_port_command, - .mode = COMMAND_ANY, - .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB " - "server listens for the next port number after the " - "base port number specified. " - "No arguments reports GDB port. \"pipe\" means listen to stdin " - "output to stdout, an integer is base port number, \"disable\" disables " - "port. Any other string is are interpreted as named pipe to listen to. " - "Output pipe is the same name as input pipe, but with 'o' appended.", - .usage = "[port_num]", - }, - { - .name = "gdb_memory_map", - .handler = handle_gdb_memory_map_command, - .mode = COMMAND_CONFIG, - .help = "enable or disable memory map", - .usage = "('enable'|'disable')" - }, - { - .name = "gdb_flash_program", - .handler = handle_gdb_flash_program_command, - .mode = COMMAND_CONFIG, - .help = "enable or disable flash program", - .usage = "('enable'|'disable')" - }, - { - .name = "gdb_report_data_abort", - .handler = handle_gdb_report_data_abort_command, - .mode = COMMAND_CONFIG, - .help = "enable or disable reporting data aborts", - .usage = "('enable'|'disable')" - }, - { - .name = "gdb_breakpoint_override", - .handler = handle_gdb_breakpoint_override_command, - .mode = COMMAND_ANY, - .help = "Display or specify type of breakpoint " - "to be used by gdb 'break' commands.", - .usage = "('hard'|'soft'|'disable')" - }, - { - .name = "gdb_target_description", - .handler = handle_gdb_target_description_command, - .mode = COMMAND_CONFIG, - .help = "enable or disable target description", - .usage = "('enable'|'disable')" - }, - { - .name = "gdb_save_tdesc", - .handler = handle_gdb_save_tdesc_command, - .mode = COMMAND_EXEC, - .help = "Save the target description file", - }, - COMMAND_REGISTRATION_DONE -}; - -int gdb_register_commands(struct command_context *cmd_ctx) -{ - gdb_port = strdup("3333"); - gdb_port_next = strdup("3333"); - return register_commands(cmd_ctx, NULL, gdb_command_handlers); -} diff --git a/src/server/gdb_server.h b/src/server/gdb_server.h deleted file mode 100644 index 2b4ac4e..0000000 --- a/src/server/gdb_server.h +++ /dev/null @@ -1,51 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007-2009 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * Copyright (C) 2011 by Broadcom Corporation * - * Evan Hunter - ehunter@broadcom.com * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifndef OPENOCD_SERVER_GDB_SERVER_H -#define OPENOCD_SERVER_GDB_SERVER_H - -struct image; -struct reg; -#include <target/target.h> - -#define GDB_BUFFER_SIZE 16384 - -int gdb_target_add_all(struct target *target); -int gdb_register_commands(struct command_context *command_context); - -int gdb_put_packet(struct connection *connection, char *buffer, int len); - -static inline struct target *get_target_from_connection(struct connection *connection) -{ - struct gdb_service *gdb_service = connection->service->priv; - return gdb_service->target; -} - -#define ERROR_GDB_BUFFER_TOO_SMALL (-800) -#define ERROR_GDB_TIMEOUT (-801) - -#endif /* OPENOCD_SERVER_GDB_SERVER_H */ diff --git a/src/server/server.c b/src/server/server.c deleted file mode 100644 index f6889a0..0000000 --- a/src/server/server.c +++ /dev/null @@ -1,751 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007-2010 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include "server.h" -#include <target/target.h> -#include <target/target_request.h> -#include <target/openrisc/jsp_server.h> -#include "openocd.h" -#include "tcl_server.h" -#include "telnet_server.h" - -#include <signal.h> - -#ifdef HAVE_NETDB_H -#include <netdb.h> -#endif - -#ifndef _WIN32 -#include <netinet/tcp.h> -#endif - -static struct service *services; - -/* shutdown_openocd == 1: exit the main event loop, and quit the - * debugger; 2: quit with non-zero return code */ -static int shutdown_openocd; - -/* store received signal to exit application by killing ourselves */ -static int last_signal; - -/* set the polling period to 100ms */ -static int polling_period = 100; - -/* address by name on which to listen for incoming TCP/IP connections */ -static char *bindto_name; - -static int add_connection(struct service *service, struct command_context *cmd_ctx) -{ - socklen_t address_size; - struct connection *c, **p; - int retval; - int flag = 1; - - c = malloc(sizeof(struct connection)); - c->fd = -1; - c->fd_out = -1; - memset(&c->sin, 0, sizeof(c->sin)); - c->cmd_ctx = copy_command_context(cmd_ctx); - c->service = service; - c->input_pending = 0; - c->priv = NULL; - c->next = NULL; - - if (service->type == CONNECTION_TCP) { - address_size = sizeof(c->sin); - - c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size); - c->fd_out = c->fd; - - /* This increases performance dramatically for e.g. GDB load which - * does not have a sliding window protocol. - * - * Ignore errors from this fn as it probably just means less performance - */ - setsockopt(c->fd, /* socket affected */ - IPPROTO_TCP, /* set option at TCP level */ - TCP_NODELAY, /* name of option */ - (char *)&flag, /* the cast is historical cruft */ - sizeof(int)); /* length of option value */ - - LOG_INFO("accepting '%s' connection on tcp/%s", service->name, service->port); - retval = service->new_connection(c); - if (retval != ERROR_OK) { - close_socket(c->fd); - LOG_ERROR("attempted '%s' connection rejected", service->name); - command_done(c->cmd_ctx); - free(c); - return retval; - } - } else if (service->type == CONNECTION_STDINOUT) { - c->fd = service->fd; - c->fd_out = fileno(stdout); - -#ifdef _WIN32 - /* we are using stdin/out so ignore ctrl-c under windoze */ - SetConsoleCtrlHandler(NULL, TRUE); -#endif - - /* do not check for new connections again on stdin */ - service->fd = -1; - - LOG_INFO("accepting '%s' connection from pipe", service->name); - retval = service->new_connection(c); - if (retval != ERROR_OK) { - LOG_ERROR("attempted '%s' connection rejected", service->name); - command_done(c->cmd_ctx); - free(c); - return retval; - } - } else if (service->type == CONNECTION_PIPE) { - c->fd = service->fd; - /* do not check for new connections again on stdin */ - service->fd = -1; - - char *out_file = alloc_printf("%so", service->port); - c->fd_out = open(out_file, O_WRONLY); - free(out_file); - if (c->fd_out == -1) { - LOG_ERROR("could not open %s", service->port); - exit(1); - } - - LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port); - retval = service->new_connection(c); - if (retval != ERROR_OK) { - LOG_ERROR("attempted '%s' connection rejected", service->name); - command_done(c->cmd_ctx); - free(c); - return retval; - } - } - - /* add to the end of linked list */ - for (p = &service->connections; *p; p = &(*p)->next) - ; - *p = c; - - if (service->max_connections != CONNECTION_LIMIT_UNLIMITED) - service->max_connections--; - - return ERROR_OK; -} - -static int remove_connection(struct service *service, struct connection *connection) -{ - struct connection **p = &service->connections; - struct connection *c; - - /* find connection */ - while ((c = *p)) { - if (c->fd == connection->fd) { - service->connection_closed(c); - if (service->type == CONNECTION_TCP) - close_socket(c->fd); - else if (service->type == CONNECTION_PIPE) { - /* The service will listen to the pipe again */ - c->service->fd = c->fd; - } - - command_done(c->cmd_ctx); - - /* delete connection */ - *p = c->next; - free(c); - - if (service->max_connections != CONNECTION_LIMIT_UNLIMITED) - service->max_connections++; - - break; - } - - /* redirect p to next list pointer */ - p = &(*p)->next; - } - - return ERROR_OK; -} - -/* FIX! make service return error instead of invoking exit() */ -int add_service(char *name, - const char *port, - int max_connections, - new_connection_handler_t new_connection_handler, - input_handler_t input_handler, - connection_closed_handler_t connection_closed_handler, - void *priv) -{ - struct service *c, **p; - struct hostent *hp; - int so_reuseaddr_option = 1; - - c = malloc(sizeof(struct service)); - - c->name = strdup(name); - c->port = strdup(port); - c->max_connections = 1; /* Only TCP/IP ports can support more than one connection */ - c->fd = -1; - c->connections = NULL; - c->new_connection = new_connection_handler; - c->input = input_handler; - c->connection_closed = connection_closed_handler; - c->priv = priv; - c->next = NULL; - long portnumber; - if (strcmp(c->port, "pipe") == 0) - c->type = CONNECTION_STDINOUT; - else { - char *end; - portnumber = strtol(c->port, &end, 0); - if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK)) { - c->portnumber = portnumber; - c->type = CONNECTION_TCP; - } else - c->type = CONNECTION_PIPE; - } - - if (c->type == CONNECTION_TCP) { - c->max_connections = max_connections; - - c->fd = socket(AF_INET, SOCK_STREAM, 0); - if (c->fd == -1) { - LOG_ERROR("error creating socket: %s", strerror(errno)); - exit(-1); - } - - setsockopt(c->fd, - SOL_SOCKET, - SO_REUSEADDR, - (void *)&so_reuseaddr_option, - sizeof(int)); - - socket_nonblock(c->fd); - - memset(&c->sin, 0, sizeof(c->sin)); - c->sin.sin_family = AF_INET; - - if (bindto_name == NULL) - c->sin.sin_addr.s_addr = INADDR_ANY; - else { - hp = gethostbyname(bindto_name); - if (hp == NULL) { - LOG_ERROR("couldn't resolve bindto address: %s", bindto_name); - exit(-1); - } - memcpy(&c->sin.sin_addr, hp->h_addr_list[0], hp->h_length); - } - c->sin.sin_port = htons(c->portnumber); - - if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) { - LOG_ERROR("couldn't bind %s to socket: %s", name, strerror(errno)); - exit(-1); - } - -#ifndef _WIN32 - int segsize = 65536; - setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int)); -#endif - int window_size = 128 * 1024; - - /* These setsockopt()s must happen before the listen() */ - - setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF, - (char *)&window_size, sizeof(window_size)); - setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF, - (char *)&window_size, sizeof(window_size)); - - if (listen(c->fd, 1) == -1) { - LOG_ERROR("couldn't listen on socket: %s", strerror(errno)); - exit(-1); - } - } else if (c->type == CONNECTION_STDINOUT) { - c->fd = fileno(stdin); - -#ifdef _WIN32 - /* for win32 set stdin/stdout to binary mode */ - if (_setmode(_fileno(stdout), _O_BINARY) < 0) - LOG_WARNING("cannot change stdout mode to binary"); - if (_setmode(_fileno(stdin), _O_BINARY) < 0) - LOG_WARNING("cannot change stdin mode to binary"); - if (_setmode(_fileno(stderr), _O_BINARY) < 0) - LOG_WARNING("cannot change stderr mode to binary"); -#else - socket_nonblock(c->fd); -#endif - } else if (c->type == CONNECTION_PIPE) { -#ifdef _WIN32 - /* we currenty do not support named pipes under win32 - * so exit openocd for now */ - LOG_ERROR("Named pipes currently not supported under this os"); - exit(1); -#else - /* Pipe we're reading from */ - c->fd = open(c->port, O_RDONLY | O_NONBLOCK); - if (c->fd == -1) { - LOG_ERROR("could not open %s", c->port); - exit(1); - } -#endif - } - - /* add to the end of linked list */ - for (p = &services; *p; p = &(*p)->next) - ; - *p = c; - - return ERROR_OK; -} - -static int remove_services(void) -{ - struct service *c = services; - - /* loop service */ - while (c) { - struct service *next = c->next; - - if (c->name) - free(c->name); - - if (c->type == CONNECTION_PIPE) { - if (c->fd != -1) - close(c->fd); - } - if (c->port) - free(c->port); - - if (c->priv) - free(c->priv); - - /* delete service */ - free(c); - - /* remember the last service for unlinking */ - c = next; - } - - services = NULL; - - return ERROR_OK; -} - -int server_loop(struct command_context *command_context) -{ - struct service *service; - - bool poll_ok = true; - - /* used in select() */ - fd_set read_fds; - int fd_max; - - /* used in accept() */ - int retval; - -#ifndef _WIN32 - if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) - LOG_ERROR("couldn't set SIGPIPE to SIG_IGN"); -#endif - - while (!shutdown_openocd) { - /* monitor sockets for activity */ - fd_max = 0; - FD_ZERO(&read_fds); - - /* add service and connection fds to read_fds */ - for (service = services; service; service = service->next) { - if (service->fd != -1) { - /* listen for new connections */ - FD_SET(service->fd, &read_fds); - - if (service->fd > fd_max) - fd_max = service->fd; - } - - if (service->connections) { - struct connection *c; - - for (c = service->connections; c; c = c->next) { - /* check for activity on the connection */ - FD_SET(c->fd, &read_fds); - if (c->fd > fd_max) - fd_max = c->fd; - } - } - } - - struct timeval tv; - tv.tv_sec = 0; - if (poll_ok) { - /* we're just polling this iteration, this is faster on embedded - * hosts */ - tv.tv_usec = 0; - retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv); - } else { - /* Every 100ms, can be changed with "poll_period" command */ - tv.tv_usec = polling_period * 1000; - /* Only while we're sleeping we'll let others run */ - openocd_sleep_prelude(); - kept_alive(); - retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv); - openocd_sleep_postlude(); - } - - if (retval == -1) { -#ifdef _WIN32 - - errno = WSAGetLastError(); - - if (errno == WSAEINTR) - FD_ZERO(&read_fds); - else { - LOG_ERROR("error during select: %s", strerror(errno)); - exit(-1); - } -#else - - if (errno == EINTR) - FD_ZERO(&read_fds); - else { - LOG_ERROR("error during select: %s", strerror(errno)); - exit(-1); - } -#endif - } - - if (retval == 0) { - /* We only execute these callbacks when there was nothing to do or we timed - *out */ - target_call_timer_callbacks(); - process_jim_events(command_context); - - FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */ - - /* We timed out/there was nothing to do, timeout rather than poll next time - **/ - poll_ok = false; - } else { - /* There was something to do, next time we'll just poll */ - poll_ok = true; - } - - /* This is a simple back-off algorithm where we immediately - * re-poll if we did something this time around. - * - * This greatly improves performance of DCC. - */ - poll_ok = poll_ok || target_got_message(); - - for (service = services; service; service = service->next) { - /* handle new connections on listeners */ - if ((service->fd != -1) - && (FD_ISSET(service->fd, &read_fds))) { - if (service->max_connections != 0) - add_connection(service, command_context); - else { - if (service->type == CONNECTION_TCP) { - struct sockaddr_in sin; - socklen_t address_size = sizeof(sin); - int tmp_fd; - tmp_fd = accept(service->fd, - (struct sockaddr *)&service->sin, - &address_size); - close_socket(tmp_fd); - } - LOG_INFO( - "rejected '%s' connection, no more connections allowed", - service->name); - } - } - - /* handle activity on connections */ - if (service->connections) { - struct connection *c; - - for (c = service->connections; c; ) { - if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending) { - retval = service->input(c); - if (retval != ERROR_OK) { - struct connection *next = c->next; - if (service->type == CONNECTION_PIPE || - service->type == CONNECTION_STDINOUT) { - /* if connection uses a pipe then - * shutdown openocd on error */ - shutdown_openocd = 1; - } - remove_connection(service, c); - LOG_INFO("dropped '%s' connection", - service->name); - c = next; - continue; - } - } - c = c->next; - } - } - } - -#ifdef _WIN32 - MSG msg; - while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) { - if (msg.message == WM_QUIT) - shutdown_openocd = 1; - } -#endif - } - - return shutdown_openocd != 2 ? ERROR_OK : ERROR_FAIL; -} - -#ifdef _WIN32 -BOOL WINAPI ControlHandler(DWORD dwCtrlType) -{ - shutdown_openocd = 1; - return TRUE; -} -#endif - -void sig_handler(int sig) -{ - /* store only first signal that hits us */ - if (!last_signal) - last_signal = sig; - shutdown_openocd = 1; -} - -int server_preinit(void) -{ - /* this currently only calls WSAStartup on native win32 systems - * before any socket operations are performed. - * This is an issue if you call init in your config script */ - -#ifdef _WIN32 - WORD wVersionRequested; - WSADATA wsaData; - - wVersionRequested = MAKEWORD(2, 2); - - if (WSAStartup(wVersionRequested, &wsaData) != 0) { - LOG_ERROR("Failed to Open Winsock"); - exit(-1); - } - - /* register ctrl-c handler */ - SetConsoleCtrlHandler(ControlHandler, TRUE); - - signal(SIGBREAK, sig_handler); -#endif - signal(SIGINT, sig_handler); - signal(SIGTERM, sig_handler); - signal(SIGABRT, sig_handler); - - return ERROR_OK; -} - -int server_init(struct command_context *cmd_ctx) -{ - int ret = tcl_init(); - if (ERROR_OK != ret) - return ret; - - return telnet_init("Open On-Chip Debugger"); -} - -int server_quit(void) -{ - remove_services(); - target_quit(); - -#ifdef _WIN32 - WSACleanup(); - SetConsoleCtrlHandler(ControlHandler, FALSE); - - return ERROR_OK; -#endif - - /* return signal number so we can kill ourselves */ - return last_signal; -} - -void exit_on_signal(int sig) -{ -#ifndef _WIN32 - /* bring back default system handler and kill yourself */ - signal(sig, SIG_DFL); - kill(getpid(), sig); -#endif -} - -int connection_write(struct connection *connection, const void *data, int len) -{ - if (len == 0) { - /* successful no-op. Sockets and pipes behave differently here... */ - return 0; - } - if (connection->service->type == CONNECTION_TCP) - return write_socket(connection->fd_out, data, len); - else - return write(connection->fd_out, data, len); -} - -int connection_read(struct connection *connection, void *data, int len) -{ - if (connection->service->type == CONNECTION_TCP) - return read_socket(connection->fd, data, len); - else - return read(connection->fd, data, len); -} - -/* tell the server we want to shut down */ -COMMAND_HANDLER(handle_shutdown_command) -{ - LOG_USER("shutdown command invoked"); - - shutdown_openocd = 1; - - if (CMD_ARGC == 1) { - if (!strcmp(CMD_ARGV[0], "error")) { - shutdown_openocd = 2; - return ERROR_FAIL; - } - } - - return ERROR_COMMAND_CLOSE_CONNECTION; -} - -COMMAND_HANDLER(handle_poll_period_command) -{ - if (CMD_ARGC == 0) - LOG_WARNING("You need to set a period value"); - else - COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], polling_period); - - LOG_INFO("set servers polling period to %ums", polling_period); - - return ERROR_OK; -} - -COMMAND_HANDLER(handle_bindto_command) -{ - switch (CMD_ARGC) { - case 0: - command_print(CMD_CTX, "bindto name: %s", bindto_name); - break; - case 1: - free(bindto_name); - bindto_name = strdup(CMD_ARGV[0]); - break; - default: - return ERROR_COMMAND_SYNTAX_ERROR; - } - return ERROR_OK; -} - -static const struct command_registration server_command_handlers[] = { - { - .name = "shutdown", - .handler = &handle_shutdown_command, - .mode = COMMAND_ANY, - .usage = "", - .help = "shut the server down", - }, - { - .name = "poll_period", - .handler = &handle_poll_period_command, - .mode = COMMAND_ANY, - .usage = "", - .help = "set the servers polling period", - }, - { - .name = "bindto", - .handler = &handle_bindto_command, - .mode = COMMAND_ANY, - .usage = "[name]", - .help = "Specify address by name on which to listen for " - "incoming TCP/IP connections", - }, - COMMAND_REGISTRATION_DONE -}; - -int server_register_commands(struct command_context *cmd_ctx) -{ - int retval = telnet_register_commands(cmd_ctx); - if (ERROR_OK != retval) - return retval; - - retval = tcl_register_commands(cmd_ctx); - if (ERROR_OK != retval) - return retval; - - retval = jsp_register_commands(cmd_ctx); - if (ERROR_OK != retval) - return retval; - - return register_commands(cmd_ctx, NULL, server_command_handlers); -} - -COMMAND_HELPER(server_port_command, unsigned short *out) -{ - switch (CMD_ARGC) { - case 0: - command_print(CMD_CTX, "%d", *out); - break; - case 1: - { - uint16_t port; - COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port); - *out = port; - break; - } - default: - return ERROR_COMMAND_SYNTAX_ERROR; - } - return ERROR_OK; -} - -COMMAND_HELPER(server_pipe_command, char **out) -{ - switch (CMD_ARGC) { - case 0: - command_print(CMD_CTX, "%s", *out); - break; - case 1: - { - if (CMD_CTX->mode == COMMAND_EXEC) { - LOG_WARNING("unable to change server port after init"); - return ERROR_COMMAND_ARGUMENT_INVALID; - } - free(*out); - *out = strdup(CMD_ARGV[0]); - break; - } - default: - return ERROR_COMMAND_SYNTAX_ERROR; - } - return ERROR_OK; -} diff --git a/src/server/server.h b/src/server/server.h deleted file mode 100644 index 68ad16d..0000000 --- a/src/server/server.h +++ /dev/null @@ -1,112 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007,2008 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifndef OPENOCD_SERVER_SERVER_H -#define OPENOCD_SERVER_SERVER_H - -#include <helper/log.h> - -#ifdef HAVE_NETINET_IN_H -#include <netinet/in.h> -#endif - -enum connection_type { - CONNECTION_TCP, - CONNECTION_PIPE, - CONNECTION_STDINOUT -}; - -#define CONNECTION_LIMIT_UNLIMITED (-1) - -struct connection { - int fd; - int fd_out; /* When using pipes we're writing to a different fd */ - struct sockaddr_in sin; - struct command_context *cmd_ctx; - struct service *service; - int input_pending; - void *priv; - struct connection *next; -}; - -typedef int (*new_connection_handler_t)(struct connection *connection); -typedef int (*input_handler_t)(struct connection *connection); -typedef int (*connection_closed_handler_t)(struct connection *connection); - -struct service { - char *name; - enum connection_type type; - char *port; - unsigned short portnumber; - int fd; - struct sockaddr_in sin; - int max_connections; - struct connection *connections; - new_connection_handler_t new_connection; - input_handler_t input; - connection_closed_handler_t connection_closed; - void *priv; - struct service *next; -}; - -int add_service(char *name, const char *port, - int max_connections, new_connection_handler_t new_connection_handler, - input_handler_t in_handler, connection_closed_handler_t close_handler, - void *priv); - -int server_preinit(void); -int server_init(struct command_context *cmd_ctx); -int server_quit(void); -void exit_on_signal(int); - -int server_loop(struct command_context *command_context); - -int server_register_commands(struct command_context *context); - -int connection_write(struct connection *connection, const void *data, int len); -int connection_read(struct connection *connection, void *data, int len); - -/** - * Used by server_loop(), defined in server_stubs.c - */ -void openocd_sleep_prelude(void); -/** - * Used by server_loop(), defined in server_stubs.c - */ -void openocd_sleep_postlude(void); - -/** - * Defines an extended command handler function declaration to enable - * access to (and manipulation of) the server port number. - * Call server_port like a normal COMMAND_HANDLER with an extra @a out parameter - * to receive the specified port number. - */ -COMMAND_HELPER(server_pipe_command, char **out); - -COMMAND_HELPER(server_port_command, unsigned short *out); - -#define ERROR_SERVER_REMOTE_CLOSED (-400) -#define ERROR_CONNECTION_REJECTED (-401) - -#endif /* OPENOCD_SERVER_SERVER_H */ diff --git a/src/server/server_stubs.c b/src/server/server_stubs.c deleted file mode 100644 index a4c0172..0000000 --- a/src/server/server_stubs.c +++ /dev/null @@ -1,30 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif -#include "server.h" - -void openocd_sleep_prelude(void) -{ - /* no-op */ -} -void openocd_sleep_postlude(void) -{ - /* no-op */ -} diff --git a/src/server/startup.tcl b/src/server/startup.tcl deleted file mode 100644 index 64ace40..0000000 --- a/src/server/startup.tcl +++ /dev/null @@ -1,10 +0,0 @@ -# Defines basic Tcl procs for OpenOCD server modules - -# Handle GDB 'R' packet. Can be overridden by configuration script, -# but it's not something one would expect target scripts to do -# normally -proc ocd_gdb_restart {target_id} { - # Fix!!! we're resetting all targets here! Really we should reset only - # one target - reset halt -} diff --git a/src/server/tcl_server.c b/src/server/tcl_server.c deleted file mode 100644 index 15a8736..0000000 --- a/src/server/tcl_server.c +++ /dev/null @@ -1,361 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2010 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include "tcl_server.h" -#include <target/target.h> -#include <helper/binarybuffer.h> - -#define TCL_SERVER_VERSION "TCL Server 0.1" -#define TCL_LINE_INITIAL (4*1024) -#define TCL_LINE_MAX (4*1024*1024) - -struct tcl_connection { - int tc_linedrop; - int tc_lineoffset; - int tc_line_size; - char *tc_line; - int tc_outerror;/* flag an output error */ - enum target_state tc_laststate; - bool tc_notify; - bool tc_trace; -}; - -static char *tcl_port; - -/* handlers */ -static int tcl_new_connection(struct connection *connection); -static int tcl_input(struct connection *connection); -static int tcl_output(struct connection *connection, const void *buf, ssize_t len); -static int tcl_closed(struct connection *connection); - -static int tcl_target_callback_event_handler(struct target *target, - enum target_event event, void *priv) -{ - struct connection *connection = priv; - struct tcl_connection *tclc; - char buf[256]; - - tclc = connection->priv; - - if (tclc->tc_notify) { - snprintf(buf, sizeof(buf), "type target_event event %s\r\n\x1a", target_event_name(event)); - tcl_output(connection, buf, strlen(buf)); - } - - if (tclc->tc_laststate != target->state) { - tclc->tc_laststate = target->state; - if (tclc->tc_notify) { - snprintf(buf, sizeof(buf), "type target_state state %s\r\n\x1a", target_state_name(target)); - tcl_output(connection, buf, strlen(buf)); - } - } - - return ERROR_OK; -} - -static int tcl_target_callback_reset_handler(struct target *target, - enum target_reset_mode reset_mode, void *priv) -{ - struct connection *connection = priv; - struct tcl_connection *tclc; - char buf[256]; - - tclc = connection->priv; - - if (tclc->tc_notify) { - snprintf(buf, sizeof(buf), "type target_reset mode %s\r\n\x1a", target_reset_mode_name(reset_mode)); - tcl_output(connection, buf, strlen(buf)); - } - - return ERROR_OK; -} - -static int tcl_target_callback_trace_handler(struct target *target, - size_t len, uint8_t *data, void *priv) -{ - struct connection *connection = priv; - struct tcl_connection *tclc; - char *header = "type target_trace data "; - char *trailer = "\r\n\x1a"; - size_t hex_len = len * 2 + 1; - size_t max_len = hex_len + strlen(header) + strlen(trailer); - char *buf, *hex; - - tclc = connection->priv; - - if (tclc->tc_trace) { - hex = malloc(hex_len); - buf = malloc(max_len); - hexify(hex, (const char *)data, len, hex_len); - snprintf(buf, max_len, "%s%s%s", header, hex, trailer); - tcl_output(connection, buf, strlen(buf)); - free(hex); - free(buf); - } - - return ERROR_OK; -} - -/* write data out to a socket. - * - * this is a blocking write, so the return value must equal the length, if - * that is not the case then flag the connection with an output error. - */ -int tcl_output(struct connection *connection, const void *data, ssize_t len) -{ - ssize_t wlen; - struct tcl_connection *tclc; - - tclc = connection->priv; - if (tclc->tc_outerror) - return ERROR_SERVER_REMOTE_CLOSED; - - wlen = connection_write(connection, data, len); - - if (wlen == len) - return ERROR_OK; - - LOG_ERROR("error during write: %d != %d", (int)wlen, (int)len); - tclc->tc_outerror = 1; - return ERROR_SERVER_REMOTE_CLOSED; -} - -/* connections */ -static int tcl_new_connection(struct connection *connection) -{ - struct tcl_connection *tclc; - - tclc = calloc(1, sizeof(struct tcl_connection)); - if (tclc == NULL) - return ERROR_CONNECTION_REJECTED; - - tclc->tc_line_size = TCL_LINE_INITIAL; - tclc->tc_line = malloc(tclc->tc_line_size); - if (tclc->tc_line == NULL) { - free(tclc); - return ERROR_CONNECTION_REJECTED; - } - - connection->priv = tclc; - - struct target *target = get_target_by_num(connection->cmd_ctx->current_target); - if (target != NULL) - tclc->tc_laststate = target->state; - - /* store the connection object on cmd_ctx so we can access it from command handlers */ - connection->cmd_ctx->output_handler_priv = connection; - - target_register_event_callback(tcl_target_callback_event_handler, connection); - target_register_reset_callback(tcl_target_callback_reset_handler, connection); - target_register_trace_callback(tcl_target_callback_trace_handler, connection); - - return ERROR_OK; -} - -static int tcl_input(struct connection *connection) -{ - Jim_Interp *interp = (Jim_Interp *)connection->cmd_ctx->interp; - int retval; - int i; - ssize_t rlen; - const char *result; - int reslen; - struct tcl_connection *tclc; - unsigned char in[256]; - char *tc_line_new; - int tc_line_size_new; - - rlen = connection_read(connection, &in, sizeof(in)); - if (rlen <= 0) { - if (rlen < 0) - LOG_ERROR("error during read: %s", strerror(errno)); - return ERROR_SERVER_REMOTE_CLOSED; - } - - tclc = connection->priv; - if (tclc == NULL) - return ERROR_CONNECTION_REJECTED; - - /* push as much data into the line as possible */ - for (i = 0; i < rlen; i++) { - /* buffer the data */ - tclc->tc_line[tclc->tc_lineoffset] = in[i]; - if (tclc->tc_lineoffset < tclc->tc_line_size) { - tclc->tc_lineoffset++; - } else if (tclc->tc_line_size >= TCL_LINE_MAX) { - /* maximum line size reached, drop line */ - tclc->tc_linedrop = 1; - } else { - /* grow line buffer: exponential below 1 MB, linear above */ - if (tclc->tc_line_size <= 1*1024*1024) - tc_line_size_new = tclc->tc_line_size * 2; - else - tc_line_size_new = tclc->tc_line_size + 1*1024*1024; - - if (tc_line_size_new > TCL_LINE_MAX) - tc_line_size_new = TCL_LINE_MAX; - - tc_line_new = realloc(tclc->tc_line, tc_line_size_new); - if (tc_line_new == NULL) { - tclc->tc_linedrop = 1; - } else { - tclc->tc_line = tc_line_new; - tclc->tc_line_size = tc_line_size_new; - tclc->tc_lineoffset++; - } - - } - - /* ctrl-z is end of command. When testing from telnet, just - * press ctrl-z a couple of times first to put telnet into the - * mode where it will send 0x1a in response to pressing ctrl-z - */ - if (in[i] != '\x1a') - continue; - - /* process the line */ - if (tclc->tc_linedrop) { -#define ESTR "line too long\n" - retval = tcl_output(connection, ESTR, sizeof(ESTR)); - if (retval != ERROR_OK) - return retval; -#undef ESTR - } else { - tclc->tc_line[tclc->tc_lineoffset-1] = '\0'; - command_run_line(connection->cmd_ctx, tclc->tc_line); - result = Jim_GetString(Jim_GetResult(interp), &reslen); - retval = tcl_output(connection, result, reslen); - if (retval != ERROR_OK) - return retval; - /* Always output ctrl-d as end of line to allow multiline results */ - tcl_output(connection, "\x1a", 1); - } - - tclc->tc_lineoffset = 0; - tclc->tc_linedrop = 0; - } - - return ERROR_OK; -} - -static int tcl_closed(struct connection *connection) -{ - struct tcl_connection *tclc; - tclc = connection->priv; - - /* cleanup connection context */ - if (tclc) { - free(tclc->tc_line); - free(tclc); - connection->priv = NULL; - } - - target_unregister_event_callback(tcl_target_callback_event_handler, connection); - target_unregister_reset_callback(tcl_target_callback_reset_handler, connection); - target_unregister_trace_callback(tcl_target_callback_trace_handler, connection); - - return ERROR_OK; -} - -int tcl_init(void) -{ - if (strcmp(tcl_port, "disabled") == 0) { - LOG_INFO("tcl server disabled"); - return ERROR_OK; - } - - return add_service("tcl", tcl_port, CONNECTION_LIMIT_UNLIMITED, - &tcl_new_connection, &tcl_input, - &tcl_closed, NULL); -} - -COMMAND_HANDLER(handle_tcl_port_command) -{ - return CALL_COMMAND_HANDLER(server_pipe_command, &tcl_port); -} - -COMMAND_HANDLER(handle_tcl_notifications_command) -{ - struct connection *connection = NULL; - struct tcl_connection *tclc = NULL; - - if (CMD_CTX->output_handler_priv != NULL) - connection = CMD_CTX->output_handler_priv; - - if (connection != NULL && !strcmp(connection->service->name, "tcl")) { - tclc = connection->priv; - return CALL_COMMAND_HANDLER(handle_command_parse_bool, &tclc->tc_notify, "Target Notification output "); - } else { - LOG_ERROR("%s: can only be called from the tcl server", CMD_NAME); - return ERROR_COMMAND_SYNTAX_ERROR; - } -} - -COMMAND_HANDLER(handle_tcl_trace_command) -{ - struct connection *connection = NULL; - struct tcl_connection *tclc = NULL; - - if (CMD_CTX->output_handler_priv != NULL) - connection = CMD_CTX->output_handler_priv; - - if (connection != NULL && !strcmp(connection->service->name, "tcl")) { - tclc = connection->priv; - return CALL_COMMAND_HANDLER(handle_command_parse_bool, &tclc->tc_trace, "Target trace output "); - } else { - LOG_ERROR("%s: can only be called from the tcl server", CMD_NAME); - return ERROR_COMMAND_SYNTAX_ERROR; - } -} - -static const struct command_registration tcl_command_handlers[] = { - { - .name = "tcl_port", - .handler = handle_tcl_port_command, - .mode = COMMAND_ANY, - .help = "Specify port on which to listen " - "for incoming Tcl syntax. " - "Read help on 'gdb_port'.", - .usage = "[port_num]", - }, - { - .name = "tcl_notifications", - .handler = handle_tcl_notifications_command, - .mode = COMMAND_EXEC, - .help = "Target Notification output", - .usage = "[on|off]", - }, - { - .name = "tcl_trace", - .handler = handle_tcl_trace_command, - .mode = COMMAND_EXEC, - .help = "Target trace output", - .usage = "[on|off]", - }, - COMMAND_REGISTRATION_DONE -}; - -int tcl_register_commands(struct command_context *cmd_ctx) -{ - tcl_port = strdup("6666"); - return register_commands(cmd_ctx, NULL, tcl_command_handlers); -} diff --git a/src/server/tcl_server.h b/src/server/tcl_server.h deleted file mode 100644 index 422c794..0000000 --- a/src/server/tcl_server.h +++ /dev/null @@ -1,26 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2008 * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifndef OPENOCD_SERVER_TCL_SERVER_H -#define OPENOCD_SERVER_TCL_SERVER_H - -#include <server/server.h> - -int tcl_init(void); -int tcl_register_commands(struct command_context *cmd_ctx); - -#endif /* OPENOCD_SERVER_TCL_SERVER_H */ diff --git a/src/server/telnet_server.c b/src/server/telnet_server.c deleted file mode 100644 index 0f5769a..0000000 --- a/src/server/telnet_server.c +++ /dev/null @@ -1,682 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007-2010 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include "telnet_server.h" -#include <target/target_request.h> -#include <helper/configuration.h> - -static char *telnet_port; - -static char *negotiate = - "\xFF\xFB\x03" /* IAC WILL Suppress Go Ahead */ - "\xFF\xFB\x01" /* IAC WILL Echo */ - "\xFF\xFD\x03" /* IAC DO Suppress Go Ahead */ - "\xFF\xFE\x01"; /* IAC DON'T Echo */ - -#define CTRL(c) (c - '@') -#define TELNET_HISTORY ".openocd_history" - -/* The only way we can detect that the socket is closed is the first time - * we write to it, we will fail. Subsequent write operations will - * succeed. Shudder! - */ -static int telnet_write(struct connection *connection, const void *data, - int len) -{ - struct telnet_connection *t_con = connection->priv; - if (t_con->closed) - return ERROR_SERVER_REMOTE_CLOSED; - - if (connection_write(connection, data, len) == len) - return ERROR_OK; - t_con->closed = 1; - return ERROR_SERVER_REMOTE_CLOSED; -} - -static int telnet_prompt(struct connection *connection) -{ - struct telnet_connection *t_con = connection->priv; - - return telnet_write(connection, t_con->prompt, strlen(t_con->prompt)); -} - -static int telnet_outputline(struct connection *connection, const char *line) -{ - int len; - - /* process lines in buffer */ - while (*line) { - char *line_end = strchr(line, '\n'); - - if (line_end) - len = line_end-line; - else - len = strlen(line); - - telnet_write(connection, line, len); - if (line_end) { - telnet_write(connection, "\r\n", 2); - line += len + 1; - } else - line += len; - } - - return ERROR_OK; -} - -static int telnet_output(struct command_context *cmd_ctx, const char *line) -{ - struct connection *connection = cmd_ctx->output_handler_priv; - - return telnet_outputline(connection, line); -} - -static void telnet_log_callback(void *priv, const char *file, unsigned line, - const char *function, const char *string) -{ - struct connection *connection = priv; - struct telnet_connection *t_con = connection->priv; - int i; - - /* if there is no prompt, simply output the message */ - if (t_con->line_cursor < 0) { - telnet_outputline(connection, string); - return; - } - - /* clear the command line */ - for (i = strlen(t_con->prompt) + t_con->line_size; i > 0; i -= 16) - telnet_write(connection, "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b", i > 16 ? 16 : i); - for (i = strlen(t_con->prompt) + t_con->line_size; i > 0; i -= 16) - telnet_write(connection, " ", i > 16 ? 16 : i); - for (i = strlen(t_con->prompt) + t_con->line_size; i > 0; i -= 16) - telnet_write(connection, "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b", i > 16 ? 16 : i); - - /* output the message */ - telnet_outputline(connection, string); - - /* put the command line to its previous state */ - telnet_prompt(connection); - telnet_write(connection, t_con->line, t_con->line_size); - for (i = t_con->line_size; i > t_con->line_cursor; i--) - telnet_write(connection, "\b", 1); -} - -static void telnet_load_history(struct telnet_connection *t_con) -{ - FILE *histfp; - char buffer[TELNET_BUFFER_SIZE]; - int i = 0; - - char *history = get_home_dir(TELNET_HISTORY); - - if (history == NULL) { - LOG_INFO("unable to get user home directory, telnet history will be disabled"); - return; - } - - histfp = fopen(history, "rb"); - - if (histfp) { - - while (fgets(buffer, sizeof(buffer), histfp) != NULL) { - - char *p = strchr(buffer, '\n'); - if (p) - *p = '\0'; - if (buffer[0] && i < TELNET_LINE_HISTORY_SIZE) - t_con->history[i++] = strdup(buffer); - } - - t_con->next_history = i; - t_con->next_history %= TELNET_LINE_HISTORY_SIZE; - /* try to set to last entry - 1, that way we skip over any exit/shutdown cmds */ - t_con->current_history = t_con->next_history > 0 ? i - 1 : 0; - fclose(histfp); - } - - free(history); -} - -static void telnet_save_history(struct telnet_connection *t_con) -{ - FILE *histfp; - int i; - int num; - - char *history = get_home_dir(TELNET_HISTORY); - - if (history == NULL) { - LOG_INFO("unable to get user home directory, telnet history will be disabled"); - return; - } - - histfp = fopen(history, "wb"); - - if (histfp) { - - num = TELNET_LINE_HISTORY_SIZE; - i = t_con->current_history + 1; - i %= TELNET_LINE_HISTORY_SIZE; - - while (t_con->history[i] == NULL && num > 0) { - i++; - i %= TELNET_LINE_HISTORY_SIZE; - num--; - } - - if (num > 0) { - for (; num > 0; num--) { - fprintf(histfp, "%s\n", t_con->history[i]); - i++; - i %= TELNET_LINE_HISTORY_SIZE; - } - } - fclose(histfp); - } - - free(history); -} - -static int telnet_new_connection(struct connection *connection) -{ - struct telnet_connection *telnet_connection; - struct telnet_service *telnet_service = connection->service->priv; - int i; - - telnet_connection = malloc(sizeof(struct telnet_connection)); - - if (!telnet_connection) { - LOG_ERROR("Failed to allocate telnet connection."); - return ERROR_FAIL; - } - - connection->priv = telnet_connection; - - /* initialize telnet connection information */ - telnet_connection->closed = 0; - telnet_connection->line_size = 0; - telnet_connection->line_cursor = 0; - telnet_connection->option_size = 0; - telnet_connection->prompt = strdup("> "); - telnet_connection->state = TELNET_STATE_DATA; - - /* output goes through telnet connection */ - command_set_output_handler(connection->cmd_ctx, telnet_output, connection); - - /* negotiate telnet options */ - telnet_write(connection, negotiate, strlen(negotiate)); - - /* print connection banner */ - if (telnet_service->banner) { - telnet_write(connection, telnet_service->banner, strlen(telnet_service->banner)); - telnet_write(connection, "\r\n", 2); - } - - /* the prompt is always placed at the line beginning */ - telnet_write(connection, "\r", 1); - telnet_prompt(connection); - - /* initialize history */ - for (i = 0; i < TELNET_LINE_HISTORY_SIZE; i++) - telnet_connection->history[i] = NULL; - telnet_connection->next_history = 0; - telnet_connection->current_history = 0; - telnet_load_history(telnet_connection); - - log_add_callback(telnet_log_callback, connection); - - return ERROR_OK; -} - -static void telnet_clear_line(struct connection *connection, - struct telnet_connection *t_con) -{ - /* move to end of line */ - if (t_con->line_cursor < t_con->line_size) - telnet_write(connection, - t_con->line + t_con->line_cursor, - t_con->line_size - t_con->line_cursor); - - /* backspace, overwrite with space, backspace */ - while (t_con->line_size > 0) { - telnet_write(connection, "\b \b", 3); - t_con->line_size--; - } - t_con->line_cursor = 0; -} - -static void telnet_history_go(struct connection *connection, int idx) -{ - struct telnet_connection *t_con = connection->priv; - - if (t_con->history[idx]) { - telnet_clear_line(connection, t_con); - t_con->line_size = strlen(t_con->history[idx]); - t_con->line_cursor = t_con->line_size; - memcpy(t_con->line, t_con->history[idx], t_con->line_size); - telnet_write(connection, t_con->line, t_con->line_size); - t_con->current_history = idx; - } - t_con->state = TELNET_STATE_DATA; -} - -static void telnet_history_up(struct connection *connection) -{ - struct telnet_connection *t_con = connection->priv; - - int last_history = (t_con->current_history > 0) ? - t_con->current_history - 1 : - TELNET_LINE_HISTORY_SIZE-1; - telnet_history_go(connection, last_history); -} - -static void telnet_history_down(struct connection *connection) -{ - struct telnet_connection *t_con = connection->priv; - - int next_history = (t_con->current_history + 1) % TELNET_LINE_HISTORY_SIZE; - telnet_history_go(connection, next_history); -} - -static int telnet_input(struct connection *connection) -{ - int bytes_read; - unsigned char buffer[TELNET_BUFFER_SIZE]; - unsigned char *buf_p; - struct telnet_connection *t_con = connection->priv; - struct command_context *command_context = connection->cmd_ctx; - - bytes_read = connection_read(connection, buffer, TELNET_BUFFER_SIZE); - - if (bytes_read == 0) - return ERROR_SERVER_REMOTE_CLOSED; - else if (bytes_read == -1) { - LOG_ERROR("error during read: %s", strerror(errno)); - return ERROR_SERVER_REMOTE_CLOSED; - } - - buf_p = buffer; - while (bytes_read) { - switch (t_con->state) { - case TELNET_STATE_DATA: - if (*buf_p == 0xff) - t_con->state = TELNET_STATE_IAC; - else { - if (isprint(*buf_p)) { /* printable character */ - /* watch buffer size leaving one spare character for - * string null termination */ - if (t_con->line_size == TELNET_LINE_MAX_SIZE-1) { - /* output audible bell if buffer is full - * "\a" does not work, at least on windows */ - telnet_write(connection, "\x07", 1); - } else if (t_con->line_cursor == t_con->line_size) { - telnet_write(connection, buf_p, 1); - t_con->line[t_con->line_size++] = *buf_p; - t_con->line_cursor++; - } else { - int i; - memmove(t_con->line + t_con->line_cursor + 1, - t_con->line + t_con->line_cursor, - t_con->line_size - t_con->line_cursor); - t_con->line[t_con->line_cursor] = *buf_p; - t_con->line_size++; - telnet_write(connection, - t_con->line + t_con->line_cursor, - t_con->line_size - t_con->line_cursor); - t_con->line_cursor++; - for (i = t_con->line_cursor; i < t_con->line_size; i++) - telnet_write(connection, "\b", 1); - } - } else { /* non-printable */ - if (*buf_p == 0x1b) { /* escape */ - t_con->state = TELNET_STATE_ESCAPE; - t_con->last_escape = '\x00'; - } else if ((*buf_p == 0xd) || (*buf_p == 0xa)) { /* CR/LF */ - int retval; - - /* skip over combinations with CR/LF and NUL characters */ - if ((bytes_read > 1) && ((*(buf_p + 1) == 0xa) || - (*(buf_p + 1) == 0xd))) { - buf_p++; - bytes_read--; - } - if ((bytes_read > 1) && (*(buf_p + 1) == 0)) { - buf_p++; - bytes_read--; - } - t_con->line[t_con->line_size] = 0; - - telnet_write(connection, "\r\n\x00", 3); - - if (strcmp(t_con->line, "history") == 0) { - int i; - for (i = 1; i < TELNET_LINE_HISTORY_SIZE; i++) { - /* the t_con->next_history line contains empty string - * (unless NULL), thus it is not printed */ - char *history_line = t_con->history[(t_con-> - next_history + i) % - TELNET_LINE_HISTORY_SIZE]; - if (history_line) { - telnet_write(connection, history_line, - strlen(history_line)); - telnet_write(connection, "\r\n\x00", 3); - } - } - t_con->line_size = 0; - t_con->line_cursor = 0; - continue; - } - - /* save only non-blank not repeating lines in the history */ - char *prev_line = t_con->history[(t_con->current_history > 0) ? - t_con->current_history - 1 : TELNET_LINE_HISTORY_SIZE-1]; - if (*t_con->line && (prev_line == NULL || - strcmp(t_con->line, prev_line))) { - /* if the history slot is already taken, free it */ - if (t_con->history[t_con->next_history]) - free(t_con->history[t_con->next_history]); - - /* add line to history */ - t_con->history[t_con->next_history] = strdup(t_con->line); - - /* wrap history at TELNET_LINE_HISTORY_SIZE */ - t_con->next_history = (t_con->next_history + 1) % - TELNET_LINE_HISTORY_SIZE; - - /* current history line starts at the new entry */ - t_con->current_history = - t_con->next_history; - - if (t_con->history[t_con->current_history]) - free(t_con->history[t_con->current_history]); - t_con->history[t_con->current_history] = strdup(""); - } - - t_con->line_size = 0; - - /* to suppress prompt in log callback during command execution */ - t_con->line_cursor = -1; - - if (strcmp(t_con->line, "shutdown") == 0) - telnet_save_history(t_con); - - retval = command_run_line(command_context, t_con->line); - - t_con->line_cursor = 0; - - if (retval == ERROR_COMMAND_CLOSE_CONNECTION) - return ERROR_SERVER_REMOTE_CLOSED; - - /* the prompt is always * placed at the line beginning */ - telnet_write(connection, "\r", 1); - - retval = telnet_prompt(connection); - if (retval == ERROR_SERVER_REMOTE_CLOSED) - return ERROR_SERVER_REMOTE_CLOSED; - - } else if ((*buf_p == 0x7f) || (*buf_p == 0x8)) { /* delete character */ - if (t_con->line_cursor > 0) { - if (t_con->line_cursor != t_con->line_size) { - int i; - telnet_write(connection, "\b", 1); - t_con->line_cursor--; - t_con->line_size--; - memmove(t_con->line + t_con->line_cursor, - t_con->line + t_con->line_cursor + 1, - t_con->line_size - - t_con->line_cursor); - - telnet_write(connection, - t_con->line + t_con->line_cursor, - t_con->line_size - - t_con->line_cursor); - telnet_write(connection, " \b", 2); - for (i = t_con->line_cursor; i < t_con->line_size; i++) - telnet_write(connection, "\b", 1); - } else { - t_con->line_size--; - t_con->line_cursor--; - /* back space: move the 'printer' head one char - * back, overwrite with space, move back again */ - telnet_write(connection, "\b \b", 3); - } - } - } else if (*buf_p == 0x15) /* clear line */ - telnet_clear_line(connection, t_con); - else if (*buf_p == CTRL('B')) { /* cursor left */ - if (t_con->line_cursor > 0) { - telnet_write(connection, "\b", 1); - t_con->line_cursor--; - } - t_con->state = TELNET_STATE_DATA; - } else if (*buf_p == CTRL('F')) { /* cursor right */ - if (t_con->line_cursor < t_con->line_size) - telnet_write(connection, t_con->line + t_con->line_cursor++, 1); - t_con->state = TELNET_STATE_DATA; - } else if (*buf_p == CTRL('P')) /* cursor up */ - telnet_history_up(connection); - else if (*buf_p == CTRL('N')) /* cursor down */ - telnet_history_down(connection); - else - LOG_DEBUG("unhandled nonprintable: %2.2x", *buf_p); - } - } - break; - case TELNET_STATE_IAC: - switch (*buf_p) { - case 0xfe: - t_con->state = TELNET_STATE_DONT; - break; - case 0xfd: - t_con->state = TELNET_STATE_DO; - break; - case 0xfc: - t_con->state = TELNET_STATE_WONT; - break; - case 0xfb: - t_con->state = TELNET_STATE_WILL; - break; - } - break; - case TELNET_STATE_SB: - break; - case TELNET_STATE_SE: - break; - case TELNET_STATE_WILL: - case TELNET_STATE_WONT: - case TELNET_STATE_DO: - case TELNET_STATE_DONT: - t_con->state = TELNET_STATE_DATA; - break; - case TELNET_STATE_ESCAPE: - if (t_con->last_escape == '[') { - if (*buf_p == 'D') { /* cursor left */ - if (t_con->line_cursor > 0) { - telnet_write(connection, "\b", 1); - t_con->line_cursor--; - } - t_con->state = TELNET_STATE_DATA; - } else if (*buf_p == 'C') { /* cursor right */ - if (t_con->line_cursor < t_con->line_size) - telnet_write(connection, - t_con->line + t_con->line_cursor++, 1); - t_con->state = TELNET_STATE_DATA; - } else if (*buf_p == 'A') { /* cursor up */ - telnet_history_up(connection); - } else if (*buf_p == 'B') { /* cursor down */ - telnet_history_down(connection); - } else if (*buf_p == '3') - t_con->last_escape = *buf_p; - else - t_con->state = TELNET_STATE_DATA; - } else if (t_con->last_escape == '3') { - /* Remove character */ - if (*buf_p == '~') { - if (t_con->line_cursor < t_con->line_size) { - int i; - t_con->line_size--; - /* remove char from line buffer */ - memmove(t_con->line + t_con->line_cursor, - t_con->line + t_con->line_cursor + 1, - t_con->line_size - t_con->line_cursor); - - /* print remainder of buffer */ - telnet_write(connection, t_con->line + t_con->line_cursor, - t_con->line_size - t_con->line_cursor); - /* overwrite last char with whitespace */ - telnet_write(connection, " \b", 2); - - /* move back to cursor position*/ - for (i = t_con->line_cursor; i < t_con->line_size; i++) - telnet_write(connection, "\b", 1); - } - - t_con->state = TELNET_STATE_DATA; - } else - t_con->state = TELNET_STATE_DATA; - } else if (t_con->last_escape == '\x00') { - if (*buf_p == '[') - t_con->last_escape = *buf_p; - else - t_con->state = TELNET_STATE_DATA; - } else { - LOG_ERROR("BUG: unexpected value in t_con->last_escape"); - t_con->state = TELNET_STATE_DATA; - } - - break; - default: - LOG_ERROR("unknown telnet state"); - exit(-1); - } - - bytes_read--; - buf_p++; - } - - return ERROR_OK; -} - -static int telnet_connection_closed(struct connection *connection) -{ - struct telnet_connection *t_con = connection->priv; - int i; - - log_remove_callback(telnet_log_callback, connection); - - if (t_con->prompt) { - free(t_con->prompt); - t_con->prompt = NULL; - } - - /* save telnet history */ - telnet_save_history(t_con); - - for (i = 0; i < TELNET_LINE_HISTORY_SIZE; i++) { - if (t_con->history[i]) { - free(t_con->history[i]); - t_con->history[i] = NULL; - } - } - - /* if this connection registered a debug-message receiver delete it */ - delete_debug_msg_receiver(connection->cmd_ctx, NULL); - - if (connection->priv) { - free(connection->priv); - connection->priv = NULL; - } else - LOG_ERROR("BUG: connection->priv == NULL"); - - return ERROR_OK; -} - -int telnet_init(char *banner) -{ - if (strcmp(telnet_port, "disabled") == 0) { - LOG_INFO("telnet server disabled"); - return ERROR_OK; - } - - struct telnet_service *telnet_service; - - telnet_service = malloc(sizeof(struct telnet_service)); - - if (!telnet_service) { - LOG_ERROR("Failed to allocate telnet service."); - return ERROR_FAIL; - } - - telnet_service->banner = banner; - - return add_service("telnet", - telnet_port, - CONNECTION_LIMIT_UNLIMITED, - telnet_new_connection, - telnet_input, - telnet_connection_closed, - telnet_service); -} - -/* daemon configuration command telnet_port */ -COMMAND_HANDLER(handle_telnet_port_command) -{ - return CALL_COMMAND_HANDLER(server_pipe_command, &telnet_port); -} - -COMMAND_HANDLER(handle_exit_command) -{ - return ERROR_COMMAND_CLOSE_CONNECTION; -} - -static const struct command_registration telnet_command_handlers[] = { - { - .name = "exit", - .handler = handle_exit_command, - .mode = COMMAND_EXEC, - .usage = "", - .help = "exit telnet session", - }, - { - .name = "telnet_port", - .handler = handle_telnet_port_command, - .mode = COMMAND_ANY, - .help = "Specify port on which to listen " - "for incoming telnet connections. " - "Read help on 'gdb_port'.", - .usage = "[port_num]", - }, - COMMAND_REGISTRATION_DONE -}; - -int telnet_register_commands(struct command_context *cmd_ctx) -{ - telnet_port = strdup("4444"); - return register_commands(cmd_ctx, NULL, telnet_command_handlers); -} diff --git a/src/server/telnet_server.h b/src/server/telnet_server.h deleted file mode 100644 index 04ba965..0000000 --- a/src/server/telnet_server.h +++ /dev/null @@ -1,70 +0,0 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007,2008 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 by Spencer Oliver * - * spen@spen-soft.co.uk * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program. If not, see <http://www.gnu.org/licenses/>. * - ***************************************************************************/ - -#ifndef OPENOCD_SERVER_TELNET_SERVER_H -#define OPENOCD_SERVER_TELNET_SERVER_H - -#include <server/server.h> - -#define TELNET_BUFFER_SIZE (1024) - -#define TELNET_OPTION_MAX_SIZE (128) -#define TELNET_LINE_HISTORY_SIZE (128) -#define TELNET_LINE_MAX_SIZE (256) - -enum telnet_states { - TELNET_STATE_DATA, - TELNET_STATE_IAC, - TELNET_STATE_SB, - TELNET_STATE_SE, - TELNET_STATE_WILL, - TELNET_STATE_WONT, - TELNET_STATE_DO, - TELNET_STATE_DONT, - TELNET_STATE_ESCAPE, -}; - -struct telnet_connection { - char *prompt; - enum telnet_states state; - char line[TELNET_LINE_MAX_SIZE]; - int line_size; - int line_cursor; - char option[TELNET_OPTION_MAX_SIZE]; - int option_size; - char last_escape; - char *history[TELNET_LINE_HISTORY_SIZE]; - int next_history; - int current_history; - int closed; -}; - -struct telnet_service { - char *banner; -}; - -int telnet_init(char *banner); -int telnet_register_commands(struct command_context *command_context); - -#endif /* OPENOCD_SERVER_TELNET_SERVER_H */ |