fix typos in source files
[fw/openocd] / src / server / server.c
index 22e01c61eb004df87ff49cf8b122eaf02412fb1a..3ba433e880ae8636e575a356eb1cb50a95922d61 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                                  *
 #include "config.h"
 #endif
 
-#include "replacements.h"
-
 #include "server.h"
-
-#include "log.h"
-#include "telnet_server.h"
 #include "target.h"
+#include "openocd.h"
 
-#include <command.h>
-#include <string.h>
-#include <stdlib.h>
-#include <errno.h>
-#include <unistd.h>
-#include <sys/types.h>
-#include <fcntl.h>
 #include <signal.h>
+
 #ifndef _WIN32
 #include <netinet/tcp.h>
 #endif
 
-service_t *services = NULL;
+
+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)
+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));
+       int flag = 1;
+
+       c = malloc(sizeof(struct connection));
        c->fd = -1;
        memset(&c->sin, 0, sizeof(c->sin));
        c->cmd_ctx = copy_command_context(cmd_ctx);
@@ -75,17 +65,17 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
        if (service->type == CONNECTION_TCP)
        {
                address_size = sizeof(c->sin);
-               
+
                c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
-               
+
                /* This increases performance dramatically for e.g. GDB load which
                 * does not have a sliding window protocol. */
-               retval=setsockopt(c->fd,        /* socket affected */
+               retval = 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);
                if ((retval = service->new_connection(c)) != ERROR_OK)
                {
@@ -98,10 +88,10 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
        else if (service->type == CONNECTION_PIPE)
        {
                c->fd = service->fd;
-               
+
                /* do not check for new connections again on stdin */
                service->fd = -1;
-               
+
                LOG_INFO("accepting '%s' connection from pipe", service->name);
                if ((retval = service->new_connection(c)) != ERROR_OK)
                {
@@ -110,53 +100,53 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
                        return retval;
                }
        }
-       
+
        /* add to the end of linked list */
        for (p = &service->connections; *p; p = &(*p)->next);
        *p = c;
-       
+
        service->max_connections--;
-       
+
        return ERROR_OK;
 }
 
-int remove_connection(service_t *service, connection_t *connection)
+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))
-       {               
+       while ((c = *p))
+       {
                if (c->fd == connection->fd)
-               {       
+               {
                        service->connection_closed(c);
                        if (service->type == CONNECTION_TCP)
                                close_socket(c->fd);
                        command_done(c->cmd_ctx);
-                       
+
                        /* delete connection */
                        *p = c->next;
                        free(c);
-                       
+
                        service->max_connections++;
                        break;
                }
-               
+
                /* redirect p to next list pointer */
-               p = &(*p)->next;                
+               p = &(*p)->next;
        }
-       
+
        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)
 {
-       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;
        c->port = port;
@@ -168,7 +158,7 @@ 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;
-       
+
        if (type == CONNECTION_TCP)
        {
                if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
@@ -176,35 +166,35 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
                        LOG_ERROR("error creating socket: %s", strerror(errno));
                        exit(-1);
                }
-               
+
                setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
-               
+
                socket_nonblock(c->fd);
-               
+
                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);
-               
+
                if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
                {
                        LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
                        exit(-1);
                }
-               
+
 #ifndef _WIN32
-               int segsize=65536;
+               int segsize = 65536;
                setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG,  &segsize, sizeof(int));
 #endif
-               int window_size = 128 * 1024;   
-       
+               int window_size = 128 * 1024;
+
                /* These setsockopt()s must happen before the listen() */
-               
+
                setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
                        (char *)&window_size, sizeof(window_size));
                setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
                        (char *)&window_size, sizeof(window_size));
-               
+
                if (listen(c->fd, 1) == -1)
                {
                        LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
@@ -215,7 +205,7 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        {
                /* use stdin */
                c->fd = STDIN_FILENO;
-               
+
 #ifdef _WIN32
                /* for win32 set stdin/stdout to binary mode */
                if (_setmode(_fileno(stdout), _O_BINARY) < 0)
@@ -233,30 +223,30 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
                LOG_ERROR("unknown connection type: %d", type);
                exit(1);
        }
-       
+
        /* add to the end of linked list */
        for (p = &services; *p; p = &(*p)->next);
        *p = c;
-       
+
        return ERROR_OK;
 }
 
 int remove_service(unsigned short port)
 {
-       service_t **p = &services;
-       service_t *c;
-       
+       struct service **p = &services;
+       struct service *c;
+
        /* find service */
-       while((c = *p))
-       {               
+       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);
@@ -265,18 +255,18 @@ int remove_service(unsigned short port)
                /* redirect p to next list pointer */
                p = &(*p)->next;
        }
