cmd: add missing usage vars
[fw/openocd] / src / server / server.c
index 256c590da082b1174cefc26a0813fbbfe3c18392..7a3c890d082496bcad91d2905f8f9a5da2da3b43 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                                  *
@@ -28,7 +28,8 @@
 #endif
 
 #include "server.h"
-#include "target.h"
+#include <target/target.h>
+#include <target/target_request.h>
 #include "openocd.h"
 #include "tcl_server.h"
 #include "telnet_server.h"
 #endif
 
 
-struct service *services = NULL;
+static struct service *services = NULL;
 
 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
 static int shutdown_openocd = 0;
 
-/* set when using pipes rather than tcp */
-int server_use_pipes = 0;
-
-int add_connection(struct service *service, struct command_context *cmd_ctx)
+static int add_connection(struct service *service, struct command_context *cmd_ctx)
 {
        socklen_t address_size;
        struct connection *c, **p;
@@ -57,6 +55,7 @@ int add_connection(struct service *service, struct command_context *cmd_ctx)
 
        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;
@@ -69,16 +68,20 @@ int add_connection(struct service *service, struct command_context *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. */
-               retval = setsockopt(c->fd,      /* socket affected */
+                * does not have a sliding window protocol. 
+                *
+                * Ignore errors from this fn as it probably just means less performance
+                */
+               setsockopt(c->fd,       /* socket affected */
                                IPPROTO_TCP,            /* set option at TCP level */
                                TCP_NODELAY,            /* name of option */
                                (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 %s", service->name, service->port);
                if ((retval = service->new_connection(c)) != ERROR_OK)
                {
                        close_socket(c->fd);
@@ -86,10 +89,15 @@ int add_connection(struct service *service, struct command_context *cmd_ctx)
                        free(c);
                        return retval;
                }
-       }
-       else if (service->type == CONNECTION_PIPE)
+       } else if (service->type == CONNECTION_STDINOUT)
        {
                c->fd = service->fd;
+               c->fd_out = fileno(stdout);
+
+#ifdef _WIN32
+               /* we are using stdin/out so ignore ctrl-c under windoze */
+               SetConsoleCtrlHandler(NULL, TRUE);
+#endif
 
                /* do not check for new connections again on stdin */
                service->fd = -1;
@@ -101,6 +109,28 @@ int add_connection(struct service *service, struct command_context *cmd_ctx)
                        free(c);
                        return retval;
                }
+       } else if (service->type == CONNECTION_PIPE)
+       {
+               c->fd = service->fd;
+               /* do not check for new connections again on stdin */
+               service->fd = -1;
+
+               char * out_file = alloc_printf("%so", service->port);
+               c->fd_out = open(out_file, O_WRONLY);
+               free(out_file);
+               if (c->fd_out == -1)
+               {
+                       LOG_ERROR("could not open %s", service->port);
+                       exit(1);
+               }
+
+               LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port);
+               if ((retval = service->new_connection(c)) != ERROR_OK)
+               {
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       free(c);
+                       return retval;
+               }
        }
 
        /* add to the end of linked list */
@@ -112,7 +142,7 @@ int add_connection(struct service *service, struct command_context *cmd_ctx)
        return ERROR_OK;
 }
 
