- fixed target->type->poll() return value
[openocd.git] / src / server / telnet_server.c
index 3ff3456a3d47d204140c647e4472caf39b089638..b40daca8a1b266ab17f4bc094ecddf9d81e158e7 100644 (file)
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "replacements.h"
+
 #include "telnet_server.h"
 
 #include "server.h"
 #include "log.h"
 #include "command.h"
 #include "target.h"
+#include "target_request.h"
 
 #include <stdlib.h>
 #include <unistd.h>
@@ -43,21 +50,66 @@ static char *negotiate =
                
 #define CTRL(c) (c - '@')
        
-void telnet_prompt(connection_t *connection)
+/* 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!
+ */
+int telnet_write(connection_t *connection, void *data, int len)
 {
        telnet_connection_t *t_con = connection->priv;
+       if (t_con->closed)
+               return ERROR_SERVER_REMOTE_CLOSED;
+
+       if (write_socket(connection->fd, data, len) == len)
+       {
+               return ERROR_OK;
+       }
+       t_con->closed = 1;
+       return ERROR_SERVER_REMOTE_CLOSED;
+}
+
+int telnet_prompt(connection_t *connection)
+{
+       telnet_connection_t *t_con = connection->priv;
+
+       return telnet_write(connection, t_con->prompt, strlen(t_con->prompt));
+}
 
-       write(connection->fd, t_con->prompt, strlen(t_con->prompt));
+int telnet_outputline(connection_t *connection, char* line)
+{
+       telnet_write(connection, line, strlen(line));
+       return telnet_write(connection, "\r\n\0", 3);
 }
 
 int telnet_output(struct command_context_s *cmd_ctx, char* line)
 {
        connection_t *connection = cmd_ctx->output_handler_priv;
        
-       write(connection->fd, line, strlen(line));
-       write(connection->fd, "\r\n\0", 3);
+       return telnet_outputline(connection, line);
+}
+
+void telnet_log_callback(void *priv, const char *file, int line, 
+               const char *function, const char *format, va_list args)
+{
+       connection_t *connection = priv;
+       char *t = allocPrintf(format, args);
+       char *t2;
+       if (t == NULL)
+               return;
+       t2=t;
+       char *endline;
+       do 
+       {
+               if ((endline=strchr(t2, '\n'))!=NULL)
+               {
+                       *endline=0;
+               }
+               telnet_outputline(connection, t2);
+               t2=endline+1;
+       } while (endline);
        
-       return ERROR_OK;
+       
+       free(t);
 }
 
 int telnet_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
