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. */
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 %s", service
->name
, service
->port
);
82 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
85 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
89 } else if (service
->type
== CONNECTION_STDINOUT
)
92 c
->fd_out
= fileno(stdout
);
95 /* we are using stdin/out so ignore ctrl-c under windoze */
96 SetConsoleCtrlHandler(NULL
, TRUE
);
99 /* do not check for new connections again on stdin */
102 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
103 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
105 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
109 } else if (service
->type
== CONNECTION_PIPE
)
112 /* do not check for new connections again on stdin */
115 char * out_file
= alloc_printf("%so", service
->port
);
116 c
->fd_out
= open(out_file
, O_WRONLY
);
120 LOG_ERROR("could not open %s", service
->port
);
124 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
125 if ((retval
= service
->new_connection(c
)) != ERROR_OK
)
127 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
133 /* add to the end of linked list */
134 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
);
137 service
->max_connections
--;
142 static int remove_connection(struct service
*service
, struct connection
*connection
)
144 struct connection
**p
= &service
->connections
;
145 struct connection
*c
;
147 /* find connection */
150 if (c
->fd
== connection
->fd
)
152 service
->connection_closed(c
);
153 if (service
->type
== CONNECTION_TCP
)
156 } else if (service
->type
== CONNECTION_PIPE
)
158 /* The service will listen to the pipe again */
159 c
->service
->fd
= c
->fd
;
162 command_done(c
->cmd_ctx
);
164 /* delete connection */
168 service
->max_connections
++;
172 /* redirect p to next list pointer */
179 /* FIX! make service return error instead of invoking exit() */
180 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
)
182 struct service
*c
, **p
;
183 int so_reuseaddr_option
= 1;
185 c
= malloc(sizeof(struct service
));
187 c
->name
= strdup(name
);
188 c
->port
= strdup(port
);
189 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
191 c
->connections
= NULL
;
192 c
->new_connection
= new_connection_handler
;
193 c
->input
= input_handler
;
194 c
->connection_closed
= connection_closed_handler
;
198 if (strcmp(c
->port
, "pipe") == 0)
200 c
->type
= CONNECTION_STDINOUT
;
204 portnumber
= strtol(c
->port
, &end
, 0);
205 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
))
207 c
->portnumber
= portnumber
;
208 c
->type
= CONNECTION_TCP
;
211 c
->type
= CONNECTION_PIPE
;
215 if (c
->type
== CONNECTION_TCP
)
217 c
->max_connections
= max_connections
;
219 if ((c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0)) == -1)
221 LOG_ERROR("error creating socket: %s", strerror(errno
));
225 setsockopt(c
->fd
, SOL_SOCKET
, SO_REUSEADDR
, (void*)&so_reuseaddr_option
, sizeof(int));
227 socket_nonblock(c
->fd
);
229 memset(&c
->sin
, 0, sizeof(c
->sin
));
230 c
->sin
.sin_family
= AF_INET
;
231 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
232 c
->sin
.sin_port
= htons(c
->portnumber
);
234 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1)
236 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
242 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
244 int window_size
= 128 * 1024;
246 /* These setsockopt()s must happen before the listen() */
248 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
249 (char *)&window_size
, sizeof(window_size
));
250 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
251 (char *)&window_size
, sizeof(window_size
));
253 if (listen(c
->fd
, 1) == -1)
255 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
259 else if (c
->type
== CONNECTION_STDINOUT
)
261 c
->fd
= fileno(stdin
);
264 /* for win32 set stdin/stdout to binary mode */
265 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
266 LOG_WARNING("cannot change stdout mode to binary");
267 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
268 LOG_WARNING("cannot change stdin mode to binary");
269 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
270 LOG_WARNING("cannot change stderr mode to binary");
272 socket_nonblock(c
->fd
);
275 else if (c
->type
== CONNECTION_PIPE
)
278 /* we currenty do not support named pipes under win32
279 * so exit openocd for now */
280 LOG_ERROR("Named pipes currently not supported under this os");
283 /* Pipe we're reading from */
284 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
287 LOG_ERROR("could not open %s", c
->port
);
293 /* add to the end of linked list */
294 for (p
= &services
; *p
; p
= &(*p
)->next
);
300 static int remove_services(void)
302 struct service
*c
= services
;
307 struct service
*next
= c
->next
;
310 free((void *)c
->name
);
312 if (c
->type
== CONNECTION_PIPE
)
318 free((void *)c
->port
);
326 /* remember the last service for unlinking */
335 int server_loop(struct command_context
*command_context
)
337 struct service
*service
;
341 /* used in select() */
345 /* used in accept() */
349 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
350 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
353 while (!shutdown_openocd
)
355 /* monitor sockets for activity */
359 /* add service and connection fds to read_fds */
360 for (service
= services
; service
; service
= service
->next
)
362 if (service
->fd
!= -1)
364 /* listen for new connections */
365 FD_SET(service
->fd
, &read_fds
);
367 if (service
->fd
> fd_max
)
368 fd_max
= service
->fd
;
371 if (service
->connections
)
373 struct connection
*c
;
375 for (c
= service
->connections
; c
; c
= c
->next
)
377 /* check for activity on the connection */
378 FD_SET(c
->fd
, &read_fds
);
389 /* we're just polling this iteration, this is faster on embedded
392 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
397 /* Only while we're sleeping we'll let others run */
398 openocd_sleep_prelude();
400 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
401 openocd_sleep_postlude();
408 errno
= WSAGetLastError();
410 if (errno
== WSAEINTR
)
414 LOG_ERROR("error during select: %s", strerror(errno
));
425 LOG_ERROR("error during select: %s", strerror(errno
));
433 /* We only execute these callbacks when there was nothing to do or we timed out */
434 target_call_timer_callbacks();
435 process_jim_events(command_context
);
437 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
439 /* We timed out/there was nothing to do, timeout rather than poll next time */
443 /* There was something to do, next time we'll just poll */
447 /* This is a simple back-off algorithm where we immediately
448 * re-poll if we did something this time around.
450 * This greatly improves performance of DCC.
452 poll_ok
= poll_ok
|| target_got_message();
454 for (service
= services
; service
; service
= service
->next
)
456 /* handle new connections on listeners */
457 if ((service
->fd
!= -1)
458 && (FD_ISSET(service
->fd
, &read_fds
)))
460 if (service
->max_connections
> 0)
462 add_connection(service
, command_context
);
466 if (service
->type
== CONNECTION_TCP
)
468 struct sockaddr_in sin
;
469 socklen_t address_size
= sizeof(sin
);
471 tmp_fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
472 close_socket(tmp_fd
);
474 LOG_INFO("rejected '%s' connection, no more connections allowed", service
->name
);
478 /* handle activity on connections */
479 if (service
->connections
)
481 struct connection
*c
;
483 for (c
= service
->connections
; c
;)
485 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
)
487 if ((retval
= service
->input(c
)) != ERROR_OK
)
489 struct connection
*next
= c
->next
;
490 if (service
->type
== CONNECTION_PIPE
)
492 /* if connection uses a pipe then shutdown openocd on error */
493 shutdown_openocd
= 1;
495 remove_connection(service
, c
);
496 LOG_INFO("dropped '%s' connection", service
->name
);
508 while (PeekMessage(&msg
,NULL
,0,0,PM_REMOVE
))
510 if (msg
.message
== WM_QUIT
)
511 shutdown_openocd
= 1;
520 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
522 shutdown_openocd
= 1;
526 void sig_handler(int sig
) {
527 shutdown_openocd
= 1;
531 int server_preinit(void)
533 /* this currently only calls WSAStartup on native win32 systems
534 * before any socket operations are performed.
535 * This is an issue if you call init in your config script */
538 WORD wVersionRequested
;
541 wVersionRequested
= MAKEWORD(2, 2);
543 if (WSAStartup(wVersionRequested
, &wsaData
) != 0)
545 LOG_ERROR("Failed to Open Winsock");
549 /* register ctrl-c handler */
550 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
552 signal(SIGINT
, sig_handler
);
553 signal(SIGTERM
, sig_handler
);
554 signal(SIGBREAK
, sig_handler
);
555 signal(SIGABRT
, sig_handler
);
561 int server_init(struct command_context
*cmd_ctx
)
563 int ret
= tcl_init();
567 return telnet_init("Open On-Chip Debugger");
570 int server_quit(void)
576 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
582 int connection_write(struct connection
*connection
, const void *data
, int len
)
586 /* successful no-op. Sockets and pipes behave differently here... */
589 if (connection
->service
->type
== CONNECTION_TCP
)
591 return write_socket(connection
->fd_out
, data
, len
);
594 return write(connection
->fd_out
, data
, len
);
598 int connection_read(struct connection
*connection
, void *data
, int len
)
600 if (connection
->service
->type
== CONNECTION_TCP
)
602 return read_socket(connection
->fd
, data
, len
);
605 return read(connection
->fd
, data
, len
);
609 /* tell the server we want to shut down */
610 COMMAND_HANDLER(handle_shutdown_command
)
612 LOG_USER("shutdown command invoked");
614 shutdown_openocd
= 1;
619 static const struct command_registration server_command_handlers
[] = {
622 .handler
= &handle_shutdown_command
,
624 .help
= "shut the server down",
626 COMMAND_REGISTRATION_DONE
629 int server_register_commands(struct command_context
*cmd_ctx
)
631 int retval
= telnet_register_commands(cmd_ctx
);
632 if (ERROR_OK
!= retval
)
635 retval
= tcl_register_commands(cmd_ctx
);
636 if (ERROR_OK
!= retval
)
639 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
642 SERVER_PORT_COMMAND()
646 command_print(CMD_CTX
, "%d", *out
);
651 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
656 return ERROR_INVALID_ARGUMENTS
;
661 SERVER_PIPE_COMMAND()
665 command_print(CMD_CTX
, "%s", *out
);
669 const char * t
= strdup(CMD_ARGV
[0]);
675 return ERROR_INVALID_ARGUMENTS
;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)