pipes: add documentation for pipes
[openocd.git] / src / server / telnet_server.c
index 514b8d0abd49d3983e8e9aca316a28666dc17bb9..98e86160a3d5d34201090caae7c69f2223cd58bb 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-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
 #include "config.h"
 #endif
 
-#include "replacements.h"
-
 #include "telnet_server.h"
+#include <target/target_request.h>
 
-#include "server.h"
-#include "log.h"
-#include "command.h"
-#include "target.h"
-#include "target_request.h"
-
-#include <stdlib.h>
-#include <unistd.h>
-#include <errno.h>
-#include <string.h>
-#include <ctype.h>
-
-static unsigned short telnet_port = 0;
-
-int handle_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_telnet_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static const char *telnet_port;
 
 static char *negotiate =
                "\xFF\xFB\x03"          /* IAC WILL Suppress Go Ahead */
@@ -60,13 +44,14 @@ static char *negotiate =
  * we write to it, we will fail. Subsequent write operations will
  * succeed. Shudder!
  */
-int telnet_write(connection_t *connection, const void *data, int len)
+static int telnet_write(struct connection *connection, const void *data,
+               int len)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
        if (t_con->closed)
                return ERROR_SERVER_REMOTE_CLOSED;
 
-       if (write_socket(connection->fd, data, len) == len)
+       if (connection_write(connection, data, len) == len)
        {
                return ERROR_OK;
        }
@@ -74,15 +59,14 @@ int telnet_write(connection_t *connection, const void *data, int len)
        return ERROR_SERVER_REMOTE_CLOSED;
 }
 
-int telnet_prompt(connection_t *connection)
+static int telnet_prompt(struct connection *connection)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
 
-       telnet_write(connection, "\r", 1); /* the prompt is always placed at the line beginning */
        return telnet_write(connection, t_con->prompt, strlen(t_con->prompt));
 }
 
-int telnet_outputline(connection_t *connection, const char *line)
+static int telnet_outputline(struct connection *connection, const char *line)
 {
        int len;
 
@@ -99,7 +83,7 @@ int telnet_outputline(connection_t *connection, const char *line)
                if (line_end)
                {
                        telnet_write(connection, "\r\n", 2);
-                       line += len+1;
+                       line += len + 1;
                }
                else
                {
@@ -110,18 +94,18 @@ int telnet_outputline(connection_t *connection, const char *line)
        return ERROR_OK;
 }
 
-int telnet_output(struct command_context_s *cmd_ctx, const char* line)
+static int telnet_output(struct command_context *cmd_ctx, const char* line)
 {
-       connection_t *connection = cmd_ctx->output_handler_priv;
+       struct connection *connection = cmd_ctx->output_handler_priv;
 
        return telnet_outputline(connection, line);
 }
 
-void telnet_log_callback(void *priv, const char *file, int line,
+static void telnet_log_callback(void *priv, const char *file, unsigned line,
                const char *function, const char *string)
 {
-       connection_t *connection = priv;
-       telnet_connection_t *t_con = connection->priv;
+       struct connection *connection = priv;
+       struct telnet_connection *t_con = connection->priv;
        int i;
 
        /* if there is no prompt, simply output the message */
@@ -132,10 +116,12 @@ void telnet_log_callback(void *priv, const char *file, int line,
        }
 
        /* clear the command line */
-       telnet_write(connection, "\r", 1);
-       for (i = strlen(t_con->prompt) + t_con->line_size; i>0; i-=16)
-               telnet_write(connection, "                ", i>16 ? 16 : i);
-       telnet_write(connection, "\r", 1);
+       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);
@@ -143,14 +129,14 @@ void telnet_log_callback(void *priv, const char *file, int line,
        /* 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--)
+       for (i = t_con->line_size; i > t_con->line_cursor; i--)
                telnet_write(connection, "\b", 1);
 }
 
-int telnet_new_connection(connection_t *connection)
+static int telnet_new_connection(struct connection *connection)
 {
-       telnet_connection_t *telnet_connection = malloc(sizeof(telnet_connection_t));
-       telnet_service_t *telnet_service = connection->service->priv;
+       struct telnet_connection *telnet_connection = malloc(sizeof(struct telnet_connection));
+       struct telnet_service *telnet_service = connection->service->priv;
        int i;
 
        connection->priv = telnet_connection;
@@ -176,6 +162,7 @@ int telnet_new_connection(connection_t *connection)
                telnet_write(connection, "\r\n", 2);
        }
 
+       telnet_write(connection, "\r", 1); /* the prompt is always placed at the line beginning */
        telnet_prompt(connection);
 
        /* initialize history */
@@ -188,12 +175,11 @@ int telnet_new_connection(connection_t *connection)
 
        log_add_callback(telnet_log_callback, connection);
 
-
-
        return ERROR_OK;
 }
 
-void telnet_clear_line(connection_t *connection, telnet_connection_t *t_con)
+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)
@@ -210,15 +196,15 @@ void telnet_clear_line(connection_t *connection, telnet_connection_t *t_con)
        t_con->line_cursor = 0;
 }
 
