1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Ø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 ***************************************************************************/
31 #include <target/target.h>
33 #include "tcl_server.h"
34 #include "telnet_server.h"
39 #include <netinet/tcp.h>
43 static struct service *services = NULL;
45 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
46 static int shutdown_openocd = 0;
48 static int add_connection(struct service *service, struct command_context *cmd_ctx)
50 socklen_t address_size;
51 struct connection *c, **p;
55 c = malloc(sizeof(struct connection));
58 memset(&c->sin, 0, sizeof(c->sin));
59 c->cmd_ctx = copy_command_context(cmd_ctx);
65 if (service->type == CONNECTION_TCP)
67 address_size = sizeof(c->sin);
69 c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
72 /* This increases performance dramatically for e.g. GDB load which
73 * does not have a sliding window protocol. */
74 retval = setsockopt(c->fd, /* socket affected */
75 IPPROTO_TCP, /* set option at TCP level */
76 TCP_NODELAY, /* name of option */
77 (char *)&flag, /* the cast is historical cruft */
78 sizeof(int)); /* length of option value */
80 LOG_INFO("accepting '%s' connection from %s", service->name, service->port);
81 if ((retval = service->new_connection(c)) != ERROR_OK)
84 LOG_ERROR("attempted '%s' connection rejected", service->name);
88 } else if (service->type == CONNECTION_STDINOUT)
91 c->fd_out = fileno(stdout);
93 /* do not check for new connections again on stdin */
96 LOG_INFO("accepting '%s' connection from pipe", service->name);
97 if ((retval = service->new_connection(c)) != ERROR_OK)
99 LOG_ERROR("attempted '%s' connection rejected", service->name);
103 } else if (service->type == CONNECTION_PIPE)
106 /* do not check for new connections again on stdin */
109 char * out_file = alloc_printf("%so", service->port);
110 c->fd_out = open(out_file, O_WRONLY);
114 LOG_ERROR("could not open %s", service->port);
118 LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port);
119 if ((retval = service->new_connection(c)) != ERROR_OK)
121 LOG_ERROR("attempted '%s' connection rejected", service->name);
127 /* add to the end of linked list */
128 for (p = &service->connections; *p; p = &(*p)->next);
131 service->max_connections--;
136 static int remove_connection(struct service *service, struct connection *connection)
138 struct connection **p = &service->connections;
139 struct connection *c;
141 /* find connection */
144 if (c->fd == connection->fd)
146 service->connection_closed(c);
147 if (service->type == CONNECTION_TCP)
150 } else if (service->type == CONNECTION_PIPE)
152 /* The service will listen to the pipe again */
153 c->service->fd = c->fd;
156 command_done(c->cmd_ctx);
158 /* delete connection */
162 service->max_connections++;
166 /* redirect p to next list pointer */
173 /* FIX! make service return error instead of invoking exit() */
174 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)
176 struct service *c, **p;
177 int so_reuseaddr_option = 1;
179 c = malloc(sizeof(struct service));
181 c->name = strdup(name);
182 c->port = strdup(port);
183 c->max_connections = 1; /* Only TCP/IP ports can support more than one connection */
185 c->connections = NULL;
186 c->new_connection = new_connection_handler;
187 c->input = input_handler;
188 c->connection_closed = connection_closed_handler;
192 if (strcmp(c->port, "pipe") == 0)
194 c->type = CONNECTION_STDINOUT;
198 strtol(c->port, &end, 0);
199 if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK))
201 c->portnumber = portnumber;
202 c->type = CONNECTION_TCP;
205 c->type = CONNECTION_PIPE;
209 if (c->type == CONNECTION_TCP)
211 c->max_connections = max_connections;
213 if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
215 LOG_ERROR("error creating socket: %s", strerror(errno));
219 setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
221 socket_nonblock(c->fd);
223 memset(&c->sin, 0, sizeof(c->sin));
224 c->sin.sin_family = AF_INET;
225 c->sin.sin_addr.s_addr = INADDR_ANY;
226 c->sin.sin_port = htons(c->portnumber);
228 if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
230 LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
236 setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
238 int window_size = 128 * 1024;
240 /* These setsockopt()s must happen before the listen() */
242 setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
243 (char *)&window_size, sizeof(window_size));
244 setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
245 (char *)&window_size, sizeof(window_size));
247 if (listen(c->fd, 1) == -1)
249 LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
253 else if (c->type == CONNECTION_STDINOUT)
255 c->fd = fileno(stdin);
258 /* for win32 set stdin/stdout to binary mode */
259 if (_setmode(_fileno(stdout), _O_BINARY) < 0)
260 LOG_WARNING("cannot change stdout mode to binary");
261 if (_setmode(_fileno(stdin), _O_BINARY) < 0)
262 LOG_WARNING("cannot change stdin mode to binary");
263 if (_setmode(_fileno(stderr), _O_BINARY) < 0)
264 LOG_WARNING("cannot change stderr mode to binary");
266 socket_nonblock(c->fd);
269 else if (c->type == CONNECTION_PIPE)
271 /* Pipe we're reading from */
272 c->fd = open(c->port, O_RDONLY | O_NONBLOCK);
275 LOG_ERROR("could not open %s", c->port);
280 /* add to the end of linked list */
281 for (p = &services; *p; p = &(*p)->next);
287 static int remove_services(void)
289 struct service *c = services;
294 struct service *next = c->next;
299 if (c->type == CONNECTION_PIPE)
305 free((void *)c->port);
313 /* remember the last service for unlinking */
322 int server_loop(struct command_context *command_context)
324 struct service *service;
328 /* used in select() */
332 /* used in accept() */
336 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
337 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
340 while (!shutdown_openocd)
342 /* monitor sockets for activity */
346 /* add service and connection fds to read_fds */
347 for (service = services; service; service = service->next)
349 if (service->fd != -1)
351 /* listen for new connections */
352 FD_SET(service->fd, &read_fds);
354 if (service->fd > fd_max)
355 fd_max = service->fd;
358 if (service->connections)
360 struct connection *c;
362 for (c = service->connections; c; c = c->next)
364 /* check for activity on the connection */
365 FD_SET(c->fd, &read_fds);
376 /* we're just polling this iteration, this is faster on embedded
379 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
384 /* Only while we're sleeping we'll let others run */
385 openocd_sleep_prelude();
387 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
388 openocd_sleep_postlude();
395 errno = WSAGetLastError();
397 if (errno == WSAEINTR)
401 LOG_ERROR("error during select: %s", strerror(errno));
412 LOG_ERROR("error during select: %s", strerror(errno));
420 /* We only execute these callbacks when there was nothing to do or we timed out */
421 target_call_timer_callbacks();
422 process_jim_events(command_context);
424 FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
426 /* We timed out/there was nothing to do, timeout rather than poll next time */
430 /* There was something to do, next time we'll just poll */
434 for (service = services; service; service = service->next)
436 /* handle new connections on listeners */
437 if ((service->fd != -1)
438 && (FD_ISSET(service->fd, &read_fds)))
440 if (service->max_connections > 0)
442 add_connection(service, command_context);
446 if (service->type == CONNECTION_TCP)
448 struct sockaddr_in sin;
449 socklen_t address_size = sizeof(sin);
451 tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
452 close_socket(tmp_fd);
454 LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
458 /* handle activity on connections */
459 if (service->connections)
461 struct connection *c;
463 for (c = service->connections; c;)
465 if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
467 if ((retval = service->input(c)) != ERROR_OK)
469 struct connection *next = c->next;
470 if (service->type == CONNECTION_PIPE)
472 /* if connection uses a pipe then shutdown openocd on error */
473 shutdown_openocd = 1;
475 remove_connection(service, c);
476 LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
488 while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
490 if (msg.message == WM_QUIT)
491 shutdown_openocd = 1;
500 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
502 shutdown_openocd = 1;
506 void sig_handler(int sig) {
507 shutdown_openocd = 1;
511 int server_preinit(void)
513 /* this currently only calls WSAStartup on native win32 systems
514 * before any socket operations are performed.
515 * This is an issue if you call init in your config script */
518 WORD wVersionRequested;
521 wVersionRequested = MAKEWORD(2, 2);
523 if (WSAStartup(wVersionRequested, &wsaData) != 0)
525 LOG_ERROR("Failed to Open Winsock");
529 if (server_use_pipes == 0)
531 /* register ctrl-c handler */
532 SetConsoleCtrlHandler(ControlHandler, TRUE);
536 /* we are using pipes so ignore ctrl-c */
537 SetConsoleCtrlHandler(NULL, TRUE);
540 signal(SIGINT, sig_handler);
541 signal(SIGTERM, sig_handler);
542 signal(SIGBREAK, sig_handler);
543 signal(SIGABRT, sig_handler);
549 int server_init(struct command_context *cmd_ctx)
551 int ret = tcl_init();
555 return telnet_init("Open On-Chip Debugger");
558 int server_quit(void)
564 SetConsoleCtrlHandler(ControlHandler, FALSE);
570 int connection_write(struct connection *connection, const void *data, int len)
574 /* successful no-op. Sockets and pipes behave differently here... */
577 if (connection->service->type == CONNECTION_TCP)
579 return write_socket(connection->fd_out, data, len);
582 return write(connection->fd_out, data, len);
586 int connection_read(struct connection *connection, void *data, int len)
588 if (connection->service->type == CONNECTION_TCP)
590 return read_socket(connection->fd, data, len);
593 return read(connection->fd, data, len);
597 /* tell the server we want to shut down */
598 COMMAND_HANDLER(handle_shutdown_command)
600 LOG_USER("shutdown command invoked");
602 shutdown_openocd = 1;
607 static const struct command_registration server_command_handlers[] = {
610 .handler = &handle_shutdown_command,
612 .help = "shut the server down",
614 COMMAND_REGISTRATION_DONE
617 int server_register_commands(struct command_context *cmd_ctx)
619 int retval = telnet_register_commands(cmd_ctx);
620 if (ERROR_OK != retval)
623 retval = tcl_register_commands(cmd_ctx);
624 if (ERROR_OK != retval)
627 return register_commands(cmd_ctx, NULL, server_command_handlers);
630 SERVER_PORT_COMMAND()
634 command_print(CMD_CTX, "%d", *out);
639 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port);
644 return ERROR_INVALID_ARGUMENTS;
649 SERVER_PIPE_COMMAND()
653 command_print(CMD_CTX, "%s", *out);
657 const char * t = strdup(CMD_ARGV[0]);
663 return ERROR_INVALID_ARGUMENTS;