server: read/write now goes through connection fn's
[fw/openocd] / src / server / server.c
index 2245c8676eee5576f833880a8ca09d0ec318a967..1c556638afff7722d464c6b8ab78824580b0ce03 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                                  *
 #endif
 
 #include "server.h"
-#include "target.h"
+#include <target/target.h>
+#include "openocd.h"
+#include "tcl_server.h"
+#include "telnet_server.h"
 
 #include <signal.h>
 
 #endif
 
 
-service_t *services = NULL;
+static struct service *services = NULL;
 
 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
 static int shutdown_openocd = 0;
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 /* set when using pipes rather than tcp */
 int server_use_pipes = 0;
 
-int add_connection(service_t *service, command_context_t *cmd_ctx)
+static int add_connection(struct service *service, struct command_context *cmd_ctx)
 {
        socklen_t address_size;
-       connection_t *c, **p;
+       struct connection *c, **p;
        int retval;
        int flag = 1;
 
-       c = malloc(sizeof(connection_t));
+       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;
@@ -67,6 +70,7 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
                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. */
@@ -76,7 +80,7 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
                                (char *)&flag,          /* the cast is historical cruft */
                                sizeof(int));           /* length of option value */
 
-               LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
+               LOG_INFO("accepting '%s' connection from %i", service->name, service->port);
                if ((retval = service->new_connection(c)) != ERROR_OK)
                {
                        close_socket(c->fd);
@@ -88,6 +92,10 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
        else if (service->type == CONNECTION_PIPE)
        {
                c->fd = service->fd;
+               c->fd_out = fileno(stdout);
+
+               /* do not check for new connections again on stdin */
+               service->fd = -1;
 
                /* do not check for new connections again on stdin */
                service->fd = -1;
@@ -110,10 +118,10 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
        return ERROR_OK;
 }
 
-int remove_connection(service_t *service, connection_t *connection)
+static int remove_connection(struct service *service, struct connection *connection)
 {
-       connection_t **p = &service->connections;
-       connection_t *c;
+       struct connection **p = &service->connections;
+       struct connection *c;
 
        /* find connection */
        while ((c = *p))
@@ -142,10 +150,10 @@ int remove_connection(service_t *service, connection_t *connection)
 
 int add_service(char *name, enum connection_type type, unsigned short 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)
 {
-       service_t *c, **p;
+       struct service *c, **p;
        int so_reuseaddr_option = 1;
 
-       c = malloc(sizeof(service_t));
+       c = malloc(sizeof(struct service));
 
        c->name = strdup(name);
        c->type = type;
@@ -203,8 +211,7 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        }
        else if (type == CONNECTION_PIPE)
        {
-               /* use stdin */
-               c->fd = STDIN_FILENO;
+               c->fd = fileno(stdin);
 
 #ifdef _WIN32
                /* for win32 set stdin/stdout to binary mode */
@@ -231,42 +238,14 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        return ERROR_OK;
 }
 
-int remove_service(unsigned short port)
-{
-       service_t **p = &services;
-       service_t *c;
-
-       /* find service */
-       while ((c = *p))
-       {
-               if (c->port == port)
-               {
-                       if (c->name)
-                               free(c->name);
-
-                       if (c->priv)
-                               free(c->priv);
-
-                       /* delete service */
-                       *p = c->next;
-                       free(c);
-               }
-
-               /* redirect p to next list pointer */
-               p = &(*p)->next;
-       }
-
-       return ERROR_OK;
-}
-
-int remove_services(void)
+static int remove_services(void)
 {
-       service_t *c = services;
+       struct service *c = services;
 
        /* loop service */
        while (c)
        {
-               service_t *next = c->next;
+               struct service *next = c->next;
 
                if (c->name)
                        free(c->name);
@@ -286,16 +265,14 @@ int remove_services(void)
        return ERROR_OK;
 }
 
-extern void openocd_sleep_prelude(void);
-extern void openocd_sleep_postlude(void);
-
-int server_loop(command_context_t *command_context)
+int server_loop(struct command_context *command_context)
 {
-       service_t *service;
+       struct service *service;
+
+       bool poll_ok = true;
 
        /* used in select() */
        fd_set read_fds;
-       struct timeval tv;
        int fd_max;
 
        /* used in accept() */
@@ -306,13 +283,9 @@ int server_loop(command_context_t *command_context)
                LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
 #endif
 
-       /* do regular tasks after at most 10ms */
-       tv.tv_sec = 0;
-       tv.tv_usec = 10000;
-
        while (!shutdown_openocd)
        {
-               /* monitor sockets for acitvity */
+               /* monitor sockets for activity */
                fd_max = 0;
                FD_ZERO(&read_fds);
 
@@ -330,7 +303,7 @@ int server_loop(command_context_t *command_context)
 
                        if (service->connections)
                        {
-                               connection_t *c;
+                               struct connection *c;
 
                                for (c = service->connections; c; c = c->next)
                                {
@@ -342,22 +315,24 @@ int server_loop(command_context_t *command_context)
                        }
                }
 
-#ifndef _WIN32
-#if BUILD_ECOSBOARD == 0
-               if (server_use_pipes == 0)
+               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
                {
-                       /* add STDIN to read_fds */
-                       FD_SET(fileno(stdin), &read_fds);
+                       /* Every 100ms */
+                       tv.tv_usec = 100000;
+                       /* 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();
                }
-#endif
-#endif
-
-               openocd_sleep_prelude();
-               kept_alive();
-
-               /* Only while we're sleeping we'll let others run */
-               retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
-               openocd_sleep_postlude();
 
                if (retval == -1)
                {
@@ -386,15 +361,20 @@ int server_loop(command_context_t *command_context)
 #endif
                }
 
-               target_call_timer_callbacks();
-               process_jim_events ();
-
                if (retval == 0)
                {
-                       /* do regular tasks after at most 100ms */
-                       tv.tv_sec = 0;
-                       tv.tv_usec = 10000;
+                       /* 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;
                }
 
                for (service = services; service; service = service->next)
@@ -409,7 +389,7 @@ int server_loop(command_context_t *command_context)
                                }
                                else
                                {
-                                       if (service->type != CONNECTION_PIPE)
+                                       if (service->type == CONNECTION_TCP)
                                        {
                                                struct sockaddr_in sin;
                                                socklen_t address_size = sizeof(sin);
@@ -424,7 +404,7 @@ int server_loop(command_context_t *command_context)
                        /* handle activity on connections */
                        if (service->connections)
                        {
-                               connection_t *c;
+                               struct connection *c;
 
                                for (c = service->connections; c;)
                                {
@@ -432,7 +412,7 @@ int server_loop(command_context_t *command_context)
                                        {
                                                if ((retval = service->input(c)) != ERROR_OK)
                                                {
-                                                       connection_t *next = c->next;
+                                                       struct connection *next = c->next;
                                                        if (service->type == CONNECTION_PIPE)
                                                        {
                                                                /* if connection uses a pipe then shutdown openocd on error */
@@ -449,21 +429,7 @@ int server_loop(command_context_t *command_context)
                        }
                }
 
-#ifndef _WIN32
-#if BUILD_ECOSBOARD == 0
-               /* check for data on stdin if not using pipes */
-               if (server_use_pipes == 0)
-               {
-                       if (FD_ISSET(fileno(stdin), &read_fds))
-                       {
-                               if (getc(stdin) == 'x')
-                               {
-                                       shutdown_openocd = 1;
-                               }
-                       }
-               }
-#endif
-#else
+#ifdef _WIN32
                MSG msg;
                while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
                {
@@ -488,8 +454,12 @@ void sig_handler(int sig) {
 }
 #endif
 
-int server_init(void)
+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;
@@ -522,6 +492,15 @@ int server_init(void)
        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();
@@ -534,18 +513,81 @@ int server_quit(void)
        return ERROR_OK;
 }
 
-int server_register_commands(command_context_t *context)
+int connection_write(struct connection *connection, const void *data, int len)
 {
-       register_command(context, NULL, "shutdown", handle_shutdown_command,
-                                        COMMAND_ANY, "shut the server down");
+       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);
+       }
+}
 
-       return ERROR_OK;
+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 */
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_shutdown_command)
 {
+       LOG_USER("shutdown command invoked");
+
        shutdown_openocd = 1;
 
-       return ERROR_COMMAND_CLOSE_CONNECTION;
+       return ERROR_OK;
+}
+
+static const struct command_registration server_command_handlers[] = {
+       {
+               .name = "shutdown",
+               .handler = &handle_shutdown_command,
+               .mode = COMMAND_ANY,
+               .help = "shut the server down",
+       },
+       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;
+
+       return register_commands(cmd_ctx, NULL, server_command_handlers);
+}
+
+SERVER_PORT_COMMAND()
+{
+       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_INVALID_ARGUMENTS;
+       }
+       return ERROR_OK;
 }