Clean up const usage to avoid excessive casting
[openocd.git] / src / server / server.c
index 0aa3383492e85315c9536ad4f574934fb1ec0d38..5e1ae36b1db0d84e2178b392f5b2b4d31f61309e 100644 (file)
-/***************************************************************************\r
- *   Copyright (C) 2005 by Dominic Rath                                    *\r
- *   Dominic.Rath@gmx.de                                                   *\r
- *                                                                         *\r
- *   This program is free software; you can redistribute it and/or modify  *\r
- *   it under the terms of the GNU General Public License as published by  *\r
- *   the Free Software Foundation; either version 2 of the License, or     *\r
- *   (at your option) any later version.                                   *\r
- *                                                                         *\r
- *   This program is distributed in the hope that it will be useful,       *\r
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *\r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *\r
- *   GNU General Public License for more details.                          *\r
- *                                                                         *\r
- *   You should have received a copy of the GNU General Public License     *\r
- *   along with this program; if not, write to the                         *\r
- *   Free Software Foundation, Inc.,                                       *\r
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *\r
- ***************************************************************************/\r
-#ifdef HAVE_CONFIG_H\r
-#include "config.h"\r
-#endif\r
-\r
-#include "replacements.h"\r
-\r
-#include "server.h"\r
-\r
-#include "log.h"\r
-#include "telnet_server.h"\r
-#include "target.h"\r
-\r
-#include <command.h>\r
-#include <string.h>\r
-#include <stdlib.h>\r
-#include <errno.h>\r
-#include <unistd.h>\r
-#include <sys/types.h>\r
-#include <fcntl.h>\r
-#include <signal.h>\r
-\r
-service_t *services = NULL;\r
-\r
-/* shutdown_openocd == 1: exit the main event loop, and quit the debugger */\r
-static int shutdown_openocd = 0;\r
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);\r
-\r
-int add_connection(service_t *service, command_context_t *cmd_ctx)\r
-{\r
-       unsigned int address_size;\r
-       connection_t *c, **p;\r
-       int retval;\r
-       \r
-       c = malloc(sizeof(connection_t));\r
-       c->fd = -1;\r
-       memset(&c->sin, 0, sizeof(c->sin));\r
-       c->cmd_ctx = copy_command_context(cmd_ctx);\r
-       c->service = service;\r
-       c->input_pending = 0;\r
-       c->priv = NULL;\r
-       c->next = NULL;\r
-\r
-       address_size = sizeof(c->sin);\r
-       c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);\r
-                               \r
-       if ((retval = service->new_connection(c)) == ERROR_OK)\r
-       {\r
-               INFO("accepted '%s' connection from %i", service->name, c->sin.sin_port);\r
-       }\r
-       else\r
-       {\r
-               close_socket(c->fd);\r
-               INFO("attempted '%s' connection rejected", service->name);\r
-               free(c);\r
-       }\r
-       \r
-       /* add to the end of linked list */\r
-       for (p = &service->connections; *p; p = &(*p)->next);\r
-       *p = c;\r
-       \r
-       service->max_connections--;\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-int remove_connection(service_t *service, connection_t *connection)\r
-{\r
-       connection_t **p = &service->connections;\r
-       connection_t *c;\r
-       \r
-       /* find connection */\r
-       while(c = *p)\r
-       {               \r
-               if (c->fd == connection->fd)\r
-               {       \r
-                       service->connection_closed(c);\r
-                       close_socket(c->fd);\r
-                       command_done(c->cmd_ctx);\r
-                       \r
-                       /* delete connection */\r
-                       *p = c->next;\r
-                       free(c);\r
-                       \r
-                       service->max_connections++;\r
-                       break;\r
-               }\r
-               \r
-               /* redirect p to next list pointer */\r
-               p = &(*p)->next;                \r
-       }\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-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)\r
-{\r
-       service_t *c, **p;\r
-       int so_reuseaddr_option = 1;\r
-       \r
-       c = malloc(sizeof(service_t));\r
-       \r
-       c->name = strdup(name);\r
-       c->type = type;\r
-       c->port = port;\r
-       c->max_connections = max_connections;\r
-       c->fd = -1;\r
-       c->connections = NULL;\r
-       c->new_connection = new_connection_handler;\r
-       c->input = input_handler;\r
-       c->connection_closed = connection_closed_handler;\r
-       c->priv = priv;\r
-       c->next = NULL;\r
-       \r
-       if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)\r
-       {\r
-               ERROR("error creating socket: %s", strerror(errno));\r
-               exit(-1);\r
-       }\r
-       \r
-       setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));\r
-       \r
-       socket_nonblock(c->fd);\r
-       \r
-       memset(&c->sin, 0, sizeof(c->sin));\r
-       c->sin.sin_family = AF_INET;\r
-       c->sin.sin_addr.s_addr = INADDR_ANY;\r
-       c->sin.sin_port = htons(port);\r
-       \r
-       if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)\r
-       {\r
-               ERROR("couldn't bind to socket: %s", strerror(errno));\r
-               exit(-1);\r
-       }\r
-       \r
-       if (listen(c->fd, 1) == -1)\r
-       {\r
-               ERROR("couldn't listen on socket: %s", strerror(errno));\r
-               exit(-1);\r
-       }\r
-       \r
-       /* add to the end of linked list */\r
-       for (p = &services; *p; p = &(*p)->next);\r
-       *p = c;\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-int remove_service(unsigned short port)\r
-{\r
-       service_t **p = &services;\r
-       service_t *c;\r
-       \r
-       /* find service */\r
-       while(c = *p)\r
-       {               \r
-               if (c->port == port)\r
-               {       \r
-                       if (c->name)\r
-                               free(c->name);\r
-                       \r
-                       if (c->priv)\r
-                               free(c->priv);\r
-                       \r
-                       /* delete service */\r
-                       *p = c->next;\r
-                       free(c);\r
-               }\r
-\r
-               /* redirect p to next list pointer */\r
-               p = &(*p)->next;\r
-       }\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-int remove_services()\r
-{\r
-       service_t *c = services;\r
-\r
-       /* loop service */\r
-       while(c)\r
-       {\r
-               service_t *next = c->next;\r
-\r
-               if (c->name)\r
-                       free(c->name);\r
-\r
-               if (c->priv)\r
-                       free(c->priv);\r
-\r
-               /* delete service */\r
-               free(c);\r
-\r
-               /* remember the last service for unlinking */\r
-               c = next;\r
-       }\r
-\r
-       services = NULL;\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-int server_loop(command_context_t *command_context)\r
-{\r
-       service_t *service;\r
-\r
-       /* used in select() */\r
-       fd_set read_fds;\r
-       struct timeval tv;\r
-       int fd_max;\r
-       \r
-       /* used in accept() */\r
-       int retval;\r
-       \r
-#ifndef _WIN32\r
-       if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)\r
-               ERROR("couldn't set SIGPIPE to SIG_IGN");\r
-#endif\r
-       \r
-       /* do regular tasks after at most 10ms */\r
-       tv.tv_sec = 0;\r
-       tv.tv_usec = 10000;\r
-       \r
-       while(!shutdown_openocd)\r
-       {\r
-               /* monitor sockets for acitvity */\r
-               fd_max = 0;\r
-               FD_ZERO(&read_fds);\r
-\r
-               /* add service and connection fds to read_fds */\r
-               for (service = services; service; service = service->next)\r
-               {\r
-                       if (service->fd != -1)\r
-                       {\r
-                               /* listen for new connections */\r
-                               FD_SET(service->fd, &read_fds);\r
-\r
-                               if (service->fd > fd_max)\r
-                                       fd_max = service->fd;\r
-                       }\r
-                       \r
-                       if (service->connections)\r
-                       {\r
-                               connection_t *c;\r
-                               \r
-                               for (c = service->connections; c; c = c->next)\r
-                               {\r
-                                       /* check for activity on the connection */\r
-                                       FD_SET(c->fd, &read_fds);\r
-                                       if (c->fd > fd_max)\r
-                                               fd_max = c->fd;\r
-                               }\r
-                       }\r
-               }\r
-               \r
-#ifndef _WIN32\r
-               /* add STDIN to read_fds */\r
-               FD_SET(fileno(stdin), &read_fds);\r
-#endif\r
-\r
-               retval = select(fd_max + 1, &read_fds, NULL, NULL, &tv);\r
-               \r
-               if (retval == -1)\r
-               {\r
-#ifdef _WIN32\r
-\r
-                       errno = WSAGetLastError();\r
-\r
-                       if (errno == WSAEINTR)\r
-                               FD_ZERO(&read_fds);\r
-                       else\r
-                       {\r
-                               ERROR("error during select: %s", strerror(errno));\r
-                               exit(-1);\r
-                       }\r
-#else\r
-\r
-                       if (errno == EINTR)\r
-                       {\r
-                               FD_ZERO(&read_fds);\r
-                       }\r
-                       else\r
-                       {\r
-                               ERROR("error during select: %s", strerror(errno));\r
-                               exit(-1);\r
-                       }\r
-#endif\r
-               }\r
-               \r
-               target_call_timer_callbacks();\r
-\r
-               if (retval == 0)\r
-               {\r
-                       /* do regular tasks after at most 100ms */\r
-                       tv.tv_sec = 0;\r
-                       tv.tv_usec = 10000;\r
-                       FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case!  */\r
-               }\r
-               \r
-               for (service = services; service; service = service->next)\r
-               {\r
-                       /* handle new connections on listeners */\r
-                       if ((service->fd != -1) \r
-                               && (FD_ISSET(service->fd, &read_fds))) \r
-                       {\r
-                               if (service->max_connections > 0)\r
-                               {\r
-                                       add_connection(service, command_context);\r
-                               }\r
-                               else\r
-                               {\r
-                                       struct sockaddr_in sin;\r
-                                       unsigned int address_size = sizeof(sin);\r
-                                       int tmp_fd;\r
-                                       tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);\r
-                                       close_socket(tmp_fd);\r
-                                       INFO("rejected '%s' connection, no more connections allowed", service->name);\r
-                               }\r
-                       }\r
-                       \r
-                       /* handle activity on connections */\r
-                       if (service->connections)\r
-                       {\r
-                               connection_t *c;\r
-                               \r
-                               for (c = service->connections; c;)\r
-                               {\r
-                                       if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)\r
-                                       {\r
-                                               if (service->input(c) != ERROR_OK)\r
-                                               {\r
-                                                       connection_t *next = c->next;\r
-                                                       remove_connection(service, c);\r
-                                                       INFO("dropped '%s' connection", service->name);\r
-                                                       c = next;\r
-                                                       continue;\r
-                                               }\r
-                                       }\r
-                                       c = c->next;\r
-                               }\r
-                       }\r
-               }\r
-               \r
-#ifndef _WIN32\r
-               if (FD_ISSET(fileno(stdin), &read_fds))\r
-               {\r
-                       if (getc(stdin) == 'x')\r
-                       {\r
-                               shutdown_openocd = 1;\r
-                       }\r
-               }\r
-#else\r
-               MSG msg;\r
-               while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))\r
-               {\r
-                       if (msg.message == WM_QUIT)\r
-                               shutdown_openocd = 1;\r
-               }\r
-#endif\r
-       }\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-#ifdef _WIN32\r
-BOOL WINAPI ControlHandler(DWORD dwCtrlType)\r
-{\r
-    shutdown_openocd = 1;\r
-    return TRUE;\r
-}\r
-\r
-void sig_handler(int sig) {\r
-    shutdown_openocd = 1;\r
-}\r
-#endif\r
-\r
-int server_init()\r
-{\r
-#ifdef _WIN32\r
-       WORD wVersionRequested;\r
-       WSADATA wsaData;\r
-\r
-       wVersionRequested = MAKEWORD( 2, 2 );\r
-\r
-       if (WSAStartup(wVersionRequested, &wsaData) != 0)\r
-       {\r
-               ERROR("Failed to Open Winsock");\r
-               exit(-1);\r
-       }\r
-\r
-       SetConsoleCtrlHandler( ControlHandler, TRUE );\r
-\r
-       signal(SIGINT, sig_handler);\r
-       signal(SIGTERM, sig_handler);\r
-       signal(SIGBREAK, sig_handler);\r
-       signal(SIGABRT, sig_handler);\r
-#endif\r
-\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-int server_quit()\r
-{\r
-       remove_services();\r
-\r
-#ifdef _WIN32\r
-       WSACleanup();\r
-       SetConsoleCtrlHandler( ControlHandler, FALSE );\r
-#endif\r
-\r
-       return ERROR_OK;\r
-}\r
-\r
-int server_register_commands(command_context_t *context)\r
-{\r
-       register_command(context, NULL, "shutdown", handle_shutdown_command,\r
-                                        COMMAND_ANY, "shut the server down");\r
-       \r
-       return ERROR_OK;\r
-}\r
-\r
-/* tell the server we want to shut down */\r
-int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)\r
-{\r
-       shutdown_openocd = 1;\r
-\r
-       return ERROR_COMMAND_CLOSE_CONNECTION;\r
-}\r
-\r
-\r
+/***************************************************************************
+ *   Copyright (C) 2005 by Dominic Rath                                    *
+ *   Dominic.Rath@gmx.de                                                   *
+ *                                                                         *
+ *   Copyright (C) 2007-2010 Ã˜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     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ ***************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "server.h"
+#include <target/target.h>
+#include <target/target_request.h>
+#include "openocd.h"
+#include "tcl_server.h"
+#include "telnet_server.h"
+
+#include <signal.h>
+
+#ifndef _WIN32
+#include <netinet/tcp.h>
+#endif
+
+static struct service *services;
+
+/* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
+static int shutdown_openocd;
+
+static int add_connection(struct service *service, struct command_context *cmd_ctx)
+{
+       socklen_t address_size;
+       struct connection *c, **p;
+       int retval;
+       int flag = 1;
+
+       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;
+       c->input_pending = 0;
+       c->priv = NULL;
+       c->next = NULL;
+
+       if (service->type == CONNECTION_TCP) {
+               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.
+                *
+                * 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 %s", service->name, service->port);
+               retval = service->new_connection(c);
+               if (retval != ERROR_OK) {
+                       close_socket(c->fd);
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       command_done(c->cmd_ctx);
+                       free(c);
+                       return retval;
+               }
+       } 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;
+
+               LOG_INFO("accepting '%s' connection from pipe", service->name);
+               retval = service->new_connection(c);
+               if (retval != ERROR_OK) {
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       command_done(c->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);
+               retval = service->new_connection(c);
+               if (retval != ERROR_OK) {
+                       LOG_ERROR("attempted '%s' connection rejected", service->name);
+                       command_done(c->cmd_ctx);
+                       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;
+}
+
+static int remove_connection(struct service *service, struct connection *connection)
+{
+       struct connection **p = &service->connections;
+       struct connection *c;
+
+       /* find connection */
+       while ((c = *p)) {
+               if (c->fd == connection->fd) {
+                       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 */
+                       *p = c->next;
+                       free(c);
+
+                       service->max_connections++;
+                       break;
+               }
+
+               /* redirect p to next list pointer */
+               p = &(*p)->next;
+       }
+
+       return ERROR_OK;
+}
+
+/* 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;
+
+       c = malloc(sizeof(struct service));
+
+       c->name = strdup(name);
+       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;
+       c->input = input_handler;
+       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 (c->type == CONNECTION_TCP) {
+               c->max_connections = max_connections;
+
+               c->fd = socket(AF_INET, SOCK_STREAM, 0);
+               if (c->fd == -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(c->portnumber);
+
+               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);
+               }
+       } else if (c->type == CONNECTION_STDINOUT) {
+               c->fd = fileno(stdin);
+
+#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
+       } else if (c->type == CONNECTION_PIPE) {
+#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 */
+       for (p = &services; *p; p = &(*p)->next)
+               ;
+       *p = c;
+
+       return ERROR_OK;
+}
+
+static int remove_services(void)
+{
+       struct service *c = services;
+
+       /* loop service */
+       while (c) {
+               struct service *next = c->next;
+
+               if (c->name)
+                       free(c->name);
+
+               if (c->type == CONNECTION_PIPE) {
+                       if (c->fd != -1)
+                               close(c->fd);
+               }
+               if (c->port)
+                       free(c->port);
+
+               if (c->priv)
+                       free(c->priv);
+
+               /* delete service */
+               free(c);
+
+               /* remember the last service for unlinking */
+               c = next;
+       }
+
+       services = NULL;
+
+       return ERROR_OK;
+}
+
+int server_loop(struct command_context *command_context)
+{
+       struct service *service;
+
+       bool poll_ok = true;
+
+       /* used in select() */
+       fd_set read_fds;
+       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");
+#endif
+
+       while (!shutdown_openocd) {
+               /* monitor sockets for activity */
+               fd_max = 0;
+               FD_ZERO(&read_fds);
+
+               /* add service and connection fds to read_fds */
+               for (service = services; service; service = service->next) {
+                       if (service->fd != -1) {
+                               /* listen for new connections */
+                               FD_SET(service->fd, &read_fds);
+
+                               if (service->fd > fd_max)
+                                       fd_max = service->fd;
+                       }
+
+                       if (service->connections) {
+                               struct connection *c;
+
+                               for (c = service->connections; c; c = c->next) {
+                                       /* check for activity on the connection */
+                                       FD_SET(c->fd, &read_fds);
+                                       if (c->fd > fd_max)
+                                               fd_max = c->fd;
+                               }
+                       }
+               }
+
+               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 {
+                       /* 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();
+               }
+
+               if (retval == -1) {
+#ifdef _WIN32
+
+                       errno = WSAGetLastError();
+
+                       if (errno == WSAEINTR)
+                               FD_ZERO(&read_fds);
+                       else {
+                               LOG_ERROR("error during select: %s", strerror(errno));
+                               exit(-1);
+                       }
+#else
+
+                       if (errno == EINTR)
+                               FD_ZERO(&read_fds);
+                       else {
+                               LOG_ERROR("error during select: %s", strerror(errno));
+                               exit(-1);
+                       }
+#endif
+               }
+
+               if (retval == 0) {
+                       /* 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 */
+                       if ((service->fd != -1)
+                           && (FD_ISSET(service->fd, &read_fds))) {
+                               if (service->max_connections > 0)
+                                       add_connection(service, command_context);
+                               else {
+                                       if (service->type == CONNECTION_TCP) {
+                                               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) {
+                               struct connection *c;
+
+                               for (c = service->connections; c; ) {
+                                       if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending) {
+                                               retval = service->input(c);
+                                               if (retval != ERROR_OK) {
+                                                       struct connection *next = c->next;
+                                                       if (service->type == CONNECTION_PIPE ||
+                                                                       service->type == CONNECTION_STDINOUT) {
+                                                               /* if connection uses a pipe then
+                                                                * shutdown openocd on error */
+                                                               shutdown_openocd = 1;
+                                                       }
+                                                       remove_connection(service, c);
+                                                       LOG_INFO("dropped '%s' connection",
+                                                               service->name);
+                                                       c = next;
+                                                       continue;
+                                               }
+                                       }
+                                       c = c->next;
+                               }
+                       }
+               }
+
+#ifdef _WIN32
+               MSG msg;
+               while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
+                       if (msg.message == WM_QUIT)
+                               shutdown_openocd = 1;
+               }
+#endif
+       }
+
+       return ERROR_OK;
+}
+
+#ifdef _WIN32
+BOOL WINAPI ControlHandler(DWORD dwCtrlType)
+{
+       shutdown_openocd = 1;
+       return TRUE;
+}
+
+void sig_handler(int sig)
+{
+       shutdown_openocd = 1;
+}
+#endif
+
+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;
+
+       wVersionRequested = MAKEWORD(2, 2);
+
+       if (WSAStartup(wVersionRequested, &wsaData) != 0) {
+               LOG_ERROR("Failed to Open Winsock");
+               exit(-1);
+       }
+
+       /* register ctrl-c handler */
+       SetConsoleCtrlHandler(ControlHandler, TRUE);
+
+       signal(SIGINT, sig_handler);
+       signal(SIGTERM, sig_handler);
+       signal(SIGBREAK, sig_handler);
+       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;
+
+       return telnet_init("Open On-Chip Debugger");
+}
+
+int server_quit(void)
+{
+       remove_services();
+
+#ifdef _WIN32
+       WSACleanup();
+       SetConsoleCtrlHandler(ControlHandler, FALSE);
+#endif
+
+       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_OK;
+}
+
+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
+};
+
+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);
+}
+
+COMMAND_HELPER(server_port_command, unsigned short *out)
+{
+       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_COMMAND_SYNTAX_ERROR;
+       }
+       return ERROR_OK;
+}
+
+COMMAND_HELPER(server_pipe_command, char **out)
+{
+       switch (CMD_ARGC) {
+               case 0:
+                       command_print(CMD_CTX, "%s", *out);
+                       break;
+               case 1:
+               {
+                       if (CMD_CTX->mode == COMMAND_EXEC) {
+                               LOG_WARNING("unable to change server port after init");
+                               return ERROR_COMMAND_ARGUMENT_INVALID;
+                       }
+                       free(*out);
+                       *out = strdup(CMD_ARGV[0]);
+                       break;
+               }
+               default:
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+       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)