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 /* shutdown_openocd == 1: exit the main event loop, and quit the
50 * debugger; 2: quit with non-zero return code */
51 static int shutdown_openocd
;
53 /* store received signal to exit application by killing ourselves */
54 static int last_signal
;
56 /* set the polling period to 100ms */
57 static int polling_period
= 100;
59 /* address by name on which to listen for incoming TCP/IP connections */
60 static char *bindto_name
;
62 static int add_connection(struct service
*service
, struct command_context
*cmd_ctx
)
64 socklen_t address_size
;
65 struct connection
*c
, **p
;
69 c
= malloc(sizeof(struct connection
));
72 memset(&c
->sin
, 0, sizeof(c
->sin
));
73 c
->cmd_ctx
= copy_command_context(cmd_ctx
);
79 if (service
->type
== CONNECTION_TCP
) {
80 address_size
= sizeof(c
->sin
);
82 c
->fd
= accept(service
->fd
, (struct sockaddr
*)&service
->sin
, &address_size
);
85 /* This increases performance dramatically for e.g. GDB load which
86 * does not have a sliding window protocol.
88 * Ignore errors from this fn as it probably just means less performance
90 setsockopt(c
->fd
, /* socket affected */
91 IPPROTO_TCP
, /* set option at TCP level */
92 TCP_NODELAY
, /* name of option */
93 (char *)&flag
, /* the cast is historical cruft */
94 sizeof(int)); /* length of option value */
96 LOG_INFO("accepting '%s' connection on tcp/%s", service
->name
, service
->port
);
97 retval
= service
->new_connection(c
);
98 if (retval
!= ERROR_OK
) {
100 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
101 command_done(c
->cmd_ctx
);
105 } else if (service
->type
== CONNECTION_STDINOUT
) {
107 c
->fd_out
= fileno(stdout
);
110 /* we are using stdin/out so ignore ctrl-c under windoze */
111 SetConsoleCtrlHandler(NULL
, TRUE
);
114 /* do not check for new connections again on stdin */
117 LOG_INFO("accepting '%s' connection from pipe", service
->name
);
118 retval
= service
->new_connection(c
);
119 if (retval
!= ERROR_OK
) {
120 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
121 command_done(c
->cmd_ctx
);
125 } else if (service
->type
== CONNECTION_PIPE
) {
127 /* do not check for new connections again on stdin */
130 char *out_file
= alloc_printf("%so", service
->port
);
131 c
->fd_out
= open(out_file
, O_WRONLY
);
133 if (c
->fd_out
== -1) {
134 LOG_ERROR("could not open %s", service
->port
);
135 command_done(c
->cmd_ctx
);
140 LOG_INFO("accepting '%s' connection from pipe %s", service
->name
, service
->port
);
141 retval
= service
->new_connection(c
);
142 if (retval
!= ERROR_OK
) {
143 LOG_ERROR("attempted '%s' connection rejected", service
->name
);
144 command_done(c
->cmd_ctx
);
150 /* add to the end of linked list */
151 for (p
= &service
->connections
; *p
; p
= &(*p
)->next
)
155 if (service
->max_connections
!= CONNECTION_LIMIT_UNLIMITED
)
156 service
->max_connections
--;
161 static int remove_connection(struct service
*service
, struct connection
*connection
)
163 struct connection
**p
= &service
->connections
;
164 struct connection
*c
;
166 /* find connection */
168 if (c
->fd
== connection
->fd
) {
169 service
->connection_closed(c
);
170 if (service
->type
== CONNECTION_TCP
)
172 else if (service
->type
== CONNECTION_PIPE
) {
173 /* The service will listen to the pipe again */
174 c
->service
->fd
= c
->fd
;
177 command_done(c
->cmd_ctx
);
179 /* delete connection */
183 if (service
->max_connections
!= CONNECTION_LIMIT_UNLIMITED
)
184 service
->max_connections
++;
189 /* redirect p to next list pointer */
196 static void free_service(struct service
*c
)
203 int add_service(char *name
,
206 new_connection_handler_t new_connection_handler
,
207 input_handler_t input_handler
,
208 connection_closed_handler_t connection_closed_handler
,
211 struct service
*c
, **p
;
213 int so_reuseaddr_option
= 1;
215 c
= malloc(sizeof(struct service
));
217 c
->name
= strdup(name
);
218 c
->port
= strdup(port
);
219 c
->max_connections
= 1; /* Only TCP/IP ports can support more than one connection */
221 c
->connections
= NULL
;
222 c
->new_connection
= new_connection_handler
;
223 c
->input
= input_handler
;
224 c
->connection_closed
= connection_closed_handler
;
228 if (strcmp(c
->port
, "pipe") == 0)
229 c
->type
= CONNECTION_STDINOUT
;
232 portnumber
= strtol(c
->port
, &end
, 0);
233 if (!*end
&& (parse_long(c
->port
, &portnumber
) == ERROR_OK
)) {
234 c
->portnumber
= portnumber
;
235 c
->type
= CONNECTION_TCP
;
237 c
->type
= CONNECTION_PIPE
;
240 if (c
->type
== CONNECTION_TCP
) {
241 c
->max_connections
= max_connections
;
243 c
->fd
= socket(AF_INET
, SOCK_STREAM
, 0);
245 LOG_ERROR("error creating socket: %s", strerror(errno
));
253 (void *)&so_reuseaddr_option
,
256 socket_nonblock(c
->fd
);
258 memset(&c
->sin
, 0, sizeof(c
->sin
));
259 c
->sin
.sin_family
= AF_INET
;
261 if (bindto_name
== NULL
)
262 c
->sin
.sin_addr
.s_addr
= INADDR_ANY
;
264 hp
= gethostbyname(bindto_name
);
266 LOG_ERROR("couldn't resolve bindto address: %s", bindto_name
);
271 memcpy(&c
->sin
.sin_addr
, hp
->h_addr_list
[0], hp
->h_length
);
273 c
->sin
.sin_port
= htons(c
->portnumber
);
275 if (bind(c
->fd
, (struct sockaddr
*)&c
->sin
, sizeof(c
->sin
)) == -1) {
276 LOG_ERROR("couldn't bind %s to socket on port %d: %s", name
, c
->portnumber
, strerror(errno
));
284 setsockopt(c
->fd
, IPPROTO_TCP
, TCP_MAXSEG
, &segsize
, sizeof(int));
286 int window_size
= 128 * 1024;
288 /* These setsockopt()s must happen before the listen() */
290 setsockopt(c
->fd
, SOL_SOCKET
, SO_SNDBUF
,
291 (char *)&window_size
, sizeof(window_size
));
292 setsockopt(c
->fd
, SOL_SOCKET
, SO_RCVBUF
,
293 (char *)&window_size
, sizeof(window_size
));
295 if (listen(c
->fd
, 1) == -1) {
296 LOG_ERROR("couldn't listen on socket: %s", strerror(errno
));
302 struct sockaddr_in addr_in
;
303 socklen_t addr_in_size
= sizeof(addr_in
);
304 getsockname(c
->fd
, (struct sockaddr
*)&addr_in
, &addr_in_size
);
305 LOG_INFO("Listening on port %hu for %s connections",
306 ntohs(addr_in
.sin_port
), name
);
307 } else if (c
->type
== CONNECTION_STDINOUT
) {
308 c
->fd
= fileno(stdin
);
311 /* for win32 set stdin/stdout to binary mode */
312 if (_setmode(_fileno(stdout
), _O_BINARY
) < 0)
313 LOG_WARNING("cannot change stdout mode to binary");
314 if (_setmode(_fileno(stdin
), _O_BINARY
) < 0)
315 LOG_WARNING("cannot change stdin mode to binary");
316 if (_setmode(_fileno(stderr
), _O_BINARY
) < 0)
317 LOG_WARNING("cannot change stderr mode to binary");
319 socket_nonblock(c
->fd
);
321 } else if (c
->type
== CONNECTION_PIPE
) {
323 /* we currenty do not support named pipes under win32
324 * so exit openocd for now */
325 LOG_ERROR("Named pipes currently not supported under this os");
329 /* Pipe we're reading from */
330 c
->fd
= open(c
->port
, O_RDONLY
| O_NONBLOCK
);
332 LOG_ERROR("could not open %s", c
->port
);
339 /* add to the end of linked list */
340 for (p
= &services
; *p
; p
= &(*p
)->next
)
347 static int remove_services(void)
349 struct service
*c
= services
;
353 struct service
*next
= c
->next
;
358 if (c
->type
== CONNECTION_PIPE
) {
371 /* remember the last service for unlinking */
380 int server_loop(struct command_context
*command_context
)
382 struct service
*service
;
386 /* used in select() */
390 /* used in accept() */
394 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
395 LOG_ERROR("couldn't set SIGPIPE to SIG_IGN");
398 while (!shutdown_openocd
) {
399 /* monitor sockets for activity */
403 /* add service and connection fds to read_fds */
404 for (service
= services
; service
; service
= service
->next
) {
405 if (service
->fd
!= -1) {
406 /* listen for new connections */
407 FD_SET(service
->fd
, &read_fds
);
409 if (service
->fd
> fd_max
)
410 fd_max
= service
->fd
;
413 if (service
->connections
) {
414 struct connection
*c
;
416 for (c
= service
->connections
; c
; c
= c
->next
) {
417 /* check for activity on the connection */
418 FD_SET(c
->fd
, &read_fds
);
428 /* we're just polling this iteration, this is faster on embedded
431 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
433 /* Every 100ms, can be changed with "poll_period" command */
434 tv
.tv_usec
= polling_period
* 1000;
435 /* Only while we're sleeping we'll let others run */
436 openocd_sleep_prelude();
438 retval
= socket_select(fd_max
+ 1, &read_fds
, NULL
, NULL
, &tv
);
439 openocd_sleep_postlude();
445 errno
= WSAGetLastError();
447 if (errno
== WSAEINTR
)
450 LOG_ERROR("error during select: %s", strerror(errno
));
458 LOG_ERROR("error during select: %s", strerror(errno
));
465 /* We only execute these callbacks when there was nothing to do or we timed
467 target_call_timer_callbacks();
468 process_jim_events(command_context
);
470 FD_ZERO(&read_fds
); /* eCos leaves read_fds unchanged in this case! */
472 /* We timed out/there was nothing to do, timeout rather than poll next time
476 /* There was something to do, next time we'll just poll */
480 /* This is a simple back-off algorithm where we immediately
481 * re-poll if we did something this time around.
483 * This greatly improves performance of DCC.
485 poll_ok
= poll_ok
|| target_got_message();
487 for (service
= services
; service
; service
= service
->next
) {
488 /* handle new connections on listeners */
489 if ((service
->fd
!= -1)
490 && (FD_ISSET(service
->fd
, &read_fds
))) {
491 if (service
->max_connections
!= 0)
492 add_connection(service
, command_context
);
494 if (service
->type
== CONNECTION_TCP
) {
495 struct sockaddr_in sin
;
496 socklen_t address_size
= sizeof(sin
);
498 tmp_fd
= accept(service
->fd
,
499 (struct sockaddr
*)&service
->sin
,
501 close_socket(tmp_fd
);
504 "rejected '%s' connection, no more connections allowed",
509 /* handle activity on connections */
510 if (service
->connections
) {
511 struct connection
*c
;
513 for (c
= service
->connections
; c
; ) {
514 if ((FD_ISSET(c
->fd
, &read_fds
)) || c
->input_pending
) {
515 retval
= service
->input(c
);
516 if (retval
!= ERROR_OK
) {
517 struct connection
*next
= c
->next
;
518 if (service
->type
== CONNECTION_PIPE
||
519 service
->type
== CONNECTION_STDINOUT
) {
520 /* if connection uses a pipe then
521 * shutdown openocd on error */
522 shutdown_openocd
= 1;
524 remove_connection(service
, c
);
525 LOG_INFO("dropped '%s' connection",
538 while (PeekMessage(&msg
, NULL
, 0, 0, PM_REMOVE
)) {
539 if (msg
.message
== WM_QUIT
)
540 shutdown_openocd
= 1;
545 return shutdown_openocd
!= 2 ? ERROR_OK
: ERROR_FAIL
;
549 BOOL WINAPI
ControlHandler(DWORD dwCtrlType
)
551 shutdown_openocd
= 1;
556 void sig_handler(int sig
)
558 /* store only first signal that hits us */
561 shutdown_openocd
= 1;
564 int server_preinit(void)
566 /* this currently only calls WSAStartup on native win32 systems
567 * before any socket operations are performed.
568 * This is an issue if you call init in your config script */
571 WORD wVersionRequested
;
574 wVersionRequested
= MAKEWORD(2, 2);
576 if (WSAStartup(wVersionRequested
, &wsaData
) != 0) {
577 LOG_ERROR("Failed to Open Winsock");
581 /* register ctrl-c handler */
582 SetConsoleCtrlHandler(ControlHandler
, TRUE
);
584 signal(SIGBREAK
, sig_handler
);
586 signal(SIGINT
, sig_handler
);
587 signal(SIGTERM
, sig_handler
);
588 signal(SIGABRT
, sig_handler
);
593 int server_init(struct command_context
*cmd_ctx
)
595 int ret
= tcl_init();
600 ret
= telnet_init("Open On-Chip Debugger");
602 if (ret
!= ERROR_OK
) {
610 int server_quit(void)
617 SetConsoleCtrlHandler(ControlHandler
, FALSE
);
622 /* return signal number so we can kill ourselves */
626 void exit_on_signal(int sig
)
629 /* bring back default system handler and kill yourself */
630 signal(sig
, SIG_DFL
);
635 int connection_write(struct connection
*connection
, const void *data
, int len
)
638 /* successful no-op. Sockets and pipes behave differently here... */
641 if (connection
->service
->type
== CONNECTION_TCP
)
642 return write_socket(connection
->fd_out
, data
, len
);
644 return write(connection
->fd_out
, data
, len
);
647 int connection_read(struct connection
*connection
, void *data
, int len
)
649 if (connection
->service
->type
== CONNECTION_TCP
)
650 return read_socket(connection
->fd
, data
, len
);
652 return read(connection
->fd
, data
, len
);
655 /* tell the server we want to shut down */
656 COMMAND_HANDLER(handle_shutdown_command
)
658 LOG_USER("shutdown command invoked");
660 shutdown_openocd
= 1;
663 if (!strcmp(CMD_ARGV
[0], "error")) {
664 shutdown_openocd
= 2;
669 return ERROR_COMMAND_CLOSE_CONNECTION
;
672 COMMAND_HANDLER(handle_poll_period_command
)
675 LOG_WARNING("You need to set a period value");
677 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], polling_period
);
679 LOG_INFO("set servers polling period to %ums", polling_period
);
684 COMMAND_HANDLER(handle_bindto_command
)
688 command_print(CMD_CTX
, "bindto name: %s", bindto_name
);
692 bindto_name
= strdup(CMD_ARGV
[0]);
695 return ERROR_COMMAND_SYNTAX_ERROR
;
700 static const struct command_registration server_command_handlers
[] = {
703 .handler
= &handle_shutdown_command
,
706 .help
= "shut the server down",
709 .name
= "poll_period",
710 .handler
= &handle_poll_period_command
,
713 .help
= "set the servers polling period",
717 .handler
= &handle_bindto_command
,
720 .help
= "Specify address by name on which to listen for "
721 "incoming TCP/IP connections",
723 COMMAND_REGISTRATION_DONE
726 int server_register_commands(struct command_context
*cmd_ctx
)
728 int retval
= telnet_register_commands(cmd_ctx
);
729 if (ERROR_OK
!= retval
)
732 retval
= tcl_register_commands(cmd_ctx
);
733 if (ERROR_OK
!= retval
)
736 retval
= jsp_register_commands(cmd_ctx
);
737 if (ERROR_OK
!= retval
)
740 return register_commands(cmd_ctx
, NULL
, server_command_handlers
);
743 COMMAND_HELPER(server_port_command
, unsigned short *out
)
747 command_print(CMD_CTX
, "%d", *out
);
752 COMMAND_PARSE_NUMBER(u16
, CMD_ARGV
[0], port
);
757 return ERROR_COMMAND_SYNTAX_ERROR
;
762 COMMAND_HELPER(server_pipe_command
, char **out
)
766 command_print(CMD_CTX
, "%s", *out
);
770 if (CMD_CTX
->mode
== COMMAND_EXEC
) {
771 LOG_WARNING("unable to change server port after init");
772 return ERROR_COMMAND_ARGUMENT_INVALID
;
775 *out
= strdup(CMD_ARGV
[0]);
779 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)