gdb_connection_t -> struct gdb_connection
[fw/openocd] / src / server / gdb_server.c
index 48144f2665a3048b6d81398c8cbc9d21df8615af..4d20a7dfee1fb22f4d1081efdbfa98508d9ab1cc 100644 (file)
@@ -40,6 +40,8 @@
 #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;
 
@@ -47,20 +49,9 @@ extern int gdb_error(connection_t *connection, int retval);
 static unsigned short gdb_port = 3333;
 static const char *DIGITS = "0123456789abcdef";
 
-static void gdb_log_callback(void *priv, const char *file, int line,
+static void gdb_log_callback(void *priv, const char *file, unsigned line,
                const char *function, const char *string);
 
-enum gdb_detach_mode
-{
-       GDB_DETACH_RESUME,
-       GDB_DETACH_RESET,
-       GDB_DETACH_HALT,
-       GDB_DETACH_NOTHING
-};
-
-/* target behaviour on gdb detach */
-enum gdb_detach_mode detach_mode = GDB_DETACH_RESUME;
-
 /* number of gdb connections, mainly to supress gdb related debugging spam
  * in helper/log.c when no gdb connections are actually active */
 int gdb_actual_connections;
@@ -103,7 +94,7 @@ int check_pending(connection_t *connection, int timeout_s, int *got_data)
         */
        struct timeval tv;
        fd_set read_fds;
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        int t;
        if (got_data == NULL)
                got_data=&t;
@@ -139,7 +130,7 @@ int check_pending(connection_t *connection, int timeout_s, int *got_data)
 
 int gdb_get_char(connection_t *connection, int* next_char)
 {
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        int retval = ERROR_OK;
 
 #ifdef _DEBUG_GDB_IO_
@@ -247,7 +238,7 @@ int gdb_get_char(connection_t *connection, int* next_char)
 
 int gdb_putback_char(connection_t *connection, int last_char)
 {
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
 
        if (gdb_con->buf_p > gdb_con->buffer)
        {
@@ -267,7 +258,7 @@ int gdb_putback_char(connection_t *connection, int last_char)
  * succeed. Shudder! */
 int gdb_write(connection_t *connection, void *data, int len)
 {
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        if (gdb_con->closed)
                return ERROR_SERVER_REMOTE_CLOSED;
 
@@ -299,7 +290,7 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
 #endif
        int reply;
        int retval;
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
 
        for (i = 0; i < len; i++)
                my_checksum += buffer[i];
@@ -433,7 +424,7 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
 
 int gdb_put_packet(connection_t *connection, char *buffer, int len)
 {
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        gdb_con->busy = 1;
        int retval = gdb_put_packet_inner(connection, buffer, len);
        gdb_con->busy = 0;
@@ -451,7 +442,7 @@ static __inline__ int fetch_packet(connection_t *connection, int *checksum_ok, i
        int character;
        int retval;
 
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        my_checksum = 0;
        int count = 0;
        count = 0;
@@ -557,7 +548,7 @@ int gdb_get_packet_inner(connection_t *connection, char *buffer, int *len)
 {
        int character;
        int retval;
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
 
        while (1)
        {
@@ -630,7 +621,7 @@ int gdb_get_packet_inner(connection_t *connection, char *buffer, int *len)
 
 int gdb_get_packet(connection_t *connection, char *buffer, int *len)
 {
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        gdb_con->busy = 1;
        int retval = gdb_get_packet_inner(connection, buffer, len);
        gdb_con->busy = 0;
@@ -669,7 +660,7 @@ int gdb_output(struct command_context_s *context, const char* line)
 
 static void gdb_frontend_halted(struct target_s *target, connection_t *connection)
 {
-       gdb_connection_t *gdb_connection = connection->priv;
+       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
@@ -712,7 +703,7 @@ int gdb_target_callback_event_handler(struct target_s *target, enum target_event
        target_handle_event(target, event);
        switch (event)
        {
-               case TARGET_EVENT_EARLY_HALTED:
+               case TARGET_EVENT_GDB_HALT:
                        gdb_frontend_halted(target, connection);
                        break;
                case TARGET_EVENT_HALTED:
@@ -734,7 +725,7 @@ int gdb_target_callback_event_handler(struct target_s *target, enum target_event
 
 int gdb_new_connection(connection_t *connection)
 {
-       gdb_connection_t *gdb_connection = malloc(sizeof(gdb_connection_t));
+       struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
        gdb_service_t *gdb_service = connection->service->priv;
        int retval;
        int initial_ack;
@@ -750,6 +741,7 @@ int gdb_new_connection(connection_t *connection)
        gdb_connection->closed = 0;
        gdb_connection->busy = 0;
        gdb_connection->noack_mode = 0;
+       gdb_connection->sync = true;
 
        /* send ACK to GDB for debug request */
        gdb_write(connection, "+", 1);
@@ -767,30 +759,6 @@ int gdb_new_connection(connection_t *connection)
        /* register callback to be informed about target events */
        target_register_event_callback(gdb_target_callback_event_handler, connection);
 
-       /* a gdb session just attached, try to put the target in halt mode.
-        *
-        * DANGER!!!!
-        *
-        * If the halt fails(e.g. target needs a reset, JTAG communication not
-        * working, etc.), then the GDB connect will succeed as
-        * the get_gdb_reg_list() will lie and return a register list with
-        * dummy values.
-        *
-        * This allows GDB monitor commands to be run from a GDB init script to
-        * initialize the target
-        *
-        * Also, since the halt() is asynchronous target connect will be
-        * instantaneous and thus avoiding annoying timeout problems during
-        * connect.
-        */
-       target_halt(gdb_service->target);
-       /* FIX!!!! could extended-remote work better here?
-        *
-        *  wait a tiny bit for halted state or we just continue. The
-        * GDB register packet will then contain garbage
-        */
-       target_wait_state(gdb_service->target, TARGET_HALTED, 500);
-
        /* remove the initial ACK from the incoming buffer */
        if ((retval = gdb_get_char(connection, &initial_ack)) != ERROR_OK)
                return retval;
@@ -814,7 +782,7 @@ int gdb_new_connection(connection_t *connection)
 int gdb_connection_closed(connection_t *connection)
 {
        gdb_service_t *gdb_service = connection->service->priv;
-       gdb_connection_t *gdb_connection = connection->priv;
+       struct gdb_connection *gdb_connection = connection->priv;
 
        /* we're done forwarding messages. Tear down callback before
         * cleaning up connection.
@@ -822,7 +790,7 @@ int gdb_connection_closed(connection_t *connection)
        log_remove_callback(gdb_log_callback, connection);
 
        gdb_actual_connections--;
-       LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d", 
+       LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
                  gdb_service->target->cmd_name,
                  target_state_name(gdb_service->target),
                  gdb_actual_connections);
@@ -1589,7 +1557,7 @@ static int compare_bank (const void * a, const void * b)
 int gdb_query_packet(connection_t *connection, target_t *target, char *packet, int packet_size)
 {
        command_context_t *cmd_ctx = connection->cmd_ctx;
-       gdb_connection_t *gdb_connection = connection->priv;
+       struct gdb_connection *gdb_connection = connection->priv;
 
        if (strstr(packet, "qRcmd,"))
        {
@@ -1609,7 +1577,11 @@ int gdb_query_packet(connection_t *connection, target_t *target, char *packet, i
                        /* 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);
@@ -1840,7 +1812,7 @@ int gdb_query_packet(connection_t *connection, target_t *target, char *packet, i
 
 int gdb_v_packet(connection_t *connection, target_t *target, char *packet, int packet_size)
 {
-       gdb_connection_t *gdb_connection = connection->priv;
+       struct gdb_connection *gdb_connection = connection->priv;
        gdb_service_t *gdb_service = connection->service->priv;
        int result;
 
@@ -1977,36 +1949,18 @@ int gdb_v_packet(connection_t *connection, target_t *target, char *packet, int p
 
 int gdb_detach(connection_t *connection, target_t *target)
 {
+       gdb_service_t *gdb_service = connection->service->priv;
 
-       switch (detach_mode)
-       {
-               case GDB_DETACH_RESUME:
-                       target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
-                       target_resume(target, 1, 0, 1, 0);
-                       break;
-
-               case GDB_DETACH_RESET:
-                       /* FIX?? make this configurable?? */
-                       target_process_reset(connection->cmd_ctx, RESET_HALT);
-                       break;
-
-               case GDB_DETACH_HALT:
-                       target_halt(target);
-                       break;
-
-               case GDB_DETACH_NOTHING:
-                       break;
-       }
+       target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
 
-       gdb_put_packet(connection, "OK", 2);
-       return ERROR_OK;
+       return gdb_put_packet(connection, "OK", 2);
 }
 
-static void gdb_log_callback(void *priv, const char *file, int line,
+static void gdb_log_callback(void *priv, const char *file, unsigned line,
                const char *function, const char *string)
 {
        connection_t *connection = priv;
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
 
        if (gdb_con->busy)
        {
@@ -2035,7 +1989,7 @@ int gdb_input_inner(connection_t *connection)
        char *packet = gdb_packet_buffer;
        int packet_size;
        int retval;
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        static int extended_protocol = 0;
 
        /* drain input buffer */
@@ -2107,20 +2061,52 @@ int gdb_input_inner(connection_t *connection)
                                case 'c':
                                case 's':
                                        {
-                                               if (target->state != TARGET_HALTED)
+                                               int retval = ERROR_OK;
+
+                                               struct gdb_connection *gdb_con = connection->priv;
+                                               log_add_callback(gdb_log_callback, connection);
+
+                                               bool nostep = false;
+                                               if (target->state == TARGET_RUNNING)
+                                               {
+                                                       LOG_WARNING("The target is already running. Halt target before stepi/continue.");
+                                                       retval = target_halt(target);
+                                                       if (retval == ERROR_OK)
+                                                               retval = target_wait_state(target, TARGET_HALTED, 100);
+                                               } 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 ((retval!=ERROR_OK) || nostep)
                                                {
-                                                       /* If the target isn't in the halted state, then we can't
+                                                       /* 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_connection_t *gdb_con = connection->priv;
                                                        gdb_con->frontend_state = TARGET_RUNNING;
-                                                       log_add_callback(gdb_log_callback, connection);
                                                        target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
                                                        int retval = gdb_step_continue_packet(connection, target, packet, packet_size);
                                                        if (retval != ERROR_OK)
@@ -2156,7 +2142,9 @@ int gdb_input_inner(connection_t *connection)
                                        /* 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 %d", get_num_by_target(target));
+                                       command_run_linef(connection->cmd_ctx,
+                                                       "ocd_gdb_restart %s",
+                                                       target->cmd_name);
                                        break;
                                default:
                                        /* ignore unkown packets */
@@ -2174,8 +2162,16 @@ int gdb_input_inner(connection_t *connection)
                {
                        if (target->state == TARGET_RUNNING)
                        {
-                               target_halt(target);
+                               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);
                        }
                }
 
@@ -2187,7 +2183,7 @@ int gdb_input_inner(connection_t *connection)
 int gdb_input(connection_t *connection)
 {
        int retval = gdb_input_inner(connection);
-       gdb_connection_t *gdb_con = connection->priv;
+       struct gdb_connection *gdb_con = connection->priv;
        if (retval == ERROR_SERVER_REMOTE_CLOSED)
                return retval;
 
@@ -2230,69 +2226,55 @@ int gdb_init(void)
        }
        else
        {
+               unsigned short port = gdb_port;
+
                while (target)
                {
                        gdb_service = malloc(sizeof(gdb_service_t));
                        gdb_service->target = target;
 
-                       add_service("gdb", CONNECTION_TCP, gdb_port + target->target_number, 1, gdb_new_connection, gdb_input, gdb_connection_closed, gdb_service);
+                       add_service("gdb", CONNECTION_TCP,
+                                       port, 1,
+                                       gdb_new_connection, gdb_input,
+                                       gdb_connection_closed, gdb_service);
 
-                       LOG_DEBUG("gdb service for target %s at port %i",
+                       LOG_DEBUG("gdb service for target %s at TCP port %i",
                                        target_get_name(target),
-                                       gdb_port + target->target_number);
+                                       port);
                        target = target->next;
+                       port++;
                }
        }
 
        return ERROR_OK;
 }
 
-/* daemon configuration command gdb_port */
-int handle_gdb_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_gdb_sync_command)
 {
-       if (argc == 0)
+       if (argc != 0)
        {
-               command_print(cmd_ctx, "%d", gdb_port);
-               return ERROR_OK;
+               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;
        }
 
-       gdb_port = strtoul(args[0], NULL, 0);
+       current_gdb_connection->sync = true;
 
        return ERROR_OK;
 }
 
-int handle_gdb_detach_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+/* daemon configuration command gdb_port */
+COMMAND_HANDLER(handle_gdb_port_command)
 {
-       if (argc == 1)
-       {
-               if (strcmp(args[0], "resume") == 0)
-               {
-                       detach_mode = GDB_DETACH_RESUME;
-                       return ERROR_OK;
-               }
-               else if (strcmp(args[0], "reset") == 0)
-               {
-                       detach_mode = GDB_DETACH_RESET;
-                       return ERROR_OK;
-               }
-               else if (strcmp(args[0], "halt") == 0)
-               {
-                       detach_mode = GDB_DETACH_HALT;
-                       return ERROR_OK;
-               }
-               else if (strcmp(args[0], "nothing") == 0)
-               {
-                       detach_mode = GDB_DETACH_NOTHING;
-                       return ERROR_OK;
-               }
-               else
-                       LOG_WARNING("invalid gdb_detach configuration directive: %s", args[0]);
-       }
-
-       return ERROR_COMMAND_SYNTAX_ERROR;
+       return CALL_COMMAND_HANDLER(server_port_command, &gdb_port);
 }
 
-int handle_gdb_memory_map_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_gdb_memory_map_command)
 {
        if (argc == 1)
        {
@@ -2313,7 +2295,7 @@ int handle_gdb_memory_map_command(struct command_context_s *cmd_ctx, char *cmd,
        return ERROR_COMMAND_SYNTAX_ERROR;
 }
 
-int handle_gdb_flash_program_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_gdb_flash_program_command)
 {
        if (argc == 1)
        {
@@ -2334,7 +2316,7 @@ int handle_gdb_flash_program_command(struct command_context_s *cmd_ctx, char *cm
        return ERROR_COMMAND_SYNTAX_ERROR;
 }
 
-int handle_gdb_report_data_abort_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_gdb_report_data_abort_command)
 {
        if (argc == 1)
        {
@@ -2356,7 +2338,7 @@ int handle_gdb_report_data_abort_command(struct command_context_s *cmd_ctx, char
 }
 
 /* gdb_breakpoint_override */
-int handle_gdb_breakpoint_override_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
 {
        if (argc == 0)
        {
@@ -2391,18 +2373,25 @@ int handle_gdb_breakpoint_override_command(struct command_context_s *cmd_ctx, ch
 
 int gdb_register_commands(command_context_t *command_context)
 {
-       register_command(command_context, NULL, "gdb_port", handle_gdb_port_command,
-                       COMMAND_ANY, "daemon configuration command gdb_port");
-       register_command(command_context, NULL, "gdb_detach", handle_gdb_detach_command,
-                       COMMAND_CONFIG, "resume/reset/halt/nothing - "
-                       "specify behavior when GDB detaches from the target");
-       register_command(command_context, NULL, "gdb_memory_map", handle_gdb_memory_map_command,
-                       COMMAND_CONFIG, "enable or disable memory map");
-       register_command(command_context, NULL, "gdb_flash_program", handle_gdb_flash_program_command,
-                       COMMAND_CONFIG, "enable or disable flash program");
-       register_command(command_context, NULL, "gdb_report_data_abort", handle_gdb_report_data_abort_command,
-                       COMMAND_CONFIG, "enable or disable reporting data aborts");
-       register_command(command_context, NULL, "gdb_breakpoint_override", handle_gdb_breakpoint_override_command,
-                       COMMAND_EXEC, "hard/soft/disable - force breakpoint type for gdb 'break' commands.");
+       register_command(command_context, NULL, "gdb_sync",
+                       handle_gdb_sync_command, COMMAND_ANY,
+                       "next stepi will return immediately allowing GDB to "
+                       "fetch register state without affecting target state");
+       register_command(command_context, NULL, "gdb_port",
+                       handle_gdb_port_command, COMMAND_ANY,
+                       "daemon configuration command gdb_port");
+       register_command(command_context, NULL, "gdb_memory_map",
+                       handle_gdb_memory_map_command, COMMAND_CONFIG,
+                       "enable or disable memory map");
+       register_command(command_context, NULL, "gdb_flash_program",
+                       handle_gdb_flash_program_command, COMMAND_CONFIG,
+                       "enable or disable flash program");
+       register_command(command_context, NULL, "gdb_report_data_abort",
+                       handle_gdb_report_data_abort_command, COMMAND_CONFIG,
+                       "enable or disable reporting data aborts");
+       register_command(command_context, NULL, "gdb_breakpoint_override",
+                       handle_gdb_breakpoint_override_command, COMMAND_EXEC,
+                       "hard/soft/disable - force type of breakpoint "
+                       "used by gdb 'break' commands.");
        return ERROR_OK;
 }