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 ***************************************************************************/
31 #include <target/target.h>
33 #include "tcl_server.h"
34 #include "telnet_server.h"
39 #include <netinet/tcp.h>
43 struct service *services = NULL;
45 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
46 static int shutdown_openocd = 0;
48 /* set when using pipes rather than tcp */
49 int server_use_pipes = 0;
51 int add_connection(struct service *service, struct command_context *cmd_ctx)
53 socklen_t address_size;
54 struct connection *c, **p;
58 c = malloc(sizeof(struct connection));
60 memset(&c->sin, 0, sizeof(c->sin));
61 c->cmd_ctx = copy_command_context(cmd_ctx);
67 if (service->type == CONNECTION_TCP)
69 address_size = sizeof(c->sin);
71 c->fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
73 /* This increases performance dramatically for e.g. GDB load which
74 * does not have a sliding window protocol. */
75 retval = setsockopt(c->fd, /* socket affected */
76 IPPROTO_TCP, /* set option at TCP level */
77 TCP_NODELAY, /* name of option */
78 (char *)&flag, /* the cast is historical cruft */
79 sizeof(int)); /* length of option value */
81 LOG_INFO("accepting '%s' connection from %i", service->name, c->sin.sin_port);
82 if ((retval = service->new_connection(c)) != ERROR_OK)
85 LOG_ERROR("attempted '%s' connection rejected", service->name);
90 else if (service->type == CONNECTION_PIPE)
94 /* do not check for new connections again on stdin */
97 LOG_INFO("accepting '%s' connection from pipe", service->name);
98 if ((retval = service->new_connection(c)) != ERROR_OK)
100 LOG_ERROR("attempted '%s' connection rejected", service->name);
106 /* add to the end of linked list */
107 for (p = &service->connections; *p; p = &(*p)->next);
110 service->max_connections--;
115 int remove_connection(struct service *service, struct connection *connection)
117 struct connection **p = &service->connections;
118 struct connection *c;
120 /* find connection */
123 if (c->fd == connection->fd)
125 service->connection_closed(c);
126 if (service->type == CONNECTION_TCP)
128 command_done(c->cmd_ctx);
130 /* delete connection */
134 service->max_connections++;
138 /* redirect p to next list pointer */
145 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)
147 struct service *c, **p;
148 int so_reuseaddr_option = 1;
150 c = malloc(sizeof(struct service));
152 c->name = strdup(name);
155 c->max_connections = max_connections;
157 c->connections = NULL;
158 c->new_connection = new_connection_handler;
159 c->input = input_handler;
160 c->connection_closed = connection_closed_handler;
164 if (type == CONNECTION_TCP)
166 if ((c->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
168 LOG_ERROR("error creating socket: %s", strerror(errno));
172 setsockopt(c->fd, SOL_SOCKET, SO_REUSEADDR, (void*)&so_reuseaddr_option, sizeof(int));
174 socket_nonblock(c->fd);
176 memset(&c->sin, 0, sizeof(c->sin));
177 c->sin.sin_family = AF_INET;
178 c->sin.sin_addr.s_addr = INADDR_ANY;
179 c->sin.sin_port = htons(port);
181 if (bind(c->fd, (struct sockaddr *)&c->sin, sizeof(c->sin)) == -1)
183 LOG_ERROR("couldn't bind to socket: %s", strerror(errno));
189 setsockopt(c->fd, IPPROTO_TCP, TCP_MAXSEG, &segsize, sizeof(int));
191 int window_size = 128 * 1024;
193 /* These setsockopt()s must happen before the listen() */
195 setsockopt(c->fd, SOL_SOCKET, SO_SNDBUF,
196 (char *)&window_size, sizeof(window_size));
197 setsockopt(c->fd, SOL_SOCKET, SO_RCVBUF,
198 (char *)&window_size, sizeof(window_size));
200 if (listen(c->fd, 1) == -1)
202 LOG_ERROR("couldn't listen on socket: %s", strerror(errno));
206 else if (type == CONNECTION_PIPE)
209 c->fd = STDIN_FILENO;
212 /* for win32 set stdin/stdout to binary mode */
213 if (_setmode(_fileno(stdout), _O_BINARY) < 0)
214 LOG_WARNING("cannot change stdout mode to binary");
215 if (_setmode(_fileno(stdin), _O_BINARY) < 0)
216 LOG_WARNING("cannot change stdin mode to binary");
217 if (_setmode(_fileno(stderr), _O_BINARY) < 0)
218 LOG_WARNING("cannot change stderr mode to binary");
220 socket_nonblock(c->fd);
225 LOG_ERROR("unknown connection type: %d", type);
229 /* add to the end of linked list */
230 for (p = &services; *p; p = &(*p)->next);
236 int remove_service(unsigned short port)
238 struct service **p = &services;
257 /* redirect p to next list pointer */
264 int remove_services(void)
266 struct service *c = services;
271 struct service *next = c->next;
282 /* remember the last service for unlinking */
291 int server_loop(struct command_context *command_context)
293 struct service *service;
297 /* used in select() */
301 /* used in accept() */
305 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
306 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
309 while (!shutdown_openocd)
311 /* monitor sockets for activity */
315 /* add service and connection fds to read_fds */
316 for (service = services; service; service = service->next)
318 if (service->fd != -1)
320 /* listen for new connections */
321 FD_SET(service->fd, &read_fds);
323 if (service->fd > fd_max)
324 fd_max = service->fd;
327 if (service->connections)
329 struct connection *c;
331 for (c = service->connections; c; c = c->next)
333 /* check for activity on the connection */
334 FD_SET(c->fd, &read_fds);
342 #if BUILD_ECOSBOARD == 0
343 if (server_use_pipes == 0)
345 /* add STDIN to read_fds */
346 FD_SET(fileno(stdin), &read_fds);
355 /* we're just polling this iteration, this is faster on embedded
358 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
363 /* Only while we're sleeping we'll let others run */
364 openocd_sleep_prelude();
366 retval = socket_select(fd_max + 1, &read_fds, NULL, NULL, &tv);
367 openocd_sleep_postlude();
374 errno = WSAGetLastError();
376 if (errno == WSAEINTR)
380 LOG_ERROR("error during select: %s", strerror(errno));
391 LOG_ERROR("error during select: %s", strerror(errno));
399 /* We only execute these callbacks when there was nothing to do or we timed out */
400 target_call_timer_callbacks();
401 process_jim_events(command_context);
403 FD_ZERO(&read_fds); /* eCos leaves read_fds unchanged in this case! */
405 /* We timed out/there was nothing to do, timeout rather than poll next time */
409 /* There was something to do, next time we'll just poll */
413 for (service = services; service; service = service->next)
415 /* handle new connections on listeners */
416 if ((service->fd != -1)
417 && (FD_ISSET(service->fd, &read_fds)))
419 if (service->max_connections > 0)
421 add_connection(service, command_context);
425 if (service->type != CONNECTION_PIPE)
427 struct sockaddr_in sin;
428 socklen_t address_size = sizeof(sin);
430 tmp_fd = accept(service->fd, (struct sockaddr *)&service->sin, &address_size);
431 close_socket(tmp_fd);
433 LOG_INFO("rejected '%s' connection, no more connections allowed", service->name);
437 /* handle activity on connections */
438 if (service->connections)
440 struct connection *c;
442 for (c = service->connections; c;)
444 if ((FD_ISSET(c->fd, &read_fds)) || c->input_pending)
446 if ((retval = service->input(c)) != ERROR_OK)
448 struct connection *next = c->next;
449 if (service->type == CONNECTION_PIPE)
451 /* if connection uses a pipe then shutdown openocd on error */
452 shutdown_openocd = 1;
454 remove_connection(service, c);
455 LOG_INFO("dropped '%s' connection - error %d", service->name, retval);
466 #if BUILD_ECOSBOARD == 0
467 /* check for data on stdin if not using pipes */
468 if (server_use_pipes == 0)
470 if (FD_ISSET(fileno(stdin), &read_fds))
472 if (getc(stdin) == 'x')
474 shutdown_openocd = 1;
481 while (PeekMessage(&msg,NULL,0,0,PM_REMOVE))
483 if (msg.message == WM_QUIT)
484 shutdown_openocd = 1;
493 BOOL WINAPI ControlHandler(DWORD dwCtrlType)
495 shutdown_openocd = 1;
499 void sig_handler(int sig) {
500 shutdown_openocd = 1;
504 int server_preinit(void)
506 /* this currently only calls WSAStartup on native win32 systems
507 * before any socket operations are performed.
508 * This is an issue if you call init in your config script */
511 WORD wVersionRequested;
514 wVersionRequested = MAKEWORD(2, 2);
516 if (WSAStartup(wVersionRequested, &wsaData) != 0)
518 LOG_ERROR("Failed to Open Winsock");
522 if (server_use_pipes == 0)
524 /* register ctrl-c handler */
525 SetConsoleCtrlHandler(ControlHandler, TRUE);
529 /* we are using pipes so ignore ctrl-c */
530 SetConsoleCtrlHandler(NULL, TRUE);
533 signal(SIGINT, sig_handler);
534 signal(SIGTERM, sig_handler);
535 signal(SIGBREAK, sig_handler);
536 signal(SIGABRT, sig_handler);
542 int server_init(struct command_context *cmd_ctx)
544 int ret = tcl_init(cmd_ctx);
548 return telnet_init("Open On-Chip Debugger");
551 int server_quit(void)
557 SetConsoleCtrlHandler(ControlHandler, FALSE);
563 /* tell the server we want to shut down */
564 COMMAND_HANDLER(handle_shutdown_command)
566 shutdown_openocd = 1;
568 return ERROR_COMMAND_CLOSE_CONNECTION;
571 static const struct command_registration server_command_handlers[] = {
574 .handler = &handle_shutdown_command,
576 .help = "shut the server down",
578 COMMAND_REGISTRATION_DONE
581 int server_register_commands(struct command_context *cmd_ctx)
583 int retval = telnet_register_commands(cmd_ctx);
584 if (ERROR_OK != retval)
587 retval = tcl_register_commands(cmd_ctx);
588 if (ERROR_OK != retval)
591 return register_commands(cmd_ctx, NULL, server_command_handlers);
594 SERVER_PORT_COMMAND()
598 command_print(CMD_CTX, "%d", *out);
603 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port);
608 return ERROR_INVALID_ARGUMENTS;