@@ -65,22 +117,19 @@ int telnet_target_callback_event_handler(struct target_s *target, enum target_ev
        struct command_context_s *cmd_ctx = priv;
        connection_t *connection = cmd_ctx->output_handler_priv;
        telnet_connection_t *t_con = connection->priv;
-       char buffer[512];
        
        switch (event)
        {
                case TARGET_EVENT_HALTED:
                        command_print(cmd_ctx, "Target %i halted", get_num_by_target(target));
-                       target->type->arch_state(target, buffer, 512);
-                       buffer[511] = 0;
-                       command_print(cmd_ctx, "%s", buffer);
-                       telnet_prompt(connection);
-                       t_con->suppress_prompt = 1;
+                       target_arch_state(target);
+                       if (!t_con->suppress_prompt)
+                               telnet_prompt(connection);
                        break;
                case TARGET_EVENT_RESUMED:
                        command_print(cmd_ctx, "Target %i resumed", get_num_by_target(target));
-                       telnet_prompt(connection);
-                       t_con->suppress_prompt = 1;
+                       if (!t_con->suppress_prompt)
+                               telnet_prompt(connection);
                        break;
                default:
                        break;
@@ -98,6 +147,7 @@ int telnet_new_connection(connection_t *connection)
        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;
@@ -109,13 +159,13 @@ int telnet_new_connection(connection_t *connection)
        command_set_output_handler(connection->cmd_ctx, telnet_output, connection);
        
        /* negotiate telnet options */
-       write(connection->fd, negotiate, strlen(negotiate));
+       telnet_write(connection, negotiate, strlen(negotiate));
        
        /* print connection banner */
        if (telnet_service->banner)
        {
-               write(connection->fd, telnet_service->banner, strlen(telnet_service->banner));
-               write(connection->fd, "\r\n\0", 3);
+               telnet_write(connection, telnet_service->banner, strlen(telnet_service->banner));
+               telnet_write(connection, "\r\n\0", 3);
        }
        
        telnet_prompt(connection);
@@ -127,7 +177,7 @@ int telnet_new_connection(connection_t *connection)
        }
        telnet_connection->next_history = 0;
        telnet_connection->current_history = 0;
-       
+
        target_register_event_callback(telnet_target_callback_event_handler, connection->cmd_ctx);
        
        return ERROR_OK;
@@ -138,13 +188,13 @@ void telnet_clear_line(connection_t *connection, telnet_connection_t *t_con)
        /* move to end of line */
        if (t_con->line_cursor < t_con->line_size)
        {
-               write(connection->fd, t_con->line + t_con->line_cursor, 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);
        }
                                                        
        /* backspace, overwrite with space, backspace */
        while (t_con->line_size > 0)
        {
-               write(connection->fd, "\b \b", 3);
+               telnet_write(connection, "\b \b", 3);
                t_con->line_size--;
        }
        t_con->line_cursor = 0;
@@ -158,7 +208,7 @@ int telnet_input(connection_t *connection)
        telnet_connection_t *t_con = connection->priv;
        command_context_t *command_context = connection->cmd_ctx;
        
-       bytes_read = read(connection->fd, buffer, TELNET_BUFFER_SIZE);
+       bytes_read = read_socket(connection->fd, buffer, TELNET_BUFFER_SIZE);
        
        if (bytes_read == 0)
                return ERROR_SERVER_REMOTE_CLOSED;
@@ -182,7 +232,7 @@ int telnet_input(connection_t *connection)
                                {
                                        if (isprint(*buf_p)) /* printable character */
                                        {
-                                               write(connection->fd, buf_p, 1);
+                                               telnet_write(connection, buf_p, 1);
                                                if (t_con->line_cursor == t_con->line_size)
                                                {
                                                        t_con->line[t_con->line_size++] = *buf_p;
@@ -194,10 +244,10 @@ int telnet_input(connection_t *connection)
                                                        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++;
-                                                       write(connection->fd, t_con->line + t_con->line_cursor, 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);
                                                        for (i = t_con->line_cursor; i < t_con->line_size; i++)
                                                        {
-                                                               write(connection->fd, "\b", 1);
+                                                               telnet_write(connection, "\b", 1);
                                                        }
                                                }
                                        }
@@ -225,7 +275,7 @@ int telnet_input(connection_t *connection)
                                                        }
                                                        t_con->line[t_con->line_size] = 0;
                                                        
-                                                       write(connection->fd, "\r\n\x00", 3);
+                                                       telnet_write(connection, "\r\n\x00", 3);
                                                        
                                                        if (strcmp(t_con->line, "history") == 0)
                                                        {
@@ -234,8 +284,8 @@ int telnet_input(connection_t *connection)
                                                                {
                                                                        if (t_con->history[i])
                                                                        {
-                                                                               write(connection->fd, t_con->history[i], strlen(t_con->history[i]));
-                                                                               write(connection->fd, "\r\n\x00", 3);
+                                                                               telnet_write(connection, t_con->history[i], strlen(t_con->history[i]));
+                                                                               telnet_write(connection, "\r\n\x00", 3);
                                                                        }
                                                                }
                                                                telnet_prompt(connection);
@@ -244,9 +294,9 @@ int telnet_input(connection_t *connection)
                                                                continue;
                                                        }
                                                        
-                                                       /* we're running a command, so we need a prompt
-                                                        * if the output handler is called, this gets set again */
-                                                       t_con->suppress_prompt = 0;
+                                                       log_setCallback(telnet_log_callback, connection);
+                                                       t_con->suppress_prompt = 1;
+                                                       
                                                        if ((retval = command_run_line(command_context, t_con->line)) != ERROR_OK)
                                                        {
                                                                if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
@@ -255,37 +305,37 @@ int telnet_input(connection_t *connection)
                                                                }
                                                        }
                                                        