-       
+
        return ERROR_OK;
 }
 
 int remove_services(void)
 {
-       service_t *c = services;
+       struct service *c = services;
 
        /* loop service */
-       while(c)
+       while (c)
        {
-               service_t *next = c->next;
+               struct service *next = c->next;
 
                if (c->name)
                        free(c->name);
@@ -292,25 +282,22 @@ int remove_services(void)
        }
 
        services = NULL;
-       
+
        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;
 
        /* used in select() */
        fd_set read_fds;
        struct timeval tv;
        int fd_max;
-       
+
        /* used in accept() */
        int retval;
-       
+
 #ifndef _WIN32
        if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
                LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
@@ -319,10 +306,10 @@ int server_loop(command_context_t *command_context)
        /* do regular tasks after at most 10ms */
        tv.tv_sec = 0;
        tv.tv_usec = 10000;
-       
-       while(!shutdown_openocd)
+
+       while (!shutdown_openocd)
        {
-               /* monitor sockets for acitvity */
+               /* monitor sockets for activity */
                fd_max = 0;
                FD_ZERO(&read_fds);
 
@@ -337,11 +324,11 @@ int server_loop(command_context_t *command_context)
                                if (service->fd > fd_max)
                                        fd_max = service->fd;
                        }
-                       
+
                        if (service->connections)
                        {
-                               connection_t *c;
-                               
+                               struct connection *c;
+
                                for (c = service->connections; c; c = c->next)
                                {
                                        /* check for activity on the connection */
@@ -351,7 +338,7 @@ int server_loop(command_context_t *command_context)
                                }
                        }
                }
-               
+
 #ifndef _WIN32
 #if BUILD_ECOSBOARD == 0
                if (server_use_pipes == 0)
@@ -364,7 +351,7 @@ int server_loop(command_context_t *command_context)
 
                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();
@@ -395,7 +382,7 @@ int server_loop(command_context_t *command_context)
                        }
 #endif
                }
-               
+
                target_call_timer_callbacks();
                process_jim_events ();
 
@@ -406,12 +393,12 @@ int server_loop(command_context_t *command_context)
                        tv.tv_usec = 10000;
                        FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case!  */
                }
-               
+
                for (service = services; service; service = service->next)
                {
                        /* handle new connections on listeners */
-                       if ((service->fd != -1) 
-                               && (FD_ISSET(service->fd, &read_fds))) 
+                       if ((service->fd != -1)
+                               && (FD_ISSET(service->fd, &read_fds)))
                        {
                                if (service->max_connections > 0)
                                {
@@ -430,19 +417,19 @@ int server_loop(command_context_t *command_context)
                                        LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
                                }
                        }
-                       
+
                        /* handle activity on connections */
                        if (service->connections)
                        {
-                               connection_t *c;
-                               
+                               struct connection *c;
+
                                for (c = service->connections; c;)
                                {
                                        if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
                                        {
                                                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 */
@@ -458,7 +445,7 @@ int server_loop(command_context_t *command_context)
                                }
                        }
                }
-               
+
 #ifndef _WIN32
 #if BUILD_ECOSBOARD == 0
                /* check for data on stdin if not using pipes */
@@ -482,7 +469,7 @@ int server_loop(command_context_t *command_context)
                }
 #endif
        }
-       
+
        return ERROR_OK;
 }
 
@@ -528,7 +515,7 @@ int server_init(void)
        signal(SIGBREAK, sig_handler);
        signal(SIGABRT, sig_handler);
 #endif
-       
+
        return ERROR_OK;
 }
 
@@ -538,24 +525,50 @@ int server_quit(void)
 
 #ifdef _WIN32
        WSACleanup();
-       SetConsoleCtrlHandler( ControlHandler, FALSE );
+       SetConsoleCtrlHandler(ControlHandler, FALSE);
 #endif
 
        return ERROR_OK;
 }
 
-int server_register_commands(command_context_t *context)
-{
-       register_command(context, NULL, "shutdown", handle_shutdown_command,
-                                        COMMAND_ANY, "shut the server down");
-       
-       return ERROR_OK;
-}
-
 /* 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)
 {
        shutdown_openocd = 1;
 
        return ERROR_COMMAND_CLOSE_CONNECTION;
 }
+
+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)
+{
+       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;
+}