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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 ***************************************************************************/
32 #include <target/target.h>
33 #include <target/target_request.h>
34 #include <target/openrisc/jsp_server.h>
36 #include "tcl_server.h"
37 #include "telnet_server.h"
42 #include <netinet/tcp.h>
45 static struct service
*services
;
47 /* shutdown_openocd == 1: exit the main event loop, and quit the
48 * debugger; 2: quit with non-zero return code */
49 static int shutdown_openocd
;
51 /* store received signal to exit application by killing ourselves */
52 static int last_signal
;
54 /* set the polling period to 100ms */
55 static int polling_period
= 100;
57 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
59 socklen_t address_size
;
60 struct connection
*c
, **p
;
64 c
= malloc(sizeof(struct connection
));
67 memset(&c
->sin
, 0, sizeof(c
->sin
));
68 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
74 if (service
->type
== CONNECTION_TCP
) {
75 address_size
= sizeof(c
->sin
);
77 c
->fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
80 /* This increases performance dramatically for e.g. GDB load which
81 * does not have a sliding window protocol.
83 * Ignore errors from this fn as it probably just means less performance
85 setsockopt(c
->fd
, /* socket affected */
86 IPPROTO_TCP
, /* set option at TCP level */
87 TCP_NODELAY
, /* name of option */
88 (char *)&flag
, /* the cast is historical cruft */
89 sizeof(int)); /* length of option value */
91 LOG_INFO("accepting '%s' connection on tcp/%s", service
->name
, service
->port
);
92 retval
= service
->new_connection(c
);
93 if (retval
!= ERROR_OK
) {
95 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
96 command_done(c
->cmd_ctx
);
100 } else if (service
->type
== CONNECTION_STDINOUT
) {
102 c
->fd_out
= fileno(stdout
);
105 /* we are using stdin/out so ignore ctrl-c under windoze */
106 SetConsoleCtrlHandler(NULL
, TRUE
);
109 /* do not check for new connections again on stdin */
112 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
113 retval
= service
->new_connection(c
);
114 if (retval
!= ERROR_OK
) {
115 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
116 command_done(c
->cmd_ctx
);
120 } else if (service
->type
== CONNECTION_PIPE
) {
122 /* do not check for new connections again on stdin */
125 char *out_file
= alloc_printf("%so", service
->port
);
126 c
->fd_out
= open(out_file
, O_WRONLY
);
128 if (c
->fd_out
== -1) {
129 LOG_ERROR("could not open %s", service
->port
);
133 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
134 retval
= service
->new_connection(c
);
135 if (retval
!= ERROR_OK
) {
136 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
137 command_done(c
->cmd_ctx
);
143 /* add to the end of linked list */
144 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
)
148 service
->max_connections
--;
153 static int remove_connection(struct service
*service
, struct connection
*connection
)
155 struct connection
**p
= &service
->connections
;
156 struct connection
*c
;
158 /* find connection */
160 if (c
->fd
== connection
->fd
) {
161 service
->connection_closed(c
);
162 if (service
->type
== CONNECTION_TCP
)
164 else if (service
->type
== CONNECTION_PIPE
) {
165 /* The service will listen to the pipe again */
166 c
->service
->fd
= c
->fd
;
169 command_done(c
->cmd_ctx
);
171 /* delete connection */
175 service
->max_connections
++;
179 /* redirect p to next list pointer */
186 /* FIX! make service return error instead of invoking exit() */
187 int add_service(char *name
,
190 new_connection_handler_t new_connection_handler
,
191 input_handler_t input_handler
,
192 connection_closed_handler_t connection_closed_handler
,
195 struct service
*c
, **p
;
196 int so_reuseaddr_option
= 1;
198 c
= malloc(sizeof(struct service
));
200 c
->name
= strdup(name
);
201 c
->port
= strdup(port
);
202 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
204 c
->connections
= NULL
;
205 c
->new_connection
= new_connection_handler
;
206 c
->input
= input_handler
;
207 c
->connection_closed
= connection_closed_handler
;
211 if (strcmp(c
->port
, "pipe") == 0)
212 c
->type
= CONNECTION_STDINOUT
;
215 portnumber
= strtol(c
->port
, &end
, 0);
216 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
)) {
217 c
->portnumber
= portnumber
;
218 c
->type
= CONNECTION_TCP
;
220 c
->type
= CONNECTION_PIPE
;
223 if (c
->type
== CONNECTION_TCP
) {
224 c
->max_connections
= max_connections
;
226 c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0);
228 LOG_ERROR("error creating socket: %s", strerror(errno
));
235 (void *)&so_reuseaddr_option
,
238 socket_nonblock(c
->fd
);
240 memset(&c
->sin
, 0, sizeof(c
->sin
));
241 c
->sin
.sin_family
= AF_INET
;
242 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
243 c
->sin
.sin_port
= htons(c
->portnumber
);
245 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1) {
246 LOG_ERROR("couldn't bind to socket: %s", strerror(errno
));
252 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
254 int window_size
= 128 * 1024;
256 /* These setsockopt()s must happen before the listen() */
258 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
259 (char *)&window_size
, sizeof(window_size
));
260 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
261 (char *)&window_size
, sizeof(window_size
));
263 if (listen(c
->fd
, 1) == -1) {
264 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
267 } else if (c
->type
== CONNECTION_STDINOUT
) {
268 c
->fd
= fileno(stdin
);
271 /* for win32 set stdin/stdout to binary mode */
272 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
273 LOG_WARNING("cannot change stdout mode to binary");
274 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
275 LOG_WARNING("cannot change stdin mode to binary");
276 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
277 LOG_WARNING("cannot change stderr mode to binary");
279 socket_nonblock(c
->fd
);
281 } else if (c
->type
== CONNECTION_PIPE
) {
283 /* we currenty do not support named pipes under win32
284 * so exit openocd for now */
285 LOG_ERROR("Named pipes currently not supported under this os");
288 /* Pipe we're reading from */
289 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
291 LOG_ERROR("could not open %s", c
->port
);
297 /* add to the end of linked list */
298 for (p
= &services
; *p
; p
= &(*p
)->next
)
305 static int remove_services(void)
307 struct service
*c
= services
;
311 struct service
*next
= c
->next
;
316 if (c
->type
== CONNECTION_PIPE
) {
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
) {
357 /* monitor sockets for activity */
361 /* add service and connection fds to read_fds */
362 for (service
= services
; service
; service
= service
->next
) {
363 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
) {
372 struct connection
*c
;
374 for (c
= service
->connections
; c
; c
= c
->next
) {
375 /* check for activity on the connection */
376 FD_SET(c
->fd
, &read_fds
);
386 /* we're just polling this iteration, this is faster on embedded
389 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
391 /* Every 100ms, can be changed with "poll_period" command */
392 tv
.tv_usec
= polling_period
* 1000;
393 /* Only while we're sleeping we'll let others run */
394 openocd_sleep_prelude();
396 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
397 openocd_sleep_postlude();
403 errno
= WSAGetLastError();
405 if (errno
== WSAEINTR
)
408 LOG_ERROR("error during select: %s", strerror(errno
));
416 LOG_ERROR("error during select: %s", strerror(errno
));
423 /* We only execute these callbacks when there was nothing to do or we timed
425 target_call_timer_callbacks();
426 process_jim_events(command_context
);
428 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
430 /* We timed out/there was nothing to do, timeout rather than poll next time
434 /* There was something to do, next time we'll just poll */
438 /* This is a simple back-off algorithm where we immediately
439 * re-poll if we did something this time around.
441 * This greatly improves performance of DCC.
443 poll_ok
= poll_ok
|| target_got_message();
445 for (service
= services
; service
; service
= service
->next
) {
446 /* handle new connections on listeners */
447 if ((service
->fd
!= -1)
448 && (FD_ISSET(service
->fd
, &read_fds
))) {
449 if (service
->max_connections
> 0)
450 add_connection(service
, command_context
);
452 if (service
->type
== CONNECTION_TCP
) {
453 struct sockaddr_in sin
;
454 socklen_t address_size
= sizeof(sin
);
456 tmp_fd
= accept(service
->fd
,
457 (struct sockaddr
*)&service
->sin
,
459 close_socket(tmp_fd
);
462 "rejected '%s' connection, no more connections allowed",
467 /* handle activity on connections */
468 if (service
->connections
) {
469 struct connection
*c
;
471 for (c
= service
->connections
; c
; ) {
472 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
) {
473 retval
= service
->input(c
);
474 if (retval
!= ERROR_OK
) {
475 struct connection
*next
= c
->next
;
476 if (service
->type
== CONNECTION_PIPE
||
477 service
->type
== CONNECTION_STDINOUT
) {
478 /* if connection uses a pipe then
479 * shutdown openocd on error */
480 shutdown_openocd
= 1;
482 remove_connection(service
, c
);
483 LOG_INFO("dropped '%s' connection",
496 while (PeekMessage(&msg
, NULL
, 0, 0, PM_REMOVE
)) {
497 if (msg
.message
== WM_QUIT
)
498 shutdown_openocd
= 1;
503 return shutdown_openocd
!= 2 ? ERROR_OK
: ERROR_FAIL
;
507 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
509 shutdown_openocd
= 1;
514 void sig_handler(int sig
)
516 /* store only first signal that hits us */
519 shutdown_openocd
= 1;
522 int server_preinit(void)
524 /* this currently only calls WSAStartup on native win32 systems
525 * before any socket operations are performed.
526 * This is an issue if you call init in your config script */
529 WORD wVersionRequested
;
532 wVersionRequested
= MAKEWORD(2, 2);
534 if (WSAStartup(wVersionRequested
, &wsaData
) != 0) {
535 LOG_ERROR("Failed to Open Winsock");
539 /* register ctrl-c handler */
540 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
542 signal(SIGBREAK
, sig_handler
);
544 signal(SIGINT
, sig_handler
);
545 signal(SIGTERM
, sig_handler
);
546 signal(SIGABRT
, sig_handler
);
551 int server_init(struct command_context
*cmd_ctx
)
553 int ret
= tcl_init();
557 return telnet_init("Open On-Chip Debugger");
560 int server_quit(void)
567 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
572 /* return signal number so we can kill ourselves */
576 void exit_on_signal(int sig
)
579 /* bring back default system handler and kill yourself */
580 signal(sig
, SIG_DFL
);
585 int connection_write(struct connection
*connection
, const void *data
, int len
)
588 /* successful no-op. Sockets and pipes behave differently here... */
591 if (connection
->service
->type
== CONNECTION_TCP
)
592 return write_socket(connection
->fd_out
, data
, len
);
594 return write(connection
->fd_out
, data
, len
);
597 int connection_read(struct connection
*connection
, void *data
, int len
)
599 if (connection
->service
->type
== CONNECTION_TCP
)
600 return read_socket(connection
->fd
, data
, len
);
602 return read(connection
->fd
, data
, len
);
605 /* tell the server we want to shut down */
606 COMMAND_HANDLER(handle_shutdown_command
)
608 LOG_USER("shutdown command invoked");
610 shutdown_openocd
= 1;
613 if (!strcmp(CMD_ARGV
[0], "error")) {
614 shutdown_openocd
= 2;
619 return ERROR_COMMAND_CLOSE_CONNECTION
;
622 COMMAND_HANDLER(handle_poll_period_command
)
625 LOG_WARNING("You need to set a period value");
627 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], polling_period
);
629 LOG_INFO("set servers polling period to %ums", polling_period
);
634 static const struct command_registration server_command_handlers
[] = {
637 .handler
= &handle_shutdown_command
,
640 .help
= "shut the server down",
643 .name
= "poll_period",
644 .handler
= &handle_poll_period_command
,
647 .help
= "set the servers polling period",
649 COMMAND_REGISTRATION_DONE
652 int server_register_commands(struct command_context
*cmd_ctx
)
654 int retval
= telnet_register_commands(cmd_ctx
);
655 if (ERROR_OK
!= retval
)
658 retval
= tcl_register_commands(cmd_ctx
);
659 if (ERROR_OK
!= retval
)
662 retval
= jsp_register_commands(cmd_ctx
);
663 if (ERROR_OK
!= retval
)
666 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
669 COMMAND_HELPER(server_port_command
, unsigned short *out
)
673 command_print(CMD_CTX
, "%d", *out
);
678 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
683 return ERROR_COMMAND_SYNTAX_ERROR
;
688 COMMAND_HELPER(server_pipe_command
, char **out
)
692 command_print(CMD_CTX
, "%s", *out
);
696 if (CMD_CTX
->mode
== COMMAND_EXEC
) {
697 LOG_WARNING("unable to change server port after init");
698 return ERROR_COMMAND_ARGUMENT_INVALID
;
701 *out
= strdup(CMD_ARGV
[0]);
705 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)