add openocd.h for top-level declarations
[openocd.git] / src / server / server.c
index b0ad834ab6b15b79842455f008100a9c8db15e2f..92292eb59b7ee605727e16211d224c88833210f8 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     *
 #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>
 
-service_t *services = NULL;
+#ifndef _WIN32
+#include <netinet/tcp.h>
+#endif
+
+
+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);
 
-int add_connection(service_t *service, command_context_t *cmd_ctx)
+/* set when using pipes rather than tcp */
+int server_use_pipes = 0;
+
+int add_connection(struct service *service, struct command_context *cmd_ctx)
 {
-       unsigned int address_size;
-       connection_t *c, **p;
+       socklen_t address_size;
+       struct connection *c, **p;
        int retval;
-       
-       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);
@@ -59,65 +62,91 @@ 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);
+               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)
+               {
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       free(c);
+                       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);
-                       close_socket(c->fd);
+                       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;
@@ -129,57 +158,95 @@ 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 ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+
+       if (type == CONNECTION_TCP)
        {
-               ERROR("error creating socket: %s", strerror(errno));
-               exit(-1);
+               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;
+
+               /* 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);
+               }
        }
-       
-       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)
+       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");
+               if (_setmode(_fileno(stderr), _O_BINARY) < 0)
+                       LOG_WARNING("cannot change stderr 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 */
        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);
@@ -188,18 +255,18 @@ int remove_service(unsigned short port)
                /* redirect p to next list pointer */
                p = &(*p)->next;
        }
-       
+
        return ERROR_OK;
 }
 
-int remove_services()
+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);
@@ -215,32 +282,32 @@ int remove_services()
        }
 
        services = NULL;
-       
+
        return ERROR_OK;
 }
 
-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)
-               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;
-       
-       while(!shutdown_openocd)
+
+       while (!shutdown_openocd)
        {
                /* monitor sockets for acitvity */
                fd_max = 0;
@@ -257,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 */
@@ -271,13 +338,25 @@ 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
+
+               openocd_sleep_prelude();
+               kept_alive();
 
-               if ((retval = select(fd_max + 1, &read_fds, NULL, NULL, &tv)) == -1)
+               /* 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)
                {
 #ifdef _WIN32
 
@@ -287,63 +366,77 @@ 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)
+                       {
                                FD_ZERO(&read_fds);
+                       }
                        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!  */
                }
-               
+
                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)
+                               {
                                        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;
+                                               socklen_t 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);
                                }
                        }
-                       
+
                        /* 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 (service->input(c) != ERROR_OK)
+                                               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 */
+                                                               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;
                                                }
@@ -352,15 +445,21 @@ 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))
@@ -370,37 +469,46 @@ int server_loop(command_context_t *command_context)
                }
 #endif
        }
-       
+
        return ERROR_OK;
 }
 
 #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;
        WSADATA wsaData;
 
-       wVersionRequested = MAKEWORD( 2, 2 );
+       wVersionRequested = MAKEWORD(2, 2);
 
        if (WSAStartup(wVersionRequested, &wsaData) != 0)
        {
-               ERROR("Failed to Open Winsock");
+               LOG_ERROR("Failed to Open Winsock");
                exit(-1);
        }
 
-       SetConsoleCtrlHandler( ControlHandler, TRUE );
+       if (server_use_pipes == 0)
+       {
+               /* register ctrl-c handler */
+               SetConsoleCtrlHandler(ControlHandler, TRUE);
+       }
+       else
+       {
+               /* we are using pipes so ignore ctrl-c */
+               SetConsoleCtrlHandler(NULL, TRUE);
+       }
 
        signal(SIGINT, sig_handler);
        signal(SIGTERM, sig_handler);
@@ -408,36 +516,54 @@ int server_init()
        signal(SIGABRT, sig_handler);
 #endif
 
-       
        return ERROR_OK;
 }
 
-int server_quit()
+int server_quit(void)
 {
        remove_services();
 
 #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;
 }
 
+int server_register_commands(struct command_context *context)
+{
+       register_command(context, NULL, "shutdown",
+                       handle_shutdown_command, COMMAND_ANY,
+                       "shut the server down");
+
+       return ERROR_OK;
+}
 
+
+SERVER_PORT_COMMAND()
+{
+       switch (argc) {
+       case 0:
+               command_print(cmd_ctx, "%d", *out);
+               break;
+       case 1:
+       {
+               uint16_t port;
+               COMMAND_PARSE_NUMBER(u16, args[0], port);
+               *out = port;
+               break;
+       }
+       default:
+               return ERROR_INVALID_ARGUMENTS;
+       }
+       return ERROR_OK;
+}

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)