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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
30 #include <target/target.h>
31 #include <target/target_request.h>
32 #include <target/openrisc/jsp_server.h>
34 #include "tcl_server.h"
35 #include "telnet_server.h"
44 #include <netinet/tcp.h>
47 static struct service *services;
49 /* shutdown_openocd == 1: exit the main event loop, and quit the
50 * debugger; 2: quit with non-zero return code */
51 static int shutdown_openocd;
53 /* store received signal to exit application by killing ourselves */
54 static int last_signal;
56 /* set the polling period to 100ms */
57 static int polling_period = 100;
59 /* address by name on which to listen for incoming TCP/IP connections */
60 static char *bindto_name;
62 static int add_connection(struct service *service, struct command_context *cmd_ctx)
64 socklen_t address_size;
65 struct connection *c, **p;
69 c = malloc(sizeof(struct connection));
72 memset(&c->sin, 0, sizeof(c->sin));
73 c->cmd_ctx = copy_command_context(cmd_ctx);
79 if (service->type == CONNECTION_TCP) {
80 address_size = sizeof(c->sin);
82 c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
85 /* This increases performance dramatically for e.g. GDB load which
86 * does not have a sliding window protocol.
88 * Ignore errors from this fn as it probably just means less performance
90 setsockopt(c->fd, /* socket affected */
91 IPPROTO_TCP, /* set option at TCP level */
92 TCP_NODELAY, /* name of option */
93 (char *)&flag, /* the cast is historical cruft */
94 sizeof(int)); /* length of option value */
96 LOG_INFO("accepting '%s' connection on tcp/%s", service->name, service->port);
97 retval = service->new_connection(c);
98 if (retval != ERROR_OK) {
100 LOG_ERROR("attempted '%s' connection rejected", service->name);
101 command_done(c->cmd_ctx);
105 } else if (service->type == CONNECTION_STDINOUT) {
107 c->fd_out = fileno(stdout);
110 /* we are using stdin/out so ignore ctrl-c under windoze */
111 SetConsoleCtrlHandler(NULL, TRUE);
114 /* do not check for new connections again on stdin */
117 LOG_INFO("accepting '%s' connection from pipe", service->name);
118 retval = service->new_connection(c);
119 if (retval != ERROR_OK) {
120 LOG_ERROR("attempted '%s' connection rejected", service->name);
121 command_done(c->cmd_ctx);
125 } else if (service->type == CONNECTION_PIPE) {
127 /* do not check for new connections again on stdin */
130 char *out_file = alloc_printf("%so", service->port);
131 c->fd_out = open(out_file, O_WRONLY);
133 if (c->fd_out == -1) {
134 LOG_ERROR("could not open %s", service->port);
135 command_done(c->cmd_ctx);
140 LOG_INFO("accepting '%s' connection from pipe %s", service->name, service->port);
141 retval = service->new_connection(c);
142 if (retval != ERROR_OK) {
143 LOG_ERROR("attempted '%s' connection rejected", service->name);
144 command_done(c->cmd_ctx);
150 /* add to the end of linked list */
151 for (p = &service->connections; *p; p = &(*p)->next)
155 if (service->max_connections != CONNECTION_LIMIT_UNLIMITED)
156 service->max_connections--;
161 static int remove_connection(struct service *service, struct connection *connection)
163 struct connection **p = &service->connections;
164 struct connection *c;
166 /* find connection */
168 if (c->fd == connection->fd) {
169 service->connection_closed(c);
170 if (service->type == CONNECTION_TCP)
172 else if (service->type == CONNECTION_PIPE) {
173 /* The service will listen to the pipe again */
174 c->service->fd = c->fd;
177 command_done(c->cmd_ctx);
179 /* delete connection */
183 if (service->max_connections != CONNECTION_LIMIT_UNLIMITED)
184 service->max_connections++;
189 /* redirect p to next list pointer */
196 static void free_service(struct service *c)
203 int add_service(char *name,
206 new_connection_handler_t new_connection_handler,
207 input_handler_t input_handler,
208 connection_closed_handler_t connection_closed_handler,
211 struct service *c, **p;
213 int so_reuseaddr_option = 1;
215 c = malloc(sizeof(struct service));
217 c->name = strdup(name);
218 c->port = strdup(port);
219 c->max_connections = 1; /* Only TCP/IP ports can support more than one connection */
221 c->connections = NULL;
222 c->new_connection = new_connection_handler;
223 c->input = input_handler;
224 c->connection_closed = connection_closed_handler;
228 if (strcmp(c->port, "pipe") == 0)
229 c->type = CONNECTION_STDINOUT;
232 portnumber = strtol(c->port, &end, 0);
233 if (!*end && (parse_long(c->port, &portnumber) == ERROR_OK)) {
234 c->portnumber = portnumber;
235 c->type = CONNECTION_TCP;
237 c->type = CONNECTION_PIPE;
240 if (c->type == CONNECTION_TCP) {
241 c->max_connections = max_connections;
243 c->fd = socket(AF_INET, SOCK_STREAM, 0);
245 LOG_ERROR("error creating socket: %s", strerror(errno));
253 (void *)&so_reuseaddr_option,
256 socket_nonblock(c->fd);
258 memset(&c->sin, 0, sizeof(c->sin));
259 c->sin.sin_family = AF_INET;
261 if (bindto_name == NULL)
262 c->sin.sin_addr.s_addr = INADDR_ANY;
264 hp = gethostbyname(bindto_name);
266 LOG_ERROR("couldn't resolve bindto address: %s", bindto_name);
271 memcpy(&c->sin.sin_addr, hp->h_addr_list[0], hp->h_length);
273 c->sin.sin_port = htons(c->portnumber);
275 if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1) {
276 LOG_ERROR("couldn't bind %s to socket on port %d: %s", name, c->portnumber, strerror(errno));
284 setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
286 int window_size = 128 * 1024;
288 /* These setsockopt()s must happen before the listen() */
290 setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
291 (char *)&window_size, sizeof(window_size));
292 setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
293 (char *)&window_size, sizeof(window_size));
295 if (listen(c->fd, 1) == -1) {
296 LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
302 struct sockaddr_in addr_in;
303 addr_in.sin_port = 0;
304 socklen_t addr_in_size = sizeof(addr_in);
305 if (getsockname(c->fd, (struct sockaddr *)&addr_in, &addr_in_size) == 0)
306 LOG_INFO("Listening on port %hu for %s connections",
307 ntohs(addr_in.sin_port), name);
308 } else if (c->type == CONNECTION_STDINOUT) {
309 c->fd = fileno(stdin);
312 /* for win32 set stdin/stdout to binary mode */
313 if (_setmode(_fileno(stdout), _O_BINARY) < 0)
314 LOG_WARNING("cannot change stdout mode to binary");
315 if (_setmode(_fileno(stdin), _O_BINARY) < 0)
316 LOG_WARNING("cannot change stdin mode to binary");
317 if (_setmode(_fileno(stderr), _O_BINARY) < 0)
318 LOG_WARNING("cannot change stderr mode to binary");
320 socket_nonblock(c->fd);
322 } else if (c->type == CONNECTION_PIPE) {
324 /* we currenty do not support named pipes under win32
325 * so exit openocd for now */
326 LOG_ERROR("Named pipes currently not supported under this os");
330 /* Pipe we're reading from */
331 c->fd = open(c->port, O_RDONLY | O_NONBLOCK);
333 LOG_ERROR("could not open %s", c->port);
340 /* add to the end of linked list */
341 for (p = &services; *p; p = &(*p)->next)
348 static int remove_services(void)
350 struct service *c = services;
354 struct service *next = c->next;
359 if (c->type == CONNECTION_PIPE) {
372 /* remember the last service for unlinking */
381 int server_loop(struct command_context *command_context)
383 struct service *service;
387 /* used in select() */
391 /* used in accept() */
395 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
396 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
399 while (!shutdown_openocd) {
400 /* monitor sockets for activity */
404 /* add service and connection fds to read_fds */
405 for (service = services; service; service = service->next) {
406 if (service->fd != -1) {
407 /* listen for new connections */
408 FD_SET(service->fd, &read_fds);
410 if (service->fd > fd_max)
411 fd_max = service->fd;
414 if (service->connections) {
415 struct connection *c;
417 for (c = service->connections; c; c = c->next) {
418 /* check for activity on the connection */
419 FD_SET(c->fd, &read_fds);
429 /* we're just polling this iteration, this is faster on embedded
432 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
434 /* Every 100ms, can be changed with "poll_period" command */
435 tv.tv_usec = polling_period * 1000;
436 /* Only while we're sleeping we'll let others run */
437 openocd_sleep_prelude();
439 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
440 openocd_sleep_postlude();
446 errno = WSAGetLastError();
448 if (errno == WSAEINTR)
451 LOG_ERROR("error during select: %s", strerror(errno));
459 LOG_ERROR("error during select: %s", strerror(errno));
466 /* We only execute these callbacks when there was nothing to do or we timed
468 target_call_timer_callbacks();
469 process_jim_events(command_context);
471 FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
473 /* We timed out/there was nothing to do, timeout rather than poll next time
477 /* There was something to do, next time we'll just poll */
481 /* This is a simple back-off algorithm where we immediately
482 * re-poll if we did something this time around.
484 * This greatly improves performance of DCC.
486 poll_ok = poll_ok || target_got_message();
488 for (service = services; service; service = service->next) {
489 /* handle new connections on listeners */
490 if ((service->fd != -1)
491 && (FD_ISSET(service->fd, &read_fds))) {
492 if (service->max_connections != 0)
493 add_connection(service, command_context);
495 if (service->type == CONNECTION_TCP) {
496 struct sockaddr_in sin;
497 socklen_t address_size = sizeof(sin);
499 tmp_fd = accept(service->fd,
500 (struct sockaddr *)&service->sin,
502 close_socket(tmp_fd);
505 "rejected '%s' connection, no more connections allowed",
510 /* handle activity on connections */
511 if (service->connections) {
512 struct connection *c;
514 for (c = service->connections; c; ) {
515 if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending) {
516 retval = service->input(c);
517 if (retval != ERROR_OK) {
518 struct connection *next = c->next;
519 if (service->type == CONNECTION_PIPE ||
520 service->type == CONNECTION_STDINOUT) {
521 /* if connection uses a pipe then
522 * shutdown openocd on error */
523 shutdown_openocd = 1;
525 remove_connection(service, c);
526 LOG_INFO("dropped '%s' connection",
539 while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
540 if (msg.message == WM_QUIT)
541 shutdown_openocd = 1;
546 return shutdown_openocd != 2 ? ERROR_OK : ERROR_FAIL;
550 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
552 shutdown_openocd = 1;
557 void sig_handler(int sig)
559 /* store only first signal that hits us */
562 shutdown_openocd = 1;
565 int server_preinit(void)
567 /* this currently only calls WSAStartup on native win32 systems
568 * before any socket operations are performed.
569 * This is an issue if you call init in your config script */
572 WORD wVersionRequested;
575 wVersionRequested = MAKEWORD(2, 2);
577 if (WSAStartup(wVersionRequested, &wsaData) != 0) {
578 LOG_ERROR("Failed to Open Winsock");
582 /* register ctrl-c handler */
583 SetConsoleCtrlHandler(ControlHandler, TRUE);
585 signal(SIGBREAK, sig_handler);
587 signal(SIGINT, sig_handler);
588 signal(SIGTERM, sig_handler);
589 signal(SIGABRT, sig_handler);
594 int server_init(struct command_context *cmd_ctx)
596 int ret = tcl_init();
601 ret = telnet_init("Open On-Chip Debugger");
603 if (ret != ERROR_OK) {
611 int server_quit(void)
618 SetConsoleCtrlHandler(ControlHandler, FALSE);
623 /* return signal number so we can kill ourselves */
627 void exit_on_signal(int sig)
630 /* bring back default system handler and kill yourself */
631 signal(sig, SIG_DFL);
636 int connection_write(struct connection *connection, const void *data, int len)
639 /* successful no-op. Sockets and pipes behave differently here... */
642 if (connection->service->type == CONNECTION_TCP)
643 return write_socket(connection->fd_out, data, len);
645 return write(connection->fd_out, data, len);
648 int connection_read(struct connection *connection, void *data, int len)
650 if (connection->service->type == CONNECTION_TCP)
651 return read_socket(connection->fd, data, len);
653 return read(connection->fd, data, len);
656 /* tell the server we want to shut down */
657 COMMAND_HANDLER(handle_shutdown_command)
659 LOG_USER("shutdown command invoked");
661 shutdown_openocd = 1;
664 if (!strcmp(CMD_ARGV[0], "error")) {
665 shutdown_openocd = 2;
670 return ERROR_COMMAND_CLOSE_CONNECTION;
673 COMMAND_HANDLER(handle_poll_period_command)
676 LOG_WARNING("You need to set a period value");
678 COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], polling_period);
680 LOG_INFO("set servers polling period to %ums", polling_period);
685 COMMAND_HANDLER(handle_bindto_command)
689 command_print(CMD_CTX, "bindto name: %s", bindto_name);
693 bindto_name = strdup(CMD_ARGV[0]);
696 return ERROR_COMMAND_SYNTAX_ERROR;
701 static const struct command_registration server_command_handlers[] = {
704 .handler = &handle_shutdown_command,
707 .help = "shut the server down",
710 .name = "poll_period",
711 .handler = &handle_poll_period_command,
714 .help = "set the servers polling period",
718 .handler = &handle_bindto_command,
721 .help = "Specify address by name on which to listen for "
722 "incoming TCP/IP connections",
724 COMMAND_REGISTRATION_DONE
727 int server_register_commands(struct command_context *cmd_ctx)
729 int retval = telnet_register_commands(cmd_ctx);
730 if (ERROR_OK != retval)
733 retval = tcl_register_commands(cmd_ctx);
734 if (ERROR_OK != retval)
737 retval = jsp_register_commands(cmd_ctx);
738 if (ERROR_OK != retval)
741 return register_commands(cmd_ctx, NULL, server_command_handlers);
744 COMMAND_HELPER(server_port_command, unsigned short *out)
748 command_print(CMD_CTX, "%d", *out);
753 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port);
758 return ERROR_COMMAND_SYNTAX_ERROR;
763 COMMAND_HELPER(server_pipe_command, char **out)
767 command_print(CMD_CTX, "%s", *out);
771 if (CMD_CTX->mode == COMMAND_EXEC) {
772 LOG_WARNING("unable to change server port after init");
773 return ERROR_COMMAND_ARGUMENT_INVALID;
776 *out = strdup(CMD_ARGV[0]);
780 return ERROR_COMMAND_SYNTAX_ERROR;