X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fserver%2Fserver.c;h=8da82ec88969ba038434763008be7e1bf339804e;hp=0f977a76c81515ab44ad348b99f296205b2c1728;hb=0466ee7e4a54d1415dea9a8fbe9b361b04895db5;hpb=8fc5a9a5e90ba1c7580e9d883aed0d790e594c8e diff --git a/src/server/server.c b/src/server/server.c index 0f977a76c8..8da82ec889 100644 --- a/src/server/server.c +++ b/src/server/server.c @@ -2,7 +2,7 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007-2010 Øyvind Harboe * * oyvind.harboe@zylin.com * * * * Copyright (C) 2008 by Spencer Oliver * @@ -23,12 +23,14 @@ * Free Software Foundation, Inc., * * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "server.h" -#include "target.h" +#include +#include #include "openocd.h" #include "tcl_server.h" #include "telnet_server.h" @@ -39,16 +41,12 @@ #include #endif - -struct service *services = NULL; +static struct service *services; /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */ -static int shutdown_openocd = 0; - -/* set when using pipes rather than tcp */ -int server_use_pipes = 0; +static int shutdown_openocd; -int add_connection(struct service *service, struct command_context *cmd_ctx) +static int add_connection(struct service *service, struct command_context *cmd_ctx) { socklen_t address_size; struct connection *c, **p; @@ -57,6 +55,7 @@ int add_connection(struct service *service, struct command_context *cmd_ctx) c = malloc(sizeof(struct connection)); c->fd = -1; + c->fd_out = -1; memset(&c->sin, 0, sizeof(c->sin)); c->cmd_ctx = copy_command_context(cmd_ctx); c->service = service; @@ -64,47 +63,78 @@ int add_connection(struct service *service, struct command_context *cmd_ctx) c->priv = NULL; c->next = NULL; - if (service->type == CONNECTION_TCP) - { + 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. */ - 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) - { + * 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_PIPE) - { + } else if (service->type == CONNECTION_STDINOUT) { c->fd = service->fd; + c->fd_out = fileno(stdout); + +#ifdef _WIN32 + /* we are using stdin/out so ignore ctrl-c under windoze */ + SetConsoleCtrlHandler(NULL, TRUE); +#endif /* do not check for new connections again on stdin */ service->fd = -1; LOG_INFO("accepting '%s' connection from pipe", service->name); - if ((retval = service->new_connection(c)) != ERROR_OK) - { + 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); + for (p = &service->connections; *p; p = &(*p)->next) + ; *p = c; service->max_connections--; @@ -112,19 +142,22 @@ int add_connection(struct service *service, struct command_context *cmd_ctx) return ERROR_OK; } -int remove_connection(struct service *service, struct connection *connection) +static int remove_connection(struct service *service, struct connection *connection) { struct connection **p = &service->connections; struct connection *c; /* find connection */ - while ((c = *p)) - { - if (c->fd == connection->fd) - { + 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 */ @@ -142,7 +175,14 @@ int remove_connection(struct service *service, struct connection *connection) return ERROR_OK; } -int add_service(char *name, enum connection_type type, unsigned short port, int max_connections, new_connection_handler_t new_connection_handler, input_handler_t input_handler, connection_closed_handler_t connection_closed_handler, void *priv) +/* FIX! make service return error instead of invoking exit() */ +int add_service(char *name, + const char *port, + int max_connections, + new_connection_handler_t new_connection_handler, + input_handler_t input_handler, + connection_closed_handler_t connection_closed_handler, + void *priv) { struct service *c, **p; int so_reuseaddr_option = 1; @@ -150,9 +190,8 @@ int add_service(char *name, enum connection_type type, unsigned short port, int c = malloc(sizeof(struct service)); c->name = strdup(name); - c->type = type; - c->port = port; - c->max_connections = max_connections; + c->port = strdup(port); + c->max_connections = 1; /* Only TCP/IP ports can support more than one connection */ c->fd = -1; c->connections = NULL; c->new_connection = new_connection_handler; @@ -160,26 +199,42 @@ int add_service(char *name, enum connection_type type, unsigned short port, int c->connection_closed = connection_closed_handler; c->priv = priv; c->next = NULL; + long portnumber; + if (strcmp(c->port, "pipe") == 0) + c->type = CONNECTION_STDINOUT; + else { + char *end; + portnumber = strtol(c->port, &end, 0); + if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK)) { + c->portnumber = portnumber; + c->type = CONNECTION_TCP; + } else + c->type = CONNECTION_PIPE; + } - if (type == CONNECTION_TCP) - { - if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1) - { + 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)); + 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); + c->sin.sin_port = htons(c->portnumber); - if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) - { + if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) { LOG_ERROR("couldn't bind to socket: %s", strerror(errno)); exit(-1); } @@ -197,16 +252,12 @@ int add_service(char *name, enum connection_type type, unsigned short port, int setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF, (char *)&window_size, sizeof(window_size)); - if (listen(c->fd, 1) == -1) - { + if (listen(c->fd, 1) == -1) { LOG_ERROR("couldn't listen on socket: %s", strerror(errno)); exit(-1); } - } - else if (type == CONNECTION_PIPE) - { - /* use stdin */ - c->fd = STDIN_FILENO; + } else if (c->type == CONNECTION_STDINOUT) { + c->fd = fileno(stdin); #ifdef _WIN32 /* for win32 set stdin/stdout to binary mode */ @@ -219,59 +270,47 @@ int add_service(char *name, enum connection_type type, unsigned short port, int #else socket_nonblock(c->fd); #endif - } - else - { - LOG_ERROR("unknown connection type: %d", type); + } 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); + for (p = &services; *p; p = &(*p)->next) + ; *p = c; return ERROR_OK; } -int remove_service(unsigned short port) -{ - struct service **p = &services; - struct service *c; - - /* find service */ - while ((c = *p)) - { - if (c->port == port) - { - if (c->name) - free(c->name); - - if (c->priv) - free(c->priv); - - /* delete service */ - *p = c->next; - free(c); - } - - /* redirect p to next list pointer */ - p = &(*p)->next; - } - - return ERROR_OK; -} - -int remove_services(void) +static int remove_services(void) { struct service *c = services; /* loop service */ - while (c) - { + while (c) { struct service *next = c->next; if (c->name) - free(c->name); + free((void *)c->name); + + if (c->type == CONNECTION_PIPE) { + if (c->fd != -1) + close(c->fd); + } + if (c->port) + free((void *)c->port); if (c->priv) free(c->priv); @@ -292,9 +331,10 @@ int server_loop(struct command_context *command_context) { struct service *service; + bool poll_ok = true; + /* used in select() */ fd_set read_fds; - struct timeval tv; int fd_max; /* used in accept() */ @@ -305,21 +345,14 @@ int server_loop(struct command_context *command_context) LOG_ERROR("couldn't set SIGPIPE to SIG_IGN"); #endif - /* do regular tasks after at most 10ms */ - tv.tv_sec = 0; - tv.tv_usec = 10000; - - while (!shutdown_openocd) - { + 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) - { + for (service = services; service; service = service->next) { + if (service->fd != -1) { /* listen for new connections */ FD_SET(service->fd, &read_fds); @@ -327,12 +360,10 @@ int server_loop(struct command_context *command_context) fd_max = service->fd; } - if (service->connections) - { + if (service->connections) { struct connection *c; - for (c = service->connections; c; c = c->next) - { + 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) @@ -341,104 +372,108 @@ int server_loop(struct command_context *command_context) } } -#ifndef _WIN32 -#if BUILD_ECOSBOARD == 0 - if (server_use_pipes == 0) - { - /* add STDIN to read_fds */ - FD_SET(fileno(stdin), &read_fds); + 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(); } -#endif -#endif - - openocd_sleep_prelude(); - kept_alive(); - /* Only while we're sleeping we'll let others run */ - retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv); - openocd_sleep_postlude(); - - if (retval == -1) - { + if (retval == -1) { #ifdef _WIN32 errno = WSAGetLastError(); if (errno == WSAEINTR) FD_ZERO(&read_fds); - else - { + else { LOG_ERROR("error during select: %s", strerror(errno)); exit(-1); } #else if (errno == EINTR) - { FD_ZERO(&read_fds); - } - else - { + else { LOG_ERROR("error during select: %s", strerror(errno)); exit(-1); } #endif } - target_call_timer_callbacks(); - process_jim_events(command_context); + 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); - 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! */ + 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; } - for (service = services; service; service = service->next) - { + /* 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))) - { + && (FD_ISSET(service->fd, &read_fds))) { if (service->max_connections > 0) - { add_connection(service, command_context); - } - else - { - if (service->type != CONNECTION_PIPE) - { + 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); + 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); + LOG_INFO( + "rejected '%s' connection, no more connections allowed", + service->name); } } /* handle activity on connections */ - if (service->connections) - { + if (service->connections) { 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) - { + 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) - { - /* if connection uses a pipe then shutdown openocd on error */ + 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 - error %d", service->name, retval); + LOG_INFO("dropped '%s' connection", + service->name); c = next; continue; } @@ -448,24 +483,9 @@ int server_loop(struct command_context *command_context) } } -#ifndef _WIN32 -#if BUILD_ECOSBOARD == 0 - /* check for data on stdin if not using pipes */ - if (server_use_pipes == 0) - { - if (FD_ISSET(fileno(stdin), &read_fds)) - { - if (getc(stdin) == 'x') - { - shutdown_openocd = 1; - } - } - } -#endif -#else +#ifdef _WIN32 MSG msg; - while (PeekMessage(&msg,NULL,0,0,PM_REMOVE)) - { + while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) { if (msg.message == WM_QUIT) shutdown_openocd = 1; } @@ -482,35 +502,31 @@ BOOL WINAPI ControlHandler(DWORD dwCtrlType) return TRUE; } -void sig_handler(int sig) { +void sig_handler(int sig) +{ shutdown_openocd = 1; } #endif -int server_init(struct command_context *cmd_ctx) +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) - { + if (WSAStartup(wVersionRequested, &wsaData) != 0) { LOG_ERROR("Failed to Open Winsock"); exit(-1); } - if (server_use_pipes == 0) - { - /* register ctrl-c handler */ - SetConsoleCtrlHandler(ControlHandler, TRUE); - } - else - { - /* we are using pipes so ignore ctrl-c */ - SetConsoleCtrlHandler(NULL, TRUE); - } + /* register ctrl-c handler */ + SetConsoleCtrlHandler(ControlHandler, TRUE); signal(SIGINT, sig_handler); signal(SIGTERM, sig_handler); @@ -518,7 +534,12 @@ int server_init(struct command_context *cmd_ctx) signal(SIGABRT, sig_handler); #endif - int ret = tcl_init(cmd_ctx); + return ERROR_OK; +} + +int server_init(struct command_context *cmd_ctx) +{ + int ret = tcl_init(); if (ERROR_OK != ret) return ret; @@ -537,12 +558,34 @@ int server_quit(void) return ERROR_OK; } +int connection_write(struct connection *connection, const void *data, int len) +{ + if (len == 0) { + /* successful no-op. Sockets and pipes behave differently here... */ + return 0; + } + if (connection->service->type == CONNECTION_TCP) + return write_socket(connection->fd_out, data, len); + else + return write(connection->fd_out, data, len); +} + +int connection_read(struct connection *connection, void *data, int len) +{ + if (connection->service->type == CONNECTION_TCP) + return read_socket(connection->fd, data, len); + else + return read(connection->fd, data, len); +} + /* tell the server we want to shut down */ COMMAND_HANDLER(handle_shutdown_command) { + LOG_USER("shutdown command invoked"); + shutdown_openocd = 1; - return ERROR_COMMAND_CLOSE_CONNECTION; + return ERROR_OK; } static const struct command_registration server_command_handlers[] = { @@ -550,6 +593,7 @@ static const struct command_registration server_command_handlers[] = { .name = "shutdown", .handler = &handle_shutdown_command, .mode = COMMAND_ANY, + .usage = "", .help = "shut the server down", }, COMMAND_REGISTRATION_DONE @@ -571,18 +615,41 @@ int server_register_commands(struct command_context *cmd_ctx) 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; + 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; } - default: - return ERROR_INVALID_ARGUMENTS; + return ERROR_OK; +} + +SERVER_PIPE_COMMAND() +{ + 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; + } + const char *t = strdup(CMD_ARGV[0]); + free((void *)*out); + *out = t; + break; + } + default: + return ERROR_COMMAND_SYNTAX_ERROR; } return ERROR_OK; }