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 ***************************************************************************/
36 #include <netinet/tcp.h>
40 service_t *services = NULL;
42 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
43 static int shutdown_openocd = 0;
45 /* set when using pipes rather than tcp */
46 int server_use_pipes = 0;
48 int add_connection(service_t *service, command_context_t *cmd_ctx)
50 socklen_t address_size;
55 c = malloc(sizeof(connection_t));
57 memset(&c->sin, 0, sizeof(c->sin));
58 c->cmd_ctx = copy_command_context(cmd_ctx);
64 if (service->type == CONNECTION_TCP)
66 address_size = sizeof(c->sin);
68 c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
70 /* This increases performance dramatically for e.g. GDB load which
71 * does not have a sliding window protocol. */
72 retval = setsockopt(c->fd, /* socket affected */
73 IPPROTO_TCP, /* set option at TCP level */
74 TCP_NODELAY, /* name of option */
75 (char *)&flag, /* the cast is historical cruft */
76 sizeof(int)); /* length of option value */
78 LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
79 if ((retval = service->new_connection(c)) != ERROR_OK)
82 LOG_ERROR("attempted '%s' connection rejected", service->name);
87 else if (service->type == CONNECTION_PIPE)
91 /* do not check for new connections again on stdin */
94 LOG_INFO("accepting '%s' connection from pipe", service->name);
95 if ((retval = service->new_connection(c)) != ERROR_OK)
97 LOG_ERROR("attempted '%s' connection rejected", service->name);
103 /* add to the end of linked list */
104 for (p = &service->connections; *p; p = &(*p)->next);
107 service->max_connections--;
112 int remove_connection(service_t *service, connection_t *connection)
114 connection_t **p = &service->connections;
117 /* find connection */
120 if (c->fd == connection->fd)
122 service->connection_closed(c);
123 if (service->type == CONNECTION_TCP)
125 command_done(c->cmd_ctx);
127 /* delete connection */
131 service->max_connections++;
135 /* redirect p to next list pointer */
142 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)
145 int so_reuseaddr_option = 1;
147 c = malloc(sizeof(service_t));
149 c->name = strdup(name);
152 c->max_connections = max_connections;
154 c->connections = NULL;
155 c->new_connection = new_connection_handler;
156 c->input = input_handler;
157 c->connection_closed = connection_closed_handler;
161 if (type == CONNECTION_TCP)
163 if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
165 LOG_ERROR("error creating socket: %s", strerror(errno));
169 setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
171 socket_nonblock(c->fd);
173 memset(&c->sin, 0, sizeof(c->sin));
174 c->sin.sin_family = AF_INET;
175 c->sin.sin_addr.s_addr = INADDR_ANY;
176 c->sin.sin_port = htons(port);
178 if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
180 LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
186 setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
188 int window_size = 128 * 1024;
190 /* These setsockopt()s must happen before the listen() */
192 setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
193 (char *)&window_size, sizeof(window_size));
194 setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
195 (char *)&window_size, sizeof(window_size));
197 if (listen(c->fd, 1) == -1)
199 LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
203 else if (type == CONNECTION_PIPE)
206 c->fd = STDIN_FILENO;
209 /* for win32 set stdin/stdout to binary mode */
210 if (_setmode(_fileno(stdout), _O_BINARY) < 0)
211 LOG_WARNING("cannot change stdout mode to binary");
212 if (_setmode(_fileno(stdin), _O_BINARY) < 0)
213 LOG_WARNING("cannot change stdin mode to binary");
214 if (_setmode(_fileno(stderr), _O_BINARY) < 0)
215 LOG_WARNING("cannot change stderr mode to binary");
217 socket_nonblock(c->fd);
222 LOG_ERROR("unknown connection type: %d", type);
226 /* add to the end of linked list */
227 for (p = &services; *p; p = &(*p)->next);
233 int remove_service(unsigned short port)
235 service_t **p = &services;
254 /* redirect p to next list pointer */
261 int remove_services(void)
263 service_t *c = services;
268 service_t *next = c->next;
279 /* remember the last service for unlinking */
288 extern void openocd_sleep_prelude(void);
289 extern void openocd_sleep_postlude(void);
291 int server_loop(command_context_t *command_context)
295 /* used in select() */
300 /* used in accept() */
304 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
305 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
308 /* do regular tasks after at most 10ms */
312 while (!shutdown_openocd)
314 /* monitor sockets for acitvity */
318 /* add service and connection fds to read_fds */
319 for (service = services; service; service = service->next)
321 if (service->fd != -1)
323 /* listen for new connections */
324 FD_SET(service->fd, &read_fds);
326 if (service->fd > fd_max)
327 fd_max = service->fd;
330 if (service->connections)
334 for (c = service->connections; c; c = c->next)
336 /* check for activity on the connection */
337 FD_SET(c->fd, &read_fds);
345 #if BUILD_ECOSBOARD == 0
346 if (server_use_pipes == 0)
348 /* add STDIN to read_fds */
349 FD_SET(fileno(stdin), &read_fds);
354 openocd_sleep_prelude();
357 /* Only while we're sleeping we'll let others run */
358 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
359 openocd_sleep_postlude();
365 errno = WSAGetLastError();
367 if (errno == WSAEINTR)
371 LOG_ERROR("error during select: %s", strerror(errno));
382 LOG_ERROR("error during select: %s", strerror(errno));
388 target_call_timer_callbacks();
389 process_jim_events ();
393 /* do regular tasks after at most 100ms */
396 FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
399 for (service = services; service; service = service->next)
401 /* handle new connections on listeners */
402 if ((service->fd != -1)
403 && (FD_ISSET(service->fd, &read_fds)))
405 if (service->max_connections > 0)
407 add_connection(service, command_context);
411 if (service->type != CONNECTION_PIPE)
413 struct sockaddr_in sin;
414 socklen_t address_size = sizeof(sin);
416 tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
417 close_socket(tmp_fd);
419 LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
423 /* handle activity on connections */
424 if (service->connections)
428 for (c = service->connections; c;)
430 if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
432 if ((retval = service->input(c)) != ERROR_OK)
434 connection_t *next = c->next;
435 if (service->type == CONNECTION_PIPE)
437 /* if connection uses a pipe then shutdown openocd on error */
438 shutdown_openocd = 1;
440 remove_connection(service, c);
441 LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
452 #if BUILD_ECOSBOARD == 0
453 /* check for data on stdin if not using pipes */
454 if (server_use_pipes == 0)
456 if (FD_ISSET(fileno(stdin), &read_fds))
458 if (getc(stdin) == 'x')
460 shutdown_openocd = 1;
467 while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
469 if (msg.message == WM_QUIT)
470 shutdown_openocd = 1;
479 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
481 shutdown_openocd = 1;
485 void sig_handler(int sig) {
486 shutdown_openocd = 1;
490 int server_init(void)
493 WORD wVersionRequested;
496 wVersionRequested = MAKEWORD(2, 2);
498 if (WSAStartup(wVersionRequested, &wsaData) != 0)
500 LOG_ERROR("Failed to Open Winsock");
504 if (server_use_pipes == 0)
506 /* register ctrl-c handler */
507 SetConsoleCtrlHandler(ControlHandler, TRUE);
511 /* we are using pipes so ignore ctrl-c */
512 SetConsoleCtrlHandler(NULL, TRUE);
515 signal(SIGINT, sig_handler);
516 signal(SIGTERM, sig_handler);
517 signal(SIGBREAK, sig_handler);
518 signal(SIGABRT, sig_handler);
524 int server_quit(void)
530 SetConsoleCtrlHandler(ControlHandler, FALSE);
536 /* tell the server we want to shut down */
537 COMMAND_HANDLER(handle_shutdown_command)
539 shutdown_openocd = 1;
541 return ERROR_COMMAND_CLOSE_CONNECTION;
544 int server_register_commands(command_context_t *context)
546 register_command(context, NULL, "shutdown",
547 handle_shutdown_command, COMMAND_ANY,
548 "shut the server down");
554 int server_port_command(struct command_context_s *cmd_ctx,
555 char *cmd, char **args, int argc, unsigned short *out)
559 command_print(cmd_ctx, "%d", *out);
564 COMMAND_PARSE_NUMBER(u16, args[0], port);
569 return ERROR_INVALID_ARGUMENTS;