- add ability for openocd to communicate to gdb using pipes (stdin/stdout).
[fw/openocd] / src / server / server.c
index 6e43cf7cf27f269dbf67af9654ed9f2428a155a3..b5b9a205db137564f96583b4160f4b481e2d9ef1 100644 (file)
@@ -2,6 +2,12 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -37,6 +43,9 @@
 #include <sys/types.h>
 #include <fcntl.h>
 #include <signal.h>
+#ifndef _WIN32
+#include <netinet/tcp.h>
+#endif
 
 service_t *services = NULL;
 
@@ -44,11 +53,15 @@ service_t *services = NULL;
 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)
 {
        unsigned int address_size;
        connection_t *c, **p;
        int retval;
+       int flag=1;
        
        c = malloc(sizeof(connection_t));
        c->fd = -1;
@@ -59,18 +72,44 @@ int add_connection(service_t *service, command_context_t *cmd_ctx)
        c->priv = NULL;
        c->next = NULL;
 
-       address_size = sizeof(c->sin);
-       c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
-                               
-       if ((retval = service->new_connection(c)) == ERROR_OK)
+       if (service->type == CONNECTION_TCP)
        {
-               INFO("accepted '%s' connection from %i", service->name, c->sin.sin_port);
+               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 */
+                               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)
+               {
+                       close_socket(c->fd);
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       free(c);
+                       return retval;
+               }
        }