-int remove_connection(struct service *service, struct connection *connection)
+static int remove_connection(struct service *service, struct connection *connection)
 {
        struct connection **p = &service->connections;
        struct connection *c;
@@ -124,7 +154,14 @@ int remove_connection(struct service *service, struct connection *connection)
                {
                        service->connection_closed(c);
                        if (service->type == CONNECTION_TCP)
+                       {
                                close_socket(c->fd);
+                       } else if (service->type == CONNECTION_PIPE)
+                       {
+                               /* The service will listen to the pipe again */
+                               c->service->fd = c->fd;
+                       }
+
                        command_done(c->cmd_ctx);
 
                        /* delete connection */
@@ -142,7 +179,8 @@ int remove_connection(struct service *service, struct connection *connection)
        return ERROR_OK;
 }
 
-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)
+/* FIX! make service return error instead of invoking exit() */
+int add_service(char *name, const char *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)
 {
        struct service *c, **p;
        int so_reuseaddr_option = 1;
@@ -150,9 +188,8 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        c = malloc(sizeof(struct service));
 
        c->name = strdup(name);
-       c->type = type;
-       c->port = port;
-       c->max_connections = max_connections;
+       c->port = strdup(port);
+       c->max_connections = 1; /* Only TCP/IP ports can support more than one connection */
        c->fd = -1;
        c->connections = NULL;
        c->new_connection = new_connection_handler;
@@ -160,9 +197,28 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        c->connection_closed = connection_closed_handler;
        c->priv = priv;
        c->next = NULL;
+       long portnumber;
+       if (strcmp(c->port, "pipe") == 0)
+       {
+               c->type = CONNECTION_STDINOUT;
+       } else
+       {
+               char *end;
+               portnumber = strtol(c->port, &end, 0);
+               if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK))
+               {
+                       c->portnumber = portnumber;
+                       c->type = CONNECTION_TCP;
+               } else
+               {
+                       c->type = CONNECTION_PIPE;
+               }
+       }
 
-       if (type == CONNECTION_TCP)
+       if (c->type == CONNECTION_TCP)
        {
+               c->max_connections = max_connections;
+
                if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
                {
                        LOG_ERROR("error creating socket: %s", strerror(errno));
@@ -176,7 +232,7 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
                memset(&c->sin, 0, sizeof(c->sin));
                c->sin.sin_family = AF_INET;
                c->sin.sin_addr.s_addr = INADDR_ANY;
-               c->sin.sin_port = htons(port);
+               c->sin.sin_port = htons(c->portnumber);
 
                if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
                {
@@ -203,10 +259,9 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
                        exit(-1);
                }
        }
-       else if (type == CONNECTION_PIPE)
+       else if (c->type == CONNECTION_STDINOUT)
        {
-               /* use stdin */
-               c->fd = STDIN_FILENO;
+               c->fd = fileno(stdin);
 
 #ifdef _WIN32
                /* for win32 set stdin/stdout to binary mode */
@@ -220,10 +275,22 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
                socket_nonblock(c->fd);
 #endif
        }
-       else
+       else if (c->type == CONNECTION_PIPE)
        {
-               LOG_ERROR("unknown connection type: %d", type);
+#ifdef _WIN32
+               /* we currenty do not support named pipes under win32
+                * so exit openocd for now */
+               LOG_ERROR("Named pipes currently not supported under this os");
                exit(1);
+#else
+               /* Pipe we're reading from */
+               c->fd = open(c->port, O_RDONLY | O_NONBLOCK);
+               if (c->fd == -1)
+               {
+                       LOG_ERROR("could not open %s", c->port);
+                       exit(1);
+               }
+#endif
        }
 
        /* add to the end of linked list */
@@ -233,35 +300,7 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        return ERROR_OK;
 }
 
