1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
30 #include "replacements.h"
35 #include "telnet_server.h"
43 #include <sys/types.h>
47 #include <netinet/tcp.h>
50 service_t *services = NULL;
52 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
53 static int shutdown_openocd = 0;
54 int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
56 /* set when using pipes rather than tcp */
57 int server_use_pipes = 0;
59 int add_connection(service_t *service, command_context_t *cmd_ctx)
61 unsigned int address_size;
66 c = malloc(sizeof(connection_t));
68 memset(&c->sin, 0, sizeof(c->sin));
69 c->cmd_ctx = copy_command_context(cmd_ctx);
75 if (service->type == CONNECTION_TCP)
77 address_size = sizeof(c->sin);
79 c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
81 /* This increases performance dramatically for e.g. GDB load which
82 * does not have a sliding window protocol. */
83 retval=setsockopt(c->fd, /* socket affected */
84 IPPROTO_TCP, /* set option at TCP level */
85 TCP_NODELAY, /* name of option */
86 (char *)&flag, /* the cast is historical cruft */
87 sizeof(int)); /* length of option value */
89 LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
90 if ((retval = service->new_connection(c)) != ERROR_OK)
93 LOG_ERROR("attempted '%s' connection rejected", service->name);
98 else if (service->type == CONNECTION_PIPE)
102 /* do not check for new connections again on stdin */
105 LOG_INFO("accepting '%s' connection from pipe", service->name);
106 if ((retval = service->new_connection(c)) != ERROR_OK)
108 LOG_ERROR("attempted '%s' connection rejected", service->name);
114 /* add to the end of linked list */
115 for (p = &service->connections; *p; p = &(*p)->next);
118 service->max_connections--;
123 int remove_connection(service_t *service, connection_t *connection)
125 connection_t **p = &service->connections;
128 /* find connection */
131 if (c->fd == connection->fd)
133 service->connection_closed(c);
134 if (service->type == CONNECTION_TCP)
136 command_done(c->cmd_ctx);
138 /* delete connection */
142 service->max_connections++;
146 /* redirect p to next list pointer */
153 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)
156 int so_reuseaddr_option = 1;
158 c = malloc(sizeof(service_t));
160 c->name = strdup(name);
163 c->max_connections = max_connections;
165 c->connections = NULL;
166 c->new_connection = new_connection_handler;
167 c->input = input_handler;
168 c->connection_closed = connection_closed_handler;
172 if (type == CONNECTION_TCP)
174 if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
176 LOG_ERROR("error creating socket: %s", strerror(errno));
180 setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
182 socket_nonblock(c->fd);
184 memset(&c->sin, 0, sizeof(c->sin));
185 c->sin.sin_family = AF_INET;
186 c->sin.sin_addr.s_addr = INADDR_ANY;
187 c->sin.sin_port = htons(port);
189 if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
191 LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
197 setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
199 int window_size = 128 * 1024;
201 /* These setsockopt()s must happen before the listen() */
203 setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
204 (char *)&window_size, sizeof(window_size));
205 setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
206 (char *)&window_size, sizeof(window_size));
208 if (listen(c->fd, 1) == -1)
210 LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
214 else if (type == CONNECTION_PIPE)
217 c->fd = STDIN_FILENO;
220 /* for win32 set stdin/stdout to binary mode */
221 if (_setmode(_fileno(stdout), _O_BINARY) < 0)
222 LOG_WARNING("cannot change stdout mode to binary");
223 if (_setmode(_fileno(stdin), _O_BINARY) < 0)
224 LOG_WARNING("cannot change stdin mode to binary");
225 if (_setmode(_fileno(stderr), _O_BINARY) < 0)
226 LOG_WARNING("cannot change stderr mode to binary");
228 socket_nonblock(c->fd);
233 LOG_ERROR("unknown connection type: %d", type);
237 /* add to the end of linked list */
238 for (p = &services; *p; p = &(*p)->next);
244 int remove_service(unsigned short port)
246 service_t **p = &services;
265 /* redirect p to next list pointer */
272 int remove_services(void)
274 service_t *c = services;
279 service_t *next = c->next;
290 /* remember the last service for unlinking */
299 extern void openocd_sleep_prelude(void);
300 extern void openocd_sleep_postlude(void);
302 int server_loop(command_context_t *command_context)
306 /* used in select() */
311 /* used in accept() */
315 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
316 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
319 /* do regular tasks after at most 10ms */
323 while(!shutdown_openocd)
325 /* monitor sockets for acitvity */
329 /* add service and connection fds to read_fds */
330 for (service = services; service; service = service->next)
332 if (service->fd != -1)
334 /* listen for new connections */
335 FD_SET(service->fd, &read_fds);
337 if (service->fd > fd_max)
338 fd_max = service->fd;
341 if (service->connections)
345 for (c = service->connections; c; c = c->next)
347 /* check for activity on the connection */
348 FD_SET(c->fd, &read_fds);
356 #if BUILD_ECOSBOARD == 0
357 if (server_use_pipes == 0)
359 /* add STDIN to read_fds */
360 FD_SET(fileno(stdin), &read_fds);
365 openocd_sleep_prelude();
368 /* Only while we're sleeping we'll let others run */
369 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
370 openocd_sleep_postlude();
376 errno = WSAGetLastError();
378 if (errno == WSAEINTR)
382 LOG_ERROR("error during select: %s", strerror(errno));
393 LOG_ERROR("error during select: %s", strerror(errno));
399 target_call_timer_callbacks();
400 process_jim_events ();
404 /* do regular tasks after at most 100ms */
407 FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
410 for (service = services; service; service = service->next)
412 /* handle new connections on listeners */
413 if ((service->fd != -1)
414 && (FD_ISSET(service->fd, &read_fds)))
416 if (service->max_connections > 0)
418 add_connection(service, command_context);
422 if (service->type != CONNECTION_PIPE)
424 struct sockaddr_in sin;
425 unsigned int address_size = sizeof(sin);
427 tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
428 close_socket(tmp_fd);
430 LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
434 /* handle activity on connections */
435 if (service->connections)
439 for (c = service->connections; c;)
441 if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
443 if ((retval = service->input(c)) != ERROR_OK)
445 connection_t *next = c->next;
446 if (service->type == CONNECTION_PIPE)
448 /* if connection uses a pipe then shutdown openocd on error */
449 shutdown_openocd = 1;
451 remove_connection(service, c);
452 LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
463 #if BUILD_ECOSBOARD == 0
464 /* check for data on stdin if not using pipes */
465 if (server_use_pipes == 0)
467 if (FD_ISSET(fileno(stdin), &read_fds))
469 if (getc(stdin) == 'x')
471 shutdown_openocd = 1;
478 while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
480 if (msg.message == WM_QUIT)
481 shutdown_openocd = 1;
490 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
492 shutdown_openocd = 1;
496 void sig_handler(int sig) {
497 shutdown_openocd = 1;
501 int server_init(void)
504 WORD wVersionRequested;
507 wVersionRequested = MAKEWORD(2, 2);
509 if (WSAStartup(wVersionRequested, &wsaData) != 0)
511 LOG_ERROR("Failed to Open Winsock");
515 if (server_use_pipes == 0)
517 /* register ctrl-c handler */
518 SetConsoleCtrlHandler(ControlHandler, TRUE);
522 /* we are using pipes so ignore ctrl-c */
523 SetConsoleCtrlHandler(NULL, TRUE);
526 signal(SIGINT, sig_handler);
527 signal(SIGTERM, sig_handler);
528 signal(SIGBREAK, sig_handler);
529 signal(SIGABRT, sig_handler);
535 int server_quit(void)
541 SetConsoleCtrlHandler( ControlHandler, FALSE );
547 int server_register_commands(command_context_t *context)
549 register_command(context, NULL, "shutdown", handle_shutdown_command,
550 COMMAND_ANY, "shut the server down");
555 /* tell the server we want to shut down */
556 int handle_shutdown_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
558 shutdown_openocd = 1;
560 return ERROR_COMMAND_CLOSE_CONNECTION;