add overridable Tcl "init_reset"
[openocd.git] / src / server / gdb_server.c
index 9b22ce274ef4002c3cdfba762512e93d8e50d74a..a0077e93e6fe99a2cec16dbf434be587b2fef76c 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
@@ -40,6 +40,8 @@
 #define _DEBUG_GDB_IO_
 #endif
 
+static gdb_connection_t *current_gdb_connection;
+
 static int gdb_breakpoint_override;
 static enum breakpoint_type gdb_breakpoint_override_type;
 
@@ -319,9 +321,9 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
                        break;
                if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
                        return retval;
-               if (reply == '$' ){
+               if (reply == '$'{
                        /* fix a problem with some IAR tools */
-                       gdb_putback_char(connection, reply );
+                       gdb_putback_char(connection, reply);
                        LOG_DEBUG("Unexpected start of new packet");
                        break;
                }
@@ -402,9 +404,9 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
                                log_remove_callback(gdb_log_callback, connection);
                                LOG_WARNING("negative reply, retrying");
                        }
-                       else if (reply == '$' ){
+                       else if (reply == '$'{
                                LOG_ERROR("GDB missing ack(1) - assumed good");
-                               gdb_putback_char(connection, reply );
+                               gdb_putback_char(connection, reply);
                                return ERROR_OK;
                        } else {
 
@@ -413,9 +415,9 @@ int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
                                return ERROR_SERVER_REMOTE_CLOSED;
                        }
                }
-               else if (reply == '$' ){
+               else if (reply == '$'{
                        LOG_ERROR("GDB missing ack(2) - assumed good");
-                       gdb_putback_char(connection, reply );
+                       gdb_putback_char(connection, reply);
                        return ERROR_OK;
                }
                else
@@ -671,7 +673,7 @@ static void gdb_frontend_halted(struct target_s *target, connection_t *connectio
 {
        gdb_connection_t *gdb_connection = connection->priv;
 
-       /* In the GDB protocol when we are stepping or coninuing execution,
+       /* 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.
@@ -709,17 +711,17 @@ int gdb_target_callback_event_handler(struct target_s *target, enum target_event
        int retval;
        connection_t *connection = priv;
 
-       target_handle_event(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:
                        target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
                        break;
                case TARGET_EVENT_GDB_FLASH_ERASE_START:
-                       target_handle_event(target, TARGET_EVENT_OLD_gdb_program_config );
+                       target_handle_event(target, TARGET_EVENT_OLD_gdb_program_config);
                        if ((retval = jtag_execute_queue()) != ERROR_OK)
                        {
                                return retval;
@@ -750,6 +752,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 +770,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;
@@ -800,9 +779,13 @@ int gdb_new_connection(connection_t *connection)
         */
        if (initial_ack != '+')
                gdb_putback_char(connection, initial_ack);
-       target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH );
+       target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH);
 
        gdb_actual_connections++;
+       LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
+                 gdb_actual_connections,
+                 gdb_service->target->cmd_name,
+                 target_state_name(gdb_service->target));
 
        return ERROR_OK;
 }
@@ -812,7 +795,16 @@ int gdb_connection_closed(connection_t *connection)
        gdb_service_t *gdb_service = connection->service->priv;
        gdb_connection_t *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",
+                 gdb_service->target->cmd_name,
+                 target_state_name(gdb_service->target),
+                 gdb_actual_connections);
 
        /* see if an image built with vFlash commands is left */
        if (gdb_connection->vflash_image)
@@ -835,11 +827,12 @@ int gdb_connection_closed(connection_t *connection)
                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);
-       log_remove_callback(gdb_log_callback, connection);
 
-       target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH );
+       target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
 
        return ERROR_OK;
 }
@@ -847,7 +840,7 @@ int gdb_connection_closed(connection_t *connection)
 void gdb_send_error(connection_t *connection, uint8_t the_error)
 {
        char err[4];
-       snprintf(err, 4, "E%2.2X", the_error );
+       snprintf(err, 4, "E%2.2X", the_error);
        gdb_put_packet(connection, err, 3);
 }
 
@@ -1360,7 +1353,7 @@ int gdb_step_continue_packet(connection_t *connection, target_t *target, char *p
        if (packet[0] == 'c')
        {
                LOG_DEBUG("continue");
-               target_handle_event(target, TARGET_EVENT_OLD_pre_resume );
+               target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
                retval = target_resume(target, current, address, 0, 0); /* resume at current address, don't handle breakpoints, not debugging */
        }
        else if (packet[0] == 's')
@@ -1595,7 +1588,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);
@@ -1872,7 +1869,7 @@ int gdb_v_packet(connection_t *connection, target_t *target, char *packet, int p
 
                /* perform any target specific operations before the erase */
                target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_ERASE_START);
-               result = flash_erase_address_range(gdb_service->target, addr, length );
+               result = flash_erase_address_range(gdb_service->target, addr, length);
                target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_ERASE_END);
 
                /* perform erase */
@@ -1964,10 +1961,10 @@ int gdb_v_packet(connection_t *connection, target_t *target, char *packet, int p
 int gdb_detach(connection_t *connection, target_t *target)
 {
 
-       switch (detach_mode )
+       switch (detach_mode)
        {
                case GDB_DETACH_RESUME:
-                       target_handle_event(target, TARGET_EVENT_OLD_pre_resume );
+                       target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
                        target_resume(target, 1, 0, 1, 0);
                        break;
 
@@ -2036,18 +2033,18 @@ int gdb_input_inner(connection_t *connection)
                /* terminate with zero */
                packet[packet_size] = 0;
 
-               if (LOG_LEVEL_IS(LOG_LVL_DEBUG ) ){
-                       if (packet[0] == 'X' ){
+               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++ ){
+                               for (x = 0 ; (x < 49) && (packet[x] != ':') ; x++{
                                        buf[x] = packet[x];
                                }
                                buf[x] = 0;
-                               LOG_DEBUG("received packet: '%s:<binary-data>'", buf );
+                               LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
                        } else {
-                               LOG_DEBUG("received packet: '%s'", packet );
+                               LOG_DEBUG("received packet: '%s'", packet);
                        }
                }
 
@@ -2093,20 +2090,52 @@ int gdb_input_inner(connection_t *connection)
                                case 'c':
                                case 's':
                                        {
-                                               if (target->state != TARGET_HALTED)
+                                               int retval = ERROR_OK;
+
+                                               gdb_connection_t *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)
                                                {
-                                                       /* If the target isn't in the halted state, then we can't
+                                                       /* 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)
+                                               {
+                                                       /* 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)
@@ -2142,7 +2171,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 */
@@ -2216,23 +2247,48 @@ 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;
 }
 
+int handle_gdb_sync_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+       if (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 */
 int handle_gdb_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
@@ -2242,9 +2298,7 @@ int handle_gdb_port_command(struct command_context_s *cmd_ctx, char *cmd, char *
                return ERROR_OK;
        }
 
-       /* only if the port wasn't overwritten by cmdline */
-       if (gdb_port == 0)
-               gdb_port = strtoul(args[0], NULL, 0);
+       gdb_port = strtoul(args[0], NULL, 0);
 
        return ERROR_OK;
 }
@@ -2379,6 +2433,8 @@ 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_sync", handle_gdb_sync_command,
+                       COMMAND_ANY, "next stepi will return immediately allowing GDB 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_detach", handle_gdb_detach_command,

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)