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 enum shutdown_reason
{
50 CONTINUE_MAIN_LOOP
, /* stay in main event loop */
51 SHUTDOWN_REQUESTED
, /* set by shutdown command; exit the event loop and quit the debugger */
52 SHUTDOWN_WITH_ERROR_CODE
, /* set by shutdown command; quit with non-zero return code */
53 SHUTDOWN_WITH_SIGNAL_CODE
/* set by sig_handler; exec shutdown then exit with signal as return code */
55 static enum shutdown_reason shutdown_openocd
= CONTINUE_MAIN_LOOP
;
57 /* store received signal to exit application by killing ourselves */
58 static int last_signal
;
60 /* set the polling period to 100ms */
61 static int polling_period
= 100;
63 /* address by name on which to listen for incoming TCP/IP connections */
64 static char *bindto_name
;
66 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
68 socklen_t address_size
;
69 struct connection
*c
, **p
;
73 c
= malloc(sizeof(struct connection
));
76 memset(&c
->sin
, 0, sizeof(c
->sin
));
77 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
79 c
->input_pending
= false;
83 if (service
->type
== CONNECTION_TCP
) {
84 address_size
= sizeof(c
->sin
);
86 c
->fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
89 /* This increases performance dramatically for e.g. GDB load which
90 * does not have a sliding window protocol.
92 * Ignore errors from this fn as it probably just means less performance
94 setsockopt(c
->fd
, /* socket affected */
95 IPPROTO_TCP
, /* set option at TCP level */
96 TCP_NODELAY
, /* name of option */
97 (char *)&flag
, /* the cast is historical cruft */
98 sizeof(int)); /* length of option value */
100 LOG_INFO("accepting '%s' connection on tcp/%s", service
->name
, service
->port
);
101 retval
= service
->new_connection(c
);
102 if (retval
!= ERROR_OK
) {
104 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
105 command_done(c
->cmd_ctx
);
109 } else if (service
->type
== CONNECTION_STDINOUT
) {
111 c
->fd_out
= fileno(stdout
);
114 /* we are using stdin/out so ignore ctrl-c under windoze */
115 SetConsoleCtrlHandler(NULL
, TRUE
);
118 /* do not check for new connections again on stdin */
121 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
122 retval
= service
->new_connection(c
);
123 if (retval
!= ERROR_OK
) {
124 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
125 command_done(c
->cmd_ctx
);
129 } else if (service
->type
== CONNECTION_PIPE
) {
131 /* do not check for new connections again on stdin */
134 char *out_file
= alloc_printf("%so", service
->port
);
135 c
->fd_out
= open(out_file
, O_WRONLY
);
137 if (c
->fd_out
== -1) {
138 LOG_ERROR("could not open %s", service
->port
);
139 command_done(c
->cmd_ctx
);
144 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
145 retval
= service
->new_connection(c
);
146 if (retval
!= ERROR_OK
) {
147 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
148 command_done(c
->cmd_ctx
);
154 /* add to the end of linked list */
155 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
)
159 if (service
->max_connections
!= CONNECTION_LIMIT_UNLIMITED
)
160 service
->max_connections
--;
165 static int remove_connection(struct service
*service
, struct connection
*connection
)
167 struct connection
**p
= &service
->connections
;
168 struct connection
*c
;
170 /* find connection */
172 if (c
->fd
== connection
->fd
) {
173 service
->connection_closed(c
);
174 if (service
->type
== CONNECTION_TCP
)
176 else if (service
->type
== CONNECTION_PIPE
) {
177 /* The service will listen to the pipe again */
178 c
->service
->fd
= c
->fd
;
181 command_done(c
->cmd_ctx
);
183 /* delete connection */
187 if (service
->max_connections
!= CONNECTION_LIMIT_UNLIMITED
)
188 service
->max_connections
++;
193 /* redirect p to next list pointer */
200 static void free_service(struct service
*c
)
207 int add_service(char *name
,
210 new_connection_handler_t new_connection_handler
,
211 input_handler_t input_handler
,
212 connection_closed_handler_t connection_closed_handler
,
215 struct service
*c
, **p
;
217 int so_reuseaddr_option
= 1;
219 c
= malloc(sizeof(struct service
));
221 c
->name
= strdup(name
);
222 c
->port
= strdup(port
);
223 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
225 c
->connections
= NULL
;
226 c
->new_connection
= new_connection_handler
;
227 c
->input
= input_handler
;
228 c
->connection_closed
= connection_closed_handler
;
232 if (strcmp(c
->port
, "pipe") == 0)
233 c
->type
= CONNECTION_STDINOUT
;
236 portnumber
= strtol(c
->port
, &end
, 0);
237 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
)) {
238 c
->portnumber
= portnumber
;
239 c
->type
= CONNECTION_TCP
;
241 c
->type
= CONNECTION_PIPE
;
244 if (c
->type
== CONNECTION_TCP
) {
245 c
->max_connections
= max_connections
;
247 c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0);
249 LOG_ERROR("error creating socket: %s", strerror(errno
));
257 (void *)&so_reuseaddr_option
,
260 socket_nonblock(c
->fd
);
262 memset(&c
->sin
, 0, sizeof(c
->sin
));
263 c
->sin
.sin_family
= AF_INET
;
265 if (bindto_name
== NULL
)
266 c
->sin
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
268 hp
= gethostbyname(bindto_name
);
270 LOG_ERROR("couldn't resolve bindto address: %s", bindto_name
);
275 memcpy(&c
->sin
.sin_addr
, hp
->h_addr_list
[0], hp
->h_length
);
277 c
->sin
.sin_port
= htons(c
->portnumber
);
279 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1) {
280 LOG_ERROR("couldn't bind %s to socket on port %d: %s", name
, c
->portnumber
, strerror(errno
));
288 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
290 int window_size
= 128 * 1024;
292 /* These setsockopt()s must happen before the listen() */
294 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
295 (char *)&window_size
, sizeof(window_size
));
296 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
297 (char *)&window_size
, sizeof(window_size
));
299 if (listen(c
->fd
, 1) == -1) {
300 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
306 struct sockaddr_in addr_in
;
307 addr_in
.sin_port
= 0;
308 socklen_t addr_in_size
= sizeof(addr_in
);
309 if (getsockname(c
->fd
, (struct sockaddr
*)&addr_in
, &addr_in_size
) == 0)
310 LOG_INFO("Listening on port %hu for %s connections",
311 ntohs(addr_in
.sin_port
), name
);
312 } else if (c
->type
== CONNECTION_STDINOUT
) {
313 c
->fd
= fileno(stdin
);
316 /* for win32 set stdin/stdout to binary mode */
317 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
318 LOG_WARNING("cannot change stdout mode to binary");
319 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
320 LOG_WARNING("cannot change stdin mode to binary");
321 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
322 LOG_WARNING("cannot change stderr mode to binary");
324 socket_nonblock(c
->fd
);
326 } else if (c
->type
== CONNECTION_PIPE
) {
328 /* we currently do not support named pipes under win32
329 * so exit openocd for now */
330 LOG_ERROR("Named pipes currently not supported under this os");
334 /* Pipe we're reading from */
335 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
337 LOG_ERROR("could not open %s", c
->port
);
344 /* add to the end of linked list */
345 for (p
= &services
; *p
; p
= &(*p
)->next
)
352 static void remove_connections(struct service
*service
)
354 struct connection
*connection
;
356 connection
= service
->connections
;
359 struct connection
*tmp
;
361 tmp
= connection
->next
;
362 remove_connection(service
, connection
);
367 int remove_service(const char *name
, const char *port
)
370 struct service
*prev
;
374 for (tmp
= services
; tmp
; prev
= tmp
, tmp
= tmp
->next
) {
375 if (!strcmp(tmp
->name
, name
) && !strcmp(tmp
->port
, port
)) {
376 remove_connections(tmp
);
379 services
= tmp
->next
;
381 prev
->next
= tmp
->next
;
383 if (tmp
->type
!= CONNECTION_STDINOUT
)
384 close_socket(tmp
->fd
);
396 static int remove_services(void)
398 struct service
*c
= services
;
402 struct service
*next
= c
->next
;
404 remove_connections(c
);
408 if (c
->type
== CONNECTION_PIPE
) {
417 /* remember the last service for unlinking */
426 int server_loop(struct command_context
*command_context
)
428 struct service
*service
;
432 /* used in select() */
436 /* used in accept() */
440 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
441 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
444 while (shutdown_openocd
== CONTINUE_MAIN_LOOP
) {
445 /* monitor sockets for activity */
449 /* add service and connection fds to read_fds */
450 for (service
= services
; service
; service
= service
->next
) {
451 if (service
->fd
!= -1) {
452 /* listen for new connections */
453 FD_SET(service
->fd
, &read_fds
);
455 if (service
->fd
> fd_max
)
456 fd_max
= service
->fd
;
459 if (service
->connections
) {
460 struct connection
*c
;
462 for (c
= service
->connections
; c
; c
= c
->next
) {
463 /* check for activity on the connection */
464 FD_SET(c
->fd
, &read_fds
);
474 /* we're just polling this iteration, this is faster on embedded
477 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
479 /* Every 100ms, can be changed with "poll_period" command */
480 tv
.tv_usec
= polling_period
* 1000;
481 /* Only while we're sleeping we'll let others run */
482 openocd_sleep_prelude();
484 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
485 openocd_sleep_postlude();
491 errno
= WSAGetLastError();
493 if (errno
== WSAEINTR
)
496 LOG_ERROR("error during select: %s", strerror(errno
));
504 LOG_ERROR("error during select: %s", strerror(errno
));
511 /* We only execute these callbacks when there was nothing to do or we timed
513 target_call_timer_callbacks();
514 process_jim_events(command_context
);
516 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
518 /* We timed out/there was nothing to do, timeout rather than poll next time
522 /* There was something to do, next time we'll just poll */
526 /* This is a simple back-off algorithm where we immediately
527 * re-poll if we did something this time around.
529 * This greatly improves performance of DCC.
531 poll_ok
= poll_ok
|| target_got_message();
533 for (service
= services
; service
; service
= service
->next
) {
534 /* handle new connections on listeners */
535 if ((service
->fd
!= -1)
536 && (FD_ISSET(service
->fd
, &read_fds
))) {
537 if (service
->max_connections
!= 0)
538 add_connection(service
, command_context
);
540 if (service
->type
== CONNECTION_TCP
) {
541 struct sockaddr_in sin
;
542 socklen_t address_size
= sizeof(sin
);
544 tmp_fd
= accept(service
->fd
,
545 (struct sockaddr
*)&service
->sin
,
547 close_socket(tmp_fd
);
550 "rejected '%s' connection, no more connections allowed",
555 /* handle activity on connections */
556 if (service
->connections
) {
557 struct connection
*c
;
559 for (c
= service
->connections
; c
; ) {
560 if ((c
->fd
>= 0 && FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
) {
561 retval
= service
->input(c
);
562 if (retval
!= ERROR_OK
) {
563 struct connection
*next
= c
->next
;
564 if (service
->type
== CONNECTION_PIPE
||
565 service
->type
== CONNECTION_STDINOUT
) {
566 /* if connection uses a pipe then
567 * shutdown openocd on error */
568 shutdown_openocd
= SHUTDOWN_REQUESTED
;
570 remove_connection(service
, c
);
571 LOG_INFO("dropped '%s' connection",
584 while (PeekMessage(&msg
, NULL
, 0, 0, PM_REMOVE
)) {
585 if (msg
.message
== WM_QUIT
)
586 shutdown_openocd
= SHUTDOWN_WITH_SIGNAL_CODE
;
591 /* when quit for signal or CTRL-C, run (eventually user implemented) "shutdown" */
592 if (shutdown_openocd
== SHUTDOWN_WITH_SIGNAL_CODE
)
593 command_run_line(command_context
, "shutdown");
595 return shutdown_openocd
== SHUTDOWN_WITH_ERROR_CODE
? ERROR_FAIL
: ERROR_OK
;
598 static void sig_handler(int sig
)
600 /* store only first signal that hits us */
601 if (shutdown_openocd
== CONTINUE_MAIN_LOOP
) {
602 shutdown_openocd
= SHUTDOWN_WITH_SIGNAL_CODE
;
604 LOG_DEBUG("Terminating on Signal %d", sig
);
606 LOG_DEBUG("Ignored extra Signal %d", sig
);
611 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
613 shutdown_openocd
= SHUTDOWN_WITH_SIGNAL_CODE
;
617 static void sigkey_handler(int sig
)
619 /* ignore keystroke generated signals if not in foreground process group */
621 if (tcgetpgrp(STDIN_FILENO
) > 0)
624 LOG_DEBUG("Ignored Signal %d", sig
);
629 int server_host_os_entry(void)
631 /* this currently only calls WSAStartup on native win32 systems
632 * before any socket operations are performed.
633 * This is an issue if you call init in your config script */
636 WORD wVersionRequested
;
639 wVersionRequested
= MAKEWORD(2, 2);
641 if (WSAStartup(wVersionRequested
, &wsaData
) != 0) {
642 LOG_ERROR("Failed to Open Winsock");
649 int server_host_os_close(void)
657 int server_preinit(void)
660 /* register ctrl-c handler */
661 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
663 signal(SIGBREAK
, sig_handler
);
664 signal(SIGINT
, sig_handler
);
666 signal(SIGHUP
, sig_handler
);
667 signal(SIGPIPE
, sig_handler
);
668 signal(SIGQUIT
, sigkey_handler
);
669 signal(SIGINT
, sigkey_handler
);
671 signal(SIGTERM
, sig_handler
);
672 signal(SIGABRT
, sig_handler
);
677 int server_init(struct command_context
*cmd_ctx
)
679 int ret
= tcl_init();
684 ret
= telnet_init("Open On-Chip Debugger");
686 if (ret
!= ERROR_OK
) {
694 int server_quit(void)
700 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
705 /* return signal number so we can kill ourselves */
709 void server_free(void)
712 telnet_service_free();
718 void exit_on_signal(int sig
)
721 /* bring back default system handler and kill yourself */
722 signal(sig
, SIG_DFL
);
727 int connection_write(struct connection
*connection
, const void *data
, int len
)
730 /* successful no-op. Sockets and pipes behave differently here... */
733 if (connection
->service
->type
== CONNECTION_TCP
)
734 return write_socket(connection
->fd_out
, data
, len
);
736 return write(connection
->fd_out
, data
, len
);
739 int connection_read(struct connection
*connection
, void *data
, int len
)
741 if (connection
->service
->type
== CONNECTION_TCP
)
742 return read_socket(connection
->fd
, data
, len
);
744 return read(connection
->fd
, data
, len
);
747 /* tell the server we want to shut down */
748 COMMAND_HANDLER(handle_shutdown_command
)
750 LOG_USER("shutdown command invoked");
752 shutdown_openocd
= SHUTDOWN_REQUESTED
;
755 if (!strcmp(CMD_ARGV
[0], "error")) {
756 shutdown_openocd
= SHUTDOWN_WITH_ERROR_CODE
;
761 return ERROR_COMMAND_CLOSE_CONNECTION
;
764 COMMAND_HANDLER(handle_poll_period_command
)
767 LOG_WARNING("You need to set a period value");
769 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], polling_period
);
771 LOG_INFO("set servers polling period to %ums", polling_period
);
776 COMMAND_HANDLER(handle_bindto_command
)
780 command_print(CMD
, "bindto name: %s", bindto_name
);
784 bindto_name
= strdup(CMD_ARGV
[0]);
787 return ERROR_COMMAND_SYNTAX_ERROR
;
792 static const struct command_registration server_command_handlers
[] = {
795 .handler
= &handle_shutdown_command
,
798 .help
= "shut the server down",
801 .name
= "poll_period",
802 .handler
= &handle_poll_period_command
,
805 .help
= "set the servers polling period",
809 .handler
= &handle_bindto_command
,
810 .mode
= COMMAND_CONFIG
,
812 .help
= "Specify address by name on which to listen for "
813 "incoming TCP/IP connections",
815 COMMAND_REGISTRATION_DONE
818 int server_register_commands(struct command_context
*cmd_ctx
)
820 int retval
= telnet_register_commands(cmd_ctx
);
821 if (ERROR_OK
!= retval
)
824 retval
= tcl_register_commands(cmd_ctx
);
825 if (ERROR_OK
!= retval
)
828 retval
= jsp_register_commands(cmd_ctx
);
829 if (ERROR_OK
!= retval
)
832 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
835 COMMAND_HELPER(server_port_command
, unsigned short *out
)
839 command_print(CMD
, "%d", *out
);
844 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
849 return ERROR_COMMAND_SYNTAX_ERROR
;
854 COMMAND_HELPER(server_pipe_command
, char **out
)
858 command_print(CMD
, "%s", *out
);
862 if (CMD_CTX
->mode
== COMMAND_EXEC
) {
863 LOG_WARNING("unable to change server port after init");
864 return ERROR_COMMAND_ARGUMENT_INVALID
;
867 *out
= strdup(CMD_ARGV
[0]);
871 return ERROR_COMMAND_SYNTAX_ERROR
;
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)