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>
32 #include <target/target_request.h>
34 #include "tcl_server.h"
35 #include "telnet_server.h"
40 #include <netinet/tcp.h>
44 static struct service
*services
= NULL
;
46 /* shutdown_openocd == 1: exit the main event loop, and quit the debugger */
47 static int shutdown_openocd
= 0;
49 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
51 socklen_t address_size
;
52 struct connection
*c
, **p
;
56 c
= malloc(sizeof(struct connection
));
59 memset(&c
->sin
, 0, sizeof(c
->sin
));
60 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
66 if (service
->type
== CONNECTION_TCP
)
68 address_size
= sizeof(c
->sin
);
70 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.
76 * Ignore errors from this fn as it probably just means less performance
78 setsockopt(c
->fd
, /* socket affected */
79 IPPROTO_TCP
, /* set option at TCP level */
80 TCP_NODELAY
, /* name of option */
81 (char *)&flag
, /* the cast is historical cruft */
82 sizeof(int)); /* length of option value */
84 LOG_INFO("accepting '%s' connection from %s", service
->name
, service
->port
);
85 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
88 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
92 } else if (service
->type
== CONNECTION_STDINOUT
)
95 c
->fd_out
= fileno(stdout
);
98 /* we are using stdin/out so ignore ctrl-c under windoze */
99 SetConsoleCtrlHandler(NULL
, TRUE
);
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
);
112 } else if (service
->type
== CONNECTION_PIPE
)
115 /* do not check for new connections again on stdin */
118 char * out_file
= alloc_printf("%so", service
->port
);
119 c
->fd_out
= open(out_file
, O_WRONLY
);
123 LOG_ERROR("could not open %s", service
->port
);
127 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
128 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
130 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
136 /* add to the end of linked list */
137 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
);
140 service
->max_connections
--;
145 static int remove_connection(struct service
*service
, struct connection
*connection
)
147 struct connection
**p
= &service
->connections
;
148 struct connection
*c
;
150 /* find connection */
153 if (c
->fd
== connection
->fd
)
155 service
->connection_closed(c
);
156 if (service
->type
== CONNECTION_TCP
)
159 } else if (service
->type
== CONNECTION_PIPE
)
161 /* The service will listen to the pipe again */
162 c
->service
->fd
= c
->fd
;
165 command_done(c
->cmd_ctx
);
167 /* delete connection */
171 service
->max_connections
++;
175 /* redirect p to next list pointer */
182 /* FIX! make service return error instead of invoking exit() */
183 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
)
185 struct service
*c
, **p
;
186 int so_reuseaddr_option
= 1;
188 c
= malloc(sizeof(struct service
));
190 c
->name
= strdup(name
);
191 c
->port
= strdup(port
);
192 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
194 c
->connections
= NULL
;
195 c
->new_connection
= new_connection_handler
;
196 c
->input
= input_handler
;
197 c
->connection_closed
= connection_closed_handler
;
201 if (strcmp(c
->port
, "pipe") == 0)
203 c
->type
= CONNECTION_STDINOUT
;
207 portnumber
= strtol(c
->port
, &end
, 0);
208 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
))
210 c
->portnumber
= portnumber
;
211 c
->type
= CONNECTION_TCP
;
214 c
->type
= CONNECTION_PIPE
;
218 if (c
->type
== CONNECTION_TCP
)
220 c
->max_connections
= max_connections
;
222 if ((c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0)) == -1)
224 LOG_ERROR("error creating socket: %s", strerror(errno
));
228 setsockopt(c
->fd
, SOL_SOCKET
, SO_REUSEADDR
, (void*)&so_reuseaddr_option
, sizeof(int));
230 socket_nonblock(c
->fd
);
232 memset(&c
->sin
, 0, sizeof(c
->sin
));
233 c
->sin
.sin_family
= AF_INET
;
234 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
235 c
->sin
.sin_port
= htons(c
->portnumber
);
237 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1)
239 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
245 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
247 int window_size
= 128 * 1024;
249 /* These setsockopt()s must happen before the listen() */
251 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
252 (char *)&window_size
, sizeof(window_size
));
253 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
254 (char *)&window_size
, sizeof(window_size
));
256 if (listen(c
->fd
, 1) == -1)
258 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
262 else if (c
->type
== CONNECTION_STDINOUT
)
264 c
->fd
= fileno(stdin
);
267 /* for win32 set stdin/stdout to binary mode */
268 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
269 LOG_WARNING("cannot change stdout mode to binary");
270 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
271 LOG_WARNING("cannot change stdin mode to binary");
272 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
273 LOG_WARNING("cannot change stderr mode to binary");
275 socket_nonblock(c
->fd
);
278 else if (c
->type
== CONNECTION_PIPE
)
281 /* we currenty do not support named pipes under win32
282 * so exit openocd for now */
283 LOG_ERROR("Named pipes currently not supported under this os");
286 /* Pipe we're reading from */
287 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
290 LOG_ERROR("could not open %s", c
->port
);
296 /* add to the end of linked list */
297 for (p
= &services
; *p
; p
= &(*p
)->next
);
303 static int remove_services(void)
305 struct service
*c
= services
;
310 struct service
*next
= c
->next
;
313 free((void *)c
->name
);
315 if (c
->type
== CONNECTION_PIPE
)
321 free((void *)c
->port
);
329 /* remember the last service for unlinking */
338 int server_loop(struct command_context
*command_context
)
340 struct service
*service
;
344 /* used in select() */
348 /* used in accept() */
352 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
353 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
356 while (!shutdown_openocd
)
358 /* monitor sockets for activity */
362 /* add service and connection fds to read_fds */
363 for (service
= services
; service
; service
= service
->next
)
365 if (service
->fd
!= -1)
367 /* listen for new connections */
368 FD_SET(service
->fd
, &read_fds
);
370 if (service
->fd
> fd_max
)
371 fd_max
= service
->fd
;
374 if (service
->connections
)
376 struct connection
*c
;
378 for (c
= service
->connections
; c
; c
= c
->next
)
380 /* check for activity on the connection */
381 FD_SET(c
->fd
, &read_fds
);
392 /* we're just polling this iteration, this is faster on embedded
395 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
400 /* Only while we're sleeping we'll let others run */
401 openocd_sleep_prelude();
403 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
404 openocd_sleep_postlude();
411 errno
= WSAGetLastError();
413 if (errno
== WSAEINTR
)
417 LOG_ERROR("error during select: %s", strerror(errno
));
428 LOG_ERROR("error during select: %s", strerror(errno
));
436 /* We only execute these callbacks when there was nothing to do or we timed out */
437 target_call_timer_callbacks();
438 process_jim_events(command_context
);
440 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
442 /* We timed out/there was nothing to do, timeout rather than poll next time */
446 /* There was something to do, next time we'll just poll */
450 /* This is a simple back-off algorithm where we immediately
451 * re-poll if we did something this time around.
453 * This greatly improves performance of DCC.
455 poll_ok
= poll_ok
|| target_got_message();
457 for (service
= services
; service
; service
= service
->next
)
459 /* handle new connections on listeners */
460 if ((service
->fd
!= -1)
461 && (FD_ISSET(service
->fd
, &read_fds
)))
463 if (service
->max_connections
> 0)
465 add_connection(service
, command_context
);
469 if (service
->type
== CONNECTION_TCP
)
471 struct sockaddr_in sin
;
472 socklen_t address_size
= sizeof(sin
);
474 tmp_fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
475 close_socket(tmp_fd
);
477 LOG_INFO("rejected '%s' connection, no more connections allowed", service
->name
);
481 /* handle activity on connections */
482 if (service
->connections
)
484 struct connection
*c
;
486 for (c
= service
->connections
; c
;)
488 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
)
490 retval
= service
->input(c
);
491 if (retval
!= ERROR_OK
)
493 struct connection
*next
= c
->next
;
494 if (service
->type
== CONNECTION_PIPE
)
496 /* if connection uses a pipe then shutdown openocd on error */
497 shutdown_openocd
= 1;
499 remove_connection(service
, c
);
500 LOG_INFO("dropped '%s' connection", service
->name
);
512 while (PeekMessage(&msg
,NULL
,0,0,PM_REMOVE
))
514 if (msg
.message
== WM_QUIT
)
515 shutdown_openocd
= 1;
524 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
526 shutdown_openocd
= 1;
530 void sig_handler(int sig
) {
531 shutdown_openocd
= 1;
535 int server_preinit(void)
537 /* this currently only calls WSAStartup on native win32 systems
538 * before any socket operations are performed.
539 * This is an issue if you call init in your config script */
542 WORD wVersionRequested
;
545 wVersionRequested
= MAKEWORD(2, 2);
547 if (WSAStartup(wVersionRequested
, &wsaData
) != 0)
549 LOG_ERROR("Failed to Open Winsock");
553 /* register ctrl-c handler */
554 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
556 signal(SIGINT
, sig_handler
);
557 signal(SIGTERM
, sig_handler
);
558 signal(SIGBREAK
, sig_handler
);
559 signal(SIGABRT
, sig_handler
);
565 int server_init(struct command_context
*cmd_ctx
)
567 int ret
= tcl_init();
571 return telnet_init("Open On-Chip Debugger");
574 int server_quit(void)
580 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
586 int connection_write(struct connection
*connection
, const void *data
, int len
)
590 /* successful no-op. Sockets and pipes behave differently here... */
593 if (connection
->service
->type
== CONNECTION_TCP
)
595 return write_socket(connection
->fd_out
, data
, len
);
598 return write(connection
->fd_out
, data
, len
);
602 int connection_read(struct connection
*connection
, void *data
, int len
)
604 if (connection
->service
->type
== CONNECTION_TCP
)
606 return read_socket(connection
->fd
, data
, len
);
609 return read(connection
->fd
, data
, len
);
613 /* tell the server we want to shut down */
614 COMMAND_HANDLER(handle_shutdown_command
)
616 LOG_USER("shutdown command invoked");
618 shutdown_openocd
= 1;
623 static const struct command_registration server_command_handlers
[] = {
626 .handler
= &handle_shutdown_command
,
628 .help
= "shut the server down",
630 COMMAND_REGISTRATION_DONE
633 int server_register_commands(struct command_context
*cmd_ctx
)
635 int retval
= telnet_register_commands(cmd_ctx
);
636 if (ERROR_OK
!= retval
)
639 retval
= tcl_register_commands(cmd_ctx
);
640 if (ERROR_OK
!= retval
)
643 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
646 SERVER_PORT_COMMAND()
650 command_print(CMD_CTX
, "%d", *out
);
655 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
660 return ERROR_INVALID_ARGUMENTS
;
665 SERVER_PIPE_COMMAND()
669 command_print(CMD_CTX
, "%s", *out
);
673 const char * t
= strdup(CMD_ARGV
[0]);
679 return ERROR_INVALID_ARGUMENTS
;