X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fserver%2Fserver.c;h=517d62a79452d5c7ca5ae7cc7dccdf22f8fa9891;hp=c70a52220fb728d07710109d5fd141775ece9362;hb=f712098323c46213a7658f6b91b3775055bc6d6a;hpb=4f9a9b8ebae8425eda3a71ccb782789cd3b8f6b7 diff --git a/src/server/server.c b/src/server/server.c index c70a52220f..517d62a794 100644 --- a/src/server/server.c +++ b/src/server/server.c @@ -19,31 +19,45 @@ * 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., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * along with this program. If not, see . * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "server.h" #include +#include +#include #include "openocd.h" #include "tcl_server.h" #include "telnet_server.h" #include +#ifdef HAVE_NETDB_H +#include +#endif + #ifndef _WIN32 #include #endif +static struct service *services; + +/* shutdown_openocd == 1: exit the main event loop, and quit the + * debugger; 2: quit with non-zero return code */ +static int shutdown_openocd; -static struct service *services = NULL; +/* store received signal to exit application by killing ourselves */ +static int last_signal; -/* shutdown_openocd == 1: exit the main event loop, and quit the debugger */ -static int shutdown_openocd = 0; +/* set the polling period to 100ms */ +static int polling_period = 100; + +/* address by name on which to listen for incoming TCP/IP connections */ +static char *bindto_name; static int add_connection(struct service *service, struct command_context *cmd_ctx) { @@ -62,31 +76,33 @@ static int add_connection(struct service *service, struct command_context *cmd_c 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 %s", service->name, service->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 on tcp/%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) - { + } else if (service->type == CONNECTION_STDINOUT) { c->fd = service->fd; c->fd_out = fileno(stdout); @@ -99,41 +115,45 @@ static int add_connection(struct service *service, struct command_context *cmd_c 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) - { + } 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); + char *out_file = alloc_printf("%so", service->port); c->fd_out = open(out_file, O_WRONLY); free(out_file); - if (c->fd_out == -1) - { + if (c->fd_out == -1) { LOG_ERROR("could not open %s", service->port); - exit(1); + command_done(c->cmd_ctx); + free(c); + return ERROR_FAIL; } LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port); - 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; } } /* 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--; + if (service->max_connections != CONNECTION_LIMIT_UNLIMITED) + service->max_connections--; return ERROR_OK; } @@ -144,16 +164,12 @@ static int remove_connection(struct service *service, struct connection *connect 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) - { + else if (service->type == CONNECTION_PIPE) { /* The service will listen to the pipe again */ c->service->fd = c->fd; } @@ -164,7 +180,9 @@ static int remove_connection(struct service *service, struct connection *connect *p = c->next; free(c); - service->max_connections++; + if (service->max_connections != CONNECTION_LIMIT_UNLIMITED) + service->max_connections++; + break; } @@ -175,17 +193,30 @@ static int remove_connection(struct service *service, struct connection *connect 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) +static void free_service(struct service *c) +{ + free(c->name); + free(c->port); + free(c); +} + +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; + struct hostent *hp; 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->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; @@ -195,45 +226,57 @@ int add_service(char *name, const char *port, int max_connections, new_connectio c->next = NULL; long portnumber; if (strcmp(c->port, "pipe") == 0) - { c->type = CONNECTION_STDINOUT; - } else - { + else { char *end; portnumber = strtol(c->port, &end, 0); - if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK)) - { + 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) - { + if (c->type == CONNECTION_TCP) { c->max_connections = max_connections; - if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1) - { + c->fd = socket(AF_INET, SOCK_STREAM, 0); + if (c->fd == -1) { LOG_ERROR("error creating socket: %s", strerror(errno)); - exit(-1); + free_service(c); + return ERROR_FAIL; } - 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; + + if (bindto_name == NULL) + c->sin.sin_addr.s_addr = INADDR_ANY; + else { + hp = gethostbyname(bindto_name); + if (hp == NULL) { + LOG_ERROR("couldn't resolve bindto address: %s", bindto_name); + close_socket(c->fd); + free_service(c); + return ERROR_FAIL; + } + memcpy(&c->sin.sin_addr, hp->h_addr_list[0], hp->h_length); + } 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); + if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) { + LOG_ERROR("couldn't bind %s to socket on port %d: %s", name, c->portnumber, strerror(errno)); + close_socket(c->fd); + free_service(c); + return ERROR_FAIL; } #ifndef _WIN32 @@ -249,14 +292,13 @@ int add_service(char *name, const char *port, int max_connections, new_connectio 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); + close_socket(c->fd); + free_service(c); + return ERROR_FAIL; } - } - else if (c->type == CONNECTION_STDINOUT) - { + } else if (c->type == CONNECTION_STDINOUT) { c->fd = fileno(stdin); #ifdef _WIN32 @@ -270,27 +312,27 @@ int add_service(char *name, const char *port, int max_connections, new_connectio #else socket_nonblock(c->fd); #endif - } - else if (c->type == CONNECTION_PIPE) - { + } 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); + free_service(c); + return ERROR_FAIL; #else /* Pipe we're reading from */ c->fd = open(c->port, O_RDONLY | O_NONBLOCK); - if (c->fd == -1) - { + if (c->fd == -1) { LOG_ERROR("could not open %s", c->port); - exit(1); + free_service(c); + return ERROR_FAIL; } #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; @@ -301,20 +343,18 @@ static int remove_services(void) struct service *c = services; /* loop service */ - while (c) - { + while (c) { struct service *next = c->next; if (c->name) - free((void *)c->name); + free(c->name); - if (c->type == CONNECTION_PIPE) - { + if (c->type == CONNECTION_PIPE) { if (c->fd != -1) close(c->fd); } if (c->port) - free((void *)c->port); + free(c->port); if (c->priv) free(c->priv); @@ -349,17 +389,14 @@ int server_loop(struct command_context *command_context) LOG_ERROR("couldn't set SIGPIPE to SIG_IGN"); #endif - 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); @@ -367,12 +404,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) @@ -383,16 +418,14 @@ int server_loop(struct command_context *command_context) struct timeval tv; tv.tv_sec = 0; - if (poll_ok) - { + 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; + } else { + /* Every 100ms, can be changed with "poll_period" command */ + tv.tv_usec = polling_period * 1000; /* Only while we're sleeping we'll let others run */ openocd_sleep_prelude(); kept_alive(); @@ -400,92 +433,91 @@ int server_loop(struct command_context *command_context) 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); + return ERROR_FAIL; } #else if (errno == EINTR) - { FD_ZERO(&read_fds); - } - else - { + else { LOG_ERROR("error during select: %s", strerror(errno)); - exit(-1); + return ERROR_FAIL; } #endif } - if (retval == 0) - { - /* We only execute these callbacks when there was nothing to do or we timed out */ + 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! */ + 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 */ + /* We timed out/there was nothing to do, timeout rather than poll next time + **/ poll_ok = false; - } else - { + } 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))) - { - if (service->max_connections > 0) - { + && (FD_ISSET(service->fd, &read_fds))) { + if (service->max_connections != 0) add_connection(service, command_context); - } - else - { - if (service->type == CONNECTION_TCP) - { + 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", service->name); + LOG_INFO("dropped '%s' connection", + service->name); c = next; continue; } @@ -497,15 +529,14 @@ int server_loop(struct command_context *command_context) #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; } #endif } - return ERROR_OK; + return shutdown_openocd != 2 ? ERROR_OK : ERROR_FAIL; } #ifdef _WIN32 @@ -514,11 +545,15 @@ BOOL WINAPI ControlHandler(DWORD dwCtrlType) shutdown_openocd = 1; return TRUE; } +#endif -void sig_handler(int sig) { +void sig_handler(int sig) +{ + /* store only first signal that hits us */ + if (!last_signal) + last_signal = sig; shutdown_openocd = 1; } -#endif int server_preinit(void) { @@ -532,20 +567,19 @@ int server_preinit(void) wVersionRequested = MAKEWORD(2, 2); - if (WSAStartup(wVersionRequested, &wsaData) != 0) - { + if (WSAStartup(wVersionRequested, &wsaData) != 0) { LOG_ERROR("Failed to Open Winsock"); - exit(-1); + return ERROR_FAIL; } /* register ctrl-c handler */ SetConsoleCtrlHandler(ControlHandler, TRUE); + signal(SIGBREAK, sig_handler); +#endif signal(SIGINT, sig_handler); signal(SIGTERM, sig_handler); - signal(SIGBREAK, sig_handler); signal(SIGABRT, sig_handler); -#endif return ERROR_OK; } @@ -553,49 +587,63 @@ int server_preinit(void) int server_init(struct command_context *cmd_ctx) { int ret = tcl_init(); - if (ERROR_OK != ret) + + if (ret != ERROR_OK) + return ret; + + ret = telnet_init("Open On-Chip Debugger"); + + if (ret != ERROR_OK) { + remove_services(); return ret; + } - return telnet_init("Open On-Chip Debugger"); + return ERROR_OK; } int server_quit(void) { remove_services(); + target_quit(); #ifdef _WIN32 WSACleanup(); SetConsoleCtrlHandler(ControlHandler, FALSE); -#endif return ERROR_OK; +#endif + + /* return signal number so we can kill ourselves */ + return last_signal; +} + +void exit_on_signal(int sig) +{ +#ifndef _WIN32 + /* bring back default system handler and kill yourself */ + signal(sig, SIG_DFL); + kill(getpid(), sig); +#endif } int connection_write(struct connection *connection, const void *data, int len) { - if (len == 0) - { + 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 - { + 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 - { + else return read(connection->fd, data, len); - } } /* tell the server we want to shut down */ @@ -605,6 +653,41 @@ COMMAND_HANDLER(handle_shutdown_command) shutdown_openocd = 1; + if (CMD_ARGC == 1) { + if (!strcmp(CMD_ARGV[0], "error")) { + shutdown_openocd = 2; + return ERROR_FAIL; + } + } + + return ERROR_COMMAND_CLOSE_CONNECTION; +} + +COMMAND_HANDLER(handle_poll_period_command) +{ + if (CMD_ARGC == 0) + LOG_WARNING("You need to set a period value"); + else + COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], polling_period); + + LOG_INFO("set servers polling period to %ums", polling_period); + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_bindto_command) +{ + switch (CMD_ARGC) { + case 0: + command_print(CMD_CTX, "bindto name: %s", bindto_name); + break; + case 1: + free(bindto_name); + bindto_name = strdup(CMD_ARGV[0]); + break; + default: + return ERROR_COMMAND_SYNTAX_ERROR; + } return ERROR_OK; } @@ -613,8 +696,24 @@ static const struct command_registration server_command_handlers[] = { .name = "shutdown", .handler = &handle_shutdown_command, .mode = COMMAND_ANY, + .usage = "", .help = "shut the server down", }, + { + .name = "poll_period", + .handler = &handle_poll_period_command, + .mode = COMMAND_ANY, + .usage = "", + .help = "set the servers polling period", + }, + { + .name = "bindto", + .handler = &handle_bindto_command, + .mode = COMMAND_ANY, + .usage = "[name]", + .help = "Specify address by name on which to listen for " + "incoming TCP/IP connections", + }, COMMAND_REGISTRATION_DONE }; @@ -628,44 +727,50 @@ int server_register_commands(struct command_context *cmd_ctx) if (ERROR_OK != retval) return retval; + retval = jsp_register_commands(cmd_ctx); + if (ERROR_OK != retval) + return retval; + return register_commands(cmd_ctx, NULL, server_command_handlers); } -SERVER_PORT_COMMAND() +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_INVALID_ARGUMENTS; + 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; } -SERVER_PIPE_COMMAND() +COMMAND_HELPER(server_pipe_command, char **out) { switch (CMD_ARGC) { - case 0: - command_print(CMD_CTX, "%s", *out); - break; - case 1: - { - const char * t = strdup(CMD_ARGV[0]); - free((void *)*out); - *out = t; - break; - } - default: - return ERROR_INVALID_ARGUMENTS; + 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; } -