-int remove_service(unsigned short port)
-{
-       struct service **p = &services;
-       struct service *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)
 {
        struct service *c = services;
 
@@ -271,7 +310,15 @@ int remove_services(void)
                struct service *next = c->next;
 
                if (c->name)
-                       free(c->name);
+                       free((void *)c->name);
+
+               if (c->type == CONNECTION_PIPE)
+               {
+                       if (c->fd != -1)
+                               close(c->fd);
+               }
+               if (c->port)
+                       free((void *)c->port);
 
                if (c->priv)
                        free(c->priv);
@@ -292,9 +339,10 @@ int server_loop(struct command_context *command_context)
 {
        struct service *service;
 
+       bool poll_ok = true;
+
        /* used in select() */
        fd_set read_fds;
-       struct timeval tv;
        int fd_max;
 
        /* used in accept() */
@@ -305,10 +353,6 @@ int server_loop(struct command_context *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 activity */
@@ -341,22 +385,24 @@ int server_loop(struct command_context *command_context)
                        }
                }
 
-#ifndef _WIN32
-#if BUILD_ECOSBOARD == 0
-               if (server_use_pipes == 0)
+               struct timeval tv;
+               tv.tv_sec = 0;
+               if (poll_ok)
                {
-                       /* add STDIN to read_fds */
-                       FD_SET(fileno(stdin), &read_fds);
+                       /* 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
+               {
+                       /* 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)
                {
@@ -385,17 +431,29 @@ int server_loop(struct command_context *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;
                }
 
+               /* This is a simple back-off algorithm where we immediately
+                * re-poll if we did something this time around.
+                *
+                * This greatly improves performance of DCC.
+                */
+               poll_ok = poll_ok || target_got_message();
+
                for (service = services; service; service = service->next)
                {
                        /* handle new connections on listeners */
@@ -408,7 +466,7 @@ int server_loop(struct command_context *command_context)
                                }
                                else
                                {
-                                       if (service->type != CONNECTION_PIPE)
+                                       if (service->type == CONNECTION_TCP)
                                        {
                                                struct sockaddr_in sin;
                                                socklen_t address_size = sizeof(sin);
@@ -429,7 +487,8 @@ int server_loop(struct command_context *command_context)
                                {
                                        if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
                                        {
-                                               if ((retval = service->input(c)) != ERROR_OK)
+                                               retval = service->input(c);
+                                               if (retval != ERROR_OK)
                                                {
                                                        struct connection *next = c->next;
                                                        if (service->type == CONNECTION_PIPE)
@@ -438,7 +497,7 @@ int server_loop(struct command_context *command_context)
                                                                shutdown_openocd = 1;
                                                        }
                                                        remove_connection(service, c);
-                                                       LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
+                                                       LOG_INFO("dropped '%s' connection", service->name);
                                                        c = next;
                                                        continue;
                                                }
@@ -448,21 +507,7 @@ int server_loop(struct command_context *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))
                {
@@ -487,8 +532,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;
@@ -501,16 +550,8 @@ int server_init(void)
                exit(-1);
        }
 
-       if (server_use_pipes == 0)
-       {
-               /* register ctrl-c handler */
-               SetConsoleCtrlHandler(ControlHandler, TRUE);
-       }
-       else
-       {
-               /* we are using pipes so ignore ctrl-c */
-               SetConsoleCtrlHandler(NULL, TRUE);
-       }
+       /* register ctrl-c handler */
+       SetConsoleCtrlHandler(ControlHandler, TRUE);
 
        signal(SIGINT, sig_handler);
        signal(SIGTERM, sig_handler);
@@ -518,6 +559,11 @@ int server_init(void)
        signal(SIGABRT, sig_handler);
 #endif
 
+       return ERROR_OK;
+}
+
+int server_init(struct command_context *cmd_ctx)
+{
        int ret = tcl_init();
        if (ERROR_OK != ret)
                return ret;
@@ -537,12 +583,41 @@ int server_quit(void)
        return ERROR_OK;
 }
 
+int connection_write(struct connection *connection, const void *data, int len)
+{
+       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);
+       }
+}
+
+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 */
 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[] = {
@@ -550,6 +625,7 @@ static const struct command_registration server_command_handlers[] = {
                .name = "shutdown",
                .handler = &handle_shutdown_command,
                .mode = COMMAND_ANY,
+               .usage = "",
                .help = "shut the server down",
        },
        COMMAND_REGISTRATION_DONE
@@ -582,7 +658,27 @@ SERVER_PORT_COMMAND()
                break;
        }
        default:
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
        return ERROR_OK;
 }
+
+SERVER_PIPE_COMMAND()
+{
+       switch (CMD_ARGC) {
+       case 0:
+               command_print(CMD_CTX, "%s", *out);
+               break;
+       case 1:
+       {
+               const char * t = strdup(CMD_ARGV[0]);
+               free((void *)*out);
+               *out = t;
+               break;
+       }
+       default:
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+       return ERROR_OK;
+}
+