-int telnet_input(connection_t *connection)
+static int telnet_input(struct connection *connection)
 {
        int bytes_read;
-       char buffer[TELNET_BUFFER_SIZE];
-       char *buf_p;
-       telnet_connection_t *t_con = connection->priv;
-       command_context_t *command_context = connection->cmd_ctx;
+       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 = read_socket(connection->fd, buffer, TELNET_BUFFER_SIZE);
+       bytes_read = connection_read(connection, buffer, TELNET_BUFFER_SIZE);
 
        if (bytes_read == 0)
                return ERROR_SERVER_REMOTE_CLOSED;
@@ -234,7 +220,7 @@ int telnet_input(connection_t *connection)
                switch (t_con->state)
                {
                        case TELNET_STATE_DATA:
-                               if (*buf_p == '\xff')
+                               if (*buf_p == 0xff)
                                {
                                        t_con->state = TELNET_STATE_IAC;
                                }
@@ -349,6 +335,7 @@ int telnet_input(connection_t *connection)
                                                        if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
                                                                return ERROR_SERVER_REMOTE_CLOSED;
 
+                                                       telnet_write(connection, "\r", 1); /* the prompt is always placed at the line beginning */
                                                        retval = telnet_prompt(connection);
                                                        if (retval == ERROR_SERVER_REMOTE_CLOSED)
                                                                return ERROR_SERVER_REMOTE_CLOSED;
@@ -413,16 +400,16 @@ int telnet_input(connection_t *connection)
                        case TELNET_STATE_IAC:
                                switch (*buf_p)
                                {
-                                       case '\xfe':
+                                       case 0xfe:
                                                t_con->state = TELNET_STATE_DONT;
                                                break;
-                                       case '\xfd':
+                                       case 0xfd:
                                                t_con->state = TELNET_STATE_DO;
                                                break;
-                                       case '\xfc':
+                                       case 0xfc:
                                                t_con->state = TELNET_STATE_WONT;
                                                break;
-                                       case '\xfb':
+                                       case 0xfb:
                                                t_con->state = TELNET_STATE_WILL;
                                                break;
                                }
@@ -555,9 +542,9 @@ int telnet_input(connection_t *connection)
        return ERROR_OK;
 }
 
-int telnet_connection_closed(connection_t *connection)
+static int telnet_connection_closed(struct connection *connection)
 {
-       telnet_connection_t *t_con = connection->priv;
+       struct telnet_connection *t_con = connection->priv;
        int i;
 
        log_remove_callback(telnet_log_callback, connection);
@@ -593,61 +580,53 @@ int telnet_connection_closed(connection_t *connection)
        return ERROR_OK;
 }
 
-int telnet_set_prompt(connection_t *connection, char *prompt)
-{
-       telnet_connection_t *t_con = connection->priv;
-
-       if (t_con->prompt != NULL)
-               free(t_con->prompt);
-
-       t_con->prompt = strdup(prompt);
-
-       return ERROR_OK;
-}
-
 int telnet_init(char *banner)
 {
-       telnet_service_t *telnet_service = malloc(sizeof(telnet_service_t));
-
-       if (telnet_port == 0)
+       if (strcmp(telnet_port, "disabled") == 0)
        {
-               LOG_WARNING("no telnet port specified, using default port 4444");
-               telnet_port = 4444;
+               LOG_INFO("telnet server disabled");
+               return ERROR_OK;
        }
 
-       telnet_service->banner = banner;
+       struct telnet_service *telnet_service = malloc(sizeof(struct telnet_service));
 
-       add_service("telnet", CONNECTION_TELNET, telnet_port, 1, telnet_new_connection, telnet_input, telnet_connection_closed, telnet_service);
+       telnet_service->banner = banner;
 
-       return ERROR_OK;
+       return add_service("telnet", telnet_port, 1, telnet_new_connection, telnet_input, telnet_connection_closed, telnet_service);
 }
 
-int telnet_register_commands(command_context_t *command_context)
+/* daemon configuration command telnet_port */
+COMMAND_HANDLER(handle_telnet_port_command)
 {
-       register_command(command_context, NULL, "exit", handle_exit_command,
-                                        COMMAND_EXEC, "exit telnet session");
-
-       register_command(command_context, NULL, "telnet_port", handle_telnet_port_command,
-                                        COMMAND_CONFIG, "port on which to listen for incoming telnet connections");
-
-       return ERROR_OK;
+       return CALL_COMMAND_HANDLER(server_pipe_command, &telnet_port);
 }
 
-/* daemon configuration command telnet_port */
-int handle_telnet_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_exit_command)
 {
-       if (argc == 0)
-       {
-               command_print(cmd_ctx, "%d", telnet_port);
-               return ERROR_OK;
-       }
-
-       telnet_port = strtoul(args[0], NULL, 0);
-
-       return ERROR_OK;
+       return ERROR_COMMAND_CLOSE_CONNECTION;
 }
 
-int handle_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static const struct command_registration telnet_command_handlers[] = {
+       {
+               .name = "exit",
+               .handler = handle_exit_command,
+               .mode = COMMAND_EXEC,
+               .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)
 {
-       return ERROR_COMMAND_CLOSE_CONNECTION;
+       telnet_port = strdup("4444");
+       return register_commands(cmd_ctx, NULL, telnet_command_handlers);
 }

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)