-                                                       /* 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);
-                                                       
-                                                       /* current history line starts at the new entry */
-                                                       t_con->current_history = t_con->next_history;
+                                                       t_con->suppress_prompt = 0;
                                                        
-                                                       if (t_con->history[t_con->current_history])
+                                                       /* Save only non-blank lines in the history */
+                                                       if (t_con->line_size > 0)
                                                        {
-                                                               free(t_con->history[t_con->current_history]);
-                                                       }
-                                                       t_con->history[t_con->current_history] = strdup("");
+                                                               /* 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;
                                                        
-                                                       /* wrap history at TELNET_LINE_HISTORY_SIZE */
-                                                       if (t_con->next_history > TELNET_LINE_HISTORY_SIZE - 1)
-                                                               t_con->next_history = 0;
+                                                               /* current history line starts at the new entry */
+                                                               t_con->current_history = t_con->next_history;
                                                        
-                                                       if (!t_con->suppress_prompt)
-                                                       {
-                                                               telnet_prompt(connection);
-                                                       }
-                                                       else
-                                                       {
-                                                               t_con->suppress_prompt = 0;
+                                                               if (t_con->history[t_con->current_history])
+                                                               {
+                                                                       free(t_con->history[t_con->current_history]);
+                                                               }
+                                                               t_con->history[t_con->current_history] = strdup("");
                                                        }
                                                        
+                                                       int t = telnet_prompt(connection);
+                                                       if (t == ERROR_SERVER_REMOTE_CLOSED)
+                                                               return t;
+                                                       
                                                        t_con->line_size = 0;
                                                        t_con->line_cursor = 0;
                                                }
@@ -296,16 +346,16 @@ int telnet_input(connection_t *connection)
                                                                if (t_con->line_cursor != t_con->line_size)
                                                                {
                                                                        int i;
-                                                                       write(connection->fd, "\b", 1);
+                                                                       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);
                                                                        
-                                                                       write(connection->fd, t_con->line + t_con->line_cursor, t_con->line_size - t_con->line_cursor);
-                                                                       write(connection->fd, " \b", 2);
+                                                                       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++)
                                                                        {
-                                                                               write(connection->fd, "\b", 1);
+                                                                               telnet_write(connection, "\b", 1);
                                                                        }
                                                                }
                                                                else
@@ -313,7 +363,7 @@ int telnet_input(connection_t *connection)
                                                                        t_con->line_size--;
                                                                        t_con->line_cursor--;
                                                                        /* back space: move the 'printer' head one char back, overwrite with space, move back again */
-                                                                       write(connection->fd, "\b \b", 3);
+                                                                       telnet_write(connection, "\b \b", 3);
                                                                }
                                                        }
                                                }
@@ -325,7 +375,7 @@ int telnet_input(connection_t *connection)
                                                {
                                                        if (t_con->line_cursor > 0)
                                                        {
-                                                               write(connection->fd, "\b", 1);
+                                                               telnet_write(connection, "\b", 1);
                                                                t_con->line_cursor--;
                                                        }
                                                        t_con->state = TELNET_STATE_DATA;
@@ -334,7 +384,7 @@ int telnet_input(connection_t *connection)
                                                {
                                                        if (t_con->line_cursor < t_con->line_size)
                                                        {
-                                                               write(connection->fd, t_con->line + t_con->line_cursor++, 1);
+                                                               telnet_write(connection, t_con->line + t_con->line_cursor++, 1);
                                                        }
                                                        t_con->state = TELNET_STATE_DATA;
                                                }
@@ -379,7 +429,7 @@ int telnet_input(connection_t *connection)
                                        {
                                                if (t_con->line_cursor > 0)
                                                {
-                                                       write(connection->fd, "\b", 1);
+                                                       telnet_write(connection, "\b", 1);
                                                        t_con->line_cursor--;
                                                }
                                                t_con->state = TELNET_STATE_DATA;
@@ -388,34 +438,34 @@ int telnet_input(connection_t *connection)
                                        {
                                                if (t_con->line_cursor < t_con->line_size)
                                                {
-                                                       write(connection->fd, t_con->line + t_con->line_cursor++, 1);
+                                                       telnet_write(connection, t_con->line + t_con->line_cursor++, 1);
                                                }
                                                t_con->state = TELNET_STATE_DATA;
                                        }
                                        else if (*buf_p == 'A') /* cursor up */
                                        {
-                                               int last_history = (t_con->current_history - 1 >= 0) ? t_con->current_history - 1 : 127;
+                                               int last_history = (t_con->current_history > 0) ? t_con->current_history - 1 : TELNET_LINE_HISTORY_SIZE-1;
                                                if (t_con->history[last_history])
                                                {
                                                        telnet_clear_line(connection, t_con);
                                                        t_con->line_size = strlen(t_con->history[last_history]);
                                                        t_con->line_cursor = t_con->line_size;
                                                        memcpy(t_con->line, t_con->history[last_history], t_con->line_size + 1);
-                                                       write(connection->fd, t_con->line, t_con->line_size);
+                                                       telnet_write(connection, t_con->line, t_con->line_size);
                                                        t_con->current_history = last_history;
                                                }
                                                t_con->state = TELNET_STATE_DATA;
                                        }
                                        else if (*buf_p == 'B') /* cursor down */
                                        {
-                                               int next_history = (t_con->current_history + 1 < 128) ? t_con->current_history + 1 : 0;
+                                               int next_history = (t_con->current_history + 1) % TELNET_LINE_HISTORY_SIZE;
                                                if (t_con->history[next_history])
                                                {
                                                        telnet_clear_line(connection, t_con);
                                                        t_con->line_size = strlen(t_con->history[next_history]);
                                                        t_con->line_cursor = t_con->line_size;
                                                        memcpy(t_con->line, t_con->history[next_history], t_con->line_size + 1);
-                                                       write(connection->fd, t_con->line, t_con->line_size);
+                                                       telnet_write(connection, t_con->line, t_con->line_size);
                                                        t_con->current_history = next_history;
                                                }
                                                t_con->state = TELNET_STATE_DATA;
@@ -442,14 +492,14 @@ int telnet_input(connection_t *connection)
                                                        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 */
-                                                       write(connection->fd, t_con->line + t_con->line_cursor, 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);
                                                        /* overwrite last char with whitespace */
-                                                       write(connection->fd, " \b", 2);
+                                                       telnet_write(connection, " \b", 2);
                                                        
                                                        /* move back to cursor position*/
                                                        for (i = t_con->line_cursor; i < t_con->line_size; i++)
                                                        {
-                                                               write(connection->fd, "\b", 1);
+                                                               telnet_write(connection, "\b", 1);
                                                        }
                                                }
                                                        
@@ -496,18 +546,32 @@ int telnet_connection_closed(connection_t *connection)
        int i;
        
        if (t_con->prompt)
+       {
                free(t_con->prompt);
+               t_con->prompt = NULL;
+       }
        
        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
+       {
                ERROR("BUG: connection->priv == NULL");
+       }
        
        target_unregister_event_callback(telnet_target_callback_event_handler, connection->cmd_ctx);
 

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)