-       else
+       else if (service->type == CONNECTION_PIPE)
        {
-               close_socket(c->fd);
-               INFO("attempted '%s' connection rejected", service->name);
-               free(c);
+#ifndef _WIN32
+               c->fd = service->fd;
+               
+               /* do not check for new connections again on stdin */
+               service->fd = -1;
+#endif
+               LOG_INFO("accepting '%s' connection from pipe", service->name);
+               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 */
@@ -88,12 +127,13 @@ int remove_connection(service_t *service, connection_t *connection)
        connection_t *c;
        
        /* find connection */
-       while(c = *p)
+       while((c = *p))
        {               
                if (c->fd == connection->fd)
                {       
                        service->connection_closed(c);
-                       close_socket(c->fd);
+                       if (service->type == CONNECTION_TCP)
+                               close_socket(c->fd);
                        command_done(c->cmd_ctx);
                        
                        /* delete connection */
@@ -130,31 +170,67 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
        c->priv = priv;
        c->next = NULL;
        
-       if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+       if (type == CONNECTION_TCP)
        {
-               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 ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+               {
+                       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;
+               setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG,  &segsize, sizeof(int));
+#endif
+               int window_size = 128 * 1024;   
        
-       if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
+               /* 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));
+                       exit(-1);
+               }
+       }
+       else if (type == CONNECTION_PIPE)
        {
-               ERROR("couldn't bind to socket: %s", strerror(errno));
-               exit(-1);
+               /* use stdin */
+               c->fd = STDIN_FILENO;
+               
+#ifdef _WIN32
+               /* for win32 set stdin/stdout to binary mode */
+               if (_setmode(_fileno(stdout), _O_BINARY) < 0)
+                       LOG_WARNING("cannot change stdout mode to binary");
+               if (_setmode(_fileno(stdin), _O_BINARY) < 0)
+                       LOG_WARNING("cannot change stdin mode to binary");
+#else
+               socket_nonblock(c->fd);
+#endif
        }
-       
-       if (listen(c->fd, 1) == -1)
+       else
        {
-               ERROR("couldn't listen on socket: %s", strerror(errno));
-               exit(-1);
+               LOG_ERROR("unknown connection type: %d", type);
+               exit(1);
        }
        
        /* add to the end of linked list */
@@ -166,11 +242,11 @@ int add_service(char *name, enum connection_type type, unsigned short port, int
 
 int remove_service(unsigned short port)
 {
-       service_t **p = services;
+       service_t **p = &services;
        service_t *c;
        
        /* find service */
-       while(c = *p)
+       while((c = *p))
        {               
                if (c->port == port)
                {       
@@ -192,7 +268,7 @@ int remove_service(unsigned short port)
        return ERROR_OK;
 }
 
-int remove_services()
+int remove_services(void)
 {
        service_t *c = services;
 
@@ -219,6 +295,9 @@ int remove_services()
        return ERROR_OK;
 }
 
+extern void openocd_sleep_prelude(void);
+extern void openocd_sleep_postlude(void);
+
 int server_loop(command_context_t *command_context)
 {
        service_t *service;
@@ -233,9 +312,9 @@ int server_loop(command_context_t *command_context)
        
 #ifndef _WIN32
        if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
-               ERROR("couldn't set SIGPIPE to SIG_IGN");
+               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;
@@ -273,12 +352,22 @@ int server_loop(command_context_t *command_context)
                }
                
 #ifndef _WIN32
-               /* add STDIN to read_fds */
-               FD_SET(fileno(stdin), &read_fds);
+#if BUILD_ECOSBOARD == 0
+               if (server_use_pipes == 0)
+               {
+                       /* add STDIN to read_fds */
+                       FD_SET(fileno(stdin), &read_fds);
+               }
+#endif
 #endif
 
-               retval = select(fd_max + 1, &read_fds, NULL, NULL, &tv);
+               openocd_sleep_prelude();
+               kept_alive();
                
+               /* Only while we're sleeping we'll let others run */
+               retval = select(fd_max + 1, &read_fds, NULL, NULL, &tv);
+               openocd_sleep_postlude();
+
                if (retval == -1)
                {
 #ifdef _WIN32
@@ -289,31 +378,32 @@ int server_loop(command_context_t *command_context)
                                FD_ZERO(&read_fds);
                        else
                        {
-                               ERROR("error during select: %s", strerror(errno));
+                               LOG_ERROR("error during select: %s", strerror(errno));
                                exit(-1);
                        }
 #else
 
                        if (errno == EINTR)
-                       {\r
+                       {
                                FD_ZERO(&read_fds);
-                       }\r
+                       }
                        else
                        {
-                               ERROR("error during select: %s", strerror(errno));
+                               LOG_ERROR("error during select: %s", strerror(errno));
                                exit(-1);
                        }
 #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;
-                       FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case!  */\r
+                       FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case!  */
                }
                
                for (service = services; service; service = service->next)
@@ -323,17 +413,20 @@ int server_loop(command_context_t *command_context)
                                && (FD_ISSET(service->fd, &read_fds))) 
                        {
                                if (service->max_connections > 0)
-                               {\r
+                               {
                                        add_connection(service, command_context);
                                }
                                else
                                {
-                                       struct sockaddr_in sin;
-                                       unsigned int address_size = sizeof(sin);
-                                       int tmp_fd;
-                                       tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
-                                       close_socket(tmp_fd);
-                                       INFO("rejected '%s' connection, no more connections allowed", service->name);
+                                       if (service->type != CONNECTION_PIPE)
+                                       {
+                                               struct sockaddr_in sin;
+                                               unsigned int address_size = sizeof(sin);
+                                               int tmp_fd;
+                                               tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
+                                               close_socket(tmp_fd);
+                                       }
+                                       LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
                                }
                        }
                        
@@ -346,11 +439,16 @@ int server_loop(command_context_t *command_context)
                                {
                                        if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
                                        {
-                                               if (service->input(c) != ERROR_OK)
+                                               if ((retval = service->input(c)) != ERROR_OK)
                                                {
                                                        connection_t *next = c->next;
+                                                       if (service->type == CONNECTION_PIPE)
+                                                       {
+                                                               /* if connection uses a pipe then shutdown openocd on error */
+                                                               shutdown_openocd = 1;
+                                                       }
                                                        remove_connection(service, c);
-                                                       INFO("dropped '%s' connection", service->name);
+                                                       LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
                                                        c = next;
                                                        continue;
                                                }
@@ -361,13 +459,19 @@ int server_loop(command_context_t *command_context)
                }
                
 #ifndef _WIN32
-               if (FD_ISSET(fileno(stdin), &read_fds))
+#if BUILD_ECOSBOARD == 0
+               /* check for data on stdin if not using pipes */
+               if (server_use_pipes == 0)
                {
-                       if (getc(stdin) == 'x')
+                       if (FD_ISSET(fileno(stdin), &read_fds))
                        {
-                               shutdown_openocd = 1;
+                               if (getc(stdin) == 'x')
+                               {
+                                       shutdown_openocd = 1;
+                               }
                        }
                }
+#endif
 #else
                MSG msg;
                while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
@@ -384,16 +488,16 @@ int server_loop(command_context_t *command_context)
 #ifdef _WIN32
 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
 {
-    shutdown_openocd = 1;
-    return TRUE;
+       shutdown_openocd = 1;
+       return TRUE;
 }
 
 void sig_handler(int sig) {
-    shutdown_openocd = 1;
+       shutdown_openocd = 1;
 }
 #endif
 
-int server_init()
+int server_init(void)
 {
 #ifdef _WIN32
        WORD wVersionRequested;
@@ -403,7 +507,7 @@ int server_init()
 
        if (WSAStartup(wVersionRequested, &wsaData) != 0)
        {
-               ERROR("Failed to Open Winsock");
+               LOG_ERROR("Failed to Open Winsock");
                exit(-1);
        }
 
@@ -414,12 +518,11 @@ int server_init()
        signal(SIGBREAK, sig_handler);
        signal(SIGABRT, sig_handler);
 #endif
-
        
        return ERROR_OK;
 }
 
-int server_quit()
+int server_quit(void)
 {
        remove_services();
 
@@ -446,5 +549,3 @@ int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char *
 
        return ERROR_COMMAND_CLOSE_CONNECTION;
 